diff options
Diffstat (limited to 'documentation')
190 files changed, 38518 insertions, 17201 deletions
diff --git a/documentation/.gitignore b/documentation/.gitignore index 35ead8af66..b23d598054 100644 --- a/documentation/.gitignore +++ b/documentation/.gitignore @@ -1,5 +1,11 @@ +sphinx/__pycache__ _build/ Pipfile.lock +poky.yaml +sphinx-static/switchers.js +releases.rst .vscode/ */svg/*.png */svg/*.pdf +styles/* +!styles/config diff --git a/documentation/.vale.ini b/documentation/.vale.ini new file mode 100644 index 0000000000..02042bb632 --- /dev/null +++ b/documentation/.vale.ini @@ -0,0 +1,7 @@ +StylesPath = styles +MinAlertLevel = suggestion +Packages = RedHat, proselint, write-good, alex, Readability, Joblint +Vocab = Yocto, OpenSource +[*.rst] +BasedOnStyles = Vale, RedHat, proselint, write-good, alex, Readability, Joblint + diff --git a/documentation/Makefile b/documentation/Makefile index f04f381bd2..189bd1dfac 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -5,6 +5,9 @@ # from the environment for the first two. SPHINXOPTS ?= -W --keep-going -j auto SPHINXBUILD ?= sphinx-build +# Release notes are excluded because they contain contributor names and commit messages which can't be modified +VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst' +VALEDOCS ?= . SOURCEDIR = . IMAGEDIRS = */svg BUILDDIR = _build @@ -20,7 +23,7 @@ endif help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: all help Makefile clean publish epub latexpdf +.PHONY: all help Makefile clean stylecheck publish epub latexpdf publish: Makefile html singlehtml rm -rf $(BUILDDIR)/$(DESTDIR)/ @@ -44,12 +47,21 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED $(SVG2PNG) --export-filename=$@ $< clean: - @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) + @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst + +stylecheck: + vale sync + vale $(VALEOPTS) $(VALEDOCS) + +sphinx-lint: + sphinx-lint $(SOURCEDIR) epub: $(PNGs) + $(SOURCEDIR)/set_versions.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) latexpdf: $(PDFs) + $(SOURCEDIR)/set_versions.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) all: html epub latexpdf @@ -57,4 +69,5 @@ all: html epub latexpdf # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: + $(SOURCEDIR)/set_versions.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/documentation/README b/documentation/README index 10b46de3e6..b60472fcbf 100644 --- a/documentation/README +++ b/documentation/README @@ -34,16 +34,18 @@ Manual Organization Here the folders corresponding to individual manuals: +* brief-yoctoprojectqs - Yocto Project Quick Start * overview-manual - Yocto Project Overview and Concepts Manual -* sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide. +* contributor-guide - Yocto Project and OpenEmbedded Contributor Guide +* ref-manual - Yocto Project Reference Manual * bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide * dev-manual - Yocto Project Development Tasks Manual * kernel-dev - Yocto Project Linux Kernel Development Manual -* ref-manual - Yocto Project Reference Manual -* brief-yoctoprojectqs - Yocto Project Quick Start * profile-manual - Yocto Project Profiling and Tracing Manual +* sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide. * toaster-manual - Toaster User Manual * test-manual - Yocto Project Test Environment Manual +* migration-guides - Yocto Project Release and Migration Notes Each folder is self-contained regarding content and figures. @@ -113,17 +115,26 @@ documentation with Python3. Sphinx might be available in your Linux distro packages repositories, however it is not recommended to use distro packages, as they might be old versions, especially if you are using an LTS version of your -distro. The recommended method to install Sphinx and all required -dependencies is to use the Python Package Index (pip). +distro. The recommended method to install the latest versions of Sphinx +and of its required dependencies is to use the Python Package Index (pip). To install all required packages run: $ pip3 install sphinx sphinx_rtd_theme pyyaml +To make sure you always have the latest versions of such packages, you +should regularly run the same command with an added "--upgrade" option: + + $ pip3 install --upgrade sphinx sphinx_rtd_theme pyyaml + Also install the "inkscape" package from your distribution. Inkscape is need to convert SVG graphics to PNG (for EPUB export) and to PDF (for PDF export). +Additionally install "fncychap.sty" TeX font if you want to build PDFs. Debian +and Ubuntu have it in "texlive-latex-extra" package while RedHat distributions +and OpenSUSE have it in "texlive-fncychap" package for example. + To build the documentation locally, run: $ cd documentation @@ -140,6 +151,34 @@ dependencies in a virtual environment: $ pipenv install $ pipenv run make html +Style checking the Yocto Project documentation +============================================== + +The project is starting to use Vale (https://vale.sh/) +to validate the text style. + +To install Vale: + + $ pip install vale + +To run Vale: + + $ make stylecheck + +Link checking the Yocto Project documentation +============================================= + +To fix errors which are not reported by Sphinx itself, +the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint). + +To install sphinx-lint: + + $ pip install sphinx-lint + +To run sphinx-lint: + + $ make sphinx-lint + Sphinx theme and CSS customization ================================== @@ -170,17 +209,18 @@ The layout of the Yocto Project manuals is organized as follows Book Chapter Section - Section - Section + Subsection + Subsubsection + Subsubsubsection -Here are the heading styles defined in Sphinx: +Here are the heading styles that we use in the manuals: - Book => overline === - Chapter => overline *** - Section => ==== - Section => ---- - Section => ^^^^ - Section => """" or ~~~~ + Book => overline === + Chapter => overline *** + Section => ==== + Subsection => ---- + Subsubsection => ~~~~ + Subsubsubsection => ^^^^ With this proposal, we preserve the same TOCs between Sphinx and Docbook. @@ -265,6 +305,19 @@ websites. More information can be found here: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html. +For external links, we use this syntax: +`link text <link URL>`__ + +instead of: +`link text <link URL>`_ + +Both syntaxes work, but the latter also creates a "link text" reference +target which could conflict with other references with the same name. +So, only use this variant when you wish to make multiple references +to this link, reusing only the target name. + +See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-links-underscore-vs-use + Anchor (<#link>) links are forbidden as they are not checked by Sphinx during the build and may be broken without knowing about it. @@ -334,13 +387,16 @@ The sphinx.ext.intersphinx extension is enabled by default so that we can cross reference content from other Sphinx based documentation projects, such as the BitBake manual. -References to the BitBake manual can be done: +References to the BitBake manual can directly be done: - With a specific description instead of the section name: - :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>` - With the section name: - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option - - Linking to the entire BitBake manual: - :doc:`BitBake User Manual <bitbake:index>` + :ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option + +If you want to refer to an entire document (or chapter) in the BitBake manual, +you have to use the ":doc:" macro with the "bitbake:" prefix: + - :doc:`BitBake User Manual <bitbake:index>` + - :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter Note that a reference to a variable (:term:`VARIABLE`) automatically points to the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. @@ -349,6 +405,11 @@ BitBake manual as follows: :term:`bitbake:BB_NUMBER_PARSE_THREADS` +This would be the same if we had identical document filenames in +both the Yocto Project and BitBake manuals: + + :ref:`bitbake:directory/file:section title` + Submitting documentation changes ================================ diff --git a/documentation/_templates/footer.html b/documentation/_templates/footer.html index 508129ede4..fb3c58d845 100644 --- a/documentation/_templates/footer.html +++ b/documentation/_templates/footer.html @@ -5,7 +5,7 @@ <br> All Rights Reserved. Linux Foundation® and Yocto Project® are registered trademarks of the Linux Foundation. <br>Linux® is a registered trademark of Linus Torvalds. <br>© Copyright {{ copyright }} - <br>Last updated on {{ last_updated }} + <br>Last updated on {{ last_updated }} from the <a href="https://git.yoctoproject.org/yocto-docs/">yocto-docs</a> git repository. </p> </div> </footer> diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst index 9b64d91efd..6b7f956707 100644 --- a/documentation/boilerplate.rst +++ b/documentation/boilerplate.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + .. include:: <xhtml1-lat1.txt> .. include:: <xhtml1-symbol.txt> @@ -8,7 +10,7 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales -<https://creativecommons.org/licenses/by-sa/2.0/uk/>`_ as published by Creative +<https://creativecommons.org/licenses/by-sa/2.0/uk/>`__ as published by Creative Commons. To report any inaccuracies or problems with this (or any other Yocto Project) diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index eaacde2d9a..61c5cbec36 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -25,18 +25,11 @@ build a reference embedded OS called Poky. in the Yocto Project Development Tasks Manual for more information. - - You may use Windows Subsystem For Linux v2 to set up a build host - using Windows 10. - - .. note:: - - 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 (wslv2)` section in the Yocto Project Development - Tasks Manual for more information. + - You may use version 2 of Windows Subsystem For Linux (WSL 2) to set + up a build host using Windows 10 or later, Windows Server 2019 or later. + 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 want more conceptual or background information on the Yocto Project, see the :doc:`/overview-manual/index`. @@ -47,7 +40,13 @@ Compatible Linux Distribution Make sure your :term:`Build Host` meets the following requirements: -- 50 Gbytes of free disk space +- At least &MIN_DISK_SPACE; Gbytes of free disk space, though + much more will help to run multiple builds and increase + performance by reusing build artifacts. + +- At least &MIN_RAM; Gbytes of RAM, though a modern modern build host with as + much RAM and as many CPU cores as possible is strongly recommended to + maximize build performance. - Runs a supported Linux distribution (i.e. recent releases of Fedora, openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux @@ -64,11 +63,12 @@ following requirements: - tar &MIN_TAR_VERSION; or greater - Python &MIN_PYTHON_VERSION; or greater. - gcc &MIN_GCC_VERSION; or greater. + - GNU make &MIN_MAKE_VERSION; or greater If your build host does not meet any of these three listed version requirements, you can take steps to prepare the system so that you can still use the Yocto Project. See the -:ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` +:ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` section in the Yocto Project Reference Manual for information. Build Host Packages @@ -76,11 +76,9 @@ Build Host Packages You must install essential host packages on your build host. The following command installs the host packages based on an Ubuntu -distribution: - -.. code-block:: shell +distribution:: - $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; + $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; .. note:: @@ -230,13 +228,13 @@ an entire Linux distribution, including the toolchain, from source. Among other things, the script creates the :term:`Build Directory`, which is ``build`` in this case and is located in the :term:`Source Directory`. After - the script runs, your current working directory is set to the Build - Directory. Later, when the build completes, the Build Directory contains all the - files created during the build. + the script runs, your current working directory is set to the + :term:`Build Directory`. Later, when the build completes, the + :term:`Build Directory` contains all the files created during the build. #. **Examine Your Local Configuration File:** When you set up the build environment, a local configuration file named ``local.conf`` becomes - available in a ``conf`` subdirectory of the Build Directory. For this + available in a ``conf`` subdirectory of the :term:`Build Directory`. For this example, the defaults are set to build for a ``qemux86`` target, which is suitable for emulation. The package manager used is set to the RPM package manager. @@ -250,18 +248,13 @@ an entire Linux distribution, including the toolchain, from source. This is relevant only when your network and the server that you use can download these artifacts faster than you would be able to build them. - To use such mirrors, uncomment the below lines in your ``local.conf`` + To use such mirrors, uncomment the below lines in your ``conf/local.conf`` file in the :term:`Build Directory`:: - BB_SIGNATURE_HANDLER = "OEEquivHash" + BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687" + SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH" BB_HASHSERVE = "auto" - BB_HASHSERVE_UPSTREAM = "typhoon.yocto.io:8687" - SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/&YOCTO_DOC_VERSION;/PATH;downloadfilename=PATH" - - The above settings assumed the use of Yocto Project &YOCTO_DOC_VERSION;. - If you are using the development version instead, set :term:`SSTATE_MIRRORS` as follows:: - - SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/dev/PATH;downloadfilename=PATH" + BB_SIGNATURE_HANDLER = "OEEquivHash" #. **Start the Build:** Continue with the following command to build an OS image for the target, which is ``core-image-sato`` in this example: @@ -273,7 +266,7 @@ an entire Linux distribution, including the toolchain, from source. For information on using the ``bitbake`` command, see the :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and Concepts Manual, or see - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` + :ref:`bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` in the BitBake User Manual. #. **Simulate Your Image Using QEMU:** Once this particular image is @@ -356,9 +349,7 @@ Follow these steps to add a hardware layer: #. **Add Your Layer to the Layer Configuration File:** Before you can use a layer during a build, you must add it to your ``bblayers.conf`` - file, which is found in the - :term:`Build Directory` ``conf`` - directory. + file, which is found in the :term:`Build Directory` ``conf`` directory. Use the ``bitbake-layers add-layer`` command to add the layer to the configuration file: @@ -374,7 +365,7 @@ Follow these steps to add a hardware layer: You can find more information on adding layers 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. Completing these steps has added the ``meta-altera`` layer to your Yocto @@ -409,7 +400,7 @@ The following commands run the tool to create a layer named For more information on layers and how to create them, see the -:ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script` +:ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script` section in the Yocto Project Development Tasks Manual. Where To Go Next @@ -424,12 +415,12 @@ information including the website, wiki pages, and user manuals: development documentation, and access to a rich Yocto Project Development Community into which you can tap. -- **Developer Screencast:** The `Getting Started with the Yocto Project - - New Developer Screencast Tutorial <https://vimeo.com/36450321>`__ - provides a 30-minute video created for users unfamiliar with the - Yocto Project but familiar with Linux build hosts. While this - screencast is somewhat dated, the introductory and fundamental - concepts are useful for the beginner. +- **Video Seminar:** The `Introduction to the Yocto Project and BitBake, Part 1 + <https://youtu.be/yuE7my3KOpo>`__ and + `Introduction to the Yocto Project and BitBake, Part 2 + <https://youtu.be/iZ05TTyzGHk>`__ videos offer a video seminar + introducing you to the most important aspects of developing a + custom embedded Linux distribution with the Yocto Project. - **Yocto Project Overview and Concepts Manual:** The :doc:`/overview-manual/index` is a great diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index f8d38ca484..11ca5d8b76 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -************************************************ -Board Support Packages (BSP) - Developer's Guide -************************************************ +************************************************** +Board Support Packages (BSP) --- Developer's Guide +************************************************** A Board Support Package (BSP) is a collection of information that defines how to support a particular hardware device, set of devices, or @@ -64,8 +64,8 @@ Here is an example that clones the Raspberry Pi BSP layer:: In addition to BSP layers, the ``meta-yocto-bsp`` layer is part of the shipped ``poky`` repository. The ``meta-yocto-bsp`` layer maintains -several "reference" BSPs including the ARM-based Beaglebone, MIPS-based -EdgeRouter, and generic versions of both 32-bit and 64-bit IA machines. +several "reference" BSPs including the ARM-based Beaglebone and generic +versions of both 32-bit and 64-bit IA machines. For information on typical BSP development workflow, see the :ref:`bsp-guide/bsp:developing a board support package (bsp)` @@ -109,8 +109,7 @@ them to the "Dependencies" section. Some layers function as a layer to hold other BSP layers. These layers are known as ":term:`container layers <Container Layer>`". An example of -this type of layer is OpenEmbedded's -`meta-openembedded <https://github.com/openembedded/meta-openembedded>`__ +this type of layer is OpenEmbedded's :oe_git:`meta-openembedded </meta-openembedded>` layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers. In cases like this, you need to include the names of the actual layers you want to work with, such as:: @@ -128,7 +127,7 @@ you want to work with, such as:: and so on. For more information on layers, see the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. Preparing Your Build Host to Work With BSP Layers @@ -166,8 +165,9 @@ section. #. *Determine the BSP Layer You Want:* The Yocto Project supports many BSPs, which are maintained in their own layers or in layers designed to contain several BSPs. To get an idea of machine support through - BSP layers, you can look at the `index of - machines <&YOCTO_RELEASE_DL_URL;/machines>`__ for the release. + BSP layers, you can look at the + :yocto_dl:`index of machines </releases/yocto/yocto-&DISTRO;/machines>` + for the release. #. *Optionally Clone the meta-intel BSP Layer:* If your hardware is based on current Intel CPUs and devices, you can leverage this BSP @@ -336,7 +336,7 @@ the :yocto_git:`Source Repositories <>`: meta-raspberrypi/recipes-bsp/formfactor/formfactor meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi meta-raspberrypi/recipes-bsp/formfactor/formfactor/raspberrypi/machconfig - meta-raspberrypi/recipes-bsp/formfactor/formfactor_0.0.bbappend + meta-raspberrypi/recipes-bsp/formfactor/formfactor_%.bbappend meta-raspberrypi/recipes-bsp/rpi-u-boot-src meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files meta-raspberrypi/recipes-bsp/rpi-u-boot-src/files/boot.cmd.in @@ -463,7 +463,7 @@ requirements are handled with the ``COPYING.MIT`` file. Licensing files can be MIT, BSD, GPLv*, and so forth. These files are recommended for the BSP but are optional and totally up to the BSP developer. For information on how to maintain license compliance, see -the ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. README File @@ -589,7 +589,7 @@ filenames correspond to the values to which users have set the These files define things such as the kernel package to use (:term:`PREFERRED_PROVIDER` of -:ref:`virtual/kernel <dev-manual/common-tasks:using virtual providers>`), +:ref:`virtual/kernel <dev-manual/new-recipe:using virtual providers>`), the hardware drivers to include in different types of images, any special software components that are needed, any bootloader information, and also any special image format requirements. @@ -620,7 +620,7 @@ You can find these files in the BSP Layer at:: This optional directory contains miscellaneous recipe files for the BSP. Most notably would be the formfactor files. For example, in the -Raspberry Pi BSP, there is the ``formfactor_0.0.bbappend`` file, which +Raspberry Pi BSP, there is the ``formfactor_%.bbappend`` file, which is an append file used to augment the recipe that starts the build. Furthermore, there are machine-specific settings used during the build that are defined by the ``machconfig`` file further down in the @@ -724,6 +724,7 @@ workflow. .. image:: figures/bsp-dev-flow.png :align: center + :width: 70% #. *Set up Your Host Development System to Support Development Using the Yocto Project*: See the ":ref:`dev-manual/start:preparing the build host`" @@ -756,36 +757,20 @@ workflow. OpenEmbedded build system knows about. For more information on layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" section in the Yocto Project Overview and Concepts Manual. You can also - reference the ":ref:`dev-manual/common-tasks:understanding and creating layers`" + reference the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. For more information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" section. .. note:: - - There are four hardware reference BSPs in the Yocto + - There are three hardware reference BSPs in the Yocto Project release, located in the ``poky/meta-yocto-bsp`` BSP layer: - Texas Instruments Beaglebone (``beaglebone-yocto``) - - Ubiquiti Networks EdgeRouter Lite (``edgerouter``) - - - Two general IA platforms (``genericx86`` and ``genericx86-64``) - - - There are three core Intel BSPs in the Yocto Project - release, in the ``meta-intel`` layer: - - - ``intel-core2-32``, which is a BSP optimized for the Core2 - family of CPUs as well as all CPUs prior to the Silvermont - core. - - - ``intel-corei7-64``, which is a BSP optimized for Nehalem - and later Core and Xeon CPUs as well as Silvermont and later - Atom CPUs, such as the Baytrail SoCs. - - - ``intel-quark``, which is a BSP optimized for the Intel - Galileo gen1 & gen2 development boards. + - Two generic IA platforms (``genericx86`` and ``genericx86-64``) When you set up a layer for a new BSP, you should follow a standard layout. This layout is described in the ":ref:`bsp-guide/bsp:example filesystem layout`" @@ -815,7 +800,7 @@ workflow. key configuration files are configured appropriately: the ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must make the OpenEmbedded build system aware of your new layer. See the - ":ref:`dev-manual/common-tasks:enabling your layer`" + ":ref:`dev-manual/layers:enabling your layer`" section in the Yocto Project Development Tasks Manual for information on how to let the build system know about your new layer. @@ -844,7 +829,7 @@ Before looking at BSP requirements, you should consider the following: layer that can be added to the Yocto Project. For guidelines on creating a layer that meets these base requirements, see the ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. - The requirements in this section apply regardless of how you package @@ -866,8 +851,7 @@ Before looking at BSP requirements, you should consider the following: dictating that a specific kernel or kernel version be used in a given BSP. -Following are the requirements for a released BSP that conform to the -Yocto Project: +The requirements for a released BSP that conform to the Yocto Project are: - *Layer Name:* The BSP must have a layer name that follows the Yocto Project standards. For information on BSP layer names, see the @@ -877,7 +861,7 @@ Yocto Project: your BSP layer as listed in the ``recipes.txt`` file, which is found in ``poky/meta`` directory of the :term:`Source Directory` or in the OpenEmbedded-Core Layer (``openembedded-core``) at - https://git.openembedded.org/openembedded-core/tree/meta. + :oe_git:`/openembedded-core/tree/meta`. You should place recipes (``*.bb`` files) and recipe modifications (``*.bbappend`` files) into ``recipes-*`` subdirectories by @@ -892,8 +876,8 @@ Yocto Project: ``recipes-*`` subdirectories specific to the recipe's function, or within a subdirectory containing a set of closely-related recipes. The recipes themselves should follow the general guidelines for - recipes used in the Yocto Project found in the ":oe_wiki:`OpenEmbedded - Style Guide </Styleguide>`". + recipes found in the ":doc:`../contributor-guide/recipe-style-guide`" + in the Yocto Project and OpenEmbedded Contributor Guide. - *License File:* You must include a license file in the ``meta-bsp_root_name`` directory. This license covers the BSP @@ -926,8 +910,8 @@ Yocto Project: - The name and contact information for the BSP layer maintainer. This is the person to whom patches and questions should be sent. For information on how to find the right person, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section in the Yocto Project Development Tasks Manual. + :doc:`../contributor-guide/submit-changes` section in the Yocto Project and + OpenEmbedded Contributor Guide. - Instructions on how to build the BSP using the BSP layer. @@ -971,7 +955,7 @@ Yocto Project: Released BSP Recommendations ---------------------------- -Following are recommendations for released BSPs that conform to the +Here are recommendations for released BSPs that conform to the Yocto Project: - *Bootable Images:* Released BSPs can contain one or more bootable @@ -1012,7 +996,7 @@ the following: - Create a ``*.bbappend`` file for the modified recipe. For information on using append files, see the - ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual. - Ensure your directory structure in the BSP layer that supports your @@ -1033,7 +1017,7 @@ the following: that additional hierarchy and the files would obviously not be able to reside in a machine-specific directory. -Following is a specific example to help you better understand the +Here is a specific example to help you better understand the process. This example customizes a recipe by adding a BSP-specific configuration file named ``interfaces`` to the ``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer @@ -1112,24 +1096,24 @@ list describes them in order of preference: #. *Use the LICENSE_FLAGS Variable to Define the Recipes that Have Commercial or Other Types of Specially-Licensed Packages:* For each of those recipes, you can specify a matching license string in a ``local.conf`` variable named - :term:`LICENSE_FLAGS_WHITELIST`. + :term:`LICENSE_FLAGS_ACCEPTED`. Specifying the matching license string signifies that you agree to the license. Thus, the build system can build the corresponding recipe and include the component in the image. 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 for details on how to use these variables. If you build as you normally would, without specifying any recipes in - the :term:`LICENSE_FLAGS_WHITELIST` variable, the build stops and provides + the :term:`LICENSE_FLAGS_ACCEPTED` variable, the build stops and provides you with the list of recipes that you have tried to include in the image - that need entries in the :term:`LICENSE_FLAGS_WHITELIST` variable. Once you + that need entries in the :term:`LICENSE_FLAGS_ACCEPTED` variable. Once you enter the appropriate license flags into it, restart the build to continue where it left off. During the build, the prompt will not appear again since you have satisfied the requirement. Once the appropriate license flags are on the white list in the - :term:`LICENSE_FLAGS_WHITELIST` variable, you can build the encumbered + :term:`LICENSE_FLAGS_ACCEPTED` variable, you can build the encumbered image with no change at all to the normal build process. #. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by @@ -1142,7 +1126,7 @@ list describes them in order of preference: click-through license agreements presented by the website. If you want to build the image yourself using the recipes contained within the BSP tarball, you will still need to create an appropriate - :term:`LICENSE_FLAGS_WHITELIST` to match the encumbered recipes in the + :term:`LICENSE_FLAGS_ACCEPTED` to match the encumbered recipes in the BSP. .. note:: @@ -1168,7 +1152,7 @@ Use these steps to create a BSP layer: ``create-layer`` subcommand to create a new general layer. For instructions on how to create a general layer using the ``bitbake-layers`` script, see the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. - *Create a Layer Configuration File:* Every layer needs a layer @@ -1178,14 +1162,14 @@ Use these steps to create a BSP layer: :yocto_git:`Source Repositories <>`. To get examples of what you need in your configuration file, locate a layer (e.g. "meta-ti") and examine the - :yocto_git:`local.conf </meta-ti/tree/conf/layer.conf>` + :yocto_git:`local.conf </meta-ti/tree/meta-ti-bsp/conf/layer.conf>` file. - *Create a Machine Configuration File:* Create a ``conf/machine/bsp_root_name.conf`` file. See :yocto_git:`meta-yocto-bsp/conf/machine </poky/tree/meta-yocto-bsp/conf/machine>` for sample ``bsp_root_name.conf`` files. There are other samples such as - :yocto_git:`meta-ti </meta-ti/tree/conf/machine>` + :yocto_git:`meta-ti </meta-ti/tree/meta-ti-bsp/conf/machine>` and :yocto_git:`meta-freescale </meta-freescale/tree/conf/machine>` from other vendors that have more specific machine and tuning @@ -1193,7 +1177,7 @@ Use these steps to create a BSP layer: - *Create a Kernel Recipe:* Create a kernel recipe in ``recipes-kernel/linux`` by either using a kernel append file or a - new custom kernel recipe file (e.g. ``yocto-linux_4.12.bb``). The BSP + new custom kernel recipe file (e.g. ``linux-yocto_4.12.bb``). The BSP layers mentioned in the previous step also contain different kernel examples. See the ":ref:`kernel-dev/common:modifying an existing recipe`" section in the Yocto Project Linux Kernel Development Manual for @@ -1208,7 +1192,7 @@ BSP Layer Configuration Example ------------------------------- The layer's ``conf`` directory contains the ``layer.conf`` configuration -file. In this example, the ``conf/layer.conf`` is the following:: +file. In this example, the ``conf/layer.conf`` file is the following:: # We have a conf and classes directory, add to BBPATH BBPATH .= ":${LAYERDIR}" @@ -1228,7 +1212,7 @@ configuration files is to examine various files for BSP from the :yocto_git:`Source Repositories <>`. For a detailed description of this particular layer configuration file, -see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`" +see ":ref:`step 3 <dev-manual/layers:creating your own layer>`" in the discussion that describes how to create layers in the Yocto Project Development Tasks Manual. @@ -1249,21 +1233,18 @@ There are one or more machine configuration files in the For example, the machine configuration file for the `BeagleBone and BeagleBone Black development boards <https://beagleboard.org/bone>`__ is -located in the layer ``poky/meta-yocto-bsp/conf/machine`` and is named -``beaglebone-yocto.conf``:: +located in :yocto_git:`poky/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf +</poky/tree/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf>`:: #@TYPE: Machine #@NAME: Beaglebone-yocto machine #@DESCRIPTION: Reference machine configuration for http://beagleboard.org/bone and http://beagleboard.org/black boards PREFERRED_PROVIDER_virtual/xserver ?= "xserver-xorg" - XSERVER ?= "xserver-xorg \ - xf86-video-modesetting \ - " MACHINE_EXTRA_RRECOMMENDS = "kernel-modules kernel-devicetree" - EXTRA_IMAGEDEPENDS += "u-boot" + EXTRA_IMAGEDEPENDS += "virtual/bootloader" DEFAULTTUNE ?= "cortexa8hf-neon" include conf/machine/include/arm/armv7a/tune-cortexa8.inc @@ -1271,19 +1252,20 @@ located in the layer ``poky/meta-yocto-bsp/conf/machine`` and is named IMAGE_FSTYPES += "tar.bz2 jffs2 wic wic.bmap" EXTRA_IMAGECMD:jffs2 = "-lnp " WKS_FILE ?= "beaglebone-yocto.wks" - IMAGE_INSTALL:append = " kernel-devicetree kernel-image-zimage" - do_image_wic[depends] += "mtools-native:do_populate_sysroot dosfstools-native:do_populate_sysroot" + MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "kernel-image kernel-devicetree" + do_image_wic[depends] += "mtools-native:do_populate_sysroot dosfstools-native:do_populate_sysroot virtual/bootloader:do_deploy" - SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyO0" - SERIAL_CONSOLES_CHECK = "${SERIAL_CONSOLES}" + SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyO0 115200;ttyAMA0" PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" - PREFERRED_VERSION_linux-yocto ?= "5.0%" + PREFERRED_VERSION_linux-yocto ?= "6.1%" KERNEL_IMAGETYPE = "zImage" KERNEL_DEVICETREE = "am335x-bone.dtb am335x-boneblack.dtb am335x-bonegreen.dtb" KERNEL_EXTRA_ARGS += "LOADADDR=${UBOOT_ENTRYPOINT}" + PREFERRED_PROVIDER_virtual/bootloader ?= "u-boot" + SPL_BINARY = "MLO" UBOOT_SUFFIX = "img" UBOOT_MACHINE = "am335x_evm_defconfig" @@ -1292,7 +1274,24 @@ located in the layer ``poky/meta-yocto-bsp/conf/machine`` and is named MACHINE_FEATURES = "usbgadget usbhost vfat alsa" - IMAGE_BOOT_FILES ?= "u-boot.${UBOOT_SUFFIX} MLO zImage am335x-bone.dtb am335x-boneblack.dtb am335x-bonegreen.dtb" + IMAGE_BOOT_FILES ?= "u-boot.${UBOOT_SUFFIX} ${SPL_BINARY} ${KERNEL_IMAGETYPE} ${KERNEL_DEVICETREE}" + + # support runqemu + EXTRA_IMAGEDEPENDS += "qemu-native qemu-helper-native" + IMAGE_CLASSES += "qemuboot" + QB_DEFAULT_FSTYPE = "wic" + QB_FSINFO = "wic:no-kernel-in-fs" + QB_KERNEL_ROOT = "/dev/vda2" + QB_SYSTEM_NAME = "qemu-system-arm" + QB_MACHINE = "-machine virt" + QB_CPU = "-cpu cortex-a15" + QB_KERNEL_CMDLINE_APPEND = "console=ttyAMA0 systemd.mask=systemd-networkd" + QB_OPT_APPEND = "-device virtio-rng-device" + QB_TAP_OPT = "-netdev tap,id=net0,ifname=@TAP@,script=no,downscript=no" + QB_NETWORK_DEVICE = "-device virtio-net-device,netdev=net0,mac=@MAC@" + QB_ROOTFS_OPT = "-drive id=disk0,file=@ROOTFS@,if=none,format=raw -device virtio-blk-device,drive=disk0" + QB_SERIAL_OPT = "" + QB_TCPSERIAL_OPT = "-device virtio-serial-device -chardev socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device virtconsole,chardev=virtcon" The variables used to configure the machine define machine-specific properties; for example, machine-dependent packages, machine tunings, the type of kernel @@ -1312,11 +1311,6 @@ Project Reference Manual. "virtual/xserver" is "xserver-xorg", available in ``poky/meta/recipes-graphics/xorg-xserver``. -- :term:`XSERVER`: The packages that - should be installed to provide an X server and drivers for the - machine. In this example, the "xserver-xorg" and - "xf86-video-modesetting" are installed. - - :term:`MACHINE_EXTRA_RRECOMMENDS`: A list of machine-dependent packages not essential for booting the image. Thus, the build does not fail if the packages do not exist. @@ -1334,12 +1328,15 @@ Project Reference Manual. needed in the root filesystem. In this case, the U-Boot recipe must be built for the image. + At the end of the file, we also use this setings to implement + ``runqemu`` support on the host machine. + - :term:`DEFAULTTUNE`: Machines use tunings to optimize machine, CPU, and application performance. These features, which are collectively known as "tuning features", - are set in the :term:`OpenEmbedded-Core (OE-Core)` layer (e.g. - ``poky/meta/conf/machine/include``). In this example, the default - tuning file is ``cortexa8hf-neon``. + are set in the :term:`OpenEmbedded-Core (OE-Core)` layer. In this + example, the default tuning file is :oe_git:`tune-cortexa8 + </openembedded-core/tree/meta/conf/machine/include/arm/armv7a/tune-cortexa8.inc>`. .. note:: @@ -1355,17 +1352,11 @@ Project Reference Manual. - :term:`EXTRA_IMAGECMD`: Specifies additional options for image creation commands. In this example, the "-lnp " option is used when creating the - `JFFS2 <https://en.wikipedia.org/wiki/JFFS2>`__ image. + :wikipedia:`JFFS2 <JFFS2>` image. - :term:`WKS_FILE`: The location of the :ref:`Wic kickstart <ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference>` file used - by the OpenEmbedded build system to create a partitioned image - (image.wic). - -- :term:`IMAGE_INSTALL`: - Specifies packages to install into an image through the - :ref:`image <ref-classes-image>` class. Recipes - use the :term:`IMAGE_INSTALL` variable. + by the OpenEmbedded build system to create a partitioned image. - ``do_image_wic[depends]``: A task that is constructed during the build. In this example, the task depends on specific tools in order @@ -1383,7 +1374,7 @@ Project Reference Manual. - :term:`PREFERRED_VERSION_linux-yocto <PREFERRED_VERSION>`: Defines the version of the recipe used to build the kernel, which is - "5.0" in this case. + "6.1" in this case. - :term:`KERNEL_IMAGETYPE`: The type of kernel to build for the device. In this case, the @@ -1448,39 +1439,35 @@ The kernel recipe used to build the kernel image for the BeagleBone device was established in the machine configuration:: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" - PREFERRED_VERSION_linux-yocto ?= "5.0%" + PREFERRED_VERSION_linux-yocto ?= "6.1%" The ``meta-yocto-bsp/recipes-kernel/linux`` directory in the layer contains metadata used to build the kernel. In this case, a kernel append file -(i.e. ``linux-yocto_5.0.bbappend``) is used to override an established -kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in +(i.e. ``linux-yocto_6.1.bbappend``) is used to override an established +kernel recipe (i.e. ``linux-yocto_6.1.bb``), which is located in :yocto_git:`/poky/tree/meta/recipes-kernel/linux`. -Following is the contents of the append file:: +The contents of the append file are:: - KBRANCH:genericx86 = "v5.0/standard/base" - KBRANCH:genericx86-64 = "v5.0/standard/base" - KBRANCH:edgerouter = "v5.0/standard/edgerouter" - KBRANCH:beaglebone-yocto = "v5.0/standard/beaglebone" + KBRANCH:genericx86 = "v6.1/standard/base" + KBRANCH:genericx86-64 = "v6.1/standard/base" + KBRANCH:beaglebone-yocto = "v6.1/standard/beaglebone" KMACHINE:genericx86 ?= "common-pc" KMACHINE:genericx86-64 ?= "common-pc-64" KMACHINE:beaglebone-yocto ?= "beaglebone" - SRCREV_machine:genericx86 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine:genericx86-64 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine:edgerouter ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine:beaglebone-yocto ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" + SRCREV_machine:genericx86 ?= "6ec439b4b456ce929c4c07fe457b5d6a4b468e86" + SRCREV_machine:genericx86-64 ?= "6ec439b4b456ce929c4c07fe457b5d6a4b468e86" + SRCREV_machine:beaglebone-yocto ?= "423e1996694b61fbfc8ec3bf062fc6461d64fde1" COMPATIBLE_MACHINE:genericx86 = "genericx86" COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64" - COMPATIBLE_MACHINE:edgerouter = "edgerouter" COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto" - LINUX_VERSION:genericx86 = "5.0.3" - LINUX_VERSION:genericx86-64 = "5.0.3" - LINUX_VERSION:edgerouter = "5.0.3" - LINUX_VERSION:beaglebone-yocto = "5.0.3" + LINUX_VERSION:genericx86 = "6.1.30" + LINUX_VERSION:genericx86-64 = "6.1.30" + LINUX_VERSION:beaglebone-yocto = "6.1.20" This particular append file works for all the machines that are part of the ``meta-yocto-bsp`` layer. The relevant statements are diff --git a/documentation/conf.py b/documentation/conf.py index 1bea180325..35c5c14535 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -15,9 +15,27 @@ import os import sys import datetime +try: + import yaml +except ImportError: + sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ + \nPlease make sure to install pyyaml Python package.\n") + sys.exit(1) -current_version = "dev" -bitbake_version = "" # Leave empty for development branch +# current_version = "dev" +# bitbake_version = "" # Leave empty for development branch +# Obtain versions from poky.yaml instead +with open("poky.yaml") as data: + buff = data.read() + subst_vars = yaml.safe_load(buff) + if "DOCCONF_VERSION" not in subst_vars: + sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml") + sys.exit(1) + current_version = subst_vars["DOCCONF_VERSION"] + if "BITBAKE_SERIES" not in subst_vars: + sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml") + sys.exit(1) + bitbake_version = subst_vars["BITBAKE_SERIES"] # String used in sidebar version = 'Version: ' + current_version @@ -35,7 +53,7 @@ author = 'The Linux Foundation' # -- General configuration --------------------------------------------------- # Prevent building with an outdated version of sphinx -needs_sphinx = "3.1" +needs_sphinx = "4.0" # to load local extension from the folder 'sphinx' sys.path.insert(0, os.path.abspath('sphinx')) @@ -72,6 +90,8 @@ rst_prolog = """ # external links and substitutions extlinks = { + 'cve': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'), + 'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'), 'yocto_home': ('https://www.yoctoproject.org%s', None), 'yocto_wiki': ('https://wiki.yoctoproject.org/wiki%s', None), 'yocto_dl': ('https://downloads.yoctoproject.org%s', None), @@ -79,7 +99,7 @@ extlinks = { 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None), 'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None), 'yocto_docs': ('https://docs.yoctoproject.org%s', None), - 'yocto_git': ('https://git.yoctoproject.org/cgit/cgit.cgi%s', None), + 'yocto_git': ('https://git.yoctoproject.org%s', None), 'yocto_sstate': ('http://sstate.yoctoproject.org%s', None), 'oe_home': ('https://www.openembedded.org%s', None), 'oe_lists': ('https://lists.openembedded.org%s', None), @@ -87,9 +107,10 @@ extlinks = { 'oe_wiki': ('https://www.openembedded.org/wiki%s', None), 'oe_layerindex': ('https://layers.openembedded.org%s', None), 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None), + 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), } -# Intersphinx config to use cross reference with Bitbake user manual +# Intersphinx config to use cross reference with BitBake user manual intersphinx_mapping = { 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) } @@ -110,7 +131,7 @@ try: } except ImportError: sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\ - \nPlease make sure to install the sphinx_rtd_theme python package.\n") + \nPlease make sure to install the sphinx_rtd_theme Python package.\n") sys.exit(1) html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg' @@ -138,8 +159,8 @@ html_last_updated_fmt = '%b %d, %Y' html_secnumber_suffix = " " latex_elements = { - 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', - 'preamble': '\setcounter{tocdepth}{2}', + 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', + 'preamble': '\\setcounter{tocdepth}{2}', } # Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG diff --git a/documentation/contributor-guide/identify-component.rst b/documentation/contributor-guide/identify-component.rst new file mode 100644 index 0000000000..a28391a66a --- /dev/null +++ b/documentation/contributor-guide/identify-component.rst @@ -0,0 +1,31 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Identify the component +********************** + +The Yocto Project and OpenEmbedded ecosystem is built of :term:`layers <Layer>` +so the first step is to identify the component where the issue likely lies. +For example, if you have a hardware issue, it is likely related to the BSP +you are using and the best place to seek advice would be from the BSP provider +or :term:`layer`. If the issue is a build/configuration one and a distro is in +use, they would likely be the first place to ask questions. If the issue is a +generic one and/or in the core classes or metadata, the core layer or BitBake +might be the appropriate component. + +Each metadata layer being used should contain a ``README`` file and that should +explain where to report issues, where to send changes and how to contact the +maintainers. + +If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake, +issues can be reported in the :yocto_bugs:`Yocto Project Bugzilla <>`. The +:yocto_lists:`yocto </g/yocto>` mailing list is a general “catch-all” location +where questions can be sent if you can’t work out where something should go. + +:term:`Poky` is a commonly used “combination” repository where multiple +components have been combined (:oe_git:`bitbake </bitbake>`, +:oe_git:`openembedded-core </openembedded-core>`, +:yocto_git:`meta-yocto </meta-yocto>` and +:yocto_git:`yocto-docs </yocto-docs>`). Patches should be submitted against the +appropriate individual component rather than :term:`Poky` itself as detailed in +the appropriate ``README`` file. + diff --git a/documentation/contributor-guide/index.rst b/documentation/contributor-guide/index.rst new file mode 100644 index 0000000000..a832169455 --- /dev/null +++ b/documentation/contributor-guide/index.rst @@ -0,0 +1,26 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +================================================ +Yocto Project and OpenEmbedded Contributor Guide +================================================ + +The Yocto Project and OpenEmbedded are open-source, community-based projects so +contributions are very welcome, it is how the code evolves and everyone can +effect change. Contributions take different forms, if you have a fix for an +issue you’ve run into, a patch is the most appropriate way to contribute it. +If you run into an issue but don’t have a solution, opening a defect in +:yocto_bugs:`Bugzilla <>` or asking questions on the mailing lists might be +more appropriate. This guide intends to point you in the right direction to +this. + + +.. toctree:: + :caption: Table of Contents + :numbered: + + identify-component + report-defect + recipe-style-guide + submit-changes + +.. include:: /boilerplate.rst diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst new file mode 100644 index 0000000000..08d8fb4259 --- /dev/null +++ b/documentation/contributor-guide/recipe-style-guide.rst @@ -0,0 +1,411 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Recipe Style Guide +****************** + +Recipe Naming Conventions +========================= + +In general, most recipes should follow the naming convention +``recipes-category/recipename/recipename_version.bb``. Recipes for related +projects may share the same recipe directory. ``recipename`` and ``category`` +may contain hyphens, but hyphens are not allowed in ``version``. + +If the recipe is tracking a Git revision that does not correspond to a released +version of the software, ``version`` may be ``git`` (e.g. ``recipename_git.bb``) +and the recipe would set :term:`PV`. + +Version Policy +============== + +Our versions follow the form ``<epoch>:<version>-<revision>`` +or in BitBake variable terms ${:term:`PE`}:${:term:`PV`}-${:term:`PR`}. We +generally follow the `Debian <https://www.debian.org/doc/debian-policy/ch-controlfields.html#version>`__ +version policy which defines these terms. + +In most cases the version :term:`PV` will be set automatically from the recipe +file name. It is recommended to use released versions of software as these are +revisions that upstream are expecting people to use. + +Recipe versions should always compare and sort correctly so that upgrades work +as expected. With conventional versions such as ``1.4`` upgrading ``to 1.5`` +this happens naturally, but some versions don't sort. For example, +``1.5 Release Candidate 2`` could be written as ``1.5rc2`` but this sorts after +``1.5``, so upgrades from feeds won't happen correctly. + +Instead the tilde (``~``) operator can be used, which sorts before the empty +string so ``1.5~rc2`` comes before ``1.5``. There is a historical syntax which +may be found where :term:`PV` is set as a combination of the prior version +``+`` the pre-release version, for example ``PV=1.4+1.5rc2``. This is a valid +syntax but the tilde form is preferred. + +For version comparisons, the ``opkg-compare-versions`` program from +``opkg-utils`` can be useful when attempting to determine how two version +numbers compare to each other. Our definitive version comparison algorithm is +the one within bitbake which aims to match those of the package managers and +Debian policy closely. + +When a recipe references a git revision that does not correspond to a released +version of software (e.g. is not a tagged version), the :term:`PV` variable +should include the Git revision using the following to make the +version clear:: + + PV = "<version>+git${SRCPV}" + +In this case, ``<version>`` should be the most recently released version of the +software from the current source revision (``git describe`` can be useful for +determining this). Whilst not recommended for published layers, this format is +also useful when using :term:`AUTOREV` to set the recipe to increment source +control revisions automatically, which can be useful during local development. + +Version Number Changes +====================== + +The :term:`PR` variable is used to indicate different revisions of a recipe +that reference the same upstream source version. It can be used to force a +new version of a recipe to be installed onto a device from a package feed. +These once had to be set manually but in most cases these can now be set and +incremented automatically by a PR Server connected with a package feed. + +When :term:`PV` increases, any existing :term:`PR` value can and should be +removed. + +If :term:`PV` changes in such a way that it does not increase with respect to +the previous value, you need to increase :term:`PE` to ensure package managers +will upgrade it correctly. If unset you should set :term:`PE` to "1" since +the default of empty is easily confused with "0" depending on the package +manager. :term:`PE` can only have an integer value. + +Recipe formatting +================= + +Variable Formatting +------------------- + +- Variable assignment should a space around each side of the operator, e.g. + ``FOO = "bar"``, not ``FOO="bar"``. + +- Double quotes should be used on the right-hand side of the assignment, + e.g. ``FOO = "bar"`` not ``FOO = 'bar'`` + +- Spaces should be used for indenting variables, with 4 spaces per tab + +- Long variables should be split over multiple lines when possible by using + the continuation character (``\``) + +- When splitting a long variable over multiple lines, all continuation lines + should be indented (with spaces) to align with the start of the quote on the + first line:: + + FOO = "this line is \ + long \ + " + + Instead of:: + + FOO = "this line is \ + long \ + " + +Python Function formatting +-------------------------- + +- Spaces must be used for indenting Python code, with 4 spaces per tab + +Shell Function formatting +------------------------- + +- The formatting of shell functions should be consistent within layers. + Some use tabs, some use spaces. + +Recipe metadata +=============== + +Required Variables +------------------ + +The following variables should be included in all recipes: + +- :term:`SUMMARY`: a one line description of the upstream project + +- :term:`DESCRIPTION`: an extended description of the upstream project, + possibly with multiple lines. If no reasonable description can be written, + this may be omitted as it defaults to :term:`SUMMARY`. + +- :term:`HOMEPAGE`: the URL to the upstream projects homepage. + +- :term:`BUGTRACKER`: the URL upstream projects bug tracking website, + if applicable. + +Recipe Ordering +--------------- + +When a variable is defined in recipes and classes, variables should follow the +general order when possible: + +- :term:`SUMMARY` +- :term:`DESCRIPTION` +- :term:`HOMEPAGE` +- :term:`BUGTRACKER` +- :term:`SECTION` +- :term:`LICENSE` +- :term:`LIC_FILES_CHKSUM` +- :term:`DEPENDS` +- :term:`PROVIDES` +- :term:`PV` +- :term:`SRC_URI` +- :term:`SRCREV` +- :term:`S` +- ``inherit ...`` +- :term:`PACKAGECONFIG` +- Build class specific variables such as ``EXTRA_QMAKEVARS_POST`` and :term:`EXTRA_OECONF` +- Tasks such as :ref:`ref-tasks-configure` +- :term:`PACKAGE_ARCH` +- :term:`PACKAGES` +- :term:`FILES` +- :term:`RDEPENDS` +- :term:`RRECOMMENDS` +- :term:`RSUGGESTS` +- :term:`RPROVIDES` +- :term:`RCONFLICTS` +- :term:`BBCLASSEXTEND` + +There are some cases where ordering is important and these cases would override +this default order. Examples include: + +- :term:`PACKAGE_ARCH` needing to be set before ``inherit packagegroup`` + +Tasks should be ordered based on the order they generally execute. For commonly +used tasks this would be: + +- :ref:`ref-tasks-fetch` +- :ref:`ref-tasks-unpack` +- :ref:`ref-tasks-patch` +- :ref:`ref-tasks-prepare_recipe_sysroot` +- :ref:`ref-tasks-configure` +- :ref:`ref-tasks-compile` +- :ref:`ref-tasks-install` +- :ref:`ref-tasks-populate_sysroot` +- :ref:`ref-tasks-package` + +Custom tasks should be sorted similarly. + +Package specific variables are typically grouped together, e.g.:: + + RDEPENDS:${PN} = “foo” + RDEPENDS:${PN}-libs = “bar” + + RRECOMMENDS:${PN} = “one” + RRECOMMENDS:${PN}-libs = “two” + +Recipe License Fields +--------------------- + +Recipes need to define both the :term:`LICENSE` and +:term:`LIC_FILES_CHKSUM` variables: + +- :term:`LICENSE`: This variable specifies the license for the software. + If you do not know the license under which the software you are + building is distributed, you should go to the source code and look + for that information. Typical files containing this information + include ``COPYING``, :term:`LICENSE`, and ``README`` files. You could + also find the information near the top of a source file. For example, + given a piece of software licensed under the GNU General Public + License version 2, you would set :term:`LICENSE` as follows:: + + LICENSE = "GPL-2.0-only" + + The licenses you specify within :term:`LICENSE` can have any name as long + as you do not use spaces, since spaces are used as separators between + license names. For standard licenses, use the names of the files in + ``meta/files/common-licenses/`` or the :term:`SPDXLICENSEMAP` flag names + defined in ``meta/conf/licenses.conf``. + +- :term:`LIC_FILES_CHKSUM`: The OpenEmbedded build system uses this + variable to make sure the license text has not changed. If it has, + the build produces an error and it affords you the chance to figure + it out and correct the problem. + + You need to specify all applicable licensing files for the software. + At the end of the configuration step, the build process will compare + the checksums of the files to be sure the text has not changed. Any + differences result in an error with the message containing the + current checksum. For more explanation and examples of how to set the + :term:`LIC_FILES_CHKSUM` variable, see the + ":ref:`dev-manual/licenses:tracking license changes`" section. + + To determine the correct checksum string, you can list the + appropriate files in the :term:`LIC_FILES_CHKSUM` variable with incorrect + md5 strings, attempt to build the software, and then note the + resulting error messages that will report the correct md5 strings. + See the ":ref:`dev-manual/new-recipe:fetching code`" section for + additional information. + + Here is an example that assumes the software has a ``COPYING`` file:: + + LIC_FILES_CHKSUM = "file://COPYING;md5=xxx" + + When you try to build the + software, the build system will produce an error and give you the + correct string that you can substitute into the recipe file for a + subsequent build. + +License Updates +~~~~~~~~~~~~~~~ + +When you change the :term:`LICENSE` or :term:`LIC_FILES_CHKSUM` in the recipe +you need to briefly explain the reason for the change via a ``License-Update:`` +tag. Often it's quite trivial, such as:: + + License-Update: copyright years refreshed + +Less often, the actual licensing terms themselves will have changed. If so, do +try to link to upstream making/justifying that decision. + +Tips and Guidelines for Writing Recipes +--------------------------------------- + +- Use :term:`BBCLASSEXTEND` instead of creating separate recipes such as ``-native`` + and ``-nativesdk`` ones, whenever possible. This avoids having to maintain multiple + recipe files at the same time. + +- Recipes should have tasks which are idempotent, i.e. that executing a given task + multiple times shouldn't change the end result. The build environment is built upon + this assumption and breaking it can cause obscure build failures. + +- For idempotence when modifying files in tasks, it is usually best to: + + - copy a file ``X`` to ``X.orig`` (only if it doesn't exist already) + - then, copy ``X.orig`` back to ``X``, + - and, finally, modify ``X``. + + This ensures if rerun the task always has the same end result and the + original file can be preserved to reuse. It also guards against an + interrupted build corrupting the file. + +Patch Upstream Status +===================== + +In order to keep track of patches applied by recipes and ultimately reduce the +number of patches that need maintaining, the OpenEmbedded build system +requires information about the upstream status of each patch. + +In its description, each patch should provide detailed information about the +bug that it addresses, such as the URL in a bug tracking system and links +to relevant mailing list archives. + +Then, you should also add an ``Upstream-Status:`` tag containing one of the +following status strings: + +``Pending`` + No determination has been made yet, or patch has not yet been submitted to + upstream. + + Keep in mind that every patch submitted upstream reduces the maintainance + burden in OpenEmbedded and Yocto Project in the long run, so this patch + status should only be used in exceptional cases if there are genuine + obstacles to submitting a patch upstream; the reason for that should be + included in the patch. + +``Submitted [where]`` + Submitted to upstream, waiting for approval. Optionally include where + it was submitted, such as the author, mailing list, etc. + +``Backport [version]`` + Accepted upstream and included in the next release, or backported from newer + upstream version, because we are at a fixed version. + Include upstream version info (e.g. commit ID or next expected version). + +``Denied`` + Not accepted by upstream, include reason in patch. + +``Inactive-Upstream [lastcommit: when (and/or) lastrelease: when]`` + The upstream is no longer available. This typically means a defunct project + where no activity has happened for a long time --- measured in years. To make + that judgement, it is recommended to look at not only when the last release + happened, but also when the last commit happened, and whether newly made bug + reports and merge requests since that time receive no reaction. It is also + recommended to add to the patch description any relevant links where the + inactivity can be clearly seen. + +``Inappropriate [reason]`` + The patch is not appropriate for upstream, include a brief reason on the + same line enclosed with ``[]``. In the past, there were several different + reasons not to submit patches upstream, but we have to consider that every + non-upstreamed patch means a maintainance burden for recipe maintainers. + Currently, the only reasons to mark patches as inappropriate for upstream + submission are: + + - ``oe specific``: the issue is specific to how OpenEmbedded performs builds + or sets things up at runtime, and can be resolved only with a patch that + is not however relevant or appropriate for general upstream submission. + - ``upstream ticket <link>``: the issue is not specific to Open-Embedded + and should be fixed upstream, but the patch in its current form is not + suitable for merging upstream, and the author lacks sufficient expertise + to develop a proper patch. Instead the issue is handled via a bug report + (include link). + +Of course, if another person later takes care of submitting this patch upstream, +the status should be changed to ``Submitted [where]``, and an additional +``Signed-off-by:`` line should be added to the patch by the person claiming +responsibility for upstreaming. + +Examples +-------- + +Here's an example of a patch that has been submitted upstream:: + + rpm: Adjusted the foo setting in bar + + [RPM Ticket #65] -- http://rpm5.org/cvs/tktview?tn=65,5 + + The foo setting in bar was decreased from X to X-50% in order to + ensure we don't exhaust all system memory with foobar threads. + + Upstream-Status: Submitted [rpm5-devel@rpm5.org] + + Signed-off-by: Joe Developer <joe.developer@example.com> + +A future update can change the value to ``Backport`` or ``Denied`` as +appropriate. + +Another example of a patch that is specific to OpenEmbedded:: + + Do not treat warnings as errors + + There are additional warnings found with musl which are + treated as errors and fails the build, we have more combinations + than upstream supports to handle. + + Upstream-Status: Inappropriate [oe specific] + +Here's a patch that has been backported from an upstream commit:: + + include missing sys/file.h for LOCK_EX + + Upstream-Status: Backport [https://github.com/systemd/systemd/commit/ac8db36cbc26694ee94beecc8dca208ec4b5fd45] + +CVE patches +=========== + +In order to have a better control of vulnerabilities, patches that fix CVEs must +contain a ``CVE:`` tag. This tag list all CVEs fixed by the patch. If more than +one CVE is fixed, separate them using spaces. + +CVE Examples +------------ + +This should be the header of patch that fixes :cve:`2015-8370` in GRUB2:: + + grub2: Fix CVE-2015-8370 + + [No upstream tracking] -- https://bugzilla.redhat.com/show_bug.cgi?id=1286966 + + Back to 28; Grub2 Authentication + + Two functions suffer from integer underflow fault; the grub_username_get() and grub_password_get()located in + grub-core/normal/auth.c and lib/crypto.c respectively. This can be exploited to obtain a Grub rescue shell. + + Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2] + CVE: CVE-2015-8370 + Signed-off-by: Joe Developer <joe.developer@example.com> diff --git a/documentation/contributor-guide/report-defect.rst b/documentation/contributor-guide/report-defect.rst new file mode 100644 index 0000000000..8ef133b842 --- /dev/null +++ b/documentation/contributor-guide/report-defect.rst @@ -0,0 +1,67 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Reporting a Defect Against the Yocto Project and OpenEmbedded +************************************************************** + +You can use the Yocto Project instance of +`Bugzilla <https://www.bugzilla.org/about/>`__ to submit a defect (bug) +against BitBake, OpenEmbedded-Core, against any other Yocto Project component +or for tool issues. For additional information on this implementation of +Bugzilla see the ":ref:`Yocto Project Bugzilla <resources-bugtracker>`" section +in the Yocto Project Reference Manual. For more detail on any of the following +steps, see the Yocto Project +:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. + +Use the following general steps to submit a bug: + +#. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. + +#. Click "File a Bug" to enter a new bug. + +#. Choose the appropriate "Classification", "Product", and "Component" + for which the bug was found. Bugs for the Yocto Project fall into + one of several classifications, which in turn break down into + several products and components. For example, for a bug against the + ``meta-intel`` layer, you would choose "Build System, Metadata & + Runtime", "BSPs", and "bsps-meta-intel", respectively. + +#. Choose the "Version" of the Yocto Project for which you found the + bug (e.g. &DISTRO;). + +#. Determine and select the "Severity" of the bug. The severity + indicates how the bug impacted your work. + +#. Choose the "Hardware" that the bug impacts. + +#. Choose the "Architecture" that the bug impacts. + +#. Choose a "Documentation change" item for the bug. Fixing a bug might + or might not affect the Yocto Project documentation. If you are + unsure of the impact to the documentation, select "Don't Know". + +#. Provide a brief "Summary" of the bug. Try to limit your summary to + just a line or two and be sure to capture the essence of the bug. + +#. Provide a detailed "Description" of the bug. You should provide as + much detail as you can about the context, behavior, output, and so + forth that surrounds the bug. You can even attach supporting files + for output from logs by using the "Add an attachment" button. + +#. Click the "Submit Bug" button submit the bug. A new Bugzilla number + is assigned to the bug and the defect is logged in the bug tracking + system. + +Once you file a bug, the bug is processed by the Yocto Project Bug +Triage Team and further details concerning the bug are assigned (e.g. +priority and owner). You are the "Submitter" of the bug and any further +categorization, progress, or comments on the bug result in Bugzilla +sending you an automated email concerning the particular change or +progress to the bug. + +There are no guarantees about if or when a bug might be worked on since an +open-source project has no dedicated engineering resources. However, the +project does have a good track record of resolving common issues over the +medium and long term. We do encourage people to file bugs so issues are +at least known about. It helps other users when they find somebody having +the same issue as they do, and an issue that is unknown is much less likely +to ever be fixed! diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst new file mode 100644 index 0000000000..47a416b245 --- /dev/null +++ b/documentation/contributor-guide/submit-changes.rst @@ -0,0 +1,827 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Contributing Changes to a Component +************************************ + +Contributions to the Yocto Project and OpenEmbedded are very welcome. +Because the system is extremely configurable and flexible, we recognize +that developers will want to extend, configure or optimize it for their +specific uses. + +.. _ref-why-mailing-lists: + +Contributing through mailing lists --- Why not using web-based workflows? +========================================================================= + +Both Yocto Project and OpenEmbedded have many key components that are +maintained by patches being submitted on mailing lists. We appreciate this +approach does look a little old fashioned when other workflows are available +through web technology such as GitHub, GitLab and others. Since we are often +asked this question, we’ve decided to document the reasons for using mailing +lists. + +One significant factor is that we value peer review. When a change is proposed +to many of the core pieces of the project, it helps to have many eyes of review +go over them. Whilst there is ultimately one maintainer who needs to make the +final call on accepting or rejecting a patch, the review is made by many eyes +and the exact people reviewing it are likely unknown to the maintainer. It is +often the surprise reviewer that catches the most interesting issues! + +This is in contrast to the "GitHub" style workflow where either just a +maintainer makes that review, or review is specifically requested from +nominated people. We believe there is significant value added to the codebase +by this peer review and that moving away from mailing lists would be to the +detriment of our code. + +We also need to acknowledge that many of our developers are used to this +mailing list workflow and have worked with it for years, with tools and +processes built around it. Changing away from this would result in a loss +of key people from the project, which would again be to its detriment. + +The projects are acutely aware that potential new contributors find the +mailing list approach off-putting and would prefer a web-based GUI. +Since we don’t believe that can work for us, the project is aiming to ensure +`patchwork <https://patchwork.yoctoproject.org/>`__ is available to help track +patch status and also looking at how tooling can provide more feedback to users +about patch status. We are looking at improving tools such as ``patchtest`` to +test user contributions before they hit the mailing lists and also at better +documenting how to use such workflows since we recognise that whilst this was +common knowledge a decade ago, it might not be as familiar now. + +Preparing Changes for Submission +================================ + +Set up Git +---------- + +The first thing to do is to install Git packages. Here is an example +on Debian and Ubuntu:: + + sudo apt install git-core git-email + +Then, you need to set a name and e-mail address that Git will +use to identify your commits:: + + git config --global user.name "Ada Lovelace" + git config --global user.email "ada.lovelace@gmail.com" + +Clone the Git repository for the component to modify +---------------------------------------------------- + +After identifying the component to modify as described in the +":doc:`../contributor-guide/identify-component`" section, clone the +corresponding Git repository. Here is an example for OpenEmbedded-Core:: + + git clone https://git.openembedded.org/openembedded-core + cd openembedded-core + +Create a new branch +------------------- + +Then, create a new branch in your local Git repository +for your changes, starting from the reference branch in the upstream +repository (often called ``master``):: + + $ git checkout <ref-branch> + $ git checkout -b my-changes + +If you have completely unrelated sets of changes to submit, you should even +create one branch for each set. + +Implement and commit changes +---------------------------- + +In each branch, you should group your changes into small, controlled and +isolated ones. Keeping changes small and isolated aids review, makes +merging/rebasing easier and keeps the change history clean should anyone need +to refer to it in future. + +To this purpose, you should create *one Git commit per change*, +corresponding to each of the patches you will eventually submit. +See `further guidance <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#separate-your-changes>`__ +in the Linux kernel documentation if needed. + +For example, when you intend to add multiple new recipes, each recipe +should be added in a separate commit. For upgrades to existing recipes, +the previous version should usually be deleted as part of the same commit +to add the upgraded version. + +#. *Stage Your Changes:* Stage your changes by using the ``git add`` + command on each file you modified. If you want to stage all the + files you modified, you can even use the ``git add -A`` command. + +#. *Commit Your Changes:* This is when you can create separate commits. For + each commit to create, use the ``git commit -s`` command with the files + or directories you want to include in the commit:: + + $ git commit -s file1 file2 dir1 dir2 ... + + To include **a**\ ll staged files:: + + $ git commit -sa + + - The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line + to your commit message. There is the same requirement for contributing + to the Linux kernel. Adding such a line signifies that you, the + submitter, have agreed to the `Developer's Certificate of Origin 1.1 + <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>`__ + as follows: + + .. code-block:: none + + Developer's Certificate of Origin 1.1 + + By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + + - Provide a single-line summary of the change and, if more + explanation is needed, provide more detail in the body of the + commit. This summary is typically viewable in the "shortlist" of + changes. Thus, providing something short and descriptive that + gives the reader a summary of the change is useful when viewing a + list of many commits. You should prefix this short description + with the recipe name (if changing a recipe), or else with the + short form path to the file being changed. + + .. note:: + + To find a suitable prefix for the commit summary, a good idea + is to look for prefixes used in previous commits touching the + same files or directories:: + + git log --oneline <paths> + + - For the body of the commit message, provide detailed information + that describes what you changed, why you made the change, and the + approach you used. It might also be helpful if you mention how you + tested the change. Provide as much detail as you can in the body + of the commit message. + + .. note:: + + If the single line summary is enough to describe a simple + change, the body of the commit message can be left empty. + + - If the change addresses a specific bug or issue that is associated + with a bug-tracking ID, include a reference to that ID in your + detailed description. For example, the Yocto Project uses a + specific convention for bug references --- any commit that addresses + a specific bug should use the following form for the detailed + description. Be sure to use the actual bug-tracking ID from + Bugzilla for bug-id:: + + Fixes [YOCTO #bug-id] + + detailed description of change + +#. *Crediting contributors:* By using the ``git commit --amend`` command, + you can add some tags to the commit description to credit other contributors + to the change: + + - ``Reported-by``: name and email of a person reporting a bug + that your commit is trying to fix. This is a good practice + to encourage people to go on reporting bugs and let them + know that their reports are taken into account. + + - ``Suggested-by``: name and email of a person to credit for the + idea of making the change. + + - ``Tested-by``, ``Reviewed-by``: name and email for people having + tested your changes or reviewed their code. These fields are + usually added by the maintainer accepting a patch, or by + yourself if you submitted your patches to early reviewers, + or are submitting an unmodified patch again as part of a + new iteration of your patch series. + + - ``CC:`` Name and email of people you want to send a copy + of your changes to. This field will be used by ``git send-email``. + + See `more guidance about using such tags + <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ + in the Linux kernel documentation. + +Test your changes +----------------- + +For each contributions you make, you should test your changes as well. +For this the Yocto Project offers several types of tests. Those tests cover +different areas and it depends on your changes which are feasible. For example run: + + - For changes that affect the build environment: + + - ``bitbake-selftest``: for changes within BitBake + + - ``oe-selftest``: to test combinations of BitBake runs + + - ``oe-build-perf-test``: to test the performance of common build scenarios + + - For changes in a recipe: + + - ``ptest``: run package specific tests, if they exist + + - ``testimage``: build an image, boot it and run testcases on it + + - If applicable, ensure also the ``native`` and ``nativesdk`` variants builds + + - For changes relating to the SDK: + + - ``testsdk``: to build, install and run tests against a SDK + + - ``testsdk_ext``: to build, install and run tests against an extended SDK + +Note that this list just gives suggestions and is not exhaustive. More details can +be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`. + +Creating Patches +================ + +Here is the general procedure on how to create patches to be sent through email: + +#. *Describe the Changes in your Branch:* If you have more than one commit + in your branch, it's recommended to provide a cover letter describing + the series of patches you are about to send. + + For this purpose, a good solution is to store the cover letter contents + in the branch itself:: + + git branch --edit-description + + This will open a text editor to fill in the description for your + changes. This description can be updated when necessary and will + be used by Git to create the cover letter together with the patches. + + It is recommended to start this description with a title line which + will serve a the subject line for the cover letter. + +#. *Generate Patches for your Branch:* The ``git format-patch`` command will + generate patch files for each of the commits in your branch. You need + to pass the reference branch your branch starts from. + + If you branch didn't need a description in the previous step:: + + $ git format-patch <ref-branch> + + If you filled a description for your branch, you will want to generate + a cover letter too:: + + $ git format-patch --cover-letter --cover-from-description=auto <ref-branch> + + After the command is run, the current directory contains numbered + ``.patch`` files for the commits in your branch. If you have a cover + letter, it will be in the ``0000-cover-letter.patch``. + + .. note:: + + The ``--cover-from-description=auto`` option makes ``git format-patch`` + use the first paragraph of the branch description as the cover + letter title. Another possibility, which is easier to remember, is to pass + only the ``--cover-letter`` option, but you will have to edit the + subject line manually every time you generate the patches. + + See the `git format-patch manual page <https://git-scm.com/docs/git-format-patch>`__ + for details. + +#. *Review each of the Patch Files:* This final review of the patches + before sending them often allows to view your changes from a different + perspective and discover defects such as typos, spacing issues or lines + or even files that you didn't intend to modify. This review should + include the cover letter patch too. + + If necessary, rework your commits as described in + ":ref:`contributor-guide/submit-changes:taking patch review into account`". + +Validating Patches with Patchtest +================================= + +``patchtest`` is available in ``openembedded-core`` as a tool for making +sure that your patches are well-formatted and contain important info for +maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status`` +tags. Note that no functional testing of the changes will be performed by ``patchtest``. +Currently, it only supports testing patches for ``openembedded-core`` branches. +To setup, perform the following:: + + pip install -r meta/lib/patchtest/requirements.txt + source oe-init-build-env + bitbake-layers add-layer ../meta-selftest + +Once these steps are complete and you have generated your patch files, +you can run ``patchtest`` like so:: + + patchtest --patch <patch_name> + +Alternatively, if you want ``patchtest`` to iterate over and test +multiple patches stored in a directory, you can use:: + + patchtest --directory <directory_name> + +By default, ``patchtest`` uses its own modules' file paths to determine what +repository and test suite to check patches against. If you wish to test +patches against a repository other than ``openembedded-core`` and/or use +a different set of tests, you can use the ``--repodir`` and ``--testdir`` +flags:: + + patchtest --patch <patch_name> --repodir <path/to/repo> --testdir <path/to/testdir> + +Finally, note that ``patchtest`` is designed to test patches in a standalone +way, so if your patches are meant to apply on top of changes made by +previous patches in a series, it is possible that ``patchtest`` will report +false failures regarding the "merge on head" test. + +Using ``patchtest`` in this manner provides a final check for the overall +quality of your changes before they are submitted for review by the +maintainers. + +Sending the Patches via Email +============================= + +Using Git to Send Patches +------------------------- + +To submit patches through email, it is very important that you send them +without any whitespace or HTML formatting that either you or your mailer +introduces. The maintainer that receives your patches needs to be able +to save and apply them directly from your emails, using the ``git am`` +command. + +Using the ``git send-email`` command is the only error-proof way of sending +your patches using email since there is no risk of compromising whitespace +in the body of the message, which can occur when you use your own mail +client. It will also properly include your patches as *inline attachments*, +which is not easy to do with standard e-mail clients without breaking lines. +If you used your regular e-mail client and shared your patches as regular +attachments, reviewers wouldn't be able to quote specific sections of your +changes and make comments about them. + +Setting up Git to Send Email +---------------------------- + +The ``git send-email`` command can send email by using a local or remote +Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or +through a direct SMTP configuration in your Git ``~/.gitconfig`` file. + +Here are the settings for letting ``git send-email`` send e-mail through your +regular STMP server, using a Google Mail account as an example:: + + git config --global sendemail.smtpserver smtp.gmail.com + git config --global sendemail.smtpserverport 587 + git config --global sendemail.smtpencryption tls + git config --global sendemail.smtpuser ada.lovelace@gmail.com + git config --global sendemail.smtppass = XXXXXXXX + +These settings will appear in the ``.gitconfig`` file in your home directory. + +If you neither can use a local MTA nor SMTP, make sure you use an email client +that does not touch the message (turning spaces in tabs, wrapping lines, etc.). +A good mail client to do so is Pine (or Alpine) or Mutt. For more +information about suitable clients, see `Email clients info for Linux +<https://www.kernel.org/doc/html/latest/process/email-clients.html>`__ +in the Linux kernel sources. + +If you use such clients, just include the patch in the body of your email. + +Finding a Suitable Mailing List +------------------------------- + +You should send patches to the appropriate mailing list so that they can be +reviewed by the right contributors and merged by the appropriate maintainer. +The specific mailing list you need to use depends on the location of the code +you are changing. + +If people have concerns with any of the patches, they will usually voice +their concern over the mailing list. If patches do not receive any negative +reviews, the maintainer of the affected layer typically takes them, tests them, +and then based on successful testing, merges them. + +In general, each component (e.g. layer) should have a ``README`` file +that indicates where to send the changes and which process to follow. + +The "poky" repository, which is the Yocto Project's reference build +environment, is a hybrid repository that contains several individual +pieces (e.g. BitBake, Metadata, documentation, and so forth) built using +the combo-layer tool. The upstream location used for submitting changes +varies by component: + +- *Core Metadata:* Send your patches to the + :oe_lists:`openembedded-core </g/openembedded-core>` + mailing list. For example, a change to anything under the ``meta`` or + ``scripts`` directories should be sent to this mailing list. + +- *BitBake:* For changes to BitBake (i.e. anything under the + ``bitbake`` directory), send your patches to the + :oe_lists:`bitbake-devel </g/bitbake-devel>` + mailing list. + +- *meta-poky* and *meta-yocto-bsp* trees: These trees contain Metadata. Use the + :yocto_lists:`poky </g/poky>` mailing list. + +- *Documentation*: For changes to the Yocto Project documentation, use the + :yocto_lists:`docs </g/docs>` mailing list. + +For changes to other layers and tools hosted in the Yocto Project source +repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the +:yocto_lists:`yocto-patches </g/yocto-patches/>` general mailing list. + +For changes to other layers hosted in the OpenEmbedded source +repositories (i.e. :oe_git:`git.openembedded.org <>`), use +the :oe_lists:`openembedded-devel </g/openembedded-devel>` +mailing list, unless specified otherwise in the layer's ``README`` file. + +If you intend to submit a new recipe that neither fits into the core Metadata, +nor into :oe_git:`meta-openembedded </meta-openembedded/>`, you should +look for a suitable layer in https://layers.openembedded.org. If similar +recipes can be expected, you may consider :ref:`dev-manual/layers:creating your own layer`. + +If in doubt, please ask on the :yocto_lists:`yocto </g/yocto/>` general mailing list +or on the :oe_lists:`openembedded-devel </g/openembedded-devel>` mailing list. + +Subscribing to the Mailing List +------------------------------- + +After identifying the right mailing list to use, you will have to subscribe to +it if you haven't done it yet. + +If you attempt to send patches to a list you haven't subscribed to, your email +will be returned as undelivered. + +However, if you don't want to be receive all the messages sent to a mailing list, +you can set your subscription to "no email". You will still be a subscriber able +to send messages, but you won't receive any e-mail. If people reply to your message, +their e-mail clients will default to including your email address in the +conversation anyway. + +Anyway, you'll also be able to access the new messages on mailing list archives, +either through a web browser, or for the lists archived on https://lore.kernel.org, +through an individual newsgroup feed or a git repository. + +Sending Patches via Email +------------------------- + +At this stage, you are ready to send your patches via email. Here's the +typical usage of ``git send-email``:: + + git send-email --to <mailing-list-address> *.patch + +Then, review each subject line and list of recipients carefully, and then +and then allow the command to send each message. + +You will see that ``git send-email`` will automatically copy the people listed +in any commit tags such as ``Signed-off-by`` or ``Reported-by``. + +In case you are sending patches for :oe_git:`meta-openembedded </meta-openembedded/>` +or any layer other than :oe_git:`openembedded-core </openembedded-core/>`, +please add the appropriate prefix so that it is clear which layer the patch is intended +to be applied to:: + + git format-patch --subject-prefix="meta-oe][PATCH" ... + +.. note:: + + It is actually possible to send patches without generating them + first. However, make sure you have reviewed your changes carefully + because ``git send-email`` will just show you the title lines of + each patch. + + Here's a command you can use if you just have one patch in your + branch:: + + git send-email --to <mailing-list-address> -1 + + If you have multiple patches and a cover letter, you can send + patches for all the commits between the reference branch + and the tip of your branch:: + + git send-email --cover-letter --cover-from-description=auto --to <mailing-list-address> -M <ref-branch> + +See the `git send-email manual page <https://git-scm.com/docs/git-send-email>`__ +for details. + +Troubleshooting Email Issues +---------------------------- + +Fixing your From identity +~~~~~~~~~~~~~~~~~~~~~~~~~ + +We have a frequent issue with contributors whose patches are received through +a ``From`` field which doesn't match the ``Signed-off-by`` information. Here is +a typical example for people sending from a domain name with :wikipedia:`DMARC`:: + + From: "Linus Torvalds via lists.openembedded.org <linus.torvalds=kernel.org@lists.openembedded.org>" + +This ``From`` field is used by ``git am`` to recreate commits with the right +author name. The following will ensure that your e-mails have an additional +``From`` field at the beginning of the Email body, and therefore that +maintainers accepting your patches don't have to fix commit author information +manually:: + + git config --global sendemail.from "linus.torvalds@kernel.org" + +The ``sendemail.from`` should match your ``user.email`` setting, +which appears in the ``Signed-off-by`` line of your commits. + +Streamlining git send-email usage +--------------------------------- + +If you want to save time and not be forced to remember the right options to use +with ``git send-email``, you can use Git configuration settings. + +- To set the right mailing list address for a given repository:: + + git config --local sendemail.to openembedded-devel@lists.openembedded.org + +- If the mailing list requires a subject prefix for the layer + (this only works when the repository only contains one layer):: + + git config --local format.subjectprefix "meta-something][PATCH" + +Using Scripts to Push a Change Upstream and Request a Pull +========================================================== + +For larger patch series it is preferable to send a pull request which not +only includes the patch but also a pointer to a branch that can be pulled +from. This involves making a local branch for your changes, pushing this +branch to an accessible repository and then using the ``create-pull-request`` +and ``send-pull-request`` scripts from openembedded-core to create and send a +patch series with a link to the branch for review. + +Follow this procedure to push a change to an upstream "contrib" Git +repository once the steps in +":ref:`contributor-guide/submit-changes:preparing changes for submission`" +have been followed: + +.. note:: + + You can find general Git information on how to push a change upstream + in the + `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__. + +#. *Request Push Access to an "Upstream" Contrib Repository:* Send an email to + ``helpdesk@yoctoproject.org``: + + - Attach your SSH public key which usually named ``id_rsa.pub.``. + If you don't have one generate it by running ``ssh-keygen -t rsa -b 4096 -C "your_email@example.com"``. + + - List the repositories you're planning to contribute to. + + - Include your preferred branch prefix for ``-contrib`` repositories. + +#. *Push Your Commits to the "Contrib" Upstream:* Push your + changes to that repository:: + + $ git push upstream_remote_repo local_branch_name + + For example, suppose you have permissions to push + into the upstream ``meta-intel-contrib`` repository and you are + working in a local branch named `your_name`\ ``/README``. The following + command pushes your local commits to the ``meta-intel-contrib`` + upstream repository and puts the commit in a branch named + `your_name`\ ``/README``:: + + $ git push meta-intel-contrib your_name/README + +#. *Determine Who to Notify:* Determine the maintainer or the mailing + list that you need to notify for the change. + + Before submitting any change, you need to be sure who the maintainer + is or what mailing list that you need to notify. Use either these + methods to find out: + + - *Maintenance File:* Examine the ``maintainers.inc`` file, which is + located in the :term:`Source Directory` at + ``meta/conf/distro/include``, to see who is responsible for code. + + - *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can + enter the following command to bring up a short list of all + commits against a specific file:: + + git shortlog -- filename + + Just provide the name of the file for which you are interested. The + information returned is not ordered by history but does include a + list of everyone who has committed grouped by name. From the list, + you can see who is responsible for the bulk of the changes against + the file. + + - *Find the Mailing List to Use:* See the + ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" + section above. + +#. *Make a Pull Request:* Notify the maintainer or the mailing list that + you have pushed a change by making a pull request. + + The Yocto Project provides two scripts that conveniently let you + generate and send pull requests to the Yocto Project. These scripts + are ``create-pull-request`` and ``send-pull-request``. You can find + these scripts in the ``scripts`` directory within the + :term:`Source Directory` (e.g. + ``poky/scripts``). + + Using these scripts correctly formats the requests without + introducing any whitespace or HTML formatting. The maintainer that + receives your patches either directly or through the mailing list + needs to be able to save and apply them directly from your emails. + Using these scripts is the preferred method for sending patches. + + First, create the pull request. For example, the following command + runs the script, specifies the upstream repository in the contrib + directory into which you pushed the change, and provides a subject + line in the created patch files:: + + $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" + + Running this script forms ``*.patch`` files in a folder named + ``pull-``\ `PID` in the current directory. One of the patch files is a + cover letter. + + Before running the ``send-pull-request`` script, you must edit the + cover letter patch to insert information about your change. After + editing the cover letter, send the pull request. For example, the + following command runs the script and specifies the patch directory + and email address. In this example, the email address is a mailing + list:: + + $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@lists.yoctoproject.org + + You need to follow the prompts as the script is interactive. + + .. note:: + + For help on using these scripts, simply provide the ``-h`` + argument as follows:: + + $ poky/scripts/create-pull-request -h + $ poky/scripts/send-pull-request -h + +Submitting Changes to Stable Release Branches +============================================= + +The process for proposing changes to a Yocto Project stable branch differs +from the steps described above. Changes to a stable branch must address +identified bugs or CVEs and should be made carefully in order to avoid the +risk of introducing new bugs or breaking backwards compatibility. Typically +bug fixes must already be accepted into the master branch before they can be +backported to a stable branch unless the bug in question does not affect the +master branch or the fix on the master branch is unsuitable for backporting. + +The list of stable branches along with the status and maintainer for each +branch can be obtained from the +:yocto_wiki:`Releases wiki page </Releases>`. + +.. note:: + + Changes will not typically be accepted for branches which are marked as + End-Of-Life (EOL). + +With this in mind, the steps to submit a change for a stable branch are as +follows: + +#. *Identify the bug or CVE to be fixed:* This information should be + collected so that it can be included in your submission. + + See :ref:`dev-manual/vulnerabilities:checking for vulnerabilities` + for details about CVE tracking. + +#. *Check if the fix is already present in the master branch:* This will + result in the most straightforward path into the stable branch for the + fix. + + #. *If the fix is present in the master branch --- submit a backport request + by email:* You should send an email to the relevant stable branch + maintainer and the mailing list with details of the bug or CVE to be + fixed, the commit hash on the master branch that fixes the issue and + the stable branches which you would like this fix to be backported to. + + #. *If the fix is not present in the master branch --- submit the fix to the + master branch first:* This will ensure that the fix passes through the + project's usual patch review and test processes before being accepted. + It will also ensure that bugs are not left unresolved in the master + branch itself. Once the fix is accepted in the master branch a backport + request can be submitted as above. + + #. *If the fix is unsuitable for the master branch --- submit a patch + directly for the stable branch:* This method should be considered as a + last resort. It is typically necessary when the master branch is using + a newer version of the software which includes an upstream fix for the + issue or when the issue has been fixed on the master branch in a way + that introduces backwards incompatible changes. In this case follow the + steps in ":ref:`contributor-guide/submit-changes:preparing changes for submission`" + and in the following sections but modify the subject header of your patch + email to include the name of the stable branch which you are + targetting. This can be done using the ``--subject-prefix`` argument to + ``git format-patch``, for example to submit a patch to the + "&DISTRO_NAME_NO_CAP_MINUS_ONE;" branch use:: + + git format-patch --subject-prefix='&DISTRO_NAME_NO_CAP_MINUS_ONE;][PATCH' ... + +Taking Patch Review into Account +================================ + +You may get feedback on your submitted patches from other community members +or from the automated patchtest service. If issues are identified in your +patches then it is usually necessary to address these before the patches are +accepted into the project. In this case you should your commits according +to the feedback and submit an updated version to the relevant mailing list. + +In any case, never fix reported issues by fixing them in new commits +on the tip of your branch. Always come up with a new series of commits +without the reported issues. + +.. note:: + + It is a good idea to send a copy to the reviewers who provided feedback + to the previous version of the patch. You can make sure this happens + by adding a ``CC`` tag to the commit description:: + + CC: William Shakespeare <bill@yoctoproject.org> + +A single patch can be amended using ``git commit --amend``, and multiple +patches can be easily reworked and reordered through an interactive Git rebase:: + + git rebase -i <ref-branch> + +See `this tutorial <https://hackernoon.com/beginners-guide-to-interactive-rebasing-346a3f9c3a6d>`__ +for practical guidance about using Git interactive rebasing. + +You should also modify the ``[PATCH]`` tag in the email subject line when +sending the revised patch to mark the new iteration as ``[PATCH v2]``, +``[PATCH v3]``, etc as appropriate. This can be done by passing the ``-v`` +argument to ``git format-patch`` with a version number:: + + git format-patch -v2 <ref-branch> + +Lastly please ensure that you also test your revised changes. In particular +please don't just edit the patch file written out by ``git format-patch`` and +resend it. + +Tracking the Status of Patches +============================== + +The Yocto Project uses a `Patchwork instance <https://patchwork.yoctoproject.org/>`__ +to track the status of patches submitted to the various mailing lists and to +support automated patch testing. Each submitted patch is checked for common +mistakes and deviations from the expected patch format and submitters are +notified by ``patchtest`` if such mistakes are found. This process helps to +reduce the burden of patch review on maintainers. + +.. note:: + + This system is imperfect and changes can sometimes get lost in the flow. + Asking about the status of a patch or change is reasonable if the change + has been idle for a while with no feedback. + +If your patches have not had any feedback in a few days, they may have already +been merged. You can run ``git pull`` branch to check this. Note that many if +not most layer maintainers do not send out acknowledgement emails when they +accept patches. Alternatively, if there is no response or merge after a few days +the patch may have been missed or the appropriate reviewers may not currently be +around. It is then perfectly fine to reply to it yourself with a reminder asking +for feedback. + +.. note:: + + Patch reviews for feature and recipe upgrade patches are likely be delayed + during a feature freeze because these types of patches aren't merged during + at that time --- you may have to wait until after the freeze is lifted. + +Maintainers also commonly use ``-next`` branches to test submissions prior to +merging patches. Thus, you can get an idea of the status of a patch based on +whether the patch has been merged into one of these branches. The commonly +used testing branches for OpenEmbedded-Core are as follows: + +- *openembedded-core "master-next" branch:* This branch is part of the + :oe_git:`openembedded-core </openembedded-core/>` repository and contains + proposed changes to the core metadata. + +- *poky "master-next" branch:* This branch is part of the + :yocto_git:`poky </poky/>` repository and combines proposed + changes to BitBake, the core metadata and the poky distro. + +Similarly, stable branches maintained by the project may have corresponding +``-next`` branches which collect proposed changes. For example, +``&DISTRO_NAME_NO_CAP;-next`` and ``&DISTRO_NAME_NO_CAP_MINUS_ONE;-next`` +branches in both the "openembdedded-core" and "poky" repositories. + +Other layers may have similar testing branches but there is no formal +requirement or standard for these so please check the documentation for the +layers you are contributing to. + diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst new file mode 100644 index 0000000000..f6f0e6afaf --- /dev/null +++ b/documentation/dev-manual/bmaptool.rst @@ -0,0 +1,59 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Flashing Images Using ``bmaptool`` +********************************** + +A fast and easy way to flash an image to a bootable device is to use +bmaptool, which is integrated into the OpenEmbedded build system. +bmaptool is a generic tool that creates a file's block map (bmap) and +then uses that map to copy the file. As compared to traditional tools +such as dd or cp, bmaptool can copy (or flash) large files like raw +system image files much faster. + +.. note:: + + - If you are using Ubuntu or Debian distributions, you can install + the ``bmap-tools`` package using the following command and then + use the tool without specifying ``PATH`` even from the root + account:: + + $ sudo apt install bmap-tools + + - If you are unable to install the ``bmap-tools`` package, you will + need to build bmaptool before using it. Use the following command:: + + $ bitbake bmaptool-native + +Following, is an example that shows how to flash a Wic image. Realize +that while this example uses a Wic image, you can use bmaptool to flash +any type of image. Use these steps to flash an image using bmaptool: + +#. *Update your local.conf File:* You need to have the following set + in your ``local.conf`` file before building your image:: + + IMAGE_FSTYPES += "wic wic.bmap" + +#. *Get Your Image:* Either have your image ready (pre-built with the + :term:`IMAGE_FSTYPES` + setting previously mentioned) or take the step to build the image:: + + $ bitbake image + +#. *Flash the Device:* Flash the device with the image by using bmaptool + depending on your particular setup. The following commands assume the + image resides in the :term:`Build Directory`'s ``deploy/images/`` area: + + - If you have write access to the media, use this command form:: + + $ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX + + - If you do not have write access to the media, set your permissions + first and then use the same command form:: + + $ sudo chmod 666 /dev/sdX + $ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX + +For help on the ``bmaptool`` command, use the following command:: + + $ bmaptool --help + diff --git a/documentation/dev-manual/build-quality.rst b/documentation/dev-manual/build-quality.rst new file mode 100644 index 0000000000..713ea3a48e --- /dev/null +++ b/documentation/dev-manual/build-quality.rst @@ -0,0 +1,409 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Maintaining Build Output Quality +******************************** + +Many factors can influence the quality of a build. For example, if you +upgrade a recipe to use a new version of an upstream software package or +you experiment with some new configuration options, subtle changes can +occur that you might not detect until later. Consider the case where +your recipe is using a newer version of an upstream package. In this +case, a new version of a piece of software might introduce an optional +dependency on another library, which is auto-detected. If that library +has already been built when the software is building, the software will +link to the built library and that library will be pulled into your +image along with the new software even if you did not want the library. + +The :ref:`ref-classes-buildhistory` class helps you maintain the quality of +your build output. You can use the class to highlight unexpected and possibly +unwanted changes in the build output. When you enable build history, it records +information about the contents of each package and image and then commits that +information to a local Git repository where you can examine the information. + +The remainder of this section describes the following: + +- :ref:`How you can enable and disable build history <dev-manual/build-quality:enabling and disabling build history>` + +- :ref:`How to understand what the build history contains <dev-manual/build-quality:understanding what the build history contains>` + +- :ref:`How to limit the information used for build history <dev-manual/build-quality:using build history to gather image information only>` + +- :ref:`How to examine the build history from both a command-line and web interface <dev-manual/build-quality:examining build history information>` + +Enabling and Disabling Build History +==================================== + +Build history is disabled by default. To enable it, add the following +:term:`INHERIT` statement and set the :term:`BUILDHISTORY_COMMIT` variable to +"1" at the end of your ``conf/local.conf`` file found in the +:term:`Build Directory`:: + + INHERIT += "buildhistory" + BUILDHISTORY_COMMIT = "1" + +Enabling build history as +previously described causes the OpenEmbedded build system to collect +build output information and commit it as a single commit to a local +:ref:`overview-manual/development-environment:git` repository. + +.. note:: + + Enabling build history increases your build times slightly, + particularly for images, and increases the amount of disk space used + during the build. + +You can disable build history by removing the previous statements from +your ``conf/local.conf`` file. + +Understanding What the Build History Contains +============================================= + +Build history information is kept in ``${``\ :term:`TOPDIR`\ ``}/buildhistory`` +in the :term:`Build Directory` as defined by the :term:`BUILDHISTORY_DIR` +variable. Here is an example abbreviated listing: + +.. image:: figures/buildhistory.png + :align: center + :width: 50% + +At the top level, there is a ``metadata-revs`` file that lists the +revisions of the repositories for the enabled layers when the build was +produced. The rest of the data splits into separate ``packages``, +``images`` and ``sdk`` directories, the contents of which are described +as follows. + +Build History Package Information +--------------------------------- + +The history for each package contains a text file that has name-value +pairs with information about the package. For example, +``buildhistory/packages/i586-poky-linux/busybox/busybox/latest`` +contains the following: + +.. code-block:: none + + PV = 1.22.1 + PR = r32 + RPROVIDES = + RDEPENDS = glibc (>= 2.20) update-alternatives-opkg + RRECOMMENDS = busybox-syslog busybox-udhcpc update-rc.d + PKGSIZE = 540168 + FILES = /usr/bin/* /usr/sbin/* /usr/lib/busybox/* /usr/lib/lib*.so.* \ + /etc /com /var /bin/* /sbin/* /lib/*.so.* /lib/udev/rules.d \ + /usr/lib/udev/rules.d /usr/share/busybox /usr/lib/busybox/* \ + /usr/share/pixmaps /usr/share/applications /usr/share/idl \ + /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers + FILELIST = /bin/busybox /bin/busybox.nosuid /bin/busybox.suid /bin/sh \ + /etc/busybox.links.nosuid /etc/busybox.links.suid + +Most of these +name-value pairs correspond to variables used to produce the package. +The exceptions are ``FILELIST``, which is the actual list of files in +the package, and ``PKGSIZE``, which is the total size of files in the +package in bytes. + +There is also a file that corresponds to the recipe from which the package +came (e.g. ``buildhistory/packages/i586-poky-linux/busybox/latest``): + +.. code-block:: none + + PV = 1.22.1 + PR = r32 + DEPENDS = initscripts kern-tools-native update-rc.d-native \ + virtual/i586-poky-linux-compilerlibs virtual/i586-poky-linux-gcc \ + virtual/libc virtual/update-alternatives + PACKAGES = busybox-ptest busybox-httpd busybox-udhcpd busybox-udhcpc \ + busybox-syslog busybox-mdev busybox-hwclock busybox-dbg \ + busybox-staticdev busybox-dev busybox-doc busybox-locale busybox + +Finally, for those recipes fetched from a version control system (e.g., +Git), there is a file that lists source revisions that are specified in +the recipe and the actual revisions used during the build. Listed +and actual revisions might differ when +:term:`SRCREV` is set to +${:term:`AUTOREV`}. Here is an +example assuming +``buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev``):: + + # SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + # SRCREV_meta = "a227f20eff056e511d504b2e490f3774ab260d6f" + SRCREV_meta ="a227f20eff056e511d504b2e490f3774ab260d6f" + +You can use the +``buildhistory-collect-srcrevs`` command with the ``-a`` option to +collect the stored :term:`SRCREV` values from build history and report them +in a format suitable for use in global configuration (e.g., +``local.conf`` or a distro include file) to override floating +:term:`AUTOREV` values to a fixed set of revisions. Here is some example +output from this command:: + + $ buildhistory-collect-srcrevs -a + # all-poky-linux + SRCREV:pn-ca-certificates = "07de54fdcc5806bde549e1edf60738c6bccf50e8" + SRCREV:pn-update-rc.d = "8636cf478d426b568c1be11dbd9346f67e03adac" + # core2-64-poky-linux + SRCREV:pn-binutils = "87d4632d36323091e731eb07b8aa65f90293da66" + SRCREV:pn-btrfs-tools = "8ad326b2f28c044cb6ed9016d7c3285e23b673c8" + SRCREV_bzip2-tests:pn-bzip2 = "f9061c030a25de5b6829e1abf373057309c734c0" + SRCREV:pn-e2fsprogs = "02540dedd3ddc52c6ae8aaa8a95ce75c3f8be1c0" + SRCREV:pn-file = "504206e53a89fd6eed71aeaf878aa3512418eab1" + SRCREV_glibc:pn-glibc = "24962427071fa532c3c48c918e9d64d719cc8a6c" + SRCREV:pn-gnome-desktop-testing = "e346cd4ed2e2102c9b195b614f3c642d23f5f6e7" + SRCREV:pn-init-system-helpers = "dbd9197569c0935029acd5c9b02b84c68fd937ee" + SRCREV:pn-kmod = "b6ecfc916a17eab8f93be5b09f4e4f845aabd3d1" + SRCREV:pn-libnsl2 = "82245c0c58add79a8e34ab0917358217a70e5100" + SRCREV:pn-libseccomp = "57357d2741a3b3d3e8425889a6b79a130e0fa2f3" + SRCREV:pn-libxcrypt = "50cf2b6dd4fdf04309445f2eec8de7051d953abf" + SRCREV:pn-ncurses = "51d0fd9cc3edb975f04224f29f777f8f448e8ced" + SRCREV:pn-procps = "19a508ea121c0c4ac6d0224575a036de745eaaf8" + SRCREV:pn-psmisc = "5fab6b7ab385080f1db725d6803136ec1841a15f" + SRCREV:pn-ptest-runner = "bcb82804daa8f725b6add259dcef2067e61a75aa" + SRCREV:pn-shared-mime-info = "18e558fa1c8b90b86757ade09a4ba4d6a6cf8f70" + SRCREV:pn-zstd = "e47e674cd09583ff0503f0f6defd6d23d8b718d3" + # qemux86_64-poky-linux + SRCREV_machine:pn-linux-yocto = "20301aeb1a64164b72bc72af58802b315e025c9c" + SRCREV_meta:pn-linux-yocto = "2d38a472b21ae343707c8bd64ac68a9eaca066a0" + # x86_64-linux + SRCREV:pn-binutils-cross-x86_64 = "87d4632d36323091e731eb07b8aa65f90293da66" + SRCREV_glibc:pn-cross-localedef-native = "24962427071fa532c3c48c918e9d64d719cc8a6c" + SRCREV_localedef:pn-cross-localedef-native = "794da69788cbf9bf57b59a852f9f11307663fa87" + SRCREV:pn-debianutils-native = "de14223e5bffe15e374a441302c528ffc1cbed57" + SRCREV:pn-libmodulemd-native = "ee80309bc766d781a144e6879419b29f444d94eb" + SRCREV:pn-virglrenderer-native = "363915595e05fb252e70d6514be2f0c0b5ca312b" + SRCREV:pn-zstd-native = "e47e674cd09583ff0503f0f6defd6d23d8b718d3" + +.. note:: + + Here are some notes on using the ``buildhistory-collect-srcrevs`` command: + + - By default, only values where the :term:`SRCREV` was not hardcoded + (usually when :term:`AUTOREV` is used) are reported. Use the ``-a`` + option to see all :term:`SRCREV` values. + + - The output statements might not have any effect if overrides are + applied elsewhere in the build system configuration. Use the + ``-f`` option to add the ``forcevariable`` override to each output + line if you need to work around this restriction. + + - The script does apply special handling when building for multiple + machines. However, the script does place a comment before each set + of values that specifies which triplet to which they belong as + previously shown (e.g., ``i586-poky-linux``). + +Build History Image Information +------------------------------- + +The files produced for each image are as follows: + +- ``image-files:`` A directory containing selected files from the root + filesystem. The files are defined by + :term:`BUILDHISTORY_IMAGE_FILES`. + +- ``build-id.txt:`` Human-readable information about the build + configuration and metadata source revisions. This file contains the + full build header as printed by BitBake. + +- ``*.dot:`` Dependency graphs for the image that are compatible with + ``graphviz``. + +- ``files-in-image.txt:`` A list of files in the image with + permissions, owner, group, size, and symlink information. + +- ``image-info.txt:`` A text file containing name-value pairs with + information about the image. See the following listing example for + more information. + +- ``installed-package-names.txt:`` A list of installed packages by name + only. + +- ``installed-package-sizes.txt:`` A list of installed packages ordered + by size. + +- ``installed-packages.txt:`` A list of installed packages with full + package filenames. + +.. note:: + + Installed package information is able to be gathered and produced + even if package management is disabled for the final image. + +Here is an example of ``image-info.txt``: + +.. code-block:: none + + DISTRO = poky + DISTRO_VERSION = 3.4+snapshot-a0245d7be08f3d24ea1875e9f8872aa6bbff93be + USER_CLASSES = buildstats + IMAGE_CLASSES = qemuboot qemuboot license_image + IMAGE_FEATURES = debug-tweaks + IMAGE_LINGUAS = + IMAGE_INSTALL = packagegroup-core-boot speex speexdsp + BAD_RECOMMENDATIONS = + NO_RECOMMENDATIONS = + PACKAGE_EXCLUDE = + ROOTFS_POSTPROCESS_COMMAND = write_package_manifest; license_create_manifest; cve_check_write_rootfs_manifest; ssh_allow_empty_password; ssh_allow_root_login; postinst_enable_logging; rootfs_update_timestamp; write_image_test_data; empty_var_volatile; sort_passwd; rootfs_reproducible; + IMAGE_POSTPROCESS_COMMAND = buildhistory_get_imageinfo ; + IMAGESIZE = 9265 + +Other than ``IMAGESIZE``, +which is the total size of the files in the image in Kbytes, the +name-value pairs are variables that may have influenced the content of +the image. This information is often useful when you are trying to +determine why a change in the package or file listings has occurred. + +Using Build History to Gather Image Information Only +---------------------------------------------------- + +As you can see, build history produces image information, including +dependency graphs, so you can see why something was pulled into the +image. If you are just interested in this information and not interested +in collecting specific package or SDK information, you can enable +writing only image information without any history by adding the +following to your ``conf/local.conf`` file found in the +:term:`Build Directory`:: + + INHERIT += "buildhistory" + BUILDHISTORY_COMMIT = "0" + BUILDHISTORY_FEATURES = "image" + +Here, you set the +:term:`BUILDHISTORY_FEATURES` +variable to use the image feature only. + +Build History SDK Information +----------------------------- + +Build history collects similar information on the contents of SDKs (e.g. +``bitbake -c populate_sdk imagename``) as compared to information it +collects for images. Furthermore, this information differs depending on +whether an extensible or standard SDK is being produced. + +The following list shows the files produced for SDKs: + +- ``files-in-sdk.txt:`` A list of files in the SDK with permissions, + owner, group, size, and symlink information. This list includes both + the host and target parts of the SDK. + +- ``sdk-info.txt:`` A text file containing name-value pairs with + information about the SDK. See the following listing example for more + information. + +- ``sstate-task-sizes.txt:`` A text file containing name-value pairs + with information about task group sizes (e.g. :ref:`ref-tasks-populate_sysroot` + tasks have a total size). The ``sstate-task-sizes.txt`` file exists + only when an extensible SDK is created. + +- ``sstate-package-sizes.txt:`` A text file containing name-value pairs + with information for the shared-state packages and sizes in the SDK. + The ``sstate-package-sizes.txt`` file exists only when an extensible + SDK is created. + +- ``sdk-files:`` A folder that contains copies of the files mentioned + in ``BUILDHISTORY_SDK_FILES`` if the files are present in the output. + Additionally, the default value of ``BUILDHISTORY_SDK_FILES`` is + specific to the extensible SDK although you can set it differently if + you would like to pull in specific files from the standard SDK. + + The default files are ``conf/local.conf``, ``conf/bblayers.conf``, + ``conf/auto.conf``, ``conf/locked-sigs.inc``, and + ``conf/devtool.conf``. Thus, for an extensible SDK, these files get + copied into the ``sdk-files`` directory. + +- The following information appears under each of the ``host`` and + ``target`` directories for the portions of the SDK that run on the + host and on the target, respectively: + + .. note:: + + The following files for the most part are empty when producing an + extensible SDK because this type of SDK is not constructed from + packages as is the standard SDK. + + - ``depends.dot:`` Dependency graph for the SDK that is compatible + with ``graphviz``. + + - ``installed-package-names.txt:`` A list of installed packages by + name only. + + - ``installed-package-sizes.txt:`` A list of installed packages + ordered by size. + + - ``installed-packages.txt:`` A list of installed packages with full + package filenames. + +Here is an example of ``sdk-info.txt``: + +.. code-block:: none + + DISTRO = poky + DISTRO_VERSION = 1.3+snapshot-20130327 + SDK_NAME = poky-glibc-i686-arm + SDK_VERSION = 1.3+snapshot + SDKMACHINE = + SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs + BAD_RECOMMENDATIONS = + SDKSIZE = 352712 + +Other than ``SDKSIZE``, which is +the total size of the files in the SDK in Kbytes, the name-value pairs +are variables that might have influenced the content of the SDK. This +information is often useful when you are trying to determine why a +change in the package or file listings has occurred. + +Examining Build History Information +----------------------------------- + +You can examine build history output from the command line or from a web +interface. + +To see any changes that have occurred (assuming you have +:term:`BUILDHISTORY_COMMIT` = "1"), +you can simply use any Git command that allows you to view the history +of a repository. Here is one method:: + + $ git log -p + +You need to realize, +however, that this method does show changes that are not significant +(e.g. a package's size changing by a few bytes). + +There is a command-line tool called ``buildhistory-diff``, though, +that queries the Git repository and prints just the differences that +might be significant in human-readable form. Here is an example:: + + $ poky/poky/scripts/buildhistory-diff . HEAD^ + Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): + /etc/anotherpkg.conf was added + /sbin/anotherpkg was added + * (installed-package-names.txt): + * anotherpkg was added + Changes to images/qemux86_64/glibc/core-image-minimal (installed-package-names.txt): + anotherpkg was added + packages/qemux86_64-poky-linux/v86d: PACKAGES: added "v86d-extras" + * PR changed from "r0" to "r1" + * PV changed from "0.1.10" to "0.1.12" + packages/qemux86_64-poky-linux/v86d/v86d: PKGSIZE changed from 110579 to 144381 (+30%) + * PR changed from "r0" to "r1" + * PV changed from "0.1.10" to "0.1.12" + +.. note:: + + The ``buildhistory-diff`` tool requires the ``GitPython`` + package. Be sure to install it using Pip3 as follows:: + + $ pip3 install GitPython --user + + + Alternatively, you can install ``python3-git`` using the appropriate + distribution package manager (e.g. ``apt``, ``dnf``, or ``zipper``). + +To see changes to the build history using a web interface, follow the +instruction in the ``README`` file +:yocto_git:`here </buildhistory-web/>`. + +Here is a sample screenshot of the interface: + +.. image:: figures/buildhistory-web.png + :width: 100% + diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst new file mode 100644 index 0000000000..fe502690dd --- /dev/null +++ b/documentation/dev-manual/building.rst @@ -0,0 +1,942 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Building +******** + +This section describes various build procedures, such as the steps +needed for a simple build, building a target for multiple configurations, +generating an image for more than one machine, and so forth. + +Building a Simple Image +======================= + +In the development environment, you need to build an image whenever you +change hardware support, add or change system libraries, or add or +change services that have dependencies. There are several methods that allow +you to build an image within the Yocto Project. This section presents +the basic steps you need to build a simple image using BitBake from a +build host running Linux. + +.. note:: + + - For information on how to build an image using + :term:`Toaster`, see the + :doc:`/toaster-manual/index`. + + - For information on how to use ``devtool`` to build images, see the + ":ref:`sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + - For a quick example on how to build an image using the + OpenEmbedded build system, see the + :doc:`/brief-yoctoprojectqs/index` document. + + - You can also use the `Yocto Project BitBake + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + extension for Visual Studio Code to build images. + +The build process creates an entire Linux distribution from source and +places it in your :term:`Build Directory` under ``tmp/deploy/images``. For +detailed information on the build process using BitBake, see the +":ref:`overview-manual/concepts:images`" section in the Yocto Project Overview +and Concepts Manual. + +The following figure and list overviews the build process: + +.. image:: figures/bitbake-build-flow.png + :width: 100% + +#. *Set up Your Host Development System to Support Development Using the + Yocto Project*: See the ":doc:`start`" section for options on how to get a + build host ready to use the Yocto Project. + +#. *Initialize the Build Environment:* Initialize the build environment + by sourcing the build environment script (i.e. + :ref:`structure-core-script`):: + + $ source oe-init-build-env [build_dir] + + When you use the initialization script, the OpenEmbedded build system + uses ``build`` as the default :term:`Build Directory` in your current work + directory. You can use a `build_dir` argument with the script to + specify a different :term:`Build Directory`. + + .. note:: + + A common practice is to use a different :term:`Build Directory` for + different targets; for example, ``~/build/x86`` for a ``qemux86`` + target, and ``~/build/arm`` for a ``qemuarm`` target. In any + event, it's typically cleaner to locate the :term:`Build Directory` + somewhere outside of your source directory. + +#. *Make Sure Your* ``local.conf`` *File is Correct*: Ensure the + ``conf/local.conf`` configuration file, which is found in the + :term:`Build Directory`, is set up how you want it. This file defines many + aspects of the build environment including the target machine architecture + through the :term:`MACHINE` variable, the packaging format used during + the build (:term:`PACKAGE_CLASSES`), and a centralized tarball download + directory through the :term:`DL_DIR` variable. + +#. *Build the Image:* Build the image using the ``bitbake`` command:: + + $ bitbake target + + .. note:: + + For information on BitBake, see the :doc:`bitbake:index`. + + The target is the name of the recipe you want to build. Common + targets are the images in ``meta/recipes-core/images``, + ``meta/recipes-sato/images``, and so forth all found in the + :term:`Source Directory`. Alternatively, the target + can be the name of a recipe for a specific piece of software such as + BusyBox. For more details about the images the OpenEmbedded build + system supports, see the + ":ref:`ref-manual/images:Images`" chapter in the Yocto + Project Reference Manual. + + As an example, the following command builds the + ``core-image-minimal`` image:: + + $ bitbake core-image-minimal + + Once an + image has been built, it often needs to be installed. The images and + kernels built by the OpenEmbedded build system are placed in the + :term:`Build Directory` in ``tmp/deploy/images``. For information on how to + run pre-built images such as ``qemux86`` and ``qemuarm``, see the + :doc:`/sdk-manual/index` manual. For + information about how to install these images, see the documentation + for your particular board or machine. + +Building Images for Multiple Targets Using Multiple Configurations +================================================================== + +You can use a single ``bitbake`` command to build multiple images or +packages for different targets where each image or package requires a +different configuration (multiple configuration builds). The builds, in +this scenario, are sometimes referred to as "multiconfigs", and this +section uses that term throughout. + +This section describes how to set up for multiple configuration builds +and how to account for cross-build dependencies between the +multiconfigs. + +Setting Up and Running a Multiple Configuration Build +----------------------------------------------------- + +To accomplish a multiple configuration build, you must define each +target's configuration separately using a parallel configuration file in +the :term:`Build Directory` or configuration directory within a layer, and you +must follow a required file hierarchy. Additionally, you must enable the +multiple configuration builds in your ``local.conf`` file. + +Follow these steps to set up and execute multiple configuration builds: + +- *Create Separate Configuration Files*: You need to create a single + configuration file for each build target (each multiconfig). + The configuration definitions are implementation dependent but often + each configuration file will define the machine and the + temporary directory BitBake uses for the build. Whether the same + temporary directory (:term:`TMPDIR`) can be shared will depend on what is + similar and what is different between the configurations. Multiple MACHINE + targets can share the same (:term:`TMPDIR`) as long as the rest of the + configuration is the same, multiple :term:`DISTRO` settings would need separate + (:term:`TMPDIR`) directories. + + For example, consider a scenario with two different multiconfigs for the same + :term:`MACHINE`: "qemux86" built + for two distributions such as "poky" and "poky-lsb". In this case, + you would need to use the different :term:`TMPDIR`. + + Here is an example showing the minimal statements needed in a + configuration file for a "qemux86" target whose temporary build + directory is ``tmpmultix86``:: + + MACHINE = "qemux86" + TMPDIR = "${TOPDIR}/tmpmultix86" + + The location for these multiconfig configuration files is specific. + They must reside in the current :term:`Build Directory` in a sub-directory of + ``conf`` named ``multiconfig`` or within a layer's ``conf`` directory + under a directory named ``multiconfig``. Here is an example that defines + two configuration files for the "x86" and "arm" multiconfigs: + + .. image:: figures/multiconfig_files.png + :align: center + :width: 50% + + The usual :term:`BBPATH` search path is used to locate multiconfig files in + a similar way to other conf files. + +- *Add the BitBake Multi-configuration Variable to the Local + Configuration File*: Use the + :term:`BBMULTICONFIG` + variable in your ``conf/local.conf`` configuration file to specify + each multiconfig. Continuing with the example from the previous + figure, the :term:`BBMULTICONFIG` variable needs to enable two + multiconfigs: "x86" and "arm" by specifying each configuration file:: + + BBMULTICONFIG = "x86 arm" + + .. note:: + + A "default" configuration already exists by definition. This + configuration is named: "" (i.e. empty string) and is defined by + the variables coming from your ``local.conf`` + file. Consequently, the previous example actually adds two + additional configurations to your build: "arm" and "x86" along + with "". + +- *Launch BitBake*: Use the following BitBake command form to launch + the multiple configuration build:: + + $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ] + + For the example in this section, the following command applies:: + + $ bitbake mc:x86:core-image-minimal mc:arm:core-image-sato mc::core-image-base + + The previous BitBake command builds a ``core-image-minimal`` image + that is configured through the ``x86.conf`` configuration file, a + ``core-image-sato`` image that is configured through the ``arm.conf`` + configuration file and a ``core-image-base`` that is configured + through your ``local.conf`` configuration file. + +.. note:: + + Support for multiple configuration builds in the Yocto Project &DISTRO; + (&DISTRO_NAME;) Release does not include Shared State (sstate) + optimizations. Consequently, if a build uses the same object twice + in, for example, two different :term:`TMPDIR` + directories, the build either loads from an existing sstate cache for + that build at the start or builds the object fresh. + +Enabling Multiple Configuration Build Dependencies +-------------------------------------------------- + +Sometimes dependencies can exist between targets (multiconfigs) in a +multiple configuration build. For example, suppose that in order to +build a ``core-image-sato`` image for an "x86" multiconfig, the root +filesystem of an "arm" multiconfig must exist. This dependency is +essentially that the +:ref:`ref-tasks-image` task in the +``core-image-sato`` recipe depends on the completion of the +:ref:`ref-tasks-rootfs` task of the +``core-image-minimal`` recipe. + +To enable dependencies in a multiple configuration build, you must +declare the dependencies in the recipe using the following statement +form:: + + task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend" + +To better show how to use this statement, consider the example scenario +from the first paragraph of this section. The following statement needs +to be added to the recipe that builds the ``core-image-sato`` image:: + + do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs" + +In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The +task on which the :ref:`ref-tasks-image` task in the recipe depends is the +:ref:`ref-tasks-rootfs` task from the ``core-image-minimal`` recipe associated +with the "arm" multiconfig. + +Once you set up this dependency, you can build the "x86" multiconfig +using a BitBake command as follows:: + + $ bitbake mc:x86:core-image-sato + +This command executes all the tasks needed to create the +``core-image-sato`` image for the "x86" multiconfig. Because of the +dependency, BitBake also executes through the :ref:`ref-tasks-rootfs` task for the +"arm" multiconfig build. + +Having a recipe depend on the root filesystem of another build might not +seem that useful. Consider this change to the statement in the +``core-image-sato`` recipe:: + + do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_image" + +In this case, BitBake must +create the ``core-image-minimal`` image for the "arm" build since the +"x86" build depends on it. + +Because "x86" and "arm" are enabled for multiple configuration builds +and have separate configuration files, BitBake places the artifacts for +each build in the respective temporary build directories (i.e. +:term:`TMPDIR`). + +Building an Initial RAM Filesystem (Initramfs) Image +==================================================== + +An initial RAM filesystem (:term:`Initramfs`) image provides a temporary root +filesystem used for early system initialization, typically providing tools and +loading modules needed to locate and mount the final root filesystem. + +Follow these steps to create an :term:`Initramfs` image: + +#. *Create the Initramfs Image Recipe:* You can reference the + ``core-image-minimal-initramfs.bb`` recipe found in the + ``meta/recipes-core`` directory of the :term:`Source Directory` + as an example from which to work. + +#. *Decide if You Need to Bundle the Initramfs Image Into the Kernel + Image:* If you want the :term:`Initramfs` image that is built to be bundled + in with the kernel image, set the :term:`INITRAMFS_IMAGE_BUNDLE` + variable to ``"1"`` in your ``local.conf`` configuration file and set the + :term:`INITRAMFS_IMAGE` variable in the recipe that builds the kernel image. + + Setting the :term:`INITRAMFS_IMAGE_BUNDLE` flag causes the :term:`Initramfs` + image to be unpacked into the ``${B}/usr/`` directory. The unpacked + :term:`Initramfs` image is then passed to the kernel's ``Makefile`` using the + :term:`CONFIG_INITRAMFS_SOURCE` variable, allowing the :term:`Initramfs` + image to be built into the kernel normally. + +#. *Optionally Add Items to the Initramfs Image Through the Initramfs + Image Recipe:* If you add items to the :term:`Initramfs` image by way of its + recipe, you should use :term:`PACKAGE_INSTALL` rather than + :term:`IMAGE_INSTALL`. :term:`PACKAGE_INSTALL` gives more direct control of + what is added to the image as compared to the defaults you might not + necessarily want that are set by the :ref:`ref-classes-image` + or :ref:`ref-classes-core-image` classes. + +#. *Build the Kernel Image and the Initramfs Image:* Build your kernel + image using BitBake. Because the :term:`Initramfs` image recipe is a + dependency of the kernel image, the :term:`Initramfs` image is built as well + and bundled with the kernel image if you used the + :term:`INITRAMFS_IMAGE_BUNDLE` variable described earlier. + +Bundling an Initramfs Image From a Separate Multiconfig +------------------------------------------------------- + +There may be a case where we want to build an :term:`Initramfs` image which does not +inherit the same distro policy as our main image, for example, we may want +our main image to use ``TCLIBC="glibc"``, but to use ``TCLIBC="musl"`` in our :term:`Initramfs` +image to keep a smaller footprint. However, by performing the steps mentioned +above the :term:`Initramfs` image will inherit ``TCLIBC="glibc"`` without allowing us +to override it. + +To achieve this, you need to perform some additional steps: + +#. *Create a multiconfig for your Initramfs image:* You can perform the steps + on ":ref:`dev-manual/building:building images for multiple targets using multiple configurations`" to create a separate multiconfig. + For the sake of simplicity let's assume such multiconfig is called: ``initramfscfg.conf`` and + contains the variables:: + + TMPDIR="${TOPDIR}/tmp-initramfscfg" + TCLIBC="musl" + +#. *Set additional Initramfs variables on your main configuration:* + Additionally, on your main configuration (``local.conf``) you need to set the + variables:: + + INITRAMFS_MULTICONFIG = "initramfscfg" + INITRAMFS_DEPLOY_DIR_IMAGE = "${TOPDIR}/tmp-initramfscfg/deploy/images/${MACHINE}" + + The variables :term:`INITRAMFS_MULTICONFIG` and :term:`INITRAMFS_DEPLOY_DIR_IMAGE` + are used to create a multiconfig dependency from the kernel to the :term:`INITRAMFS_IMAGE` + to be built coming from the ``initramfscfg`` multiconfig, and to let the + buildsystem know where the :term:`INITRAMFS_IMAGE` will be located. + + Building a system with such configuration will build the kernel using the + main configuration but the :ref:`ref-tasks-bundle_initramfs` task will grab the + selected :term:`INITRAMFS_IMAGE` from :term:`INITRAMFS_DEPLOY_DIR_IMAGE` + instead, resulting in a musl based :term:`Initramfs` image bundled in the kernel + but a glibc based main image. + + The same is applicable to avoid inheriting :term:`DISTRO_FEATURES` on :term:`INITRAMFS_IMAGE` + or to build a different :term:`DISTRO` for it such as ``poky-tiny``. + + +Building a Tiny System +====================== + +Very small distributions have some significant advantages such as +requiring less on-die or in-package memory (cheaper), better performance +through efficient cache usage, lower power requirements due to less +memory, faster boot times, and reduced development overhead. Some +real-world examples where a very small distribution gives you distinct +advantages are digital cameras, medical devices, and small headless +systems. + +This section presents information that shows you how you can trim your +distribution to even smaller sizes than the ``poky-tiny`` distribution, +which is around 5 Mbytes, that can be built out-of-the-box using the +Yocto Project. + +Tiny System Overview +-------------------- + +The following list presents the overall steps you need to consider and +perform to create distributions with smaller root filesystems, achieve +faster boot times, maintain your critical functionality, and avoid +initial RAM disks: + +- :ref:`Determine your goals and guiding principles + <dev-manual/building:goals and guiding principles>` + +- :ref:`dev-manual/building:understand what contributes to your image size` + +- :ref:`Reduce the size of the root filesystem + <dev-manual/building:trim the root filesystem>` + +- :ref:`Reduce the size of the kernel <dev-manual/building:trim the kernel>` + +- :ref:`dev-manual/building:remove package management requirements` + +- :ref:`dev-manual/building:look for other ways to minimize size` + +- :ref:`dev-manual/building:iterate on the process` + +Goals and Guiding Principles +---------------------------- + +Before you can reach your destination, you need to know where you are +going. Here is an example list that you can use as a guide when creating +very small distributions: + +- Determine how much space you need (e.g. a kernel that is 1 Mbyte or + less and a root filesystem that is 3 Mbytes or less). + +- Find the areas that are currently taking 90% of the space and + concentrate on reducing those areas. + +- Do not create any difficult "hacks" to achieve your goals. + +- Leverage the device-specific options. + +- Work in a separate layer so that you keep changes isolated. For + information on how to create layers, see the + ":ref:`dev-manual/layers:understanding and creating layers`" section. + +Understand What Contributes to Your Image Size +---------------------------------------------- + +It is easiest to have something to start with when creating your own +distribution. You can use the Yocto Project out-of-the-box to create the +``poky-tiny`` distribution. Ultimately, you will want to make changes in +your own distribution that are likely modeled after ``poky-tiny``. + +.. note:: + + To use ``poky-tiny`` in your build, set the :term:`DISTRO` variable in your + ``local.conf`` file to "poky-tiny" as described in the + ":ref:`dev-manual/custom-distribution:creating your own distribution`" + section. + +Understanding some memory concepts will help you reduce the system size. +Memory consists of static, dynamic, and temporary memory. Static memory +is the TEXT (code), DATA (initialized data in the code), and BSS +(uninitialized data) sections. Dynamic memory represents memory that is +allocated at runtime: stacks, hash tables, and so forth. Temporary +memory is recovered after the boot process. This memory consists of +memory used for decompressing the kernel and for the ``__init__`` +functions. + +To help you see where you currently are with kernel and root filesystem +sizes, you can use two tools found in the :term:`Source Directory` +in the +``scripts/tiny/`` directory: + +- ``ksize.py``: Reports component sizes for the kernel build objects. + +- ``dirsize.py``: Reports component sizes for the root filesystem. + +This next tool and command help you organize configuration fragments and +view file dependencies in a human-readable form: + +- ``merge_config.sh``: Helps you manage configuration files and + fragments within the kernel. With this tool, you can merge individual + configuration fragments together. The tool allows you to make + overrides and warns you of any missing configuration options. The + tool is ideal for allowing you to iterate on configurations, create + minimal configurations, and create configuration files for different + machines without having to duplicate your process. + + The ``merge_config.sh`` script is part of the Linux Yocto kernel Git + repositories (i.e. ``linux-yocto-3.14``, ``linux-yocto-3.10``, + ``linux-yocto-3.8``, and so forth) in the ``scripts/kconfig`` + directory. + + For more information on configuration fragments, see the + ":ref:`kernel-dev/common:creating configuration fragments`" + section in the Yocto Project Linux Kernel Development Manual. + +- ``bitbake -u taskexp -g bitbake_target``: Using the BitBake command + with these options brings up a Dependency Explorer from which you can + view file dependencies. Understanding these dependencies allows you + to make informed decisions when cutting out various pieces of the + kernel and root filesystem. + +Trim the Root Filesystem +------------------------ + +The root filesystem is made up of packages for booting, libraries, and +applications. To change things, you can configure how the packaging +happens, which changes the way you build them. You can also modify the +filesystem itself or select a different filesystem. + +First, find out what is hogging your root filesystem by running the +``dirsize.py`` script from your root directory:: + + $ cd root-directory-of-image + $ dirsize.py 100000 > dirsize-100k.log + $ cat dirsize-100k.log + +You can apply a filter to the script to ignore files +under a certain size. The previous example filters out any files below +100 Kbytes. The sizes reported by the tool are uncompressed, and thus +will be smaller by a relatively constant factor in a compressed root +filesystem. When you examine your log file, you can focus on areas of +the root filesystem that take up large amounts of memory. + +You need to be sure that what you eliminate does not cripple the +functionality you need. One way to see how packages relate to each other +is by using the Dependency Explorer UI with the BitBake command:: + + $ cd image-directory + $ bitbake -u taskexp -g image + +Use the interface to +select potential packages you wish to eliminate and see their dependency +relationships. + +When deciding how to reduce the size, get rid of packages that result in +minimal impact on the feature set. For example, you might not need a VGA +display. Or, you might be able to get by with ``devtmpfs`` and ``mdev`` +instead of ``udev``. + +Use your ``local.conf`` file to make changes. For example, to eliminate +``udev`` and ``glib``, set the following in the local configuration +file:: + + VIRTUAL-RUNTIME_dev_manager = "" + +Finally, you should consider exactly the type of root filesystem you +need to meet your needs while also reducing its size. For example, +consider ``cramfs``, ``squashfs``, ``ubifs``, ``ext2``, or an +:term:`Initramfs` using ``initramfs``. Be aware that ``ext3`` requires a 1 +Mbyte journal. If you are okay with running read-only, you do not need +this journal. + +.. note:: + + After each round of elimination, you need to rebuild your system and + then use the tools to see the effects of your reductions. + +Trim the Kernel +--------------- + +The kernel is built by including policies for hardware-independent +aspects. What subsystems do you enable? For what architecture are you +building? Which drivers do you build by default? + +.. note:: + + You can modify the kernel source if you want to help with boot time. + +Run the ``ksize.py`` script from the top-level Linux build directory to +get an idea of what is making up the kernel:: + + $ cd top-level-linux-build-directory + $ ksize.py > ksize.log + $ cat ksize.log + +When you examine the log, you will see how much space is taken up with +the built-in ``.o`` files for drivers, networking, core kernel files, +filesystem, sound, and so forth. The sizes reported by the tool are +uncompressed, and thus will be smaller by a relatively constant factor +in a compressed kernel image. Look to reduce the areas that are large +and taking up around the "90% rule." + +To examine, or drill down, into any particular area, use the ``-d`` +option with the script:: + + $ ksize.py -d > ksize.log + +Using this option +breaks out the individual file information for each area of the kernel +(e.g. drivers, networking, and so forth). + +Use your log file to see what you can eliminate from the kernel based on +features you can let go. For example, if you are not going to need +sound, you do not need any drivers that support sound. + +After figuring out what to eliminate, you need to reconfigure the kernel +to reflect those changes during the next build. You could run +``menuconfig`` and make all your changes at once. However, that makes it +difficult to see the effects of your individual eliminations and also +makes it difficult to replicate the changes for perhaps another target +device. A better method is to start with no configurations using +``allnoconfig``, create configuration fragments for individual changes, +and then manage the fragments into a single configuration file using +``merge_config.sh``. The tool makes it easy for you to iterate using the +configuration change and build cycle. + +Each time you make configuration changes, you need to rebuild the kernel +and check to see what impact your changes had on the overall size. + +Remove Package Management Requirements +-------------------------------------- + +Packaging requirements add size to the image. One way to reduce the size +of the image is to remove all the packaging requirements from the image. +This reduction includes both removing the package manager and its unique +dependencies as well as removing the package management data itself. + +To eliminate all the packaging requirements for an image, be sure that +"package-management" is not part of your +:term:`IMAGE_FEATURES` +statement for the image. When you remove this feature, you are removing +the package manager as well as its dependencies from the root +filesystem. + +Look for Other Ways to Minimize Size +------------------------------------ + +Depending on your particular circumstances, other areas that you can +trim likely exist. The key to finding these areas is through tools and +methods described here combined with experimentation and iteration. Here +are a couple of areas to experiment with: + +- ``glibc``: In general, follow this process: + + #. Remove ``glibc`` features from + :term:`DISTRO_FEATURES` + that you think you do not need. + + #. Build your distribution. + + #. If the build fails due to missing symbols in a package, determine + if you can reconfigure the package to not need those features. For + example, change the configuration to not support wide character + support as is done for ``ncurses``. Or, if support for those + characters is needed, determine what ``glibc`` features provide + the support and restore the configuration. + + 4. Rebuild and repeat the process. + +- ``busybox``: For BusyBox, use a process similar as described for + ``glibc``. A difference is you will need to boot the resulting system + to see if you are able to do everything you expect from the running + system. You need to be sure to integrate configuration fragments into + Busybox because BusyBox handles its own core features and then allows + you to add configuration fragments on top. + +Iterate on the Process +---------------------- + +If you have not reached your goals on system size, you need to iterate +on the process. The process is the same. Use the tools and see just what +is taking up 90% of the root filesystem and the kernel. Decide what you +can eliminate without limiting your device beyond what you need. + +Depending on your system, a good place to look might be Busybox, which +provides a stripped down version of Unix tools in a single, executable +file. You might be able to drop virtual terminal services or perhaps +ipv6. + +Building Images for More than One Machine +========================================= + +A common scenario developers face is creating images for several +different machines that use the same software environment. In this +situation, it is tempting to set the tunings and optimization flags for +each build specifically for the targeted hardware (i.e. "maxing out" the +tunings). Doing so can considerably add to build times and package feed +maintenance collectively for the machines. For example, selecting tunes +that are extremely specific to a CPU core used in a system might enable +some micro optimizations in GCC for that particular system but would +otherwise not gain you much of a performance difference across the other +systems as compared to using a more general tuning across all the builds +(e.g. setting :term:`DEFAULTTUNE` +specifically for each machine's build). Rather than "max out" each +build's tunings, you can take steps that cause the OpenEmbedded build +system to reuse software across the various machines where it makes +sense. + +If build speed and package feed maintenance are considerations, you +should consider the points in this section that can help you optimize +your tunings to best consider build times and package feed maintenance. + +- *Share the :term:`Build Directory`:* If at all possible, share the + :term:`TMPDIR` across builds. The Yocto Project supports switching between + different :term:`MACHINE` values in the same :term:`TMPDIR`. This practice + is well supported and regularly used by developers when building for + multiple machines. When you use the same :term:`TMPDIR` for multiple + machine builds, the OpenEmbedded build system can reuse the existing native + and often cross-recipes for multiple machines. Thus, build time decreases. + + .. note:: + + If :term:`DISTRO` settings change or fundamental configuration settings + such as the filesystem layout, you need to work with a clean :term:`TMPDIR`. + Sharing :term:`TMPDIR` under these circumstances might work but since it is + not guaranteed, you should use a clean :term:`TMPDIR`. + +- *Enable the Appropriate Package Architecture:* By default, the + OpenEmbedded build system enables three levels of package + architectures: "all", "tune" or "package", and "machine". Any given + recipe usually selects one of these package architectures (types) for + its output. Depending for what a given recipe creates packages, + making sure you enable the appropriate package architecture can + directly impact the build time. + + A recipe that just generates scripts can enable "all" architecture + because there are no binaries to build. To specifically enable "all" + architecture, be sure your recipe inherits the + :ref:`ref-classes-allarch` class. + This class is useful for "all" architectures because it configures + many variables so packages can be used across multiple architectures. + + If your recipe needs to generate packages that are machine-specific + or when one of the build or runtime dependencies is already + machine-architecture dependent, which makes your recipe also + machine-architecture dependent, make sure your recipe enables the + "machine" package architecture through the + :term:`MACHINE_ARCH` + variable:: + + PACKAGE_ARCH = "${MACHINE_ARCH}" + + When you do not + specifically enable a package architecture through the + :term:`PACKAGE_ARCH`, The + OpenEmbedded build system defaults to the + :term:`TUNE_PKGARCH` setting:: + + PACKAGE_ARCH = "${TUNE_PKGARCH}" + +- *Choose a Generic Tuning File if Possible:* Some tunes are more + generic and can run on multiple targets (e.g. an ``armv5`` set of + packages could run on ``armv6`` and ``armv7`` processors in most + cases). Similarly, ``i486`` binaries could work on ``i586`` and + higher processors. You should realize, however, that advances on + newer processor versions would not be used. + + If you select the same tune for several different machines, the + OpenEmbedded build system reuses software previously built, thus + speeding up the overall build time. Realize that even though a new + sysroot for each machine is generated, the software is not recompiled + and only one package feed exists. + +- *Manage Granular Level Packaging:* Sometimes there are cases where + injecting another level of package architecture beyond the three + higher levels noted earlier can be useful. For example, consider how + NXP (formerly Freescale) allows for the easy reuse of binary packages + in their layer + :yocto_git:`meta-freescale </meta-freescale/>`. + In this example, the + :yocto_git:`fsl-dynamic-packagearch </meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>` + class shares GPU packages for i.MX53 boards because all boards share + the AMD GPU. The i.MX6-based boards can do the same because all + boards share the Vivante GPU. This class inspects the BitBake + datastore to identify if the package provides or depends on one of + the sub-architecture values. If so, the class sets the + :term:`PACKAGE_ARCH` value + based on the ``MACHINE_SUBARCH`` value. If the package does not + provide or depend on one of the sub-architecture values but it + matches a value in the machine-specific filter, it sets + :term:`MACHINE_ARCH`. This + behavior reduces the number of packages built and saves build time by + reusing binaries. + +- *Use Tools to Debug Issues:* Sometimes you can run into situations + where software is being rebuilt when you think it should not be. For + example, the OpenEmbedded build system might not be using shared + state between machines when you think it should be. These types of + situations are usually due to references to machine-specific + variables such as :term:`MACHINE`, + :term:`SERIAL_CONSOLES`, + :term:`XSERVER`, + :term:`MACHINE_FEATURES`, + and so forth in code that is supposed to only be tune-specific or + when the recipe depends + (:term:`DEPENDS`, + :term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, and so forth) + on some other recipe that already has + :term:`PACKAGE_ARCH` defined + as "${MACHINE_ARCH}". + + .. note:: + + Patches to fix any issues identified are most welcome as these + issues occasionally do occur. + + For such cases, you can use some tools to help you sort out the + situation: + + - ``state-diff-machines.sh``*:* You can find this tool in the + ``scripts`` directory of the Source Repositories. See the comments + in the script for information on how to use the tool. + + - *BitBake's "-S printdiff" Option:* Using this option causes + BitBake to try to establish the most recent signature match + (e.g. in the shared state cache) and then compare matched signatures + to determine the stamps and delta where these two stamp trees diverge. + +Building Software from an External Source +========================================= + +By default, the OpenEmbedded build system uses the :term:`Build Directory` +when building source code. The build process involves fetching the source +files, unpacking them, and then patching them if necessary before the build +takes place. + +There are situations where you might want to build software from source +files that are external to and thus outside of the OpenEmbedded build +system. For example, suppose you have a project that includes a new BSP +with a heavily customized kernel. And, you want to minimize exposing the +build system to the development team so that they can focus on their +project and maintain everyone's workflow as much as possible. In this +case, you want a kernel source directory on the development machine +where the development occurs. You want the recipe's +:term:`SRC_URI` variable to point to +the external directory and use it as is, not copy it. + +To build from software that comes from an external source, all you need to do +is inherit the :ref:`ref-classes-externalsrc` class and then set +the :term:`EXTERNALSRC` variable to point to your external source code. Here +are the statements to put in your ``local.conf`` file:: + + INHERIT += "externalsrc" + EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree" + +This next example shows how to accomplish the same thing by setting +:term:`EXTERNALSRC` in the recipe itself or in the recipe's append file:: + + EXTERNALSRC = "path" + EXTERNALSRC_BUILD = "path" + +.. note:: + + In order for these settings to take effect, you must globally or + locally inherit the :ref:`ref-classes-externalsrc` class. + +By default, :ref:`ref-classes-externalsrc` builds the source code in a +directory separate from the external source directory as specified by +:term:`EXTERNALSRC`. If you need +to have the source built in the same directory in which it resides, or +some other nominated directory, you can set +:term:`EXTERNALSRC_BUILD` +to point to that directory:: + + EXTERNALSRC_BUILD:pn-myrecipe = "path-to-your-source-tree" + +Replicating a Build Offline +=========================== + +It can be useful to take a "snapshot" of upstream sources used in a +build and then use that "snapshot" later to replicate the build offline. +To do so, you need to first prepare and populate your downloads +directory your "snapshot" of files. Once your downloads directory is +ready, you can use it at any time and from any machine to replicate your +build. + +Follow these steps to populate your Downloads directory: + +#. *Create a Clean Downloads Directory:* Start with an empty downloads + directory (:term:`DL_DIR`). You + start with an empty downloads directory by either removing the files + in the existing directory or by setting :term:`DL_DIR` to point to either + an empty location or one that does not yet exist. + +#. *Generate Tarballs of the Source Git Repositories:* Edit your + ``local.conf`` configuration file as follows:: + + DL_DIR = "/home/your-download-dir/" + BB_GENERATE_MIRROR_TARBALLS = "1" + + During + the fetch process in the next step, BitBake gathers the source files + and creates tarballs in the directory pointed to by :term:`DL_DIR`. See + the + :term:`BB_GENERATE_MIRROR_TARBALLS` + variable for more information. + +#. *Populate Your Downloads Directory Without Building:* Use BitBake to + fetch your sources but inhibit the build:: + + $ bitbake target --runonly=fetch + + The downloads directory (i.e. ``${DL_DIR}``) now has + a "snapshot" of the source files in the form of tarballs, which can + be used for the build. + +#. *Optionally Remove Any Git or other SCM Subdirectories From the + Downloads Directory:* If you want, you can clean up your downloads + directory by removing any Git or other Source Control Management + (SCM) subdirectories such as ``${DL_DIR}/git2/*``. The tarballs + already contain these subdirectories. + +Once your downloads directory has everything it needs regarding source +files, you can create your "own-mirror" and build your target. +Understand that you can use the files to build the target offline from +any machine and at any time. + +Follow these steps to build your target using the files in the downloads +directory: + +#. *Using Local Files Only:* Inside your ``local.conf`` file, add the + :term:`SOURCE_MIRROR_URL` variable, inherit the + :ref:`ref-classes-own-mirrors` class, and use the + :term:`BB_NO_NETWORK` variable to your ``local.conf``:: + + SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" + INHERIT += "own-mirrors" + BB_NO_NETWORK = "1" + + The :term:`SOURCE_MIRROR_URL` and :ref:`ref-classes-own-mirrors` + class set up the system to use the downloads directory as your "own + mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that + BitBake's fetching process in step 3 stays local, which means files + from your "own-mirror" are used. + +#. *Start With a Clean Build:* You can start with a clean build by + removing the ``${``\ :term:`TMPDIR`\ ``}`` directory or using a new + :term:`Build Directory`. + +#. *Build Your Target:* Use BitBake to build your target:: + + $ bitbake target + + The build completes using the known local "snapshot" of source + files from your mirror. The resulting tarballs for your "snapshot" of + source files are in the downloads directory. + + .. note:: + + The offline build does not work if recipes attempt to find the + latest version of software by setting + :term:`SRCREV` to + ``${``\ :term:`AUTOREV`\ ``}``:: + + SRCREV = "${AUTOREV}" + + When a recipe sets :term:`SRCREV` to + ``${``\ :term:`AUTOREV`\ ``}``, the build system accesses the network in an + attempt to determine the latest version of software from the SCM. + Typically, recipes that use :term:`AUTOREV` are custom or modified + recipes. Recipes that reside in public repositories usually do not + use :term:`AUTOREV`. + + If you do have recipes that use :term:`AUTOREV`, you can take steps to + still use the recipes in an offline build. Do the following: + + #. Use a configuration generated by enabling :ref:`build + history <dev-manual/build-quality:maintaining build output quality>`. + + #. Use the ``buildhistory-collect-srcrevs`` command to collect the + stored :term:`SRCREV` values from the build's history. For more + information on collecting these values, see the + ":ref:`dev-manual/build-quality:build history package information`" + section. + + #. Once you have the correct source revisions, you can modify + those recipes to set :term:`SRCREV` to specific versions of the + software. + diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst deleted file mode 100644 index ed6b1446f3..0000000000 --- a/documentation/dev-manual/common-tasks.rst +++ /dev/null @@ -1,11509 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -************ -Common Tasks -************ - -This chapter describes fundamental procedures such as creating layers, -adding new software packages, extending or customizing images, porting -work to new hardware (adding a new machine), and so forth. You will find -that the procedures documented here occur often in the development cycle -using the Yocto Project. - -Understanding and Creating Layers -================================= - -The OpenEmbedded build system supports organizing -:term:`Metadata` into multiple layers. -Layers allow you to isolate different types of customizations from each -other. For introductory information on the Yocto Project Layer Model, -see the -":ref:`overview-manual/yp-intro:the yocto project layer model`" -section in the Yocto Project Overview and Concepts Manual. - -Creating Your Own Layer ------------------------ - -.. note:: - - It is very easy to create your own layers to use with the OpenEmbedded - build system, as the Yocto Project ships with tools that speed up creating - layers. This section describes the steps you perform by hand to create - layers so that you can better understand them. For information about the - layer-creation tools, see the - ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" - section in the Yocto Project Board Support Package (BSP) Developer's - Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" - section further down in this manual. - -Follow these general steps to create your layer without using tools: - -1. *Check Existing Layers:* Before creating a new layer, you should be - sure someone has not already created a layer containing the Metadata - you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>` - for a list of layers from the OpenEmbedded community that can be used in - the Yocto Project. You could find a layer that is identical or close - to what you need. - -2. *Create a Directory:* Create the directory for your layer. When you - create the layer, be sure to create the directory in an area not - associated with the Yocto Project :term:`Source Directory` - (e.g. the cloned ``poky`` repository). - - While not strictly required, prepend the name of the directory with - the string "meta-". For example:: - - meta-mylayer - meta-GUI_xyz - meta-mymachine - - With rare exceptions, a layer's name follows this form:: - - meta-root_name - - Following this layer naming convention can save - you trouble later when tools, components, or variables "assume" your - layer name begins with "meta-". A notable example is in configuration - files as shown in the following step where layer names without the - "meta-" string are appended to several variables used in the - configuration. - -3. *Create a Layer Configuration File:* Inside your new layer folder, - you need to create a ``conf/layer.conf`` file. It is easiest to take - an existing layer configuration file and copy that to your layer's - ``conf`` directory and then modify the file as needed. - - The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project - :yocto_git:`Source Repositories </poky/tree/meta-yocto-bsp/conf>` - demonstrates the required syntax. For your layer, you need to replace - "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" - for a layer named "meta-machinexyz"):: - - # We have a conf and classes directory, add to BBPATH - BBPATH .= ":${LAYERDIR}" - - # We have recipes-* directories, add to BBFILES - BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ - ${LAYERDIR}/recipes-*/*/*.bbappend" - - BBFILE_COLLECTIONS += "yoctobsp" - BBFILE_PATTERN_yoctobsp = "^${LAYERDIR}/" - BBFILE_PRIORITY_yoctobsp = "5" - LAYERVERSION_yoctobsp = "4" - LAYERSERIES_COMPAT_yoctobsp = "dunfell" - - Following is an explanation of the layer configuration file: - - - :term:`BBPATH`: Adds the layer's - root directory to BitBake's search path. Through the use of the - :term:`BBPATH` variable, BitBake locates class files (``.bbclass``), - configuration files, and files that are included with ``include`` - and ``require`` statements. For these cases, BitBake uses the - first file that matches the name found in :term:`BBPATH`. This is - similar to the way the ``PATH`` variable is used for binaries. It - is recommended, therefore, that you use unique class and - configuration filenames in your custom layer. - - - :term:`BBFILES`: Defines the - location for all recipes in the layer. - - - :term:`BBFILE_COLLECTIONS`: - Establishes the current layer through a unique identifier that is - used throughout the OpenEmbedded build system to refer to the - layer. In this example, the identifier "yoctobsp" is the - representation for the container layer named "meta-yocto-bsp". - - - :term:`BBFILE_PATTERN`: - Expands immediately during parsing to provide the directory of the - layer. - - - :term:`BBFILE_PRIORITY`: - Establishes a priority to use for recipes in the layer when the - OpenEmbedded build finds recipes of the same name in different - layers. - - - :term:`LAYERVERSION`: - Establishes a version number for the layer. You can use this - version number to specify this exact version of the layer as a - dependency when using the - :term:`LAYERDEPENDS` - variable. - - - :term:`LAYERDEPENDS`: - Lists all layers on which this layer depends (if any). - - - :term:`LAYERSERIES_COMPAT`: - Lists the :yocto_wiki:`Yocto Project </Releases>` - releases for which the current version is compatible. This - variable is a good way to indicate if your particular layer is - current. - -4. *Add Content:* Depending on the type of layer, add the content. If - the layer adds support for a machine, add the machine configuration - in a ``conf/machine/`` file within the layer. If the layer adds - distro policy, add the distro configuration in a ``conf/distro/`` - file within the layer. If the layer introduces new recipes, put the - recipes you need in ``recipes-*`` subdirectories within the layer. - - .. note:: - - For an explanation of layer hierarchy that is compliant with the - Yocto Project, see the ":ref:`bsp-guide/bsp:example filesystem layout`" - section in the Yocto Project Board Support Package (BSP) Developer's Guide. - -5. *Optionally Test for Compatibility:* If you want permission to use - the Yocto Project Compatibility logo with your layer or application - that uses your layer, perform the steps to apply for compatibility. - See the - ":ref:`dev-manual/common-tasks:making sure your layer is compatible with yocto project`" - section for more information. - -Following Best Practices When Creating Layers ---------------------------------------------- - -To create layers that are easier to maintain and that will not impact -builds for other machines, you should consider the information in the -following list: - -- *Avoid "Overlaying" Entire Recipes from Other Layers in Your - Configuration:* In other words, do not copy an entire recipe into - your layer and then modify it. Rather, use an append file - (``.bbappend``) to override only those parts of the original recipe - you need to modify. - -- *Avoid Duplicating Include Files:* Use append files (``.bbappend``) - for each recipe that uses an include file. Or, if you are introducing - a new recipe that requires the included file, use the path relative - to the original layer directory to refer to the file. For example, - use ``require recipes-core/``\ `package`\ ``/``\ `file`\ ``.inc`` instead - of ``require`` `file`\ ``.inc``. If you're finding you have to overlay - the include file, it could indicate a deficiency in the include file - in the layer to which it originally belongs. If this is the case, you - should try to address that deficiency instead of overlaying the - include file. For example, you could address this by getting the - maintainer of the include file to add a variable or variables to make - it easy to override the parts needing to be overridden. - -- *Structure Your Layers:* Proper use of overrides within append files - and placement of machine-specific files within your layer can ensure - that a build is not using the wrong Metadata and negatively impacting - a build for a different machine. Following are some examples: - - - *Modify Variables to Support a Different Machine:* Suppose you - have a layer named ``meta-one`` that adds support for building - machine "one". To do so, you use an append file named - ``base-files.bbappend`` and create a dependency on "foo" by - altering the :term:`DEPENDS` - variable:: - - DEPENDS = "foo" - - The dependency is created during any - build that includes the layer ``meta-one``. However, you might not - want this dependency for all machines. For example, suppose you - are building for machine "two" but your ``bblayers.conf`` file has - the ``meta-one`` layer included. During the build, the - ``base-files`` for machine "two" will also have the dependency on - ``foo``. - - To make sure your changes apply only when building machine "one", - use a machine override with the :term:`DEPENDS` statement:: - - DEPENDS:one = "foo" - - You should follow the same strategy when using ``:append`` - and ``:prepend`` operations:: - - DEPENDS:append:one = " foo" - DEPENDS:prepend:one = "foo " - - As an actual example, here's a - snippet from the generic kernel include file ``linux-yocto.inc``, - wherein the kernel compile and link options are adjusted in the - case of a subset of the supported architectures:: - - DEPENDS:append:aarch64 = " libgcc" - KERNEL_CC:append:aarch64 = " ${TOOLCHAIN_OPTIONS}" - KERNEL_LD:append:aarch64 = " ${TOOLCHAIN_OPTIONS}" - - DEPENDS:append:nios2 = " libgcc" - KERNEL_CC:append:nios2 = " ${TOOLCHAIN_OPTIONS}" - KERNEL_LD:append:nios2 = " ${TOOLCHAIN_OPTIONS}" - - DEPENDS:append:arc = " libgcc" - KERNEL_CC:append:arc = " ${TOOLCHAIN_OPTIONS}" - KERNEL_LD:append:arc = " ${TOOLCHAIN_OPTIONS}" - - KERNEL_FEATURES:append:qemuall=" features/debug/printk.scc" - - - *Place Machine-Specific Files in Machine-Specific Locations:* When - you have a base recipe, such as ``base-files.bb``, that contains a - :term:`SRC_URI` statement to a - file, you can use an append file to cause the build to use your - own version of the file. For example, an append file in your layer - at ``meta-one/recipes-core/base-files/base-files.bbappend`` could - extend :term:`FILESPATH` using :term:`FILESEXTRAPATHS` as follows:: - - FILESEXTRAPATHS:prepend := "${THISDIR}/${BPN}:" - - The build for machine "one" will pick up your machine-specific file as - long as you have the file in - ``meta-one/recipes-core/base-files/base-files/``. However, if you - are building for a different machine and the ``bblayers.conf`` - file includes the ``meta-one`` layer and the location of your - machine-specific file is the first location where that file is - found according to :term:`FILESPATH`, builds for all machines will - also use that machine-specific file. - - You can make sure that a machine-specific file is used for a - particular machine by putting the file in a subdirectory specific - to the machine. For example, rather than placing the file in - ``meta-one/recipes-core/base-files/base-files/`` as shown above, - put it in ``meta-one/recipes-core/base-files/base-files/one/``. - Not only does this make sure the file is used only when building - for machine "one", but the build process locates the file more - quickly. - - In summary, you need to place all files referenced from - :term:`SRC_URI` in a machine-specific subdirectory within the layer in - order to restrict those files to machine-specific builds. - -- *Perform Steps to Apply for Yocto Project Compatibility:* If you want - permission to use the Yocto Project Compatibility logo with your - layer or application that uses your layer, perform the steps to apply - for compatibility. See the - ":ref:`dev-manual/common-tasks:making sure your layer is compatible with yocto project`" - section for more information. - -- *Follow the Layer Naming Convention:* Store custom layers in a Git - repository that use the ``meta-layer_name`` format. - -- *Group Your Layers Locally:* Clone your repository alongside other - cloned ``meta`` directories from the :term:`Source Directory`. - -Making Sure Your Layer is Compatible With Yocto Project -------------------------------------------------------- - -When you create a layer used with the Yocto Project, it is advantageous -to make sure that the layer interacts well with existing Yocto Project -layers (i.e. the layer is compatible with the Yocto Project). Ensuring -compatibility makes the layer easy to be consumed by others in the Yocto -Project community and could allow you permission to use the Yocto -Project Compatible Logo. - -.. note:: - - Only Yocto Project member organizations are permitted to use the - Yocto Project Compatible Logo. The logo is not available for general - use. For information on how to become a Yocto Project member - organization, see the :yocto_home:`Yocto Project Website <>`. - -The Yocto Project Compatibility Program consists of a layer application -process that requests permission to use the Yocto Project Compatibility -Logo for your layer and application. The process consists of two parts: - -1. Successfully passing a script (``yocto-check-layer``) that when run - against your layer, tests it against constraints based on experiences - of how layers have worked in the real world and where pitfalls have - been found. Getting a "PASS" result from the script is required for - successful compatibility registration. - -2. Completion of an application acceptance form, which you can find at - :yocto_home:`/webform/yocto-project-compatible-registration`. - -To be granted permission to use the logo, you need to satisfy the -following: - -- Be able to check the box indicating that you got a "PASS" when - running the script against your layer. - -- Answer "Yes" to the questions on the form or have an acceptable - explanation for any questions answered "No". - -- Be a Yocto Project Member Organization. - -The remainder of this section presents information on the registration -form and on the ``yocto-check-layer`` script. - -Yocto Project Compatible Program Application -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use the form to apply for your layer's approval. Upon successful -application, you can use the Yocto Project Compatibility Logo with your -layer and the application that uses your layer. - -To access the form, use this link: -:yocto_home:`/webform/yocto-project-compatible-registration`. -Follow the instructions on the form to complete your application. - -The application consists of the following sections: - -- *Contact Information:* Provide your contact information as the fields - require. Along with your information, provide the released versions - of the Yocto Project for which your layer is compatible. - -- *Acceptance Criteria:* Provide "Yes" or "No" answers for each of the - items in the checklist. There is space at the bottom of the form for - any explanations for items for which you answered "No". - -- *Recommendations:* Provide answers for the questions regarding Linux - kernel use and build success. - -``yocto-check-layer`` Script -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The ``yocto-check-layer`` script provides you a way to assess how -compatible your layer is with the Yocto Project. You should run this -script prior to using the form to apply for compatibility as described -in the previous section. You need to achieve a "PASS" result in order to -have your application form successfully processed. - -The script divides tests into three areas: COMMON, BSP, and DISTRO. For -example, given a distribution layer (DISTRO), the layer must pass both -the COMMON and DISTRO related tests. Furthermore, if your layer is a BSP -layer, the layer must pass the COMMON and BSP set of tests. - -To execute the script, enter the following commands from your build -directory:: - - $ source oe-init-build-env - $ yocto-check-layer your_layer_directory - -Be sure to provide the actual directory for your -layer as part of the command. - -Entering the command causes the script to determine the type of layer -and then to execute a set of specific tests against the layer. The -following list overviews the test: - -- ``common.test_readme``: Tests if a ``README`` file exists in the - layer and the file is not empty. - -- ``common.test_parse``: Tests to make sure that BitBake can parse the - files without error (i.e. ``bitbake -p``). - -- ``common.test_show_environment``: Tests that the global or per-recipe - environment is in order without errors (i.e. ``bitbake -e``). - -- ``common.test_world``: Verifies that ``bitbake world`` works. - -- ``common.test_signatures``: Tests to be sure that BSP and DISTRO - layers do not come with recipes that change signatures. - -- ``common.test_layerseries_compat``: Verifies layer compatibility is - set properly. - -- ``bsp.test_bsp_defines_machines``: Tests if a BSP layer has machine - configurations. - -- ``bsp.test_bsp_no_set_machine``: Tests to ensure a BSP layer does not - set the machine when the layer is added. - -- ``bsp.test_machine_world``: Verifies that ``bitbake world`` works - regardless of which machine is selected. - -- ``bsp.test_machine_signatures``: Verifies that building for a - particular machine affects only the signature of tasks specific to - that machine. - -- ``distro.test_distro_defines_distros``: Tests if a DISTRO layer has - distro configurations. - -- ``distro.test_distro_no_set_distros``: Tests to ensure a DISTRO layer - does not set the distribution when the layer is added. - -Enabling Your Layer -------------------- - -Before the OpenEmbedded build system can use your new layer, you need to -enable it. To enable your layer, simply add your layer's path to the -:term:`BBLAYERS` variable in your ``conf/bblayers.conf`` file, which is -found in the :term:`Build Directory`. -The following example shows how to enable your new -``meta-mylayer`` layer (note how your new layer exists outside of -the official ``poky`` repository which you would have checked out earlier):: - - # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf - # changes incompatibly - POKY_BBLAYERS_CONF_VERSION = "2" - BBPATH = "${TOPDIR}" - BBFILES ?= "" - BBLAYERS ?= " \ - /home/user/poky/meta \ - /home/user/poky/meta-poky \ - /home/user/poky/meta-yocto-bsp \ - /home/user/mystuff/meta-mylayer \ - " - -BitBake parses each ``conf/layer.conf`` file from the top down as -specified in the :term:`BBLAYERS` variable within the ``conf/bblayers.conf`` -file. During the processing of each ``conf/layer.conf`` file, BitBake -adds the recipes, classes and configurations contained within the -particular layer to the source directory. - -Appending Other Layers Metadata With Your Layer ------------------------------------------------ - -A recipe that appends Metadata to another recipe is called a BitBake -append file. A BitBake append file uses the ``.bbappend`` file type -suffix, while the corresponding recipe to which Metadata is being -appended uses the ``.bb`` file type suffix. - -You can use a ``.bbappend`` file in your layer to make additions or -changes to the content of another layer's recipe without having to copy -the other layer's recipe into your layer. Your ``.bbappend`` file -resides in your layer, while the main ``.bb`` recipe file to which you -are appending Metadata resides in a different layer. - -Being able to append information to an existing recipe not only avoids -duplication, but also automatically applies recipe changes from a -different layer into your layer. If you were copying recipes, you would -have to manually merge changes as they occur. - -When you create an append file, you must use the same root name as the -corresponding recipe file. For example, the append file -``someapp_3.1.bbappend`` must apply to ``someapp_3.1.bb``. This -means the original recipe and append filenames are version -number-specific. If the corresponding recipe is renamed to update to a -newer version, you must also rename and possibly update the -corresponding ``.bbappend`` as well. During the build process, BitBake -displays an error on starting if it detects a ``.bbappend`` file that -does not have a corresponding recipe with a matching name. See the -:term:`BB_DANGLINGAPPENDS_WARNONLY` -variable for information on how to handle this error. - -Overlaying a File Using Your Layer -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -As an example, consider the main formfactor recipe and a corresponding -formfactor append file both from the :term:`Source Directory`. -Here is the main -formfactor recipe, which is named ``formfactor_0.0.bb`` and located in -the "meta" layer at ``meta/recipes-bsp/formfactor``:: - - SUMMARY = "Device formfactor information" - DESCRIPTION = "A formfactor configuration file provides information about the \ - target hardware for which the image is being built and information that the \ - build system cannot obtain from other sources such as the kernel." - SECTION = "base" - LICENSE = "MIT" - LIC_FILES_CHKSUM = "file://${COREBASE}/meta/COPYING.MIT;md5=3da9cfbcb788c80a0384361b4de20420" - PR = "r45" - - SRC_URI = "file://config file://machconfig" - S = "${WORKDIR}" - - PACKAGE_ARCH = "${MACHINE_ARCH}" - INHIBIT_DEFAULT_DEPS = "1" - - do_install() { - # Install file only if it has contents - install -d ${D}${sysconfdir}/formfactor/ - install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/ - if [ -s "${S}/machconfig" ]; then - install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/ - fi - } - -In the main recipe, note the :term:`SRC_URI` -variable, which tells the OpenEmbedded build system where to find files -during the build. - -Following is the append file, which is named ``formfactor_0.0.bbappend`` -and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The -file is in the layer at ``recipes-bsp/formfactor``:: - - FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:" - -By default, the build system uses the -:term:`FILESPATH` variable to -locate files. This append file extends the locations by setting the -:term:`FILESEXTRAPATHS` -variable. Setting this variable in the ``.bbappend`` file is the most -reliable and recommended method for adding directories to the search -path used by the build system to find files. - -The statement in this example extends the directories to include -``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``, -which resolves to a directory named ``formfactor`` in the same directory -in which the append file resides (i.e. -``meta-raspberrypi/recipes-bsp/formfactor``. This implies that you must -have the supporting directory structure set up that will contain any -files or patches you will be including from the layer. - -Using the immediate expansion assignment operator ``:=`` is important -because of the reference to :term:`THISDIR`. The trailing colon character is -important as it ensures that items in the list remain colon-separated. - -.. note:: - - BitBake automatically defines the :term:`THISDIR` variable. You should - never set this variable yourself. Using ":prepend" as part of the - :term:`FILESEXTRAPATHS` ensures your path will be searched prior to other - paths in the final list. - - Also, not all append files add extra files. Many append files simply - allow to add build options (e.g. ``systemd``). For these cases, your - append file would not even use the :term:`FILESEXTRAPATHS` statement. - -The end result of this ``.bbappend`` file is that on a Raspberry Pi, where -``rpi`` will exist in the list of :term:`OVERRIDES`, the file -``meta-raspberrypi/recipes-bsp/formfactor/formfactor/rpi/machconfig`` will be -used during :ref:`ref-tasks-fetch` and the test for a non-zero file size in -:ref:`ref-tasks-install` will return true, and the file will be installed. - -Installing Additional Files Using Your Layer -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -As another example, consider the main ``xserver-xf86-config`` recipe and a -corresponding ``xserver-xf86-config`` append file both from the :term:`Source -Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named -``xserver-xf86-config_0.1.bb`` and located in the "meta" layer at -``meta/recipes-graphics/xorg-xserver``:: - - SUMMARY = "X.Org X server configuration file" - HOMEPAGE = "http://www.x.org" - SECTION = "x11/base" - LICENSE = "MIT-X" - LIC_FILES_CHKSUM = "file://${COREBASE}/meta/COPYING.MIT;md5=3da9cfbcb788c80a0384361b4de20420" - PR = "r33" - - SRC_URI = "file://xorg.conf" - - S = "${WORKDIR}" - - CONFFILES:${PN} = "${sysconfdir}/X11/xorg.conf" - - PACKAGE_ARCH = "${MACHINE_ARCH}" - ALLOW_EMPTY:${PN} = "1" - - do_install () { - if test -s ${WORKDIR}/xorg.conf; then - install -d ${D}/${sysconfdir}/X11 - install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/ - fi - } - -Following is the append file, which is named ``xserver-xf86-config_%.bbappend`` -and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The -file is in the layer at ``recipes-graphics/xorg-xserver``:: - - FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:" - - SRC_URI:append:rpi = " \ - file://xorg.conf.d/98-pitft.conf \ - file://xorg.conf.d/99-calibration.conf \ - " - do_install:append:rpi () { - PITFT="${@bb.utils.contains("MACHINE_FEATURES", "pitft", "1", "0", d)}" - if [ "${PITFT}" = "1" ]; then - install -d ${D}/${sysconfdir}/X11/xorg.conf.d/ - install -m 0644 ${WORKDIR}/xorg.conf.d/98-pitft.conf ${D}/${sysconfdir}/X11/xorg.conf.d/ - install -m 0644 ${WORKDIR}/xorg.conf.d/99-calibration.conf ${D}/${sysconfdir}/X11/xorg.conf.d/ - fi - } - - FILES:${PN}:append:rpi = " ${sysconfdir}/X11/xorg.conf.d/*" - -Building off of the previous example, we once again are setting the -:term:`FILESEXTRAPATHS` variable. In this case we are also using -:term:`SRC_URI` to list additional source files to use when ``rpi`` is found in -the list of :term:`OVERRIDES`. The :ref:`ref-tasks-install` task will then perform a -check for an additional :term:`MACHINE_FEATURES` that if set will cause these -additional files to be installed. These additional files are listed in -:term:`FILES` so that they will be packaged. - -Prioritizing Your Layer ------------------------ - -Each layer is assigned a priority value. Priority values control which -layer takes precedence if there are recipe files with the same name in -multiple layers. For these cases, the recipe file from the layer with a -higher priority number takes precedence. Priority values also affect the -order in which multiple ``.bbappend`` files for the same recipe are -applied. You can either specify the priority manually, or allow the -build system to calculate it based on the layer's dependencies. - -To specify the layer's priority manually, use the -:term:`BBFILE_PRIORITY` -variable and append the layer's root name:: - - BBFILE_PRIORITY_mylayer = "1" - -.. note:: - - It is possible for a recipe with a lower version number - :term:`PV` in a layer that has a higher - priority to take precedence. - - Also, the layer priority does not currently affect the precedence - order of ``.conf`` or ``.bbclass`` files. Future versions of BitBake - might address this. - -Managing Layers ---------------- - -You can use the BitBake layer management tool ``bitbake-layers`` to -provide a view into the structure of recipes across a multi-layer -project. Being able to generate output that reports on configured layers -with their paths and priorities and on ``.bbappend`` files and their -applicable recipes can help to reveal potential problems. - -For help on the BitBake layer management tool, use the following -command:: - - $ bitbake-layers --help - NOTE: Starting bitbake server... - usage: bitbake-layers [-d] [-q] [-F] [--color COLOR] [-h] <subcommand> ... - - BitBake layers utility - - optional arguments: - -d, --debug Enable debug output - -q, --quiet Print only errors - -F, --force Force add without recipe parse verification - --color COLOR Colorize output (where COLOR is auto, always, never) - -h, --help show this help message and exit - - subcommands: - <subcommand> - layerindex-fetch Fetches a layer from a layer index along with its - dependent layers, and adds them to conf/bblayers.conf. - layerindex-show-depends - Find layer dependencies from layer index. - add-layer Add one or more layers to bblayers.conf. - remove-layer Remove one or more layers from bblayers.conf. - flatten flatten layer configuration into a separate output - directory. - show-layers show current configured layers. - show-overlayed list overlayed recipes (where the same recipe exists - in another layer) - show-recipes list available recipes, showing the layer they are - provided by - show-appends list bbappend files and recipe files they apply to - show-cross-depends Show dependencies between recipes that cross layer - boundaries. - create-layer Create a basic layer - - Use bitbake-layers <subcommand> --help to get help on a specific command - -The following list describes the available commands: - -- ``help:`` Displays general help or help on a specified command. - -- ``show-layers:`` Shows the current configured layers. - -- ``show-overlayed:`` Lists overlayed recipes. A recipe is overlayed - when a recipe with the same name exists in another layer that has a - higher layer priority. - -- ``show-recipes:`` Lists available recipes and the layers that - provide them. - -- ``show-appends:`` Lists ``.bbappend`` files and the recipe files to - which they apply. - -- ``show-cross-depends:`` Lists dependency relationships between - recipes that cross layer boundaries. - -- ``add-layer:`` Adds a layer to ``bblayers.conf``. - -- ``remove-layer:`` Removes a layer from ``bblayers.conf`` - -- ``flatten:`` Flattens the layer configuration into a separate - output directory. Flattening your layer configuration builds a - "flattened" directory that contains the contents of all layers, with - any overlayed recipes removed and any ``.bbappend`` files appended to - the corresponding recipes. You might have to perform some manual - cleanup of the flattened layer as follows: - - - Non-recipe files (such as patches) are overwritten. The flatten - command shows a warning for these files. - - - Anything beyond the normal layer setup has been added to the - ``layer.conf`` file. Only the lowest priority layer's - ``layer.conf`` is used. - - - Overridden and appended items from ``.bbappend`` files need to be - cleaned up. The contents of each ``.bbappend`` end up in the - flattened recipe. However, if there are appended or changed - variable values, you need to tidy these up yourself. Consider the - following example. Here, the ``bitbake-layers`` command adds the - line ``#### bbappended ...`` so that you know where the following - lines originate:: - - ... - DESCRIPTION = "A useful utility" - ... - EXTRA_OECONF = "--enable-something" - ... - - #### bbappended from meta-anotherlayer #### - - DESCRIPTION = "Customized utility" - EXTRA_OECONF += "--enable-somethingelse" - - - Ideally, you would tidy up these utilities as follows:: - - ... - DESCRIPTION = "Customized utility" - ... - EXTRA_OECONF = "--enable-something --enable-somethingelse" - ... - -- ``layerindex-fetch``: Fetches a layer from a layer index, along - with its dependent layers, and adds the layers to the - ``conf/bblayers.conf`` file. - -- ``layerindex-show-depends``: Finds layer dependencies from the - layer index. - -- ``create-layer``: Creates a basic layer. - -Creating a General Layer Using the ``bitbake-layers`` Script ------------------------------------------------------------- - -The ``bitbake-layers`` script with the ``create-layer`` subcommand -simplifies creating a new general layer. - -.. note:: - - - For information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" - section in the Yocto - Project Board Specific (BSP) Developer's Guide. - - - In order to use a layer with the OpenEmbedded build system, you - need to add the layer to your ``bblayers.conf`` configuration - file. See the ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" - section for more information. - -The default mode of the script's operation with this subcommand is to -create a layer with the following: - -- A layer priority of 6. - -- A ``conf`` subdirectory that contains a ``layer.conf`` file. - -- A ``recipes-example`` subdirectory that contains a further - subdirectory named ``example``, which contains an ``example.bb`` - recipe file. - -- A ``COPYING.MIT``, which is the license statement for the layer. The - script assumes you want to use the MIT license, which is typical for - most layers, for the contents of the layer itself. - -- A ``README`` file, which is a file describing the contents of your - new layer. - -In its simplest form, you can use the following command form to create a -layer. The command creates a layer whose name corresponds to -"your_layer_name" in the current directory:: - - $ bitbake-layers create-layer your_layer_name - -As an example, the following command creates a layer named ``meta-scottrif`` -in your home directory:: - - $ cd /usr/home - $ bitbake-layers create-layer meta-scottrif - NOTE: Starting bitbake server... - Add your new layer with 'bitbake-layers add-layer meta-scottrif' - -If you want to set the priority of the layer to other than the default -value of "6", you can either use the ``--priority`` option or you -can edit the -:term:`BBFILE_PRIORITY` value -in the ``conf/layer.conf`` after the script creates it. Furthermore, if -you want to give the example recipe file some name other than the -default, you can use the ``--example-recipe-name`` option. - -The easiest way to see how the ``bitbake-layers create-layer`` command -works is to experiment with the script. You can also read the usage -information by entering the following:: - - $ bitbake-layers create-layer --help - NOTE: Starting bitbake server... - usage: bitbake-layers create-layer [-h] [--priority PRIORITY] - [--example-recipe-name EXAMPLERECIPE] - layerdir - - Create a basic layer - - positional arguments: - layerdir Layer directory to create - - optional arguments: - -h, --help show this help message and exit - --priority PRIORITY, -p PRIORITY - Layer directory to create - --example-recipe-name EXAMPLERECIPE, -e EXAMPLERECIPE - Filename of the example recipe - -Adding a Layer Using the ``bitbake-layers`` Script --------------------------------------------------- - -Once you create your general layer, you must add it to your -``bblayers.conf`` file. Adding the layer to this configuration file -makes the OpenEmbedded build system aware of your layer so that it can -search it for metadata. - -Add your layer by using the ``bitbake-layers add-layer`` command:: - - $ bitbake-layers add-layer your_layer_name - -Here is an example that adds a -layer named ``meta-scottrif`` to the configuration file. Following the -command that adds the layer is another ``bitbake-layers`` command that -shows the layers that are in your ``bblayers.conf`` file:: - - $ bitbake-layers add-layer meta-scottrif - NOTE: Starting bitbake server... - Parsing recipes: 100% |##########################################################| Time: 0:00:49 - Parsing of 1441 .bb files complete (0 cached, 1441 parsed). 2055 targets, 56 skipped, 0 masked, 0 errors. - $ bitbake-layers show-layers - NOTE: Starting bitbake server... - layer path priority - ========================================================================== - meta /home/scottrif/poky/meta 5 - meta-poky /home/scottrif/poky/meta-poky 5 - meta-yocto-bsp /home/scottrif/poky/meta-yocto-bsp 5 - workspace /home/scottrif/poky/build/workspace 99 - meta-scottrif /home/scottrif/poky/build/meta-scottrif 6 - - -Adding the layer to this file -enables the build system to locate the layer during the build. - -.. note:: - - During a build, the OpenEmbedded build system looks in the layers - from the top of the list down to the bottom in that order. - -Customizing Images -================== - -You can customize images to satisfy particular requirements. This -section describes several methods and provides guidelines for each. - -Customizing Images Using ``local.conf`` ---------------------------------------- - -Probably the easiest way to customize an image is to add a package by -way of the ``local.conf`` configuration file. Because it is limited to -local use, this method generally only allows you to add packages and is -not as flexible as creating your own customized image. When you add -packages using local variables this way, you need to realize that these -variable changes are in effect for every build and consequently affect -all images, which might not be what you require. - -To add a package to your image using the local configuration file, use -the :term:`IMAGE_INSTALL` variable with the ``:append`` operator:: - - IMAGE_INSTALL:append = " strace" - -Use of the syntax is important; specifically, the leading space -after the opening quote and before the package name, which is -``strace`` in this example. This space is required since the ``:append`` -operator does not add the space. - -Furthermore, you must use ``:append`` instead of the ``+=`` operator if -you want to avoid ordering issues. The reason for this is because doing -so unconditionally appends to the variable and avoids ordering problems -due to the variable being set in image recipes and ``.bbclass`` files -with operators like ``?=``. Using ``:append`` ensures the operation -takes effect. - -As shown in its simplest use, ``IMAGE_INSTALL:append`` affects all -images. It is possible to extend the syntax so that the variable applies -to a specific image only. Here is an example:: - - IMAGE_INSTALL:append:pn-core-image-minimal = " strace" - -This example adds ``strace`` to the ``core-image-minimal`` image only. - -You can add packages using a similar approach through the -:term:`CORE_IMAGE_EXTRA_INSTALL` variable. If you use this variable, only -``core-image-*`` images are affected. - -Customizing Images Using Custom ``IMAGE_FEATURES`` and ``EXTRA_IMAGE_FEATURES`` -------------------------------------------------------------------------------- - -Another method for customizing your image is to enable or disable -high-level image features by using the -:term:`IMAGE_FEATURES` and -:term:`EXTRA_IMAGE_FEATURES` -variables. Although the functions for both variables are nearly -equivalent, best practices dictate using :term:`IMAGE_FEATURES` from within -a recipe and using :term:`EXTRA_IMAGE_FEATURES` from within your -``local.conf`` file, which is found in the -:term:`Build Directory`. - -To understand how these features work, the best reference is -:ref:`meta/classes/image.bbclass <ref-classes-image>`. -This class lists out the available -:term:`IMAGE_FEATURES` of which most map to package groups while some, such -as ``debug-tweaks`` and ``read-only-rootfs``, resolve as general -configuration settings. - -In summary, the file looks at the contents of the :term:`IMAGE_FEATURES` -variable and then maps or configures the feature accordingly. Based on -this information, the build system automatically adds the appropriate -packages or configurations to the -:term:`IMAGE_INSTALL` variable. -Effectively, you are enabling extra features by extending the class or -creating a custom class for use with specialized image ``.bb`` files. - -Use the :term:`EXTRA_IMAGE_FEATURES` variable from within your local -configuration file. Using a separate area from which to enable features -with this variable helps you avoid overwriting the features in the image -recipe that are enabled with :term:`IMAGE_FEATURES`. The value of -:term:`EXTRA_IMAGE_FEATURES` is added to :term:`IMAGE_FEATURES` within -``meta/conf/bitbake.conf``. - -To illustrate how you can use these variables to modify your image, -consider an example that selects the SSH server. The Yocto Project ships -with two SSH servers you can use with your images: Dropbear and OpenSSH. -Dropbear is a minimal SSH server appropriate for resource-constrained -environments, while OpenSSH is a well-known standard SSH server -implementation. By default, the ``core-image-sato`` image is configured -to use Dropbear. The ``core-image-full-cmdline`` and ``core-image-lsb`` -images both include OpenSSH. The ``core-image-minimal`` image does not -contain an SSH server. - -You can customize your image and change these defaults. Edit the -:term:`IMAGE_FEATURES` variable in your recipe or use the -:term:`EXTRA_IMAGE_FEATURES` in your ``local.conf`` file so that it -configures the image you are working with to include -``ssh-server-dropbear`` or ``ssh-server-openssh``. - -.. note:: - - See the ":ref:`ref-manual/features:image features`" section in the Yocto - Project Reference Manual for a complete list of image features that ship - with the Yocto Project. - -Customizing Images Using Custom .bb Files ------------------------------------------ - -You can also customize an image by creating a custom recipe that defines -additional software as part of the image. The following example shows -the form for the two lines you need:: - - IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2" - inherit core-image - -Defining the software using a custom recipe gives you total control over -the contents of the image. It is important to use the correct names of -packages in the :term:`IMAGE_INSTALL` variable. You must use the -OpenEmbedded notation and not the Debian notation for the names (e.g. -``glibc-dev`` instead of ``libc6-dev``). - -The other method for creating a custom image is to base it on an -existing image. For example, if you want to create an image based on -``core-image-sato`` but add the additional package ``strace`` to the -image, copy the ``meta/recipes-sato/images/core-image-sato.bb`` to a new -``.bb`` and add the following line to the end of the copy:: - - IMAGE_INSTALL += "strace" - -Customizing Images Using Custom Package Groups ----------------------------------------------- - -For complex custom images, the best approach for customizing an image is -to create a custom package group recipe that is used to build the image -or images. A good example of a package group recipe is -``meta/recipes-core/packagegroups/packagegroup-base.bb``. - -If you examine that recipe, you see that the :term:`PACKAGES` variable lists -the package group packages to produce. The ``inherit packagegroup`` -statement sets appropriate default values and automatically adds -``-dev``, ``-dbg``, and ``-ptest`` complementary packages for each -package specified in the :term:`PACKAGES` statement. - -.. note:: - - The ``inherit packagegroup`` line should be located near the top of the - recipe, certainly before the :term:`PACKAGES` statement. - -For each package you specify in :term:`PACKAGES`, you can use :term:`RDEPENDS` -and :term:`RRECOMMENDS` entries to provide a list of packages the parent -task package should contain. You can see examples of these further down -in the ``packagegroup-base.bb`` recipe. - -Here is a short, fabricated example showing the same basic pieces for a -hypothetical packagegroup defined in ``packagegroup-custom.bb``, where -the variable :term:`PN` is the standard way to abbreviate the reference to -the full packagegroup name ``packagegroup-custom``:: - - DESCRIPTION = "My Custom Package Groups" - - inherit packagegroup - - PACKAGES = "\ - ${PN}-apps \ - ${PN}-tools \ - " - - RDEPENDS:${PN}-apps = "\ - dropbear \ - portmap \ - psplash" - - RDEPENDS:${PN}-tools = "\ - oprofile \ - oprofileui-server \ - lttng-tools" - - RRECOMMENDS:${PN}-tools = "\ - kernel-module-oprofile" - -In the previous example, two package group packages are created with -their dependencies and their recommended package dependencies listed: -``packagegroup-custom-apps``, and ``packagegroup-custom-tools``. To -build an image using these package group packages, you need to add -``packagegroup-custom-apps`` and/or ``packagegroup-custom-tools`` to -:term:`IMAGE_INSTALL`. For other forms of image dependencies see the other -areas of this section. - -Customizing an Image Hostname ------------------------------ - -By default, the configured hostname (i.e. ``/etc/hostname``) in an image -is the same as the machine name. For example, if -:term:`MACHINE` equals "qemux86", the -configured hostname written to ``/etc/hostname`` is "qemux86". - -You can customize this name by altering the value of the "hostname" -variable in the ``base-files`` recipe using either an append file or a -configuration file. Use the following in an append file:: - - hostname = "myhostname" - -Use the following in a configuration file:: - - hostname:pn-base-files = "myhostname" - -Changing the default value of the variable "hostname" can be useful in -certain situations. For example, suppose you need to do extensive -testing on an image and you would like to easily identify the image -under test from existing images with typical default hostnames. In this -situation, you could change the default hostname to "testme", which -results in all the images using the name "testme". Once testing is -complete and you do not need to rebuild the image for test any longer, -you can easily reset the default hostname. - -Another point of interest is that if you unset the variable, the image -will have no default hostname in the filesystem. Here is an example that -unsets the variable in a configuration file:: - - hostname:pn-base-files = "" - -Having no default hostname in the filesystem is suitable for -environments that use dynamic hostnames such as virtual machines. - -Writing a New Recipe -==================== - -Recipes (``.bb`` files) are fundamental components in the Yocto Project -environment. Each software component built by the OpenEmbedded build -system requires a recipe to define the component. This section describes -how to create, write, and test a new recipe. - -.. note:: - - For information on variables that are useful for recipes and for - information about recipe naming issues, see the - ":ref:`ref-manual/varlocality:recipes`" section of the Yocto Project - Reference Manual. - -Overview --------- - -The following figure shows the basic process for creating a new recipe. -The remainder of the section provides details for the steps. - -.. image:: figures/recipe-workflow.png - :align: center - -Locate or Automatically Create a Base Recipe --------------------------------------------- - -You can always write a recipe from scratch. However, there are three choices -that can help you quickly get started with a new recipe: - -- ``devtool add``: A command that assists in creating a recipe and an - environment conducive to development. - -- ``recipetool create``: A command provided by the Yocto Project that - automates creation of a base recipe based on the source files. - -- *Existing Recipes:* Location and modification of an existing recipe - that is similar in function to the recipe you need. - -.. note:: - - For information on recipe syntax, see the - ":ref:`dev-manual/common-tasks:recipe syntax`" section. - -Creating the Base Recipe Using ``devtool add`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The ``devtool add`` command uses the same logic for auto-creating the -recipe as ``recipetool create``, which is listed below. Additionally, -however, ``devtool add`` sets up an environment that makes it easy for -you to patch the source and to make changes to the recipe as is often -necessary when adding a recipe to build a new piece of software to be -included in a build. - -You can find a complete description of the ``devtool add`` command in -the ":ref:`sdk-manual/extensible:a closer look at \`\`devtool add\`\``" section -in the Yocto Project Application Development and the Extensible Software -Development Kit (eSDK) manual. - -Creating the Base Recipe Using ``recipetool create`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -``recipetool create`` automates creation of a base recipe given a set of -source code files. As long as you can extract or point to the source -files, the tool will construct a recipe and automatically configure all -pre-build information into the recipe. For example, suppose you have an -application that builds using Autotools. Creating the base recipe using -``recipetool`` results in a recipe that has the pre-build dependencies, -license requirements, and checksums configured. - -To run the tool, you just need to be in your -:term:`Build Directory` and have sourced the -build environment setup script (i.e. -:ref:`structure-core-script`). -To get help on the tool, use the following command:: - - $ recipetool -h - NOTE: Starting bitbake server... - usage: recipetool [-d] [-q] [--color COLOR] [-h] <subcommand> ... - - OpenEmbedded recipe tool - - options: - -d, --debug Enable debug output - -q, --quiet Print only errors - --color COLOR Colorize output (where COLOR is auto, always, never) - -h, --help show this help message and exit - - subcommands: - create Create a new recipe - newappend Create a bbappend for the specified target in the specified - layer - setvar Set a variable within a recipe - appendfile Create/update a bbappend to replace a target file - appendsrcfiles Create/update a bbappend to add or replace source files - appendsrcfile Create/update a bbappend to add or replace a source file - Use recipetool <subcommand> --help to get help on a specific command - -Running ``recipetool create -o OUTFILE`` creates the base recipe and -locates it properly in the layer that contains your source files. -Following are some syntax examples: - - - Use this syntax to generate a recipe based on source. Once generated, - the recipe resides in the existing source code layer:: - - recipetool create -o OUTFILE source - - - Use this syntax to generate a recipe using code that - you extract from source. The extracted code is placed in its own layer - defined by :term:`EXTERNALSRC`. - :: - - recipetool create -o OUTFILE -x EXTERNALSRC source - - - Use this syntax to generate a recipe based on source. The options - direct ``recipetool`` to generate debugging information. Once generated, - the recipe resides in the existing source code layer:: - - recipetool create -d -o OUTFILE source - -Locating and Using a Similar Recipe -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Before writing a recipe from scratch, it is often useful to discover -whether someone else has already written one that meets (or comes close -to meeting) your needs. The Yocto Project and OpenEmbedded communities -maintain many recipes that might be candidates for what you are doing. -You can find a good central index of these recipes in the -:oe_layerindex:`OpenEmbedded Layer Index <>`. - -Working from an existing recipe or a skeleton recipe is the best way to -get started. Here are some points on both methods: - -- *Locate and modify a recipe that is close to what you want to do:* - This method works when you are familiar with the current recipe - space. The method does not work so well for those new to the Yocto - Project or writing recipes. - - Some risks associated with this method are using a recipe that has - areas totally unrelated to what you are trying to accomplish with - your recipe, not recognizing areas of the recipe that you might have - to add from scratch, and so forth. All these risks stem from - unfamiliarity with the existing recipe space. - -- *Use and modify the following skeleton recipe:* If for some reason - you do not want to use ``recipetool`` and you cannot find an existing - recipe that is close to meeting your needs, you can use the following - structure to provide the fundamental areas of a new recipe. - :: - - DESCRIPTION = "" - HOMEPAGE = "" - LICENSE = "" - SECTION = "" - DEPENDS = "" - LIC_FILES_CHKSUM = "" - - SRC_URI = "" - -Storing and Naming the Recipe ------------------------------ - -Once you have your base recipe, you should put it in your own layer and -name it appropriately. Locating it correctly ensures that the -OpenEmbedded build system can find it when you use BitBake to process -the recipe. - -- *Storing Your Recipe:* The OpenEmbedded build system locates your - recipe through the layer's ``conf/layer.conf`` file and the - :term:`BBFILES` variable. This - variable sets up a path from which the build system can locate - recipes. Here is the typical use:: - - BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ - ${LAYERDIR}/recipes-*/*/*.bbappend" - - Consequently, you need to be sure you locate your new recipe inside - your layer such that it can be found. - - You can find more information on how layers are structured in the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" section. - -- *Naming Your Recipe:* When you name your recipe, you need to follow - this naming convention:: - - basename_version.bb - - Use lower-cased characters and do not include the reserved suffixes - ``-native``, ``-cross``, ``-initial``, or ``-dev`` casually (i.e. do not use - them as part of your recipe name unless the string applies). Here are some - examples: - - .. code-block:: none - - cups_1.7.0.bb - gawk_4.0.2.bb - irssi_0.8.16-rc1.bb - -Running a Build on the Recipe ------------------------------ - -Creating a new recipe is usually an iterative process that requires -using BitBake to process the recipe multiple times in order to -progressively discover and add information to the recipe file. - -Assuming you have sourced the build environment setup script (i.e. -:ref:`structure-core-script`) and you are in -the :term:`Build Directory`, use -BitBake to process your recipe. All you need to provide is the -``basename`` of the recipe as described in the previous section:: - - $ bitbake basename - -During the build, the OpenEmbedded build system creates a temporary work -directory for each recipe -(``${``\ :term:`WORKDIR`\ ``}``) -where it keeps extracted source files, log files, intermediate -compilation and packaging files, and so forth. - -The path to the per-recipe temporary work directory depends on the -context in which it is being built. The quickest way to find this path -is to have BitBake return it by running the following:: - - $ bitbake -e basename | grep ^WORKDIR= - -As an example, assume a Source Directory -top-level folder named ``poky``, a default Build Directory at -``poky/build``, and a ``qemux86-poky-linux`` machine target system. -Furthermore, suppose your recipe is named ``foo_1.3.0.bb``. In this -case, the work directory the build system uses to build the package -would be as follows:: - - poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 - -Inside this directory you can find sub-directories such as ``image``, -``packages-split``, and ``temp``. After the build, you can examine these -to determine how well the build went. - -.. note:: - - You can find log files for each task in the recipe's ``temp`` - directory (e.g. ``poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0/temp``). - Log files are named ``log.taskname`` (e.g. ``log.do_configure``, - ``log.do_fetch``, and ``log.do_compile``). - -You can find more information about the build process in -":doc:`/overview-manual/development-environment`" -chapter of the Yocto Project Overview and Concepts Manual. - -Fetching Code -------------- - -The first thing your recipe must do is specify how to fetch the source -files. Fetching is controlled mainly through the -:term:`SRC_URI` variable. Your recipe -must have a :term:`SRC_URI` variable that points to where the source is -located. For a graphical representation of source locations, see the -":ref:`overview-manual/concepts:sources`" section in -the Yocto Project Overview and Concepts Manual. - -The :ref:`ref-tasks-fetch` task uses -the prefix of each entry in the :term:`SRC_URI` variable value to determine -which :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` to use to get your -source files. It is the :term:`SRC_URI` variable that triggers the fetcher. -The :ref:`ref-tasks-patch` task uses -the variable after source is fetched to apply patches. The OpenEmbedded -build system uses -:term:`FILESOVERRIDES` for -scanning directory locations for local files in :term:`SRC_URI`. - -The :term:`SRC_URI` variable in your recipe must define each unique location -for your source files. It is good practice to not hard-code version -numbers in a URL used in :term:`SRC_URI`. Rather than hard-code these -values, use ``${``\ :term:`PV`\ ``}``, -which causes the fetch process to use the version specified in the -recipe filename. Specifying the version in this manner means that -upgrading the recipe to a future version is as simple as renaming the -recipe to match the new version. - -Here is a simple example from the -``meta/recipes-devtools/strace/strace_5.5.bb`` recipe where the source -comes from a single tarball. Notice the use of the -:term:`PV` variable:: - - SRC_URI = "https://strace.io/files/${PV}/strace-${PV}.tar.xz \ - -Files mentioned in :term:`SRC_URI` whose names end in a typical archive -extension (e.g. ``.tar``, ``.tar.gz``, ``.tar.bz2``, ``.zip``, and so -forth), are automatically extracted during the -:ref:`ref-tasks-unpack` task. For -another example that specifies these types of files, see the -":ref:`dev-manual/common-tasks:autotooled package`" section. - -Another way of specifying source is from an SCM. For Git repositories, -you must specify :term:`SRCREV` and -you should specify :term:`PV` to include -the revision with :term:`SRCPV`. Here -is an example from the recipe -``meta/recipes-kernel/blktrace/blktrace_git.bb``:: - - SRCREV = "d6918c8832793b4205ed3bfede78c2f915c23385" - - PR = "r6" - PV = "1.0.5+git${SRCPV}" - - SRC_URI = "git://git.kernel.dk/blktrace.git \ - file://ldflags.patch" - -If your :term:`SRC_URI` statement includes URLs pointing to individual files -fetched from a remote server other than a version control system, -BitBake attempts to verify the files against checksums defined in your -recipe to ensure they have not been tampered with or otherwise modified -since the recipe was written. Two checksums are used: -``SRC_URI[md5sum]`` and ``SRC_URI[sha256sum]``. - -If your :term:`SRC_URI` variable points to more than a single URL (excluding -SCM URLs), you need to provide the ``md5`` and ``sha256`` checksums for -each URL. For these cases, you provide a name for each URL as part of -the :term:`SRC_URI` and then reference that name in the subsequent checksum -statements. Here is an example combining lines from the files -``git.inc`` and ``git_2.24.1.bb``:: - - SRC_URI = "${KERNELORG_MIRROR}/software/scm/git/git-${PV}.tar.gz;name=tarball \ - ${KERNELORG_MIRROR}/software/scm/git/git-manpages-${PV}.tar.gz;name=manpages" - - SRC_URI[tarball.md5sum] = "166bde96adbbc11c8843d4f8f4f9811b" - SRC_URI[tarball.sha256sum] = "ad5334956301c86841eb1e5b1bb20884a6bad89a10a6762c958220c7cf64da02" - SRC_URI[manpages.md5sum] = "31c2272a8979022497ba3d4202df145d" - SRC_URI[manpages.sha256sum] = "9a7ae3a093bea39770eb96ca3e5b40bff7af0b9f6123f089d7821d0e5b8e1230" - -Proper values for ``md5`` and ``sha256`` checksums might be available -with other signatures on the download page for the upstream source (e.g. -``md5``, ``sha1``, ``sha256``, ``GPG``, and so forth). Because the -OpenEmbedded build system only deals with ``sha256sum`` and ``md5sum``, -you should verify all the signatures you find by hand. - -If no :term:`SRC_URI` checksums are specified when you attempt to build the -recipe, or you provide an incorrect checksum, the build will produce an -error for each missing or incorrect checksum. As part of the error -message, the build system provides the checksum string corresponding to -the fetched file. Once you have the correct checksums, you can copy and -paste them into your recipe and then run the build again to continue. - -.. note:: - - As mentioned, if the upstream source provides signatures for - verifying the downloaded source code, you should verify those - manually before setting the checksum values in the recipe and - continuing with the build. - -This final example is a bit more complicated and is from the -``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The -example's :term:`SRC_URI` statement identifies multiple files as the source -files for the recipe: a tarball, a patch file, a desktop file, and an -icon. -:: - - SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \ - file://xwc.patch \ - file://rxvt.desktop \ - file://rxvt.png" - -When you specify local files using the ``file://`` URI protocol, the -build system fetches files from the local machine. The path is relative -to the :term:`FILESPATH` variable -and searches specific directories in a certain order: -``${``\ :term:`BP`\ ``}``, -``${``\ :term:`BPN`\ ``}``, and -``files``. The directories are assumed to be subdirectories of the -directory in which the recipe or append file resides. For another -example that specifies these types of files, see the -":ref:`dev-manual/common-tasks:single .c file package (hello world!)`" section. - -The previous example also specifies a patch file. Patch files are files -whose names usually end in ``.patch`` or ``.diff`` but can end with -compressed suffixes such as ``diff.gz`` and ``patch.bz2``, for example. -The build system automatically applies patches as described in the -":ref:`dev-manual/common-tasks:patching code`" section. - -Unpacking Code --------------- - -During the build, the -:ref:`ref-tasks-unpack` task unpacks -the source with ``${``\ :term:`S`\ ``}`` -pointing to where it is unpacked. - -If you are fetching your source files from an upstream source archived -tarball and the tarball's internal structure matches the common -convention of a top-level subdirectory named -``${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, -then you do not need to set :term:`S`. However, if :term:`SRC_URI` specifies to -fetch source from an archive that does not use this convention, or from -an SCM like Git or Subversion, your recipe needs to define :term:`S`. - -If processing your recipe using BitBake successfully unpacks the source -files, you need to be sure that the directory pointed to by ``${S}`` -matches the structure of the source. - -Patching Code -------------- - -Sometimes it is necessary to patch code after it has been fetched. Any -files mentioned in :term:`SRC_URI` whose names end in ``.patch`` or -``.diff`` or compressed versions of these suffixes (e.g. ``diff.gz`` are -treated as patches. The -:ref:`ref-tasks-patch` task -automatically applies these patches. - -The build system should be able to apply patches with the "-p1" option -(i.e. one directory level in the path will be stripped off). If your -patch needs to have more directory levels stripped off, specify the -number of levels using the "striplevel" option in the :term:`SRC_URI` entry -for the patch. Alternatively, if your patch needs to be applied in a -specific subdirectory that is not specified in the patch file, use the -"patchdir" option in the entry. - -As with all local files referenced in -:term:`SRC_URI` using ``file://``, -you should place patch files in a directory next to the recipe either -named the same as the base name of the recipe -(:term:`BP` and -:term:`BPN`) or "files". - -Licensing ---------- - -Your recipe needs to have both the -:term:`LICENSE` and -:term:`LIC_FILES_CHKSUM` -variables: - -- :term:`LICENSE`: This variable specifies the license for the software. - If you do not know the license under which the software you are - building is distributed, you should go to the source code and look - for that information. Typical files containing this information - include ``COPYING``, :term:`LICENSE`, and ``README`` files. You could - also find the information near the top of a source file. For example, - given a piece of software licensed under the GNU General Public - License version 2, you would set :term:`LICENSE` as follows:: - - LICENSE = "GPLv2" - - The licenses you specify within :term:`LICENSE` can have any name as long - as you do not use spaces, since spaces are used as separators between - license names. For standard licenses, use the names of the files in - ``meta/files/common-licenses/`` or the :term:`SPDXLICENSEMAP` flag names - defined in ``meta/conf/licenses.conf``. - -- :term:`LIC_FILES_CHKSUM`: The OpenEmbedded build system uses this - variable to make sure the license text has not changed. If it has, - the build produces an error and it affords you the chance to figure - it out and correct the problem. - - You need to specify all applicable licensing files for the software. - At the end of the configuration step, the build process will compare - the checksums of the files to be sure the text has not changed. Any - differences result in an error with the message containing the - current checksum. For more explanation and examples of how to set the - :term:`LIC_FILES_CHKSUM` variable, see the - ":ref:`dev-manual/common-tasks:tracking license changes`" section. - - To determine the correct checksum string, you can list the - appropriate files in the :term:`LIC_FILES_CHKSUM` variable with incorrect - md5 strings, attempt to build the software, and then note the - resulting error messages that will report the correct md5 strings. - See the ":ref:`dev-manual/common-tasks:fetching code`" section for - additional information. - - Here is an example that assumes the software has a ``COPYING`` file:: - - LIC_FILES_CHKSUM = "file://COPYING;md5=xxx" - - When you try to build the - software, the build system will produce an error and give you the - correct string that you can substitute into the recipe file for a - subsequent build. - -Dependencies ------------- - -Most software packages have a short list of other packages that they -require, which are called dependencies. These dependencies fall into two -main categories: build-time dependencies, which are required when the -software is built; and runtime dependencies, which are required to be -installed on the target in order for the software to run. - -Within a recipe, you specify build-time dependencies using the -:term:`DEPENDS` variable. Although there are nuances, -items specified in :term:`DEPENDS` should be names of other -recipes. It is important that you specify all build-time dependencies -explicitly. - -Another consideration is that configure scripts might automatically -check for optional dependencies and enable corresponding functionality -if those dependencies are found. If you wish to make a recipe that is -more generally useful (e.g. publish the recipe in a layer for others to -use), instead of hard-disabling the functionality, you can use the -:term:`PACKAGECONFIG` variable to allow functionality and the -corresponding dependencies to be enabled and disabled easily by other -users of the recipe. - -Similar to build-time dependencies, you specify runtime dependencies -through a variable - -:term:`RDEPENDS`, which is -package-specific. All variables that are package-specific need to have -the name of the package added to the end as an override. Since the main -package for a recipe has the same name as the recipe, and the recipe's -name can be found through the -``${``\ :term:`PN`\ ``}`` variable, then -you specify the dependencies for the main package by setting -``RDEPENDS:${PN}``. If the package were named ``${PN}-tools``, then you -would set ``RDEPENDS:${PN}-tools``, and so forth. - -Some runtime dependencies will be set automatically at packaging time. -These dependencies include any shared library dependencies (i.e. if a -package "example" contains "libexample" and another package "mypackage" -contains a binary that links to "libexample" then the OpenEmbedded build -system will automatically add a runtime dependency to "mypackage" on -"example"). See the -":ref:`overview-manual/concepts:automatically added runtime dependencies`" -section in the Yocto Project Overview and Concepts Manual for further -details. - -Configuring the Recipe ----------------------- - -Most software provides some means of setting build-time configuration -options before compilation. Typically, setting these options is -accomplished by running a configure script with options, or by modifying -a build configuration file. - -.. note:: - - As of Yocto Project Release 1.7, some of the core recipes that - package binary configuration scripts now disable the scripts due to - the scripts previously requiring error-prone path substitution. The - OpenEmbedded build system uses ``pkg-config`` now, which is much more - robust. You can find a list of the ``*-config`` scripts that are disabled - in the ":ref:`migration-1.7-binary-configuration-scripts-disabled`" section - in the Yocto Project Reference Manual. - -A major part of build-time configuration is about checking for -build-time dependencies and possibly enabling optional functionality as -a result. You need to specify any build-time dependencies for the -software you are building in your recipe's -:term:`DEPENDS` value, in terms of -other recipes that satisfy those dependencies. You can often find -build-time or runtime dependencies described in the software's -documentation. - -The following list provides configuration items of note based on how -your software is built: - -- *Autotools:* If your source files have a ``configure.ac`` file, then - your software is built using Autotools. If this is the case, you just - need to modify the configuration. - - When using Autotools, your recipe needs to inherit the - :ref:`autotools <ref-classes-autotools>` class - and your recipe does not have to contain a - :ref:`ref-tasks-configure` task. - However, you might still want to make some adjustments. For example, - you can set - :term:`EXTRA_OECONF` or - :term:`PACKAGECONFIG_CONFARGS` - to pass any needed configure options that are specific to the recipe. - -- *CMake:* If your source files have a ``CMakeLists.txt`` file, then - your software is built using CMake. If this is the case, you just - need to modify the configuration. - - When you use CMake, your recipe needs to inherit the - :ref:`cmake <ref-classes-cmake>` class and your - recipe does not have to contain a - :ref:`ref-tasks-configure` task. - You can make some adjustments by setting - :term:`EXTRA_OECMAKE` to - pass any needed configure options that are specific to the recipe. - - .. note:: - - If you need to install one or more custom CMake toolchain files - that are supplied by the application you are building, install the - files to ``${D}${datadir}/cmake/Modules`` during ``do_install``. - -- *Other:* If your source files do not have a ``configure.ac`` or - ``CMakeLists.txt`` file, then your software is built using some - method other than Autotools or CMake. If this is the case, you - normally need to provide a - :ref:`ref-tasks-configure` task - in your recipe unless, of course, there is nothing to configure. - - Even if your software is not being built by Autotools or CMake, you - still might not need to deal with any configuration issues. You need - to determine if configuration is even a required step. You might need - to modify a Makefile or some configuration file used for the build to - specify necessary build options. Or, perhaps you might need to run a - provided, custom configure script with the appropriate options. - - For the case involving a custom configure script, you would run - ``./configure --help`` and look for the options you need to set. - -Once configuration succeeds, it is always good practice to look at the -``log.do_configure`` file to ensure that the appropriate options have -been enabled and no additional build-time dependencies need to be added -to :term:`DEPENDS`. For example, if the configure script reports that it -found something not mentioned in :term:`DEPENDS`, or that it did not find -something that it needed for some desired optional functionality, then -you would need to add those to :term:`DEPENDS`. Looking at the log might -also reveal items being checked for, enabled, or both that you do not -want, or items not being found that are in :term:`DEPENDS`, in which case -you would need to look at passing extra options to the configure script -as needed. For reference information on configure options specific to -the software you are building, you can consult the output of the -``./configure --help`` command within ``${S}`` or consult the software's -upstream documentation. - -Using Headers to Interface with Devices ---------------------------------------- - -If your recipe builds an application that needs to communicate with some -device or needs an API into a custom kernel, you will need to provide -appropriate header files. Under no circumstances should you ever modify -the existing -``meta/recipes-kernel/linux-libc-headers/linux-libc-headers.inc`` file. -These headers are used to build ``libc`` and must not be compromised -with custom or machine-specific header information. If you customize -``libc`` through modified headers all other applications that use -``libc`` thus become affected. - -.. note:: - - Never copy and customize the ``libc`` header file (i.e. - ``meta/recipes-kernel/linux-libc-headers/linux-libc-headers.inc``). - -The correct way to interface to a device or custom kernel is to use a -separate package that provides the additional headers for the driver or -other unique interfaces. When doing so, your application also becomes -responsible for creating a dependency on that specific provider. - -Consider the following: - -- Never modify ``linux-libc-headers.inc``. Consider that file to be - part of the ``libc`` system, and not something you use to access the - kernel directly. You should access ``libc`` through specific ``libc`` - calls. - -- Applications that must talk directly to devices should either provide - necessary headers themselves, or establish a dependency on a special - headers package that is specific to that driver. - -For example, suppose you want to modify an existing header that adds I/O -control or network support. If the modifications are used by a small -number programs, providing a unique version of a header is easy and has -little impact. When doing so, bear in mind the guidelines in the -previous list. - -.. note:: - - If for some reason your changes need to modify the behavior of the ``libc``, - and subsequently all other applications on the system, use a ``.bbappend`` - to modify the ``linux-kernel-headers.inc`` file. However, take care to not - make the changes machine specific. - -Consider a case where your kernel is older and you need an older -``libc`` ABI. The headers installed by your recipe should still be a -standard mainline kernel, not your own custom one. - -When you use custom kernel headers you need to get them from -:term:`STAGING_KERNEL_DIR`, -which is the directory with kernel headers that are required to build -out-of-tree modules. Your recipe will also need the following:: - - do_configure[depends] += "virtual/kernel:do_shared_workdir" - -Compilation ------------ - -During a build, the ``do_compile`` task happens after source is fetched, -unpacked, and configured. If the recipe passes through ``do_compile`` -successfully, nothing needs to be done. - -However, if the compile step fails, you need to diagnose the failure. -Here are some common issues that cause failures. - -.. note:: - - For cases where improper paths are detected for configuration files - or for when libraries/headers cannot be found, be sure you are using - the more robust ``pkg-config``. See the note in section - ":ref:`dev-manual/common-tasks:Configuring the Recipe`" for additional information. - -- *Parallel build failures:* These failures manifest themselves as - intermittent errors, or errors reporting that a file or directory - that should be created by some other part of the build process could - not be found. This type of failure can occur even if, upon - inspection, the file or directory does exist after the build has - failed, because that part of the build process happened in the wrong - order. - - To fix the problem, you need to either satisfy the missing dependency - in the Makefile or whatever script produced the Makefile, or (as a - workaround) set :term:`PARALLEL_MAKE` to an empty string:: - - PARALLEL_MAKE = "" - - For information on parallel Makefile issues, see the - ":ref:`dev-manual/common-tasks:debugging parallel make races`" section. - -- *Improper host path usage:* This failure applies to recipes building - for the target or ``nativesdk`` only. The failure occurs when the - compilation process uses improper headers, libraries, or other files - from the host system when cross-compiling for the target. - - To fix the problem, examine the ``log.do_compile`` file to identify - the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and - so forth) and then either add configure options, apply a patch, or do - both. - -- *Failure to find required libraries/headers:* If a build-time - dependency is missing because it has not been declared in - :term:`DEPENDS`, or because the - dependency exists but the path used by the build process to find the - file is incorrect and the configure step did not detect it, the - compilation process could fail. For either of these failures, the - compilation process notes that files could not be found. In these - cases, you need to go back and add additional options to the - configure script as well as possibly add additional build-time - dependencies to :term:`DEPENDS`. - - Occasionally, it is necessary to apply a patch to the source to - ensure the correct paths are used. If you need to specify paths to - find files staged into the sysroot from other recipes, use the - variables that the OpenEmbedded build system provides (e.g. - :term:`STAGING_BINDIR`, :term:`STAGING_INCDIR`, :term:`STAGING_DATADIR`, and so - forth). - -Installing ----------- - -During ``do_install``, the task copies the built files along with their -hierarchy to locations that would mirror their locations on the target -device. The installation process copies files from the -``${``\ :term:`S`\ ``}``, -``${``\ :term:`B`\ ``}``, and -``${``\ :term:`WORKDIR`\ ``}`` -directories to the ``${``\ :term:`D`\ ``}`` -directory to create the structure as it should appear on the target -system. - -How your software is built affects what you must do to be sure your -software is installed correctly. The following list describes what you -must do for installation depending on the type of build system used by -the software being built: - -- *Autotools and CMake:* If the software your recipe is building uses - Autotools or CMake, the OpenEmbedded build system understands how to - install the software. Consequently, you do not have to have a - ``do_install`` task as part of your recipe. You just need to make - sure the install portion of the build completes with no issues. - However, if you wish to install additional files not already being - installed by ``make install``, you should do this using a - ``do_install:append`` function using the install command as described - in the "Manual" bulleted item later in this list. - -- *Other (using* ``make install``\ *)*: You need to define a ``do_install`` - function in your recipe. The function should call - ``oe_runmake install`` and will likely need to pass in the - destination directory as well. How you pass that path is dependent on - how the ``Makefile`` being run is written (e.g. ``DESTDIR=${D}``, - ``PREFIX=${D}``, ``INSTALLROOT=${D}``, and so forth). - - For an example recipe using ``make install``, see the - ":ref:`dev-manual/common-tasks:makefile-based package`" section. - -- *Manual:* You need to define a ``do_install`` function in your - recipe. The function must first use ``install -d`` to create the - directories under - ``${``\ :term:`D`\ ``}``. Once the - directories exist, your function can use ``install`` to manually - install the built software into the directories. - - You can find more information on ``install`` at - https://www.gnu.org/software/coreutils/manual/html_node/install-invocation.html. - -For the scenarios that do not use Autotools or CMake, you need to track -the installation and diagnose and fix any issues until everything -installs correctly. You need to look in the default location of -``${D}``, which is ``${WORKDIR}/image``, to be sure your files have been -installed correctly. - -.. note:: - - - During the installation process, you might need to modify some of - the installed files to suit the target layout. For example, you - might need to replace hard-coded paths in an initscript with - values of variables provided by the build system, such as - replacing ``/usr/bin/`` with ``${bindir}``. If you do perform such - modifications during ``do_install``, be sure to modify the - destination file after copying rather than before copying. - Modifying after copying ensures that the build system can - re-execute ``do_install`` if needed. - - - ``oe_runmake install``, which can be run directly or can be run - indirectly by the - :ref:`autotools <ref-classes-autotools>` and - :ref:`cmake <ref-classes-cmake>` classes, - runs ``make install`` in parallel. Sometimes, a Makefile can have - missing dependencies between targets that can result in race - conditions. If you experience intermittent failures during - ``do_install``, you might be able to work around them by disabling - parallel Makefile installs by adding the following to the recipe:: - - PARALLEL_MAKEINST = "" - - See :term:`PARALLEL_MAKEINST` for additional information. - - - If you need to install one or more custom CMake toolchain files - that are supplied by the application you are building, install the - files to ``${D}${datadir}/cmake/Modules`` during - :ref:`ref-tasks-install`. - -Enabling System Services ------------------------- - -If you want to install a service, which is a process that usually starts -on boot and runs in the background, then you must include some -additional definitions in your recipe. - -If you are adding services and the service initialization script or the -service file itself is not installed, you must provide for that -installation in your recipe using a ``do_install:append`` function. If -your recipe already has a ``do_install`` function, update the function -near its end rather than adding an additional ``do_install:append`` -function. - -When you create the installation for your services, you need to -accomplish what is normally done by ``make install``. In other words, -make sure your installation arranges the output similar to how it is -arranged on the target system. - -The OpenEmbedded build system provides support for starting services two -different ways: - -- *SysVinit:* SysVinit is a system and service manager that manages the - init system used to control the very basic functions of your system. - The init program is the first program started by the Linux kernel - when the system boots. Init then controls the startup, running and - shutdown of all other programs. - - To enable a service using SysVinit, your recipe needs to inherit the - :ref:`update-rc.d <ref-classes-update-rc.d>` - class. The class helps facilitate safely installing the package on - the target. - - You will need to set the - :term:`INITSCRIPT_PACKAGES`, - :term:`INITSCRIPT_NAME`, - and - :term:`INITSCRIPT_PARAMS` - variables within your recipe. - -- *systemd:* System Management Daemon (systemd) was designed to replace - SysVinit and to provide enhanced management of services. For more - information on systemd, see the systemd homepage at - https://freedesktop.org/wiki/Software/systemd/. - - To enable a service using systemd, your recipe needs to inherit the - :ref:`systemd <ref-classes-systemd>` class. See - the ``systemd.bbclass`` file located in your :term:`Source Directory` - section for - more information. - -Packaging ---------- - -Successful packaging is a combination of automated processes performed -by the OpenEmbedded build system and some specific steps you need to -take. The following list describes the process: - -- *Splitting Files*: The ``do_package`` task splits the files produced - by the recipe into logical components. Even software that produces a - single binary might still have debug symbols, documentation, and - other logical components that should be split out. The ``do_package`` - task ensures that files are split up and packaged correctly. - -- *Running QA Checks*: The - :ref:`insane <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. This - step performs a range of checks to be sure the build's output is free - of common problems that show up during runtime. For information on - these checks, see the - :ref:`insane <ref-classes-insane>` class and - the ":ref:`ref-manual/qa-checks:qa error and warning messages`" - chapter in the Yocto Project Reference Manual. - -- *Hand-Checking Your Packages*: After you build your software, you - need to be sure your packages are correct. Examine the - ``${``\ :term:`WORKDIR`\ ``}/packages-split`` - directory and make sure files are where you expect them to be. If you - discover problems, you can set - :term:`PACKAGES`, - :term:`FILES`, - ``do_install(:append)``, and so forth as needed. - -- *Splitting an Application into Multiple Packages*: If you need to - split an application into several packages, see the - ":ref:`dev-manual/common-tasks:splitting an application into multiple packages`" - section for an example. - -- *Installing a Post-Installation Script*: For an example showing how - to install a post-installation script, see the - ":ref:`dev-manual/common-tasks:post-installation scripts`" section. - -- *Marking Package Architecture*: Depending on what your recipe is - building and how it is configured, it might be important to mark the - packages produced as being specific to a particular machine, or to - mark them as not being specific to a particular machine or - architecture at all. - - By default, packages apply to any machine with the same architecture - as the target machine. When a recipe produces packages that are - machine-specific (e.g. the - :term:`MACHINE` value is passed - into the configure script or a patch is applied only for a particular - machine), you should mark them as such by adding the following to the - recipe:: - - PACKAGE_ARCH = "${MACHINE_ARCH}" - - On the other hand, if the recipe produces packages that do not - contain anything specific to the target machine or architecture at - all (e.g. recipes that simply package script files or configuration - files), you should use the - :ref:`allarch <ref-classes-allarch>` class to - do this for you by adding this to your recipe:: - - inherit allarch - - Ensuring that the package architecture is correct is not critical - while you are doing the first few builds of your recipe. However, it - is important in order to ensure that your recipe rebuilds (or does - not rebuild) appropriately in response to changes in configuration, - and to ensure that you get the appropriate packages installed on the - target machine, particularly if you run separate builds for more than - one target machine. - -Sharing Files Between Recipes ------------------------------ - -Recipes often need to use files provided by other recipes on the build -host. For example, an application linking to a common library needs -access to the library itself and its associated headers. The way this -access is accomplished is by populating a sysroot with files. Each -recipe has two sysroots in its work directory, one for target files -(``recipe-sysroot``) and one for files that are native to the build host -(``recipe-sysroot-native``). - -.. note:: - - You could find the term "staging" used within the Yocto project - regarding files populating sysroots (e.g. the :term:`STAGING_DIR` - variable). - -Recipes should never populate the sysroot directly (i.e. write files -into sysroot). Instead, files should be installed into standard -locations during the -:ref:`ref-tasks-install` task within -the ``${``\ :term:`D`\ ``}`` directory. The -reason for this limitation is that almost all files that populate the -sysroot are cataloged in manifests in order to ensure the files can be -removed later when a recipe is either modified or removed. Thus, the -sysroot is able to remain free from stale files. - -A subset of the files installed by the :ref:`ref-tasks-install` task are -used by the :ref:`ref-tasks-populate_sysroot` task as defined by the the -:term:`SYSROOT_DIRS` variable to automatically populate the sysroot. It -is possible to modify the list of directories that populate the sysroot. -The following example shows how you could add the ``/opt`` directory to -the list of directories within a recipe:: - - SYSROOT_DIRS += "/opt" - -.. note:: - - The `/sysroot-only` is to be used by recipes that generate artifacts - that are not included in the target filesystem, allowing them to share - these artifacts without needing to use the :term:`DEPLOY_DIR`. - -For a more complete description of the :ref:`ref-tasks-populate_sysroot` -task and its associated functions, see the -:ref:`staging <ref-classes-staging>` class. - -Using Virtual Providers ------------------------ - -Prior to a build, if you know that several different recipes provide the -same functionality, you can use a virtual provider (i.e. ``virtual/*``) -as a placeholder for the actual provider. The actual provider is -determined at build-time. - -A common scenario where a virtual provider is used would be for the -kernel recipe. Suppose you have three kernel recipes whose -:term:`PN` values map to ``kernel-big``, -``kernel-mid``, and ``kernel-small``. Furthermore, each of these recipes -in some way uses a :term:`PROVIDES` -statement that essentially identifies itself as being able to provide -``virtual/kernel``. Here is one way through the -:ref:`kernel <ref-classes-kernel>` class:: - - PROVIDES += "${@ "virtual/kernel" if (d.getVar("KERNEL_PACKAGE_NAME") == "kernel") else "" }" - -Any recipe that inherits the :ref:`kernel <ref-classes-kernel>` class is -going to utilize a :term:`PROVIDES` statement that identifies that recipe as -being able to provide the ``virtual/kernel`` item. - -Now comes the time to actually build an image and you need a kernel -recipe, but which one? You can configure your build to call out the -kernel recipe you want by using the :term:`PREFERRED_PROVIDER` variable. As -an example, consider the :yocto_git:`x86-base.inc -</poky/tree/meta/conf/machine/include/x86/x86-base.inc>` include file, which is a -machine (i.e. :term:`MACHINE`) configuration file. This include file is the -reason all x86-based machines use the ``linux-yocto`` kernel. Here are the -relevant lines from the include file:: - - PREFERRED_PROVIDER_virtual/kernel ??= "linux-yocto" - PREFERRED_VERSION_linux-yocto ??= "4.15%" - -When you use a virtual provider, you do not have to "hard code" a recipe -name as a build dependency. You can use the -:term:`DEPENDS` variable to state the -build is dependent on ``virtual/kernel`` for example:: - - DEPENDS = "virtual/kernel" - -During the build, the OpenEmbedded build system picks -the correct recipe needed for the ``virtual/kernel`` dependency based on -the :term:`PREFERRED_PROVIDER` variable. If you want to use the small kernel -mentioned at the beginning of this section, configure your build as -follows:: - - PREFERRED_PROVIDER_virtual/kernel ??= "kernel-small" - -.. note:: - - Any recipe that :term:`PROVIDES` a ``virtual/*`` item that is ultimately not - selected through :term:`PREFERRED_PROVIDER` does not get built. Preventing these - recipes from building is usually the desired behavior since this mechanism's - purpose is to select between mutually exclusive alternative providers. - -The following lists specific examples of virtual providers: - -- ``virtual/kernel``: Provides the name of the kernel recipe to use - when building a kernel image. - -- ``virtual/bootloader``: Provides the name of the bootloader to use - when building an image. - -- ``virtual/libgbm``: Provides ``gbm.pc``. - -- ``virtual/egl``: Provides ``egl.pc`` and possibly ``wayland-egl.pc``. - -- ``virtual/libgl``: Provides ``gl.pc`` (i.e. libGL). - -- ``virtual/libgles1``: Provides ``glesv1_cm.pc`` (i.e. libGLESv1_CM). - -- ``virtual/libgles2``: Provides ``glesv2.pc`` (i.e. libGLESv2). - -.. note:: - - Virtual providers only apply to build time dependencies specified with - :term:`PROVIDES` and :term:`DEPENDS`. They do not apply to runtime - dependencies specified with :term:`RPROVIDES` and :term:`RDEPENDS`. - -Properly Versioning Pre-Release Recipes ---------------------------------------- - -Sometimes the name of a recipe can lead to versioning problems when the -recipe is upgraded to a final release. For example, consider the -``irssi_0.8.16-rc1.bb`` recipe file in the list of example recipes in -the ":ref:`dev-manual/common-tasks:storing and naming the recipe`" section. -This recipe is at a release candidate stage (i.e. "rc1"). When the recipe is -released, the recipe filename becomes ``irssi_0.8.16.bb``. The version -change from ``0.8.16-rc1`` to ``0.8.16`` is seen as a decrease by the -build system and package managers, so the resulting packages will not -correctly trigger an upgrade. - -In order to ensure the versions compare properly, the recommended -convention is to set :term:`PV` within the -recipe to "previous_version+current_version". You can use an additional -variable so that you can use the current version elsewhere. Here is an -example:: - - REALPV = "0.8.16-rc1" - PV = "0.8.15+${REALPV}" - -Post-Installation Scripts -------------------------- - -Post-installation scripts run immediately after installing a package on -the target or during image creation when a package is included in an -image. To add a post-installation script to a package, add a -``pkg_postinst:``\ `PACKAGENAME`\ ``()`` function to the recipe file -(``.bb``) and replace `PACKAGENAME` with the name of the package you want -to attach to the ``postinst`` script. To apply the post-installation -script to the main package for the recipe, which is usually what is -required, specify -``${``\ :term:`PN`\ ``}`` in place of -PACKAGENAME. - -A post-installation function has the following structure:: - - pkg_postinst:PACKAGENAME() { - # Commands to carry out - } - -The script defined in the post-installation function is called when the -root filesystem is created. If the script succeeds, the package is -marked as installed. - -.. note:: - - Any RPM post-installation script that runs on the target should - return a 0 exit code. RPM does not allow non-zero exit codes for - these scripts, and the RPM package manager will cause the package to - fail installation on the target. - -Sometimes it is necessary for the execution of a post-installation -script to be delayed until the first boot. For example, the script might -need to be executed on the device itself. To delay script execution -until boot time, you must explicitly mark post installs to defer to the -target. You can use ``pkg_postinst_ontarget()`` or call -``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. Any -failure of a ``pkg_postinst()`` script (including exit 1) triggers an -error during the -:ref:`ref-tasks-rootfs` task. - -If you have recipes that use ``pkg_postinst`` function and they require -the use of non-standard native tools that have dependencies during -root filesystem construction, you need to use the -:term:`PACKAGE_WRITE_DEPS` -variable in your recipe to list these tools. If you do not use this -variable, the tools might be missing and execution of the -post-installation script is deferred until first boot. Deferring the -script to the first boot is undesirable and impossible for read-only -root filesystems. - -.. note:: - - There is equivalent support for pre-install, pre-uninstall, and post-uninstall - scripts by way of ``pkg_preinst``, ``pkg_prerm``, and ``pkg_postrm``, - respectively. These scrips work in exactly the same way as does - ``pkg_postinst`` with the exception that they run at different times. Also, - because of when they run, they are not applicable to being run at image - creation time like ``pkg_postinst``. - -Testing -------- - -The final step for completing your recipe is to be sure that the -software you built runs correctly. To accomplish runtime testing, add -the build's output packages to your image and test them on the target. - -For information on how to customize your image by adding specific -packages, see ":ref:`dev-manual/common-tasks:customizing images`" section. - -Examples --------- - -To help summarize how to write a recipe, this section provides some -examples given various scenarios: - -- Recipes that use local files - -- Using an Autotooled package - -- Using a Makefile-based package - -- Splitting an application into multiple packages - -- Adding binaries to an image - -Single .c File Package (Hello World!) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Building an application from a single file that is stored locally (e.g. -under ``files``) requires a recipe that has the file listed in the -:term:`SRC_URI` variable. Additionally, you need to manually write the -``do_compile`` and ``do_install`` tasks. The :term:`S` variable defines the -directory containing the source code, which is set to -:term:`WORKDIR` in this case - the -directory BitBake uses for the build. -:: - - SUMMARY = "Simple helloworld application" - SECTION = "examples" - LICENSE = "MIT" - LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302" - - SRC_URI = "file://helloworld.c" - - S = "${WORKDIR}" - - do_compile() { - ${CC} ${LDFLAGS} helloworld.c -o helloworld - } - - do_install() { - install -d ${D}${bindir} - install -m 0755 helloworld ${D}${bindir} - } - -By default, the ``helloworld``, ``helloworld-dbg``, and -``helloworld-dev`` packages are built. For information on how to -customize the packaging process, see the -":ref:`dev-manual/common-tasks:splitting an application into multiple packages`" -section. - -Autotooled Package -~~~~~~~~~~~~~~~~~~ - -Applications that use Autotools such as ``autoconf`` and ``automake`` -require a recipe that has a source archive listed in :term:`SRC_URI` and -also inherit the -:ref:`autotools <ref-classes-autotools>` class, -which contains the definitions of all the steps needed to build an -Autotool-based application. The result of the build is automatically -packaged. And, if the application uses NLS for localization, packages -with local information are generated (one package per language). -Following is one example: (``hello_2.3.bb``) -:: - - SUMMARY = "GNU Helloworld application" - SECTION = "examples" - LICENSE = "GPLv2+" - LIC_FILES_CHKSUM = "file://COPYING;md5=751419260aa954499f7abaabaa882bbe" - - SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz" - - inherit autotools gettext - -The variable :term:`LIC_FILES_CHKSUM` is used to track source license -changes as described in the -":ref:`dev-manual/common-tasks:tracking license changes`" section in -the Yocto Project Overview and Concepts Manual. You can quickly create -Autotool-based recipes in a manner similar to the previous example. - -Makefile-Based Package -~~~~~~~~~~~~~~~~~~~~~~ - -Applications that use GNU ``make`` also require a recipe that has the -source archive listed in :term:`SRC_URI`. You do not need to add a -``do_compile`` step since by default BitBake starts the ``make`` command -to compile the application. If you need additional ``make`` options, you -should store them in the -:term:`EXTRA_OEMAKE` or -:term:`PACKAGECONFIG_CONFARGS` -variables. BitBake passes these options into the GNU ``make`` -invocation. Note that a ``do_install`` task is still required. -Otherwise, BitBake runs an empty ``do_install`` task by default. - -Some applications might require extra parameters to be passed to the -compiler. For example, the application might need an additional header -path. You can accomplish this by adding to the :term:`CFLAGS` variable. The -following example shows this:: - - CFLAGS:prepend = "-I ${S}/include " - -In the following example, ``mtd-utils`` is a makefile-based package:: - - SUMMARY = "Tools for managing memory technology devices" - SECTION = "base" - DEPENDS = "zlib lzo e2fsprogs util-linux" - HOMEPAGE = "http://www.linux-mtd.infradead.org/" - LICENSE = "GPLv2+" - LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \ - file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c" - - # Use the latest version at 26 Oct, 2013 - SRCREV = "9f107132a6a073cce37434ca9cda6917dd8d866b" - SRC_URI = "git://git.infradead.org/mtd-utils.git \ - file://add-exclusion-to-mkfs-jffs2-git-2.patch \ - " - - PV = "1.5.1+git${SRCPV}" - - S = "${WORKDIR}/git" - - EXTRA_OEMAKE = "'CC=${CC}' 'RANLIB=${RANLIB}' 'AR=${AR}' 'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' 'BUILDDIR=${S}'" - - do_install () { - oe_runmake install DESTDIR=${D} SBINDIR=${sbindir} MANDIR=${mandir} INCLUDEDIR=${includedir} - } - - PACKAGES =+ "mtd-utils-jffs2 mtd-utils-ubifs mtd-utils-misc" - - FILES:mtd-utils-jffs2 = "${sbindir}/mkfs.jffs2 ${sbindir}/jffs2dump ${sbindir}/jffs2reader ${sbindir}/sumtool" - FILES:mtd-utils-ubifs = "${sbindir}/mkfs.ubifs ${sbindir}/ubi*" - FILES:mtd-utils-misc = "${sbindir}/nftl* ${sbindir}/ftl* ${sbindir}/rfd* ${sbindir}/doc* ${sbindir}/serve_image ${sbindir}/recv_image" - - PARALLEL_MAKE = "" - - BBCLASSEXTEND = "native" - -Splitting an Application into Multiple Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can use the variables :term:`PACKAGES` and :term:`FILES` to split an -application into multiple packages. - -Following is an example that uses the ``libxpm`` recipe. By default, -this recipe generates a single package that contains the library along -with a few binaries. You can modify the recipe to split the binaries -into separate packages:: - - require xorg-lib-common.inc - - SUMMARY = "Xpm: X Pixmap extension library" - LICENSE = "MIT" - LIC_FILES_CHKSUM = "file://COPYING;md5=51f4270b012ecd4ab1a164f5f4ed6cf7" - DEPENDS += "libxext libsm libxt" - PE = "1" - - XORG_PN = "libXpm" - - PACKAGES =+ "sxpm cxpm" - FILES:cxpm = "${bindir}/cxpm" - FILES:sxpm = "${bindir}/sxpm" - -In the previous example, we want to ship the ``sxpm`` and ``cxpm`` -binaries in separate packages. Since ``bindir`` would be packaged into -the main :term:`PN` package by default, we prepend the :term:`PACKAGES` variable -so additional package names are added to the start of list. This results -in the extra ``FILES:*`` variables then containing information that -define which files and directories go into which packages. Files -included by earlier packages are skipped by latter packages. Thus, the -main :term:`PN` package does not include the above listed files. - -Packaging Externally Produced Binaries -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sometimes, you need to add pre-compiled binaries to an image. For -example, suppose that there are binaries for proprietary code, -created by a particular division of a company. Your part of the company -needs to use those binaries as part of an image that you are building -using the OpenEmbedded build system. Since you only have the binaries -and not the source code, you cannot use a typical recipe that expects to -fetch the source specified in -:term:`SRC_URI` and then compile it. - -One method is to package the binaries and then install them as part of -the image. Generally, it is not a good idea to package binaries since, -among other things, it can hinder the ability to reproduce builds and -could lead to compatibility problems with ABI in the future. However, -sometimes you have no choice. - -The easiest solution is to create a recipe that uses the -:ref:`bin_package <ref-classes-bin-package>` class -and to be sure that you are using default locations for build artifacts. -In most cases, the :ref:`bin_package <ref-classes-bin-package>` class handles "skipping" the -configure and compile steps as well as sets things up to grab packages -from the appropriate area. In particular, this class sets ``noexec`` on -both the :ref:`ref-tasks-configure` -and :ref:`ref-tasks-compile` tasks, -sets ``FILES:${PN}`` to "/" so that it picks up all files, and sets up a -:ref:`ref-tasks-install` task, which -effectively copies all files from ``${S}`` to ``${D}``. The -:ref:`bin_package <ref-classes-bin-package>` class works well when the files extracted into ``${S}`` -are already laid out in the way they should be laid out on the target. -For more information on these variables, see the -:term:`FILES`, -:term:`PN`, -:term:`S`, and -:term:`D` variables in the Yocto Project -Reference Manual's variable glossary. - -.. note:: - - - Using :term:`DEPENDS` is a good - idea even for components distributed in binary form, and is often - necessary for shared libraries. For a shared library, listing the - library dependencies in :term:`DEPENDS` makes sure that the libraries - are available in the staging sysroot when other recipes link - against the library, which might be necessary for successful - linking. - - - Using :term:`DEPENDS` also allows runtime dependencies between - packages to be added automatically. See the - ":ref:`overview-manual/concepts:automatically added runtime dependencies`" - section in the Yocto Project Overview and Concepts Manual for more - information. - -If you cannot use the :ref:`bin_package <ref-classes-bin-package>` class, you need to be sure you are -doing the following: - -- Create a recipe where the - :ref:`ref-tasks-configure` and - :ref:`ref-tasks-compile` tasks do - nothing: It is usually sufficient to just not define these tasks in - the recipe, because the default implementations do nothing unless a - Makefile is found in - ``${``\ :term:`S`\ ``}``. - - If ``${S}`` might contain a Makefile, or if you inherit some class - that replaces ``do_configure`` and ``do_compile`` with custom - versions, then you can use the - ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` - flag to turn the tasks into no-ops, as follows:: - - do_configure[noexec] = "1" - do_compile[noexec] = "1" - - Unlike - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`, - using the flag preserves the dependency chain from the - :ref:`ref-tasks-fetch`, - :ref:`ref-tasks-unpack`, and - :ref:`ref-tasks-patch` tasks to the - :ref:`ref-tasks-install` task. - -- Make sure your ``do_install`` task installs the binaries - appropriately. - -- Ensure that you set up :term:`FILES` - (usually - ``FILES:${``\ :term:`PN`\ ``}``) to - point to the files you have installed, which of course depends on - where you have installed them and whether those files are in - different locations than the defaults. - -.. note:: - - If image prelinking is enabled (e.g. :ref:`image-prelink <ref-classes-image-prelink>` is in :term:`USER_CLASSES` - which it is by default), prelink will change the binaries in the generated images - and this often catches people out. Remove that class to ensure binaries are - preserved exactly if that is necessary. - -Following Recipe Style Guidelines ---------------------------------- - -When writing recipes, it is good to conform to existing style -guidelines. The :oe_wiki:`OpenEmbedded Styleguide </Styleguide>` wiki page -provides rough guidelines for preferred recipe style. - -It is common for existing recipes to deviate a bit from this style. -However, aiming for at least a consistent style is a good idea. Some -practices, such as omitting spaces around ``=`` operators in assignments -or ordering recipe components in an erratic way, are widely seen as poor -style. - -Recipe Syntax -------------- - -Understanding recipe file syntax is important for writing recipes. The -following list overviews the basic items that make up a BitBake recipe -file. For more complete BitBake syntax descriptions, see the -":doc:`bitbake-user-manual/bitbake-user-manual-metadata`" -chapter of the BitBake User Manual. - -- *Variable Assignments and Manipulations:* Variable assignments allow - a value to be assigned to a variable. The assignment can be static - text or might include the contents of other variables. In addition to - the assignment, appending and prepending operations are also - supported. - - The following example shows some of the ways you can use variables in - recipes:: - - S = "${WORKDIR}/postfix-${PV}" - CFLAGS += "-DNO_ASM" - SRC_URI:append = " file://fixup.patch" - -- *Functions:* Functions provide a series of actions to be performed. - You usually use functions to override the default implementation of a - task function or to complement a default function (i.e. append or - prepend to an existing function). Standard functions use ``sh`` shell - syntax, although access to OpenEmbedded variables and internal - methods are also available. - - Here is an example function from the ``sed`` recipe:: - - do_install () { - autotools_do_install - install -d ${D}${base_bindir} - mv ${D}${bindir}/sed ${D}${base_bindir}/sed - rmdir ${D}${bindir}/ - } - - It is - also possible to implement new functions that are called between - existing tasks as long as the new functions are not replacing or - complementing the default functions. You can implement functions in - Python instead of shell. Both of these options are not seen in the - majority of recipes. - -- *Keywords:* BitBake recipes use only a few keywords. You use keywords - to include common functions (``inherit``), load parts of a recipe - from other files (``include`` and ``require``) and export variables - to the environment (``export``). - - The following example shows the use of some of these keywords:: - - export POSTCONF = "${STAGING_BINDIR}/postconf" - inherit autoconf - require otherfile.inc - -- *Comments (#):* Any lines that begin with the hash character (``#``) - are treated as comment lines and are ignored:: - - # This is a comment - -This next list summarizes the most important and most commonly used -parts of the recipe syntax. For more information on these parts of the -syntax, you can reference the -:doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata` chapter -in the BitBake User Manual. - -- *Line Continuation (\\):* Use the backward slash (``\``) character to - split a statement over multiple lines. Place the slash character at - the end of the line that is to be continued on the next line:: - - VAR = "A really long \ - line" - - .. note:: - - You cannot have any characters including spaces or tabs after the - slash character. - -- *Using Variables (${VARNAME}):* Use the ``${VARNAME}`` syntax to - access the contents of a variable:: - - SRC_URI = "${SOURCEFORGE_MIRROR}/libpng/zlib-${PV}.tar.gz" - - .. note:: - - It is important to understand that the value of a variable - expressed in this form does not get substituted automatically. The - expansion of these expressions happens on-demand later (e.g. - usually when a function that makes reference to the variable - executes). This behavior ensures that the values are most - appropriate for the context in which they are finally used. On the - rare occasion that you do need the variable expression to be - expanded immediately, you can use the - := - operator instead of - = - when you make the assignment, but this is not generally needed. - -- *Quote All Assignments ("value"):* Use double quotes around values in - all variable assignments (e.g. ``"value"``). Following is an example:: - - VAR1 = "${OTHERVAR}" - VAR2 = "The version is ${PV}" - -- *Conditional Assignment (?=):* Conditional assignment is used to - assign a value to a variable, but only when the variable is currently - unset. Use the question mark followed by the equal sign (``?=``) to - make a "soft" assignment used for conditional assignment. Typically, - "soft" assignments are used in the ``local.conf`` file for variables - that are allowed to come through from the external environment. - - Here is an example where ``VAR1`` is set to "New value" if it is - currently empty. However, if ``VAR1`` has already been set, it - remains unchanged:: - - VAR1 ?= "New value" - - In this next example, ``VAR1`` is left with the value "Original value":: - - VAR1 = "Original value" - VAR1 ?= "New value" - -- *Appending (+=):* Use the plus character followed by the equals sign - (``+=``) to append values to existing variables. - - .. note:: - - This operator adds a space between the existing content of the - variable and the new content. - - Here is an example:: - - SRC_URI += "file://fix-makefile.patch" - -- *Prepending (=+):* Use the equals sign followed by the plus character - (``=+``) to prepend values to existing variables. - - .. note:: - - This operator adds a space between the new content and the - existing content of the variable. - - Here is an example:: - - VAR =+ "Starts" - -- *Appending (:append):* Use the ``:append`` operator to append values - to existing variables. This operator does not add any additional - space. Also, the operator is applied after all the ``+=``, and ``=+`` - operators have been applied and after all ``=`` assignments have - occurred. - - The following example shows the space being explicitly added to the - start to ensure the appended value is not merged with the existing - value:: - - SRC_URI:append = " file://fix-makefile.patch" - - You can also use - the ``:append`` operator with overrides, which results in the actions - only being performed for the specified target or machine:: - - SRC_URI:append:sh4 = " file://fix-makefile.patch" - -- *Prepending (:prepend):* Use the ``:prepend`` operator to prepend - values to existing variables. This operator does not add any - additional space. Also, the operator is applied after all the ``+=``, - and ``=+`` operators have been applied and after all ``=`` - assignments have occurred. - - The following example shows the space being explicitly added to the - end to ensure the prepended value is not merged with the existing - value:: - - CFLAGS:prepend = "-I${S}/myincludes " - - You can also use the - ``:prepend`` operator with overrides, which results in the actions - only being performed for the specified target or machine:: - - CFLAGS:prepend:sh4 = "-I${S}/myincludes " - -- *Overrides:* You can use overrides to set a value conditionally, - typically based on how the recipe is being built. For example, to set - the :term:`KBRANCH` variable's - value to "standard/base" for any target - :term:`MACHINE`, except for - qemuarm where it should be set to "standard/arm-versatile-926ejs", - you would do the following:: - - KBRANCH = "standard/base" - KBRANCH:qemuarm = "standard/arm-versatile-926ejs" - - Overrides are also used to separate - alternate values of a variable in other situations. For example, when - setting variables such as - :term:`FILES` and - :term:`RDEPENDS` that are - specific to individual packages produced by a recipe, you should - always use an override that specifies the name of the package. - -- *Indentation:* Use spaces for indentation rather than tabs. For - shell functions, both currently work. However, it is a policy - decision of the Yocto Project to use tabs in shell functions. Realize - that some layers have a policy to use spaces for all indentation. - -- *Using Python for Complex Operations:* For more advanced processing, - it is possible to use Python code during variable assignments (e.g. - search and replacement on a variable). - - You indicate Python code using the ``${@python_code}`` syntax for the - variable assignment:: - - SRC_URI = "ftp://ftp.info-zip.org/pub/infozip/src/zip${@d.getVar('PV',1).replace('.', '')}.tgz - -- *Shell Function Syntax:* Write shell functions as if you were writing - a shell script when you describe a list of actions to take. You - should ensure that your script works with a generic ``sh`` and that - it does not require any ``bash`` or other shell-specific - functionality. The same considerations apply to various system - utilities (e.g. ``sed``, ``grep``, ``awk``, and so forth) that you - might wish to use. If in doubt, you should check with multiple - implementations - including those from BusyBox. - -Adding a New Machine -==================== - -Adding a new machine to the Yocto Project is a straightforward process. -This section describes how to add machines that are similar to those -that the Yocto Project already supports. - -.. note:: - - Although well within the capabilities of the Yocto Project, adding a - totally new architecture might require changes to ``gcc``/``glibc`` - and to the site information, which is beyond the scope of this - manual. - -For a complete example that shows how to add a new machine, see the -":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" -section in the Yocto Project Board Support Package (BSP) Developer's -Guide. - -Adding the Machine Configuration File -------------------------------------- - -To add a new machine, you need to add a new machine configuration file -to the layer's ``conf/machine`` directory. This configuration file -provides details about the device you are adding. - -The OpenEmbedded build system uses the root name of the machine -configuration file to reference the new machine. For example, given a -machine configuration file named ``crownbay.conf``, the build system -recognizes the machine as "crownbay". - -The most important variables you must set in your machine configuration -file or include from a lower-level configuration file are as follows: - -- :term:`TARGET_ARCH` (e.g. "arm") - -- ``PREFERRED_PROVIDER_virtual/kernel`` - -- :term:`MACHINE_FEATURES` (e.g. "apm screen wifi") - -You might also need these variables: - -- :term:`SERIAL_CONSOLES` (e.g. "115200;ttyS0 115200;ttyS1") - -- :term:`KERNEL_IMAGETYPE` (e.g. "zImage") - -- :term:`IMAGE_FSTYPES` (e.g. "tar.gz jffs2") - -You can find full details on these variables in the reference section. -You can leverage existing machine ``.conf`` files from -``meta-yocto-bsp/conf/machine/``. - -Adding a Kernel for the Machine -------------------------------- - -The OpenEmbedded build system needs to be able to build a kernel for the -machine. You need to either create a new kernel recipe for this machine, -or extend an existing kernel recipe. You can find several kernel recipe -examples in the Source Directory at ``meta/recipes-kernel/linux`` that -you can use as references. - -If you are creating a new kernel recipe, normal recipe-writing rules -apply for setting up a :term:`SRC_URI`. Thus, you need to specify any -necessary patches and set :term:`S` to point at the source code. You need to -create a ``do_configure`` task that configures the unpacked kernel with -a ``defconfig`` file. You can do this by using a ``make defconfig`` -command or, more commonly, by copying in a suitable ``defconfig`` file -and then running ``make oldconfig``. By making use of ``inherit kernel`` -and potentially some of the ``linux-*.inc`` files, most other -functionality is centralized and the defaults of the class normally work -well. - -If you are extending an existing kernel recipe, it is usually a matter -of adding a suitable ``defconfig`` file. The file needs to be added into -a location similar to ``defconfig`` files used for other machines in a -given kernel recipe. A possible way to do this is by listing the file in -the :term:`SRC_URI` and adding the machine to the expression in -:term:`COMPATIBLE_MACHINE`:: - - COMPATIBLE_MACHINE = '(qemux86|qemumips)' - -For more information on ``defconfig`` files, see the -":ref:`kernel-dev/common:changing the configuration`" -section in the Yocto Project Linux Kernel Development Manual. - -Adding a Formfactor Configuration File --------------------------------------- - -A formfactor configuration file provides information about the target -hardware for which the image is being built and information that the -build system cannot obtain from other sources such as the kernel. Some -examples of information contained in a formfactor configuration file -include framebuffer orientation, whether or not the system has a -keyboard, the positioning of the keyboard in relation to the screen, and -the screen resolution. - -The build system uses reasonable defaults in most cases. However, if -customization is necessary, you need to create a ``machconfig`` file in -the ``meta/recipes-bsp/formfactor/files`` directory. This directory -contains directories for specific machines such as ``qemuarm`` and -``qemux86``. For information about the settings available and the -defaults, see the ``meta/recipes-bsp/formfactor/files/config`` file -found in the same area. - -Following is an example for "qemuarm" machine:: - - HAVE_TOUCHSCREEN=1 - HAVE_KEYBOARD=1 - DISPLAY_CAN_ROTATE=0 - DISPLAY_ORIENTATION=0 - #DISPLAY_WIDTH_PIXELS=640 - #DISPLAY_HEIGHT_PIXELS=480 - #DISPLAY_BPP=16 - DISPLAY_DPI=150 - DISPLAY_SUBPIXEL_ORDER=vrgb - -Upgrading Recipes -================= - -Over time, upstream developers publish new versions for software built -by layer recipes. It is recommended to keep recipes up-to-date with -upstream version releases. - -While there are several methods to upgrade a recipe, you might -consider checking on the upgrade status of a recipe first. You can do so -using the ``devtool check-upgrade-status`` command. See the -":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" -section in the Yocto Project Reference Manual for more information. - -The remainder of this section describes three ways you can upgrade a -recipe. You can use the Automated Upgrade Helper (AUH) to set up -automatic version upgrades. Alternatively, you can use -``devtool upgrade`` to set up semi-automatic version upgrades. Finally, -you can manually upgrade a recipe by editing the recipe itself. - -Using the Auto Upgrade Helper (AUH) ------------------------------------ - -The AUH utility works in conjunction with the OpenEmbedded build system -in order to automatically generate upgrades for recipes based on new -versions being published upstream. Use AUH when you want to create a -service that performs the upgrades automatically and optionally sends -you an email with the results. - -AUH allows you to update several recipes with a single use. You can also -optionally perform build and integration tests using images with the -results saved to your hard drive and emails of results optionally sent -to recipe maintainers. Finally, AUH creates Git commits with appropriate -commit messages in the layer's tree for the changes made to recipes. - -.. note:: - - In some conditions, you should not use AUH to upgrade recipes - and should instead use either ``devtool upgrade`` or upgrade your - recipes manually: - - - When AUH cannot complete the upgrade sequence. This situation - usually results because custom patches carried by the recipe - cannot be automatically rebased to the new version. In this case, - ``devtool upgrade`` allows you to manually resolve conflicts. - - - When for any reason you want fuller control over the upgrade - process. For example, when you want special arrangements for - testing. - -The following steps describe how to set up the AUH utility: - -1. *Be Sure the Development Host is Set Up:* You need to be sure that - your development host is set up to use the Yocto Project. For - information on how to set up your host, see the - ":ref:`dev-manual/start:Preparing the Build Host`" section. - -2. *Make Sure Git is Configured:* The AUH utility requires Git to be - configured because AUH uses Git to save upgrades. Thus, you must have - Git user and email configured. The following command shows your - configurations:: - - $ git config --list - - If you do not have the user and - email configured, you can use the following commands to do so:: - - $ git config --global user.name some_name - $ git config --global user.email username@domain.com - -3. *Clone the AUH Repository:* To use AUH, you must clone the repository - onto your development host. The following command uses Git to create - a local copy of the repository on your system:: - - $ git clone git://git.yoctoproject.org/auto-upgrade-helper - Cloning into 'auto-upgrade-helper'... remote: Counting objects: 768, done. - remote: Compressing objects: 100% (300/300), done. - remote: Total 768 (delta 499), reused 703 (delta 434) - Receiving objects: 100% (768/768), 191.47 KiB | 98.00 KiB/s, done. - Resolving deltas: 100% (499/499), done. - Checking connectivity... done. - - AUH is not part of the :term:`OpenEmbedded-Core (OE-Core)` or - :term:`Poky` repositories. - -4. *Create a Dedicated Build Directory:* Run the - :ref:`structure-core-script` - script to create a fresh build directory that you use exclusively for - running the AUH utility:: - - $ cd poky - $ source oe-init-build-env your_AUH_build_directory - - Re-using an existing build directory and its configurations is not - recommended as existing settings could cause AUH to fail or behave - undesirably. - -5. *Make Configurations in Your Local Configuration File:* Several - settings are needed in the ``local.conf`` file in the build - directory you just created for AUH. Make these following - configurations: - - - If you want to enable :ref:`Build - History <dev-manual/common-tasks:maintaining build output quality>`, - which is optional, you need the following lines in the - ``conf/local.conf`` file:: - - INHERIT =+ "buildhistory" - BUILDHISTORY_COMMIT = "1" - - With this configuration and a successful - upgrade, a build history "diff" file appears in the - ``upgrade-helper/work/recipe/buildhistory-diff.txt`` file found in - your build directory. - - - If you want to enable testing through the - :ref:`testimage <ref-classes-testimage*>` - class, which is optional, you need to have the following set in - your ``conf/local.conf`` file:: - - INHERIT += "testimage" - - .. note:: - - If your distro does not enable by default ptest, which Poky - does, you need the following in your ``local.conf`` file:: - - DISTRO_FEATURES:append = " ptest" - - -6. *Optionally Start a vncserver:* If you are running in a server - without an X11 session, you need to start a vncserver:: - - $ vncserver :1 - $ export DISPLAY=:1 - -7. *Create and Edit an AUH Configuration File:* You need to have the - ``upgrade-helper/upgrade-helper.conf`` configuration file in your - build directory. You can find a sample configuration file in the - :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`. - - Read through the sample file and make configurations as needed. For - example, if you enabled build history in your ``local.conf`` as - described earlier, you must enable it in ``upgrade-helper.conf``. - - Also, if you are using the default ``maintainers.inc`` file supplied - with Poky and located in ``meta-yocto`` and you do not set a - "maintainers_whitelist" or "global_maintainer_override" in the - ``upgrade-helper.conf`` configuration, and you specify "-e all" on - the AUH command-line, the utility automatically sends out emails to - all the default maintainers. Please avoid this. - -This next set of examples describes how to use the AUH: - -- *Upgrading a Specific Recipe:* To upgrade a specific recipe, use the - following form:: - - $ upgrade-helper.py recipe_name - - For example, this command upgrades the ``xmodmap`` recipe:: - - $ upgrade-helper.py xmodmap - -- *Upgrading a Specific Recipe to a Particular Version:* To upgrade a - specific recipe to a particular version, use the following form:: - - $ upgrade-helper.py recipe_name -t version - - For example, this command upgrades the ``xmodmap`` recipe to version 1.2.3:: - - $ upgrade-helper.py xmodmap -t 1.2.3 - -- *Upgrading all Recipes to the Latest Versions and Suppressing Email - Notifications:* To upgrade all recipes to their most recent versions - and suppress the email notifications, use the following command:: - - $ upgrade-helper.py all - -- *Upgrading all Recipes to the Latest Versions and Send Email - Notifications:* To upgrade all recipes to their most recent versions - and send email messages to maintainers for each attempted recipe as - well as a status email, use the following command:: - - $ upgrade-helper.py -e all - -Once you have run the AUH utility, you can find the results in the AUH -build directory:: - - ${BUILDDIR}/upgrade-helper/timestamp - -The AUH utility -also creates recipe update commits from successful upgrade attempts in -the layer tree. - -You can easily set up to run the AUH utility on a regular basis by using -a cron job. See the -:yocto_git:`weeklyjob.sh </auto-upgrade-helper/tree/weeklyjob.sh>` -file distributed with the utility for an example. - -Using ``devtool upgrade`` -------------------------- - -As mentioned earlier, an alternative method for upgrading recipes to -newer versions is to use -:doc:`devtool upgrade </ref-manual/devtool-reference>`. -You can read about ``devtool upgrade`` in general 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. - -To see all the command-line options available with ``devtool upgrade``, -use the following help command:: - - $ devtool upgrade -h - -If you want to find out what version a recipe is currently at upstream -without any attempt to upgrade your local version of the recipe, you can -use the following command:: - - $ devtool latest-version recipe_name - -As mentioned in the previous section describing AUH, ``devtool upgrade`` -works in a less-automated manner than AUH. Specifically, -``devtool upgrade`` only works on a single recipe that you name on the -command line, cannot perform build and integration testing using images, -and does not automatically generate commits for changes in the source -tree. Despite all these "limitations", ``devtool upgrade`` updates the -recipe file to the new upstream version and attempts to rebase custom -patches contained by the recipe as needed. - -.. note:: - - AUH uses much of ``devtool upgrade`` behind the scenes making AUH somewhat - of a "wrapper" application for ``devtool upgrade``. - -A typical scenario involves having used Git to clone an upstream -repository that you use during build operations. Because you have built the -recipe in the past, the layer is likely added to your -configuration already. If for some reason, the layer is not added, you -could add it easily using the -":ref:`bitbake-layers <bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script>`" -script. For example, suppose you use the ``nano.bb`` recipe from the -``meta-oe`` layer in the ``meta-openembedded`` repository. For this -example, assume that the layer has been cloned into following area:: - - /home/scottrif/meta-openembedded - -The following command from your -:term:`Build Directory` adds the layer to -your build configuration (i.e. ``${BUILDDIR}/conf/bblayers.conf``):: - - $ bitbake-layers add-layer /home/scottrif/meta-openembedded/meta-oe - NOTE: Starting bitbake server... - Parsing recipes: 100% |##########################################| Time: 0:00:55 - Parsing of 1431 .bb files complete (0 cached, 1431 parsed). 2040 targets, 56 skipped, 0 masked, 0 errors. - Removing 12 recipes from the x86_64 sysroot: 100% |##############| Time: 0:00:00 - Removing 1 recipes from the x86_64_i586 sysroot: 100% |##########| Time: 0:00:00 - Removing 5 recipes from the i586 sysroot: 100% |#################| Time: 0:00:00 - Removing 5 recipes from the qemux86 sysroot: 100% |##############| Time: 0:00:00 - -For this example, assume that the ``nano.bb`` recipe that -is upstream has a 2.9.3 version number. However, the version in the -local repository is 2.7.4. The following command from your build -directory automatically upgrades the recipe for you: - -.. note:: - - Using the ``-V`` option is not necessary. Omitting the version number causes - ``devtool upgrade`` to upgrade the recipe to the most recent version. - -:: - - $ devtool upgrade nano -V 2.9.3 - NOTE: Starting bitbake server... - NOTE: Creating workspace layer in /home/scottrif/poky/build/workspace - Parsing recipes: 100% |##########################################| Time: 0:00:46 - Parsing of 1431 .bb files complete (0 cached, 1431 parsed). 2040 targets, 56 skipped, 0 masked, 0 errors. - NOTE: Extracting current version source... - NOTE: Resolving any missing task queue dependencies - . - . - . - NOTE: Executing SetScene Tasks - NOTE: Executing RunQueue Tasks - NOTE: Tasks Summary: Attempted 74 tasks of which 72 didn't need to be rerun and all succeeded. - Adding changed files: 100% |#####################################| Time: 0:00:00 - NOTE: Upgraded source extracted to /home/scottrif/poky/build/workspace/sources/nano - NOTE: New recipe is /home/scottrif/poky/build/workspace/recipes/nano/nano_2.9.3.bb - -Continuing with this example, you can use ``devtool build`` to build the -newly upgraded recipe:: - - $ devtool build nano - NOTE: Starting bitbake server... - Loading cache: 100% |################################################################################################| Time: 0:00:01 - Loaded 2040 entries from dependency cache. - Parsing recipes: 100% |##############################################################################################| Time: 0:00:00 - Parsing of 1432 .bb files complete (1431 cached, 1 parsed). 2041 targets, 56 skipped, 0 masked, 0 errors. - NOTE: Resolving any missing task queue dependencies - . - . - . - NOTE: Executing SetScene Tasks - NOTE: Executing RunQueue Tasks - NOTE: nano: compiling from external source tree /home/scottrif/poky/build/workspace/sources/nano - NOTE: Tasks Summary: Attempted 520 tasks of which 304 didn't need to be rerun and all succeeded. - -Within the ``devtool upgrade`` workflow, you can -deploy and test your rebuilt software. For this example, -however, running ``devtool finish`` cleans up the workspace once the -source in your workspace is clean. This usually means using Git to stage -and submit commits for the changes generated by the upgrade process. - -Once the tree is clean, you can clean things up in this example with the -following command from the ``${BUILDDIR}/workspace/sources/nano`` -directory:: - - $ devtool finish nano meta-oe - NOTE: Starting bitbake server... - Loading cache: 100% |################################################################################################| Time: 0:00:00 - Loaded 2040 entries from dependency cache. - Parsing recipes: 100% |##############################################################################################| Time: 0:00:01 - Parsing of 1432 .bb files complete (1431 cached, 1 parsed). 2041 targets, 56 skipped, 0 masked, 0 errors. - NOTE: Adding new patch 0001-nano.bb-Stuff-I-changed-when-upgrading-nano.bb.patch - NOTE: Updating recipe nano_2.9.3.bb - NOTE: Removing file /home/scottrif/meta-openembedded/meta-oe/recipes-support/nano/nano_2.7.4.bb - NOTE: Moving recipe file to /home/scottrif/meta-openembedded/meta-oe/recipes-support/nano - NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/nano as-is; if you no longer need it then please delete it manually - - -Using the ``devtool finish`` command cleans up the workspace and creates a patch -file based on your commits. The tool puts all patch files back into the -source directory in a sub-directory named ``nano`` in this case. - -Manually Upgrading a Recipe ---------------------------- - -If for some reason you choose not to upgrade recipes using -:ref:`dev-manual/common-tasks:Using the Auto Upgrade Helper (AUH)` or -by :ref:`dev-manual/common-tasks:Using \`\`devtool upgrade\`\``, -you can manually edit the recipe files to upgrade the versions. - -.. note:: - - Manually updating multiple recipes scales poorly and involves many - steps. The recommendation to upgrade recipe versions is through AUH - or ``devtool upgrade``, both of which automate some steps and provide - guidance for others needed for the manual process. - -To manually upgrade recipe versions, follow these general steps: - -1. *Change the Version:* Rename the recipe such that the version (i.e. - the :term:`PV` part of the recipe name) - changes appropriately. If the version is not part of the recipe name, - change the value as it is set for :term:`PV` within the recipe itself. - -2. *Update* :term:`SRCREV` *if Needed*: If the source code your recipe builds - is fetched from Git or some other version control system, update - :term:`SRCREV` to point to the - commit hash that matches the new version. - -3. *Build the Software:* Try to build the recipe using BitBake. Typical - build failures include the following: - - - License statements were updated for the new version. For this - case, you need to review any changes to the license and update the - values of :term:`LICENSE` and - :term:`LIC_FILES_CHKSUM` - as needed. - - .. note:: - - License changes are often inconsequential. For example, the - license text's copyright year might have changed. - - - Custom patches carried by the older version of the recipe might - fail to apply to the new version. For these cases, you need to - review the failures. Patches might not be necessary for the new - version of the software if the upgraded version has fixed those - issues. If a patch is necessary and failing, you need to rebase it - into the new version. - -4. *Optionally Attempt to Build for Several Architectures:* Once you - successfully build the new software for a given architecture, you - could test the build for other architectures by changing the - :term:`MACHINE` variable and - rebuilding the software. This optional step is especially important - if the recipe is to be released publicly. - -5. *Check the Upstream Change Log or Release Notes:* Checking both these - reveals if there are new features that could break - backwards-compatibility. If so, you need to take steps to mitigate or - eliminate that situation. - -6. *Optionally Create a Bootable Image and Test:* If you want, you can - test the new software by booting it onto actual hardware. - -7. *Create a Commit with the Change in the Layer Repository:* After all - builds work and any testing is successful, you can create commits for - any changes in the layer holding your upgraded recipe. - -Finding Temporary Source Code -============================= - -You might find it helpful during development to modify the temporary -source code used by recipes to build packages. For example, suppose you -are developing a patch and you need to experiment a bit to figure out -your solution. After you have initially built the package, you can -iteratively tweak the source code, which is located in the -:term:`Build Directory`, and then you can -force a re-compile and quickly test your altered code. Once you settle -on a solution, you can then preserve your changes in the form of -patches. - -During a build, the unpacked temporary source code used by recipes to -build packages is available in the Build Directory as defined by the -:term:`S` variable. Below is the default -value for the :term:`S` variable as defined in the -``meta/conf/bitbake.conf`` configuration file in the -:term:`Source Directory`:: - - S = "${WORKDIR}/${BP}" - -You should be aware that many recipes override the -:term:`S` variable. For example, recipes that fetch their source from Git -usually set :term:`S` to ``${WORKDIR}/git``. - -.. note:: - - The :term:`BP` represents the base recipe name, which consists of the name - and version:: - - BP = "${BPN}-${PV}" - - -The path to the work directory for the recipe -(:term:`WORKDIR`) is defined as -follows:: - - ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} - -The actual directory depends on several things: - -- :term:`TMPDIR`: The top-level build - output directory. - -- :term:`MULTIMACH_TARGET_SYS`: - The target system identifier. - -- :term:`PN`: The recipe name. - -- :term:`EXTENDPE`: The epoch - (if - :term:`PE` is not specified, which is - usually the case for most recipes, then :term:`EXTENDPE` is blank). - -- :term:`PV`: The recipe version. - -- :term:`PR`: The recipe revision. - -As an example, assume a Source Directory top-level folder named -``poky``, a default Build Directory at ``poky/build``, and a -``qemux86-poky-linux`` machine target system. Furthermore, suppose your -recipe is named ``foo_1.3.0.bb``. In this case, the work directory the -build system uses to build the package would be as follows:: - - poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 - -Using Quilt in Your Workflow -============================ - -`Quilt <https://savannah.nongnu.org/projects/quilt>`__ is a powerful tool -that allows you to capture source code changes without having a clean -source tree. This section outlines the typical workflow you can use to -modify source code, test changes, and then preserve the changes in the -form of a patch all using Quilt. - -.. note:: - - With regard to preserving changes to source files, if you clean a - recipe or have ``rm_work`` enabled, the - :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` - as described in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual is a safer - development flow than the flow that uses Quilt. - -Follow these general steps: - -1. *Find the Source Code:* Temporary source code used by the - OpenEmbedded build system is kept in the - :term:`Build Directory`. See the - ":ref:`dev-manual/common-tasks:finding temporary source code`" section to - learn how to locate the directory that has the temporary source code for a - particular package. - -2. *Change Your Working Directory:* You need to be in the directory that - has the temporary source code. That directory is defined by the - :term:`S` variable. - -3. *Create a New Patch:* Before modifying source code, you need to - create a new patch. To create a new patch file, use ``quilt new`` as - below:: - - $ quilt new my_changes.patch - -4. *Notify Quilt and Add Files:* After creating the patch, you need to - notify Quilt about the files you plan to edit. You notify Quilt by - adding the files to the patch you just created:: - - $ quilt add file1.c file2.c file3.c - -5. *Edit the Files:* Make your changes in the source code to the files - you added to the patch. - -6. *Test Your Changes:* Once you have modified the source code, the - easiest way to test your changes is by calling the ``do_compile`` - task as shown in the following example:: - - $ bitbake -c compile -f package - - The ``-f`` or ``--force`` option forces the specified task to - execute. If you find problems with your code, you can just keep - editing and re-testing iteratively until things work as expected. - - .. note:: - - All the modifications you make to the temporary source code disappear - once you run the ``do_clean`` or ``do_cleanall`` tasks using BitBake - (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). - Modifications will also disappear if you use the ``rm_work`` feature as - described in the - ":ref:`dev-manual/common-tasks:conserving disk space during builds`" - section. - -7. *Generate the Patch:* Once your changes work as expected, you need to - use Quilt to generate the final patch that contains all your - modifications. - :: - - $ quilt refresh - - At this point, the - ``my_changes.patch`` file has all your edits made to the ``file1.c``, - ``file2.c``, and ``file3.c`` files. - - You can find the resulting patch file in the ``patches/`` - subdirectory of the source (:term:`S`) directory. - -8. *Copy the Patch File:* For simplicity, copy the patch file into a - directory named ``files``, which you can create in the same directory - that holds the recipe (``.bb``) file or the append (``.bbappend``) - file. Placing the patch here guarantees that the OpenEmbedded build - system will find the patch. Next, add the patch into the :term:`SRC_URI` - of the recipe. Here is an example:: - - SRC_URI += "file://my_changes.patch" - -Using a Development Shell -========================= - -When debugging certain commands or even when just editing packages, -``devshell`` can be a useful tool. When you invoke ``devshell``, all -tasks up to and including -:ref:`ref-tasks-patch` are run for the -specified target. Then, a new terminal is opened and you are placed in -``${``\ :term:`S`\ ``}``, the source -directory. In the new terminal, all the OpenEmbedded build-related -environment variables are still defined so you can use commands such as -``configure`` and ``make``. The commands execute just as if the -OpenEmbedded build system were executing them. Consequently, working -this way can be helpful when debugging a build or preparing software to -be used with the OpenEmbedded build system. - -Following is an example that uses ``devshell`` on a target named -``matchbox-desktop``:: - - $ bitbake matchbox-desktop -c devshell - -This command spawns a terminal with a shell prompt within the -OpenEmbedded build environment. The -:term:`OE_TERMINAL` variable -controls what type of shell is opened. - -For spawned terminals, the following occurs: - -- The ``PATH`` variable includes the cross-toolchain. - -- The ``pkgconfig`` variables find the correct ``.pc`` files. - -- The ``configure`` command finds the Yocto Project site files as well - as any other necessary files. - -Within this environment, you can run configure or compile commands as if -they were being run by the OpenEmbedded build system itself. As noted -earlier, the working directory also automatically changes to the Source -Directory (:term:`S`). - -To manually run a specific task using ``devshell``, run the -corresponding ``run.*`` script in the -``${``\ :term:`WORKDIR`\ ``}/temp`` -directory (e.g., ``run.do_configure.``\ `pid`). If a task's script does -not exist, which would be the case if the task was skipped by way of the -sstate cache, you can create the task by first running it outside of the -``devshell``:: - - $ bitbake -c task - -.. note:: - - - Execution of a task's ``run.*`` script and BitBake's execution of - a task are identical. In other words, running the script re-runs - the task just as it would be run using the ``bitbake -c`` command. - - - Any ``run.*`` file that does not have a ``.pid`` extension is a - symbolic link (symlink) to the most recent version of that file. - -Remember, that the ``devshell`` is a mechanism that allows you to get -into the BitBake task execution environment. And as such, all commands -must be called just as BitBake would call them. That means you need to -provide the appropriate options for cross-compilation and so forth as -applicable. - -When you are finished using ``devshell``, exit the shell or close the -terminal window. - -.. note:: - - - It is worth remembering that when using ``devshell`` you need to - use the full compiler name such as ``arm-poky-linux-gnueabi-gcc`` - instead of just using ``gcc``. The same applies to other - applications such as ``binutils``, ``libtool`` and so forth. - BitBake sets up environment variables such as :term:`CC` to assist - applications, such as ``make`` to find the correct tools. - - - It is also worth noting that ``devshell`` still works over X11 - forwarding and similar situations. - -Using a Python Development Shell -================================ - -Similar to working within a development shell as described in the -previous section, you can also spawn and work within an interactive -Python development shell. When debugging certain commands or even when -just editing packages, ``pydevshell`` can be a useful tool. When you -invoke the ``pydevshell`` task, all tasks up to and including -:ref:`ref-tasks-patch` are run for the -specified target. Then a new terminal is opened. Additionally, key -Python objects and code are available in the same way they are to -BitBake tasks, in particular, the data store 'd'. So, commands such as -the following are useful when exploring the data store and running -functions:: - - pydevshell> d.getVar("STAGING_DIR") - '/media/build1/poky/build/tmp/sysroots' - pydevshell> d.getVar("STAGING_DIR", False) - '${TMPDIR}/sysroots' - pydevshell> d.setVar("FOO", "bar") - pydevshell> d.getVar("FOO") - 'bar' - pydevshell> d.delVar("FOO") - pydevshell> d.getVar("FOO") - pydevshell> bb.build.exec_func("do_unpack", d) - pydevshell> - -The commands execute just as if the OpenEmbedded build -system were executing them. Consequently, working this way can be -helpful when debugging a build or preparing software to be used with the -OpenEmbedded build system. - -Following is an example that uses ``pydevshell`` on a target named -``matchbox-desktop``:: - - $ bitbake matchbox-desktop -c pydevshell - -This command spawns a terminal and places you in an interactive Python -interpreter within the OpenEmbedded build environment. The -:term:`OE_TERMINAL` variable -controls what type of shell is opened. - -When you are finished using ``pydevshell``, you can exit the shell -either by using Ctrl+d or closing the terminal window. - -Building -======== - -This section describes various build procedures, such as the steps -needed for a simple build, building a target for multiple configurations, -generating an image for more than one machine, and so forth. - -Building a Simple Image ------------------------ - -In the development environment, you need to build an image whenever you -change hardware support, add or change system libraries, or add or -change services that have dependencies. There are several methods that allow -you to build an image within the Yocto Project. This section presents -the basic steps you need to build a simple image using BitBake from a -build host running Linux. - -.. note:: - - - For information on how to build an image using - :term:`Toaster`, see the - :doc:`/toaster-manual/index`. - - - For information on how to use ``devtool`` to build images, see the - ":ref:`sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - - For a quick example on how to build an image using the - OpenEmbedded build system, see the - :doc:`/brief-yoctoprojectqs/index` document. - -The build process creates an entire Linux distribution from source and -places it in your :term:`Build Directory` under -``tmp/deploy/images``. For detailed information on the build process -using BitBake, see the ":ref:`overview-manual/concepts:images`" section in the -Yocto Project Overview and Concepts Manual. - -The following figure and list overviews the build process: - -.. image:: figures/bitbake-build-flow.png - :align: center - -1. *Set up Your Host Development System to Support Development Using the - Yocto Project*: See the ":doc:`start`" section for options on how to get a - build host ready to use the Yocto Project. - -2. *Initialize the Build Environment:* Initialize the build environment - by sourcing the build environment script (i.e. - :ref:`structure-core-script`):: - - $ source oe-init-build-env [build_dir] - - When you use the initialization script, the OpenEmbedded build system - uses ``build`` as the default :term:`Build Directory` in your current work - directory. You can use a `build_dir` argument with the script to - specify a different build directory. - - .. note:: - - A common practice is to use a different Build Directory for - different targets; for example, ``~/build/x86`` for a ``qemux86`` - target, and ``~/build/arm`` for a ``qemuarm`` target. In any - event, it's typically cleaner to locate the build directory - somewhere outside of your source directory. - -3. *Make Sure Your* ``local.conf`` *File is Correct*: Ensure the - ``conf/local.conf`` configuration file, which is found in the Build - Directory, is set up how you want it. This file defines many aspects - of the build environment including the target machine architecture - through the :term:`MACHINE` variable, the packaging format used during - the build - (:term:`PACKAGE_CLASSES`), - and a centralized tarball download directory through the - :term:`DL_DIR` variable. - -4. *Build the Image:* Build the image using the ``bitbake`` command:: - - $ bitbake target - - .. note:: - - For information on BitBake, see the :doc:`bitbake:index`. - - The target is the name of the recipe you want to build. Common - targets are the images in ``meta/recipes-core/images``, - ``meta/recipes-sato/images``, and so forth all found in the - :term:`Source Directory`. Alternatively, the target - can be the name of a recipe for a specific piece of software such as - BusyBox. For more details about the images the OpenEmbedded build - system supports, see the - ":ref:`ref-manual/images:Images`" chapter in the Yocto - Project Reference Manual. - - As an example, the following command builds the - ``core-image-minimal`` image:: - - $ bitbake core-image-minimal - - Once an - image has been built, it often needs to be installed. The images and - kernels built by the OpenEmbedded build system are placed in the - Build Directory in ``tmp/deploy/images``. For information on how to - run pre-built images such as ``qemux86`` and ``qemuarm``, see the - :doc:`/sdk-manual/index` manual. For - information about how to install these images, see the documentation - for your particular board or machine. - -Building Images for Multiple Targets Using Multiple Configurations ------------------------------------------------------------------- - -You can use a single ``bitbake`` command to build multiple images or -packages for different targets where each image or package requires a -different configuration (multiple configuration builds). The builds, in -this scenario, are sometimes referred to as "multiconfigs", and this -section uses that term throughout. - -This section describes how to set up for multiple configuration builds -and how to account for cross-build dependencies between the -multiconfigs. - -Setting Up and Running a Multiple Configuration Build -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To accomplish a multiple configuration build, you must define each -target's configuration separately using a parallel configuration file in -the :term:`Build Directory`, and you -must follow a required file hierarchy. Additionally, you must enable the -multiple configuration builds in your ``local.conf`` file. - -Follow these steps to set up and execute multiple configuration builds: - -- *Create Separate Configuration Files*: You need to create a single - configuration file for each build target (each multiconfig). - Minimally, each configuration file must define the machine and the - temporary directory BitBake uses for the build. Suggested practice - dictates that you do not overlap the temporary directories used - during the builds. However, it is possible that you can share the - temporary directory - (:term:`TMPDIR`). For example, - consider a scenario with two different multiconfigs for the same - :term:`MACHINE`: "qemux86" built - for two distributions such as "poky" and "poky-lsb". In this case, - you might want to use the same :term:`TMPDIR`. - - Here is an example showing the minimal statements needed in a - configuration file for a "qemux86" target whose temporary build - directory is ``tmpmultix86``:: - - MACHINE = "qemux86" - TMPDIR = "${TOPDIR}/tmpmultix86" - - The location for these multiconfig configuration files is specific. - They must reside in the current build directory in a sub-directory of - ``conf`` named ``multiconfig``. Following is an example that defines - two configuration files for the "x86" and "arm" multiconfigs: - - .. image:: figures/multiconfig_files.png - :align: center - - The reason for this required file hierarchy is because the :term:`BBPATH` - variable is not constructed until the layers are parsed. - Consequently, using the configuration file as a pre-configuration - file is not possible unless it is located in the current working - directory. - -- *Add the BitBake Multi-configuration Variable to the Local - Configuration File*: Use the - :term:`BBMULTICONFIG` - variable in your ``conf/local.conf`` configuration file to specify - each multiconfig. Continuing with the example from the previous - figure, the :term:`BBMULTICONFIG` variable needs to enable two - multiconfigs: "x86" and "arm" by specifying each configuration file:: - - BBMULTICONFIG = "x86 arm" - - .. note:: - - A "default" configuration already exists by definition. This - configuration is named: "" (i.e. empty string) and is defined by - the variables coming from your ``local.conf`` - file. Consequently, the previous example actually adds two - additional configurations to your build: "arm" and "x86" along - with "". - -- *Launch BitBake*: Use the following BitBake command form to launch - the multiple configuration build:: - - $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ] - - For the example in this section, the following command applies:: - - $ bitbake mc:x86:core-image-minimal mc:arm:core-image-sato mc::core-image-base - - The previous BitBake command builds a ``core-image-minimal`` image - that is configured through the ``x86.conf`` configuration file, a - ``core-image-sato`` image that is configured through the ``arm.conf`` - configuration file and a ``core-image-base`` that is configured - through your ``local.conf`` configuration file. - -.. note:: - - Support for multiple configuration builds in the Yocto Project &DISTRO; - (&DISTRO_NAME;) Release does not include Shared State (sstate) - optimizations. Consequently, if a build uses the same object twice - in, for example, two different :term:`TMPDIR` - directories, the build either loads from an existing sstate cache for - that build at the start or builds the object fresh. - -Enabling Multiple Configuration Build Dependencies -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sometimes dependencies can exist between targets (multiconfigs) in a -multiple configuration build. For example, suppose that in order to -build a ``core-image-sato`` image for an "x86" multiconfig, the root -filesystem of an "arm" multiconfig must exist. This dependency is -essentially that the -:ref:`ref-tasks-image` task in the -``core-image-sato`` recipe depends on the completion of the -:ref:`ref-tasks-rootfs` task of the -``core-image-minimal`` recipe. - -To enable dependencies in a multiple configuration build, you must -declare the dependencies in the recipe using the following statement -form:: - - task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend" - -To better show how to use this statement, consider the example scenario -from the first paragraph of this section. The following statement needs -to be added to the recipe that builds the ``core-image-sato`` image:: - - do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs" - -In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The -task on which the ``do_image`` task in the recipe depends is the -``do_rootfs`` task from the ``core-image-minimal`` recipe associated -with the "arm" multiconfig. - -Once you set up this dependency, you can build the "x86" multiconfig -using a BitBake command as follows:: - - $ bitbake mc:x86:core-image-sato - -This command executes all the tasks needed to create the -``core-image-sato`` image for the "x86" multiconfig. Because of the -dependency, BitBake also executes through the ``do_rootfs`` task for the -"arm" multiconfig build. - -Having a recipe depend on the root filesystem of another build might not -seem that useful. Consider this change to the statement in the -``core-image-sato`` recipe:: - - do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_image" - -In this case, BitBake must -create the ``core-image-minimal`` image for the "arm" build since the -"x86" build depends on it. - -Because "x86" and "arm" are enabled for multiple configuration builds -and have separate configuration files, BitBake places the artifacts for -each build in the respective temporary build directories (i.e. -:term:`TMPDIR`). - -Building an Initial RAM Filesystem (initramfs) Image ----------------------------------------------------- - -An initial RAM filesystem (initramfs) image provides a temporary root -filesystem used for early system initialization (e.g. loading of modules -needed to locate and mount the "real" root filesystem). - -.. note:: - - The initramfs image is the successor of initial RAM disk (initrd). It - is a "copy in and out" (cpio) archive of the initial filesystem that - gets loaded into memory during the Linux startup process. Because - Linux uses the contents of the archive during initialization, the - initramfs image needs to contain all of the device drivers and tools - needed to mount the final root filesystem. - -Follow these steps to create an initramfs image: - -1. *Create the initramfs Image Recipe:* You can reference the - ``core-image-minimal-initramfs.bb`` recipe found in the - ``meta/recipes-core`` directory of the :term:`Source Directory` - as an example - from which to work. - -2. *Decide if You Need to Bundle the initramfs Image Into the Kernel - Image:* If you want the initramfs image that is built to be bundled - in with the kernel image, set the - :term:`INITRAMFS_IMAGE_BUNDLE` - variable to "1" in your ``local.conf`` configuration file and set the - :term:`INITRAMFS_IMAGE` - variable in the recipe that builds the kernel image. - - .. note:: - - It is recommended that you bundle the initramfs image with the - kernel image to avoid circular dependencies between the kernel - recipe and the initramfs recipe should the initramfs image include - kernel modules. - - Setting the :term:`INITRAMFS_IMAGE_BUNDLE` flag causes the initramfs - image to be unpacked into the ``${B}/usr/`` directory. The unpacked - initramfs image is then passed to the kernel's ``Makefile`` using the - :term:`CONFIG_INITRAMFS_SOURCE` - variable, allowing the initramfs image to be built into the kernel - normally. - - .. 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. - - .. note:: - - If you choose to not bundle the initramfs image with the kernel - image, you are essentially using an - `Initial RAM Disk (initrd) <https://en.wikipedia.org/wiki/Initrd>`__. - Creating an initrd is handled primarily through the :term:`INITRD_IMAGE`, - ``INITRD_LIVE``, and ``INITRD_IMAGE_LIVE`` variables. For more - information, see the :ref:`ref-classes-image-live` file. - -3. *Optionally Add Items to the initramfs Image Through the initramfs - Image Recipe:* If you add items to the initramfs image by way of its - recipe, you should use - :term:`PACKAGE_INSTALL` - rather than - :term:`IMAGE_INSTALL`. - :term:`PACKAGE_INSTALL` gives more direct control of what is added to the - image as compared to the defaults you might not necessarily want that - are set by the :ref:`image <ref-classes-image>` - or :ref:`core-image <ref-classes-core-image>` - classes. - -4. *Build the Kernel Image and the initramfs Image:* Build your kernel - image using BitBake. Because the initramfs image recipe is a - dependency of the kernel image, the initramfs image is built as well - and bundled with the kernel image if you used the - :term:`INITRAMFS_IMAGE_BUNDLE` - variable described earlier. - -Building a Tiny System ----------------------- - -Very small distributions have some significant advantages such as -requiring less on-die or in-package memory (cheaper), better performance -through efficient cache usage, lower power requirements due to less -memory, faster boot times, and reduced development overhead. Some -real-world examples where a very small distribution gives you distinct -advantages are digital cameras, medical devices, and small headless -systems. - -This section presents information that shows you how you can trim your -distribution to even smaller sizes than the ``poky-tiny`` distribution, -which is around 5 Mbytes, that can be built out-of-the-box using the -Yocto Project. - -Tiny System Overview -~~~~~~~~~~~~~~~~~~~~ - -The following list presents the overall steps you need to consider and -perform to create distributions with smaller root filesystems, achieve -faster boot times, maintain your critical functionality, and avoid -initial RAM disks: - -- :ref:`Determine your goals and guiding principles - <dev-manual/common-tasks:goals and guiding principles>` - -- :ref:`dev-manual/common-tasks:understand what contributes to your image size` - -- :ref:`Reduce the size of the root filesystem - <dev-manual/common-tasks:trim the root filesystem>` - -- :ref:`Reduce the size of the kernel <dev-manual/common-tasks:trim the kernel>` - -- :ref:`dev-manual/common-tasks:remove package management requirements` - -- :ref:`dev-manual/common-tasks:look for other ways to minimize size` - -- :ref:`dev-manual/common-tasks:iterate on the process` - -Goals and Guiding Principles -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Before you can reach your destination, you need to know where you are -going. Here is an example list that you can use as a guide when creating -very small distributions: - -- Determine how much space you need (e.g. a kernel that is 1 Mbyte or - less and a root filesystem that is 3 Mbytes or less). - -- Find the areas that are currently taking 90% of the space and - concentrate on reducing those areas. - -- Do not create any difficult "hacks" to achieve your goals. - -- Leverage the device-specific options. - -- Work in a separate layer so that you keep changes isolated. For - information on how to create layers, see the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" section. - -Understand What Contributes to Your Image Size -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -It is easiest to have something to start with when creating your own -distribution. You can use the Yocto Project out-of-the-box to create the -``poky-tiny`` distribution. Ultimately, you will want to make changes in -your own distribution that are likely modeled after ``poky-tiny``. - -.. note:: - - To use ``poky-tiny`` in your build, set the :term:`DISTRO` variable in your - ``local.conf`` file to "poky-tiny" as described in the - ":ref:`dev-manual/common-tasks:creating your own distribution`" - section. - -Understanding some memory concepts will help you reduce the system size. -Memory consists of static, dynamic, and temporary memory. Static memory -is the TEXT (code), DATA (initialized data in the code), and BSS -(uninitialized data) sections. Dynamic memory represents memory that is -allocated at runtime: stacks, hash tables, and so forth. Temporary -memory is recovered after the boot process. This memory consists of -memory used for decompressing the kernel and for the ``__init__`` -functions. - -To help you see where you currently are with kernel and root filesystem -sizes, you can use two tools found in the :term:`Source Directory` -in the -``scripts/tiny/`` directory: - -- ``ksize.py``: Reports component sizes for the kernel build objects. - -- ``dirsize.py``: Reports component sizes for the root filesystem. - -This next tool and command help you organize configuration fragments and -view file dependencies in a human-readable form: - -- ``merge_config.sh``: Helps you manage configuration files and - fragments within the kernel. With this tool, you can merge individual - configuration fragments together. The tool allows you to make - overrides and warns you of any missing configuration options. The - tool is ideal for allowing you to iterate on configurations, create - minimal configurations, and create configuration files for different - machines without having to duplicate your process. - - The ``merge_config.sh`` script is part of the Linux Yocto kernel Git - repositories (i.e. ``linux-yocto-3.14``, ``linux-yocto-3.10``, - ``linux-yocto-3.8``, and so forth) in the ``scripts/kconfig`` - directory. - - For more information on configuration fragments, see the - ":ref:`kernel-dev/common:creating configuration fragments`" - section in the Yocto Project Linux Kernel Development Manual. - -- ``bitbake -u taskexp -g bitbake_target``: Using the BitBake command - with these options brings up a Dependency Explorer from which you can - view file dependencies. Understanding these dependencies allows you - to make informed decisions when cutting out various pieces of the - kernel and root filesystem. - -Trim the Root Filesystem -~~~~~~~~~~~~~~~~~~~~~~~~ - -The root filesystem is made up of packages for booting, libraries, and -applications. To change things, you can configure how the packaging -happens, which changes the way you build them. You can also modify the -filesystem itself or select a different filesystem. - -First, find out what is hogging your root filesystem by running the -``dirsize.py`` script from your root directory:: - - $ cd root-directory-of-image - $ dirsize.py 100000 > dirsize-100k.log - $ cat dirsize-100k.log - -You can apply a filter to the script to ignore files -under a certain size. The previous example filters out any files below -100 Kbytes. The sizes reported by the tool are uncompressed, and thus -will be smaller by a relatively constant factor in a compressed root -filesystem. When you examine your log file, you can focus on areas of -the root filesystem that take up large amounts of memory. - -You need to be sure that what you eliminate does not cripple the -functionality you need. One way to see how packages relate to each other -is by using the Dependency Explorer UI with the BitBake command:: - - $ cd image-directory - $ bitbake -u taskexp -g image - -Use the interface to -select potential packages you wish to eliminate and see their dependency -relationships. - -When deciding how to reduce the size, get rid of packages that result in -minimal impact on the feature set. For example, you might not need a VGA -display. Or, you might be able to get by with ``devtmpfs`` and ``mdev`` -instead of ``udev``. - -Use your ``local.conf`` file to make changes. For example, to eliminate -``udev`` and ``glib``, set the following in the local configuration -file:: - - VIRTUAL-RUNTIME_dev_manager = "" - -Finally, you should consider exactly the type of root filesystem you -need to meet your needs while also reducing its size. For example, -consider ``cramfs``, ``squashfs``, ``ubifs``, ``ext2``, or an -``initramfs`` using ``initramfs``. Be aware that ``ext3`` requires a 1 -Mbyte journal. If you are okay with running read-only, you do not need -this journal. - -.. note:: - - After each round of elimination, you need to rebuild your system and - then use the tools to see the effects of your reductions. - -Trim the Kernel -~~~~~~~~~~~~~~~ - -The kernel is built by including policies for hardware-independent -aspects. What subsystems do you enable? For what architecture are you -building? Which drivers do you build by default? - -.. note:: - - You can modify the kernel source if you want to help with boot time. - -Run the ``ksize.py`` script from the top-level Linux build directory to -get an idea of what is making up the kernel:: - - $ cd top-level-linux-build-directory - $ ksize.py > ksize.log - $ cat ksize.log - -When you examine the log, you will see how much space is taken up with -the built-in ``.o`` files for drivers, networking, core kernel files, -filesystem, sound, and so forth. The sizes reported by the tool are -uncompressed, and thus will be smaller by a relatively constant factor -in a compressed kernel image. Look to reduce the areas that are large -and taking up around the "90% rule." - -To examine, or drill down, into any particular area, use the ``-d`` -option with the script:: - - $ ksize.py -d > ksize.log - -Using this option -breaks out the individual file information for each area of the kernel -(e.g. drivers, networking, and so forth). - -Use your log file to see what you can eliminate from the kernel based on -features you can let go. For example, if you are not going to need -sound, you do not need any drivers that support sound. - -After figuring out what to eliminate, you need to reconfigure the kernel -to reflect those changes during the next build. You could run -``menuconfig`` and make all your changes at once. However, that makes it -difficult to see the effects of your individual eliminations and also -makes it difficult to replicate the changes for perhaps another target -device. A better method is to start with no configurations using -``allnoconfig``, create configuration fragments for individual changes, -and then manage the fragments into a single configuration file using -``merge_config.sh``. The tool makes it easy for you to iterate using the -configuration change and build cycle. - -Each time you make configuration changes, you need to rebuild the kernel -and check to see what impact your changes had on the overall size. - -Remove Package Management Requirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Packaging requirements add size to the image. One way to reduce the size -of the image is to remove all the packaging requirements from the image. -This reduction includes both removing the package manager and its unique -dependencies as well as removing the package management data itself. - -To eliminate all the packaging requirements for an image, be sure that -"package-management" is not part of your -:term:`IMAGE_FEATURES` -statement for the image. When you remove this feature, you are removing -the package manager as well as its dependencies from the root -filesystem. - -Look for Other Ways to Minimize Size -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Depending on your particular circumstances, other areas that you can -trim likely exist. The key to finding these areas is through tools and -methods described here combined with experimentation and iteration. Here -are a couple of areas to experiment with: - -- ``glibc``: In general, follow this process: - - 1. Remove ``glibc`` features from - :term:`DISTRO_FEATURES` - that you think you do not need. - - 2. Build your distribution. - - 3. If the build fails due to missing symbols in a package, determine - if you can reconfigure the package to not need those features. For - example, change the configuration to not support wide character - support as is done for ``ncurses``. Or, if support for those - characters is needed, determine what ``glibc`` features provide - the support and restore the configuration. - - 4. Rebuild and repeat the process. - -- ``busybox``: For BusyBox, use a process similar as described for - ``glibc``. A difference is you will need to boot the resulting system - to see if you are able to do everything you expect from the running - system. You need to be sure to integrate configuration fragments into - Busybox because BusyBox handles its own core features and then allows - you to add configuration fragments on top. - -Iterate on the Process -~~~~~~~~~~~~~~~~~~~~~~ - -If you have not reached your goals on system size, you need to iterate -on the process. The process is the same. Use the tools and see just what -is taking up 90% of the root filesystem and the kernel. Decide what you -can eliminate without limiting your device beyond what you need. - -Depending on your system, a good place to look might be Busybox, which -provides a stripped down version of Unix tools in a single, executable -file. You might be able to drop virtual terminal services or perhaps -ipv6. - -Building Images for More than One Machine ------------------------------------------ - -A common scenario developers face is creating images for several -different machines that use the same software environment. In this -situation, it is tempting to set the tunings and optimization flags for -each build specifically for the targeted hardware (i.e. "maxing out" the -tunings). Doing so can considerably add to build times and package feed -maintenance collectively for the machines. For example, selecting tunes -that are extremely specific to a CPU core used in a system might enable -some micro optimizations in GCC for that particular system but would -otherwise not gain you much of a performance difference across the other -systems as compared to using a more general tuning across all the builds -(e.g. setting :term:`DEFAULTTUNE` -specifically for each machine's build). Rather than "max out" each -build's tunings, you can take steps that cause the OpenEmbedded build -system to reuse software across the various machines where it makes -sense. - -If build speed and package feed maintenance are considerations, you -should consider the points in this section that can help you optimize -your tunings to best consider build times and package feed maintenance. - -- *Share the Build Directory:* If at all possible, share the - :term:`TMPDIR` across builds. The - Yocto Project supports switching between different - :term:`MACHINE` values in the same - :term:`TMPDIR`. This practice is well supported and regularly used by - developers when building for multiple machines. When you use the same - :term:`TMPDIR` for multiple machine builds, the OpenEmbedded build system - can reuse the existing native and often cross-recipes for multiple - machines. Thus, build time decreases. - - .. note:: - - If :term:`DISTRO` settings change or fundamental configuration settings - such as the filesystem layout, you need to work with a clean :term:`TMPDIR`. - Sharing :term:`TMPDIR` under these circumstances might work but since it is - not guaranteed, you should use a clean :term:`TMPDIR`. - -- *Enable the Appropriate Package Architecture:* By default, the - OpenEmbedded build system enables three levels of package - architectures: "all", "tune" or "package", and "machine". Any given - recipe usually selects one of these package architectures (types) for - its output. Depending for what a given recipe creates packages, - making sure you enable the appropriate package architecture can - directly impact the build time. - - A recipe that just generates scripts can enable "all" architecture - because there are no binaries to build. To specifically enable "all" - architecture, be sure your recipe inherits the - :ref:`allarch <ref-classes-allarch>` class. - This class is useful for "all" architectures because it configures - many variables so packages can be used across multiple architectures. - - If your recipe needs to generate packages that are machine-specific - or when one of the build or runtime dependencies is already - machine-architecture dependent, which makes your recipe also - machine-architecture dependent, make sure your recipe enables the - "machine" package architecture through the - :term:`MACHINE_ARCH` - variable:: - - PACKAGE_ARCH = "${MACHINE_ARCH}" - - When you do not - specifically enable a package architecture through the - :term:`PACKAGE_ARCH`, The - OpenEmbedded build system defaults to the - :term:`TUNE_PKGARCH` setting:: - - PACKAGE_ARCH = "${TUNE_PKGARCH}" - -- *Choose a Generic Tuning File if Possible:* Some tunes are more - generic and can run on multiple targets (e.g. an ``armv5`` set of - packages could run on ``armv6`` and ``armv7`` processors in most - cases). Similarly, ``i486`` binaries could work on ``i586`` and - higher processors. You should realize, however, that advances on - newer processor versions would not be used. - - If you select the same tune for several different machines, the - OpenEmbedded build system reuses software previously built, thus - speeding up the overall build time. Realize that even though a new - sysroot for each machine is generated, the software is not recompiled - and only one package feed exists. - -- *Manage Granular Level Packaging:* Sometimes there are cases where - injecting another level of package architecture beyond the three - higher levels noted earlier can be useful. For example, consider how - NXP (formerly Freescale) allows for the easy reuse of binary packages - in their layer - :yocto_git:`meta-freescale </meta-freescale/>`. - In this example, the - :yocto_git:`fsl-dynamic-packagearch </meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>` - class shares GPU packages for i.MX53 boards because all boards share - the AMD GPU. The i.MX6-based boards can do the same because all - boards share the Vivante GPU. This class inspects the BitBake - datastore to identify if the package provides or depends on one of - the sub-architecture values. If so, the class sets the - :term:`PACKAGE_ARCH` value - based on the ``MACHINE_SUBARCH`` value. If the package does not - provide or depend on one of the sub-architecture values but it - matches a value in the machine-specific filter, it sets - :term:`MACHINE_ARCH`. This - behavior reduces the number of packages built and saves build time by - reusing binaries. - -- *Use Tools to Debug Issues:* Sometimes you can run into situations - where software is being rebuilt when you think it should not be. For - example, the OpenEmbedded build system might not be using shared - state between machines when you think it should be. These types of - situations are usually due to references to machine-specific - variables such as :term:`MACHINE`, - :term:`SERIAL_CONSOLES`, - :term:`XSERVER`, - :term:`MACHINE_FEATURES`, - and so forth in code that is supposed to only be tune-specific or - when the recipe depends - (:term:`DEPENDS`, - :term:`RDEPENDS`, - :term:`RRECOMMENDS`, - :term:`RSUGGESTS`, and so forth) - on some other recipe that already has - :term:`PACKAGE_ARCH` defined - as "${MACHINE_ARCH}". - - .. note:: - - Patches to fix any issues identified are most welcome as these - issues occasionally do occur. - - For such cases, you can use some tools to help you sort out the - situation: - - - ``state-diff-machines.sh``*:* You can find this tool in the - ``scripts`` directory of the Source Repositories. See the comments - in the script for information on how to use the tool. - - - *BitBake's "-S printdiff" Option:* Using this option causes - BitBake to try to establish the closest signature match it can - (e.g. in the shared state cache) and then run ``bitbake-diffsigs`` - over the matches to determine the stamps and delta where these two - stamp trees diverge. - -Building Software from an External Source ------------------------------------------ - -By default, the OpenEmbedded build system uses the -:term:`Build Directory` when building source -code. The build process involves fetching the source files, unpacking -them, and then patching them if necessary before the build takes place. - -There are situations where you might want to build software from source -files that are external to and thus outside of the OpenEmbedded build -system. For example, suppose you have a project that includes a new BSP -with a heavily customized kernel. And, you want to minimize exposing the -build system to the development team so that they can focus on their -project and maintain everyone's workflow as much as possible. In this -case, you want a kernel source directory on the development machine -where the development occurs. You want the recipe's -:term:`SRC_URI` variable to point to -the external directory and use it as is, not copy it. - -To build from software that comes from an external source, all you need -to do is inherit the -:ref:`externalsrc <ref-classes-externalsrc>` class -and then set the -:term:`EXTERNALSRC` variable to -point to your external source code. Here are the statements to put in -your ``local.conf`` file:: - - INHERIT += "externalsrc" - EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree" - -This next example shows how to accomplish the same thing by setting -:term:`EXTERNALSRC` in the recipe itself or in the recipe's append file:: - - EXTERNALSRC = "path" - EXTERNALSRC_BUILD = "path" - -.. note:: - - In order for these settings to take effect, you must globally or - locally inherit the :ref:`externalsrc <ref-classes-externalsrc>` - class. - -By default, ``externalsrc.bbclass`` builds the source code in a -directory separate from the external source directory as specified by -:term:`EXTERNALSRC`. If you need -to have the source built in the same directory in which it resides, or -some other nominated directory, you can set -:term:`EXTERNALSRC_BUILD` -to point to that directory:: - - EXTERNALSRC_BUILD:pn-myrecipe = "path-to-your-source-tree" - -Replicating a Build Offline ---------------------------- - -It can be useful to take a "snapshot" of upstream sources used in a -build and then use that "snapshot" later to replicate the build offline. -To do so, you need to first prepare and populate your downloads -directory your "snapshot" of files. Once your downloads directory is -ready, you can use it at any time and from any machine to replicate your -build. - -Follow these steps to populate your Downloads directory: - -1. *Create a Clean Downloads Directory:* Start with an empty downloads - directory (:term:`DL_DIR`). You - start with an empty downloads directory by either removing the files - in the existing directory or by setting :term:`DL_DIR` to point to either - an empty location or one that does not yet exist. - -2. *Generate Tarballs of the Source Git Repositories:* Edit your - ``local.conf`` configuration file as follows:: - - DL_DIR = "/home/your-download-dir/" - BB_GENERATE_MIRROR_TARBALLS = "1" - - During - the fetch process in the next step, BitBake gathers the source files - and creates tarballs in the directory pointed to by :term:`DL_DIR`. See - the - :term:`BB_GENERATE_MIRROR_TARBALLS` - variable for more information. - -3. *Populate Your Downloads Directory Without Building:* Use BitBake to - fetch your sources but inhibit the build:: - - $ bitbake target --runonly=fetch - - The downloads directory (i.e. ``${DL_DIR}``) now has - a "snapshot" of the source files in the form of tarballs, which can - be used for the build. - -4. *Optionally Remove Any Git or other SCM Subdirectories From the - Downloads Directory:* If you want, you can clean up your downloads - directory by removing any Git or other Source Control Management - (SCM) subdirectories such as ``${DL_DIR}/git2/*``. The tarballs - already contain these subdirectories. - -Once your downloads directory has everything it needs regarding source -files, you can create your "own-mirror" and build your target. -Understand that you can use the files to build the target offline from -any machine and at any time. - -Follow these steps to build your target using the files in the downloads -directory: - -1. *Using Local Files Only:* Inside your ``local.conf`` file, add the - :term:`SOURCE_MIRROR_URL` variable, inherit the - :ref:`own-mirrors <ref-classes-own-mirrors>` class, and use the - :term:`BB_NO_NETWORK` variable to your ``local.conf``. - :: - - SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" - INHERIT += "own-mirrors" - BB_NO_NETWORK = "1" - - The :term:`SOURCE_MIRROR_URL` and :ref:`own-mirrors <ref-classes-own-mirrors>` - class set up the system to use the downloads directory as your "own - mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that - BitBake's fetching process in step 3 stays local, which means files - from your "own-mirror" are used. - -2. *Start With a Clean Build:* You can start with a clean build by - removing the - ``${``\ :term:`TMPDIR`\ ``}`` - directory or using a new :term:`Build Directory`. - -3. *Build Your Target:* Use BitBake to build your target:: - - $ bitbake target - - The build completes using the known local "snapshot" of source - files from your mirror. The resulting tarballs for your "snapshot" of - source files are in the downloads directory. - - .. note:: - - The offline build does not work if recipes attempt to find the - latest version of software by setting - :term:`SRCREV` to - ``${``\ :term:`AUTOREV`\ ``}``:: - - SRCREV = "${AUTOREV}" - - When a recipe sets :term:`SRCREV` to - ``${``\ :term:`AUTOREV`\ ``}``, the build system accesses the network in an - attempt to determine the latest version of software from the SCM. - Typically, recipes that use :term:`AUTOREV` are custom or modified - recipes. Recipes that reside in public repositories usually do not - use :term:`AUTOREV`. - - If you do have recipes that use :term:`AUTOREV`, you can take steps to - still use the recipes in an offline build. Do the following: - - 1. Use a configuration generated by enabling :ref:`build - history <dev-manual/common-tasks:maintaining build output quality>`. - - 2. Use the ``buildhistory-collect-srcrevs`` command to collect the - stored :term:`SRCREV` values from the build's history. For more - information on collecting these values, see the - ":ref:`dev-manual/common-tasks:build history package information`" - section. - - 3. Once you have the correct source revisions, you can modify - those recipes to set :term:`SRCREV` to specific versions of the - software. - -Speeding Up a Build -=================== - -Build time can be an issue. By default, the build system uses simple -controls to try and maximize build efficiency. In general, the default -settings for all the following variables result in the most efficient -build times when dealing with single socket systems (i.e. a single CPU). -If you have multiple CPUs, you might try increasing the default values -to gain more speed. See the descriptions in the glossary for each -variable for more information: - -- :term:`BB_NUMBER_THREADS`: - The maximum number of threads BitBake simultaneously executes. - -- :term:`BB_NUMBER_PARSE_THREADS`: - The number of threads BitBake uses during parsing. - -- :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. - -- :term:`PARALLEL_MAKEINST`: - Extra options passed to the ``make`` command during the - :ref:`ref-tasks-install` task in - order to specify parallel installation on the local build host. - -As mentioned, these variables all scale to the number of processor cores -available on the build system. For single socket systems, this -auto-scaling ensures that the build system fundamentally takes advantage -of potential parallel operations during the build based on the build -machine's capabilities. - -Following are additional factors that can affect build speed: - -- File system type: The file system type that the build is being - performed on can also influence performance. Using ``ext4`` is - recommended as compared to ``ext2`` and ``ext3`` due to ``ext4`` - improved features such as extents. - -- Disabling the updating of access time using ``noatime``: The - ``noatime`` mount option prevents the build system from updating file - and directory access times. - -- Setting a longer commit: Using the "commit=" mount option increases - the interval in seconds between disk cache writes. Changing this - interval from the five second default to something longer increases - the risk of data loss but decreases the need to write to the disk, - thus increasing the build performance. - -- Choosing the packaging backend: Of the available packaging backends, - IPK is the fastest. Additionally, selecting a singular packaging - backend also helps. - -- Using ``tmpfs`` for :term:`TMPDIR` - as a temporary file system: While this can help speed up the build, - the benefits are limited due to the compiler using ``-pipe``. The - build system goes to some lengths to avoid ``sync()`` calls into the - file system on the principle that if there was a significant failure, - the :term:`Build Directory` - contents could easily be rebuilt. - -- Inheriting the - :ref:`rm_work <ref-classes-rm-work>` class: - Inheriting this class has shown to speed up builds due to - significantly lower amounts of data stored in the data cache as well - as on disk. Inheriting this class also makes cleanup of - :term:`TMPDIR` faster, at the - expense of being easily able to dive into the source code. File - system maintainers have recommended that the fastest way to clean up - large numbers of files is to reformat partitions rather than delete - files due to the linear nature of partitions. This, of course, - assumes you structure the disk partitions and file systems in a way - that this is practical. - -Aside from the previous list, you should keep some trade offs in mind -that can help you speed up the build: - -- Remove items from - :term:`DISTRO_FEATURES` - that you might not need. - -- Exclude debug symbols and other debug information: If you do not need - these symbols and other debug information, disabling the ``*-dbg`` - package generation can speed up the build. You can disable this - generation by setting the - :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` - variable to "1". - -- Disable static library generation for recipes derived from - ``autoconf`` or ``libtool``: Following is an example showing how to - disable static libraries and still provide an override to handle - exceptions:: - - STATICLIBCONF = "--disable-static" - STATICLIBCONF:sqlite3-native = "" - EXTRA_OECONF += "${STATICLIBCONF}" - - .. note:: - - - Some recipes need static libraries in order to work correctly - (e.g. ``pseudo-native`` needs ``sqlite3-native``). Overrides, - as in the previous example, account for these kinds of - exceptions. - - - Some packages have packaging code that assumes the presence of - the static libraries. If so, you might need to exclude them as - well. - -Working With Libraries -====================== - -Libraries are an integral part of your system. This section describes -some common practices you might find helpful when working with libraries -to build your system: - -- :ref:`How to include static library files - <dev-manual/common-tasks:including static library files>` - -- :ref:`How to use the Multilib feature to combine multiple versions of - library files into a single image - <dev-manual/common-tasks:combining multiple versions of library files into one image>` - -- :ref:`How to install multiple versions of the same library in parallel on - the same system - <dev-manual/common-tasks:installing multiple versions of the same library>` - -Including Static Library Files ------------------------------- - -If you are building a library and the library offers static linking, you -can control which static library files (``*.a`` files) get included in -the built library. - -The :term:`PACKAGES` and -:term:`FILES:* <FILES>` variables in the -``meta/conf/bitbake.conf`` configuration file define how files installed -by the ``do_install`` task are packaged. By default, the :term:`PACKAGES` -variable includes ``${PN}-staticdev``, which represents all static -library files. - -.. note:: - - Some previously released versions of the Yocto Project defined the - static library files through ``${PN}-dev``. - -Following is part of the BitBake configuration file, where you can see -how the static library files are defined:: - - PACKAGE_BEFORE_PN ?= "" - PACKAGES = "${PN}-src ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}" - PACKAGES_DYNAMIC = "^${PN}-locale-.*" - FILES = "" - - FILES:${PN} = "${bindir}/* ${sbindir}/* ${libexecdir}/* ${libdir}/lib*${SOLIBS} \ - ${sysconfdir} ${sharedstatedir} ${localstatedir} \ - ${base_bindir}/* ${base_sbindir}/* \ - ${base_libdir}/*${SOLIBS} \ - ${base_prefix}/lib/udev ${prefix}/lib/udev \ - ${base_libdir}/udev ${libdir}/udev \ - ${datadir}/${BPN} ${libdir}/${BPN}/* \ - ${datadir}/pixmaps ${datadir}/applications \ - ${datadir}/idl ${datadir}/omf ${datadir}/sounds \ - ${libdir}/bonobo/servers" - - FILES:${PN}-bin = "${bindir}/* ${sbindir}/*" - - FILES:${PN}-doc = "${docdir} ${mandir} ${infodir} ${datadir}/gtk-doc \ - ${datadir}/gnome/help" - SECTION:${PN}-doc = "doc" - - FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" - FILES:${PN}-dev = "${includedir} ${FILES_SOLIBSDEV} ${libdir}/*.la \ - ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \ - ${datadir}/aclocal ${base_libdir}/*.o \ - ${libdir}/${BPN}/*.la ${base_libdir}/*.la \ - ${libdir}/cmake ${datadir}/cmake" - SECTION:${PN}-dev = "devel" - ALLOW_EMPTY:${PN}-dev = "1" - RDEPENDS:${PN}-dev = "${PN} (= ${EXTENDPKGV})" - - FILES:${PN}-staticdev = "${libdir}/*.a ${base_libdir}/*.a ${libdir}/${BPN}/*.a" - SECTION:${PN}-staticdev = "devel" - RDEPENDS:${PN}-staticdev = "${PN}-dev (= ${EXTENDPKGV})" - -Combining Multiple Versions of Library Files into One Image ------------------------------------------------------------ - -The build system offers the ability to build libraries with different -target optimizations or architecture formats and combine these together -into one system image. You can link different binaries in the image -against the different libraries as needed for specific use cases. This -feature is called "Multilib". - -An example would be where you have most of a system compiled in 32-bit -mode using 32-bit libraries, but you have something large, like a -database engine, that needs to be a 64-bit application and uses 64-bit -libraries. Multilib allows you to get the best of both 32-bit and 64-bit -libraries. - -While the Multilib feature is most commonly used for 32 and 64-bit -differences, the approach the build system uses facilitates different -target optimizations. You could compile some binaries to use one set of -libraries and other binaries to use a different set of libraries. The -libraries could differ in architecture, compiler options, or other -optimizations. - -There are several examples in the ``meta-skeleton`` layer found in the -:term:`Source Directory`: - -- :oe_git:`conf/multilib-example.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example.conf>` - configuration file. - -- :oe_git:`conf/multilib-example2.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example2.conf>` - configuration file. - -- :oe_git:`recipes-multilib/images/core-image-multilib-example.bb </openembedded-core/tree/meta-skeleton/recipes-multilib/images/core-image-multilib-example.bb>` - recipe - -Preparing to Use Multilib -~~~~~~~~~~~~~~~~~~~~~~~~~ - -User-specific requirements drive the Multilib feature. Consequently, -there is no one "out-of-the-box" configuration that would -meet your needs. - -In order to enable Multilib, you first need to ensure your recipe is -extended to support multiple libraries. Many standard recipes are -already extended and support multiple libraries. You can check in the -``meta/conf/multilib.conf`` configuration file in the -:term:`Source Directory` to see how this is -done using the -:term:`BBCLASSEXTEND` variable. -Eventually, all recipes will be covered and this list will not be -needed. - -For the most part, the :ref:`Multilib <ref-classes-multilib*>` -class extension works automatically to -extend the package name from ``${PN}`` to ``${MLPREFIX}${PN}``, where -:term:`MLPREFIX` is the particular multilib (e.g. "lib32-" or "lib64-"). -Standard variables such as -:term:`DEPENDS`, -:term:`RDEPENDS`, -:term:`RPROVIDES`, -:term:`RRECOMMENDS`, -:term:`PACKAGES`, and -:term:`PACKAGES_DYNAMIC` are -automatically extended by the system. If you are extending any manual -code in the recipe, you can use the ``${MLPREFIX}`` variable to ensure -those names are extended correctly. - -Using Multilib -~~~~~~~~~~~~~~ - -After you have set up the recipes, you need to define the actual -combination of multiple libraries you want to build. You accomplish this -through your ``local.conf`` configuration file in the -:term:`Build Directory`. An example -configuration would be as follows:: - - MACHINE = "qemux86-64" - require conf/multilib.conf - MULTILIBS = "multilib:lib32" - DEFAULTTUNE:virtclass-multilib-lib32 = "x86" - IMAGE_INSTALL:append = "lib32-glib-2.0" - -This example enables an additional library named -``lib32`` alongside the normal target packages. When combining these -"lib32" alternatives, the example uses "x86" for tuning. For information -on this particular tuning, see -``meta/conf/machine/include/ia32/arch-ia32.inc``. - -The example then includes ``lib32-glib-2.0`` in all the images, which -illustrates one method of including a multiple library dependency. You -can use a normal image build to include this dependency, for example:: - - $ bitbake core-image-sato - -You can also build Multilib packages -specifically with a command like this:: - - $ bitbake lib32-glib-2.0 - -Additional Implementation Details -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -There are generic implementation details as well as details that are specific to -package management systems. Following are implementation details -that exist regardless of the package management system: - -- The typical convention used for the class extension code as used by - Multilib assumes that all package names specified in - :term:`PACKAGES` that contain - ``${PN}`` have ``${PN}`` at the start of the name. When that - convention is not followed and ``${PN}`` appears at the middle or the - end of a name, problems occur. - -- The :term:`TARGET_VENDOR` - value under Multilib will be extended to "-vendormlmultilib" (e.g. - "-pokymllib32" for a "lib32" Multilib with Poky). The reason for this - slightly unwieldy contraction is that any "-" characters in the - vendor string presently break Autoconf's ``config.sub``, and other - separators are problematic for different reasons. - -Here are the implementation details for the RPM Package Management System: - -- A unique architecture is defined for the Multilib packages, along - with creating a unique deploy folder under ``tmp/deploy/rpm`` in the - :term:`Build Directory`. For - example, consider ``lib32`` in a ``qemux86-64`` image. The possible - architectures in the system are "all", "qemux86_64", - "lib32:qemux86_64", and "lib32:x86". - -- The ``${MLPREFIX}`` variable is stripped from ``${PN}`` during RPM - packaging. The naming for a normal RPM package and a Multilib RPM - package in a ``qemux86-64`` system resolves to something similar to - ``bash-4.1-r2.x86_64.rpm`` and ``bash-4.1.r2.lib32_x86.rpm``, - respectively. - -- When installing a Multilib image, the RPM backend first installs the - base image and then installs the Multilib libraries. - -- The build system relies on RPM to resolve the identical files in the - two (or more) Multilib packages. - -Here are the implementation details for the IPK Package Management System: - -- The ``${MLPREFIX}`` is not stripped from ``${PN}`` during IPK - packaging. The naming for a normal RPM package and a Multilib IPK - package in a ``qemux86-64`` system resolves to something like - ``bash_4.1-r2.x86_64.ipk`` and ``lib32-bash_4.1-rw:x86.ipk``, - respectively. - -- The IPK deploy folder is not modified with ``${MLPREFIX}`` because - packages with and without the Multilib feature can exist in the same - folder due to the ``${PN}`` differences. - -- IPK defines a sanity check for Multilib installation using certain - rules for file comparison, overridden, etc. - -Installing Multiple Versions of the Same Library ------------------------------------------------- - -There are be situations where you need to install and use multiple versions -of the same library on the same system at the same time. This -almost always happens when a library API changes and you have -multiple pieces of software that depend on the separate versions of the -library. To accommodate these situations, you can install multiple -versions of the same library in parallel on the same system. - -The process is straightforward as long as the libraries use proper -versioning. With properly versioned libraries, all you need to do to -individually specify the libraries is create separate, appropriately -named recipes where the :term:`PN` part of -the name includes a portion that differentiates each library version -(e.g. the major part of the version number). Thus, instead of having a -single recipe that loads one version of a library (e.g. ``clutter``), -you provide multiple recipes that result in different versions of the -libraries you want. As an example, the following two recipes would allow -the two separate versions of the ``clutter`` library to co-exist on the -same system: - -.. code-block:: none - - clutter-1.6_1.6.20.bb - clutter-1.8_1.8.4.bb - -Additionally, if -you have other recipes that depend on a given library, you need to use -the :term:`DEPENDS` variable to -create the dependency. Continuing with the same example, if you want to -have a recipe depend on the 1.8 version of the ``clutter`` library, use -the following in your recipe:: - - DEPENDS = "clutter-1.8" - -Using x32 psABI -=============== - -x32 processor-specific Application Binary Interface (`x32 -psABI <https://software.intel.com/en-us/node/628948>`__) is a native -32-bit processor-specific ABI for Intel 64 (x86-64) architectures. An -ABI defines the calling conventions between functions in a processing -environment. The interface determines what registers are used and what -the sizes are for various C data types. - -Some processing environments prefer using 32-bit applications even when -running on Intel 64-bit platforms. Consider the i386 psABI, which is a -very old 32-bit ABI for Intel 64-bit platforms. The i386 psABI does not -provide efficient use and access of the Intel 64-bit processor -resources, leaving the system underutilized. Now consider the x86_64 -psABI. This ABI is newer and uses 64-bits for data sizes and program -pointers. The extra bits increase the footprint size of the programs, -libraries, and also increases the memory and file system size -requirements. Executing under the x32 psABI enables user programs to -utilize CPU and system resources more efficiently while keeping the -memory footprint of the applications low. Extra bits are used for -registers but not for addressing mechanisms. - -The Yocto Project supports the final specifications of x32 psABI as -follows: - -- You can create packages and images in x32 psABI format on x86_64 - architecture targets. - -- You can successfully build recipes with the x32 toolchain. - -- You can create and boot ``core-image-minimal`` and - ``core-image-sato`` images. - -- There is RPM Package Manager (RPM) support for x32 binaries. - -- There is support for large images. - -To use the x32 psABI, you need to edit your ``conf/local.conf`` -configuration file as follows:: - - MACHINE = "qemux86-64" - DEFAULTTUNE = "x86-64-x32" - baselib = "${@d.getVar('BASE_LIB:tune-' + (d.getVar('DEFAULTTUNE') \ - or 'INVALID')) or 'lib'}" - -Once you have set -up your configuration file, use BitBake to build an image that supports -the x32 psABI. Here is an example:: - - $ bitbake core-image-sato - -Enabling GObject Introspection Support -====================================== - -`GObject introspection <https://gi.readthedocs.io/en/latest/>`__ -is the standard mechanism for accessing GObject-based software from -runtime environments. GObject is a feature of the GLib library that -provides an object framework for the GNOME desktop and related software. -GObject Introspection adds information to GObject that allows objects -created within it to be represented across different programming -languages. If you want to construct GStreamer pipelines using Python, or -control UPnP infrastructure using Javascript and GUPnP, GObject -introspection is the only way to do it. - -This section describes the Yocto Project support for generating and -packaging GObject introspection data. GObject introspection data is a -description of the API provided by libraries built on top of the GLib -framework, and, in particular, that framework's GObject mechanism. -GObject Introspection Repository (GIR) files go to ``-dev`` packages, -``typelib`` files go to main packages as they are packaged together with -libraries that are introspected. - -The data is generated when building such a library, by linking the -library with a small executable binary that asks the library to describe -itself, and then executing the binary and processing its output. - -Generating this data in a cross-compilation environment is difficult -because the library is produced for the target architecture, but its -code needs to be executed on the build host. This problem is solved with -the OpenEmbedded build system by running the code through QEMU, which -allows precisely that. Unfortunately, QEMU does not always work -perfectly as mentioned in the ":ref:`dev-manual/common-tasks:known issues`" -section. - -Enabling the Generation of Introspection Data ---------------------------------------------- - -Enabling the generation of introspection data (GIR files) in your -library package involves the following: - -1. Inherit the - :ref:`gobject-introspection <ref-classes-gobject-introspection>` - class. - -2. Make sure introspection is not disabled anywhere in the recipe or - from anything the recipe includes. Also, make sure that - "gobject-introspection-data" is not in - :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` - and that "qemu-usermode" is not in - :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. - In either of these conditions, nothing will happen. - -3. Try to build the recipe. If you encounter build errors that look like - something is unable to find ``.so`` libraries, check where these - libraries are located in the source tree and add the following to the - recipe:: - - GIR_EXTRA_LIBS_PATH = "${B}/something/.libs" - - .. note:: - - See recipes in the ``oe-core`` repository that use that - :term:`GIR_EXTRA_LIBS_PATH` variable as an example. - -4. Look for any other errors, which probably mean that introspection - support in a package is not entirely standard, and thus breaks down - in a cross-compilation environment. For such cases, custom-made fixes - are needed. A good place to ask and receive help in these cases is - the :ref:`Yocto Project mailing - lists <resources-mailinglist>`. - -.. note:: - - Using a library that no longer builds against the latest Yocto - Project release and prints introspection related errors is a good - candidate for the previous procedure. - -Disabling the Generation of Introspection Data ----------------------------------------------- - -You might find that you do not want to generate introspection data. Or, -perhaps QEMU does not work on your build host and target architecture -combination. If so, you can use either of the following methods to -disable GIR file generations: - -- Add the following to your distro configuration:: - - DISTRO_FEATURES_BACKFILL_CONSIDERED = "gobject-introspection-data" - - Adding this statement disables generating introspection data using - QEMU but will still enable building introspection tools and libraries - (i.e. building them does not require the use of QEMU). - -- Add the following to your machine configuration:: - - MACHINE_FEATURES_BACKFILL_CONSIDERED = "qemu-usermode" - - Adding this statement disables the use of QEMU when building packages for your - machine. Currently, this feature is used only by introspection - recipes and has the same effect as the previously described option. - - .. note:: - - Future releases of the Yocto Project might have other features - affected by this option. - -If you disable introspection data, you can still obtain it through other -means such as copying the data from a suitable sysroot, or by generating -it on the target hardware. The OpenEmbedded build system does not -currently provide specific support for these techniques. - -Testing that Introspection Works in an Image --------------------------------------------- - -Use the following procedure to test if generating introspection data is -working in an image: - -1. Make sure that "gobject-introspection-data" is not in - :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` - and that "qemu-usermode" is not in - :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. - -2. Build ``core-image-sato``. - -3. Launch a Terminal and then start Python in the terminal. - -4. Enter the following in the terminal:: - - >>> from gi.repository import GLib - >>> GLib.get_host_name() - -5. For something a little more advanced, enter the following see: - https://python-gtk-3-tutorial.readthedocs.io/en/latest/introduction.html - -Known Issues ------------- - -Here are know issues in GObject Introspection Support: - -- ``qemu-ppc64`` immediately crashes. Consequently, you cannot build - introspection data on that architecture. - -- x32 is not supported by QEMU. Consequently, introspection data is - disabled. - -- musl causes transient GLib binaries to crash on assertion failures. - Consequently, generating introspection data is disabled. - -- Because QEMU is not able to run the binaries correctly, introspection - is disabled for some specific packages under specific architectures - (e.g. ``gcr``, ``libsecret``, and ``webkit``). - -- QEMU usermode might not work properly when running 64-bit binaries - under 32-bit host machines. In particular, "qemumips64" is known to - not work under i686. - -Optionally Using an External Toolchain -====================================== - -You might want to use an external toolchain as part of your development. -If this is the case, the fundamental steps you need to accomplish are as -follows: - -- Understand where the installed toolchain resides. For cases where you - need to build the external toolchain, you would need to take separate - steps to build and install the toolchain. - -- Make sure you add the layer that contains the toolchain to your - ``bblayers.conf`` file through the - :term:`BBLAYERS` variable. - -- Set the ``EXTERNAL_TOOLCHAIN`` variable in your ``local.conf`` file - to the location in which you installed the toolchain. - -A good example of an external toolchain used with the Yocto Project is -Mentor Graphics Sourcery G++ Toolchain. You can see information on how -to use that particular layer in the ``README`` file at -https://github.com/MentorEmbedded/meta-sourcery/. You can find -further information by reading about the -:term:`TCMODE` variable in the Yocto -Project Reference Manual's variable glossary. - -Creating Partitioned Images Using Wic -===================================== - -Creating an image for a particular hardware target using the -OpenEmbedded build system does not necessarily mean you can boot that -image as is on your device. Physical devices accept and boot images in -various ways depending on the specifics of the device. Usually, -information about the hardware can tell you what image format the device -requires. Should your device require multiple partitions on an SD card, -flash, or an HDD, you can use the OpenEmbedded Image Creator, Wic, to -create the properly partitioned image. - -The ``wic`` command generates partitioned images from existing -OpenEmbedded build artifacts. Image generation is driven by partitioning -commands contained in an Openembedded kickstart file (``.wks``) -specified either directly on the command line or as one of a selection -of canned kickstart files as shown with the ``wic list images`` command -in the -":ref:`dev-manual/common-tasks:generate an image using an existing kickstart file`" -section. When you apply the command to a given set of build artifacts, the -result is an image or set of images that can be directly written onto media and -used on a particular system. - -.. note:: - - For a kickstart file reference, see the - ":ref:`ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference`" - Chapter in the Yocto Project Reference Manual. - -The ``wic`` command and the infrastructure it is based on is by -definition incomplete. The purpose of the command is to allow the -generation of customized images, and as such, was designed to be -completely extensible through a plugin interface. See the -":ref:`dev-manual/common-tasks:using the wic plugin interface`" section -for information on these plugins. - -This section provides some background information on Wic, describes what -you need to have in place to run the tool, provides instruction on how -to use the Wic utility, provides information on using the Wic plugins -interface, and provides several examples that show how to use Wic. - -Background ----------- - -This section provides some background on the Wic utility. While none of -this information is required to use Wic, you might find it interesting. - -- The name "Wic" is derived from OpenEmbedded Image Creator (oeic). The - "oe" diphthong in "oeic" was promoted to the letter "w", because - "oeic" is both difficult to remember and to pronounce. - -- Wic is loosely based on the Meego Image Creator (``mic``) framework. - The Wic implementation has been heavily modified to make direct use - of OpenEmbedded build artifacts instead of package installation and - configuration, which are already incorporated within the OpenEmbedded - artifacts. - -- Wic is a completely independent standalone utility that initially - provides easier-to-use and more flexible replacements for an existing - functionality in OE-Core's - :ref:`image-live <ref-classes-image-live>` - class. The difference between Wic and those examples is that with Wic - the functionality of those scripts is implemented by a - general-purpose partitioning language, which is based on Redhat - kickstart syntax. - -Requirements ------------- - -In order to use the Wic utility with the OpenEmbedded Build system, your -system needs to meet the following requirements: - -- The Linux distribution on your development host must support the - Yocto Project. See the ":ref:`detailed-supported-distros`" - section in the Yocto Project Reference Manual for the list of - distributions that support the Yocto Project. - -- The standard system utilities, such as ``cp``, must be installed on - your development host system. - -- You must have sourced the build environment setup script (i.e. - :ref:`structure-core-script`) found in the - :term:`Build Directory`. - -- You need to have the build artifacts already available, which - typically means that you must have already created an image using the - Openembedded build system (e.g. ``core-image-minimal``). While it - might seem redundant to generate an image in order to create an image - using Wic, the current version of Wic requires the artifacts in the - form generated by the OpenEmbedded build system. - -- You must build several native tools, which are built to run on the - build system:: - - $ bitbake parted-native dosfstools-native mtools-native - -- Include "wic" as part of the - :term:`IMAGE_FSTYPES` - variable. - -- Include the name of the :ref:`wic kickstart file <openembedded-kickstart-wks-reference>` - as part of the :term:`WKS_FILE` variable - -Getting Help ------------- - -You can get general help for the ``wic`` command by entering the ``wic`` -command by itself or by entering the command with a help argument as -follows:: - - $ wic -h - $ wic --help - $ wic help - -Currently, Wic supports seven commands: ``cp``, ``create``, ``help``, -``list``, ``ls``, ``rm``, and ``write``. You can get help for all these -commands except "help" by using the following form:: - - $ wic help command - -For example, the following command returns help for the ``write`` -command:: - - $ wic help write - -Wic supports help for three topics: ``overview``, ``plugins``, and -``kickstart``. You can get help for any topic using the following form:: - - $ wic help topic - -For example, the following returns overview help for Wic:: - - $ wic help overview - -There is one additional level of help for Wic. You can get help on -individual images through the ``list`` command. You can use the ``list`` -command to return the available Wic images as follows:: - - $ wic list images - genericx86 Create an EFI disk image for genericx86* - edgerouter Create SD card image for Edgerouter - beaglebone-yocto Create SD card image for Beaglebone - qemux86-directdisk Create a qemu machine 'pcbios' direct disk image - systemd-bootdisk Create an EFI disk image with systemd-boot - mkhybridiso Create a hybrid ISO image - mkefidisk Create an EFI disk image - sdimage-bootpart Create SD card image with a boot partition - directdisk-multi-rootfs Create multi rootfs image using rootfs plugin - directdisk Create a 'pcbios' direct disk image - directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config - qemuriscv Create qcow2 image for RISC-V QEMU machines - directdisk-gpt Create a 'pcbios' direct disk image - efi-bootdisk - -Once you know the list of available -Wic images, you can use ``help`` with the command to get help on a -particular image. For example, the following command returns help on the -"beaglebone-yocto" image:: - - $ wic list beaglebone-yocto help - - Creates a partitioned SD card image for Beaglebone. - Boot files are located in the first vfat partition. - -Operational Modes ------------------ - -You can use Wic in two different modes, depending on how much control -you need for specifying the Openembedded build artifacts that are used -for creating the image: Raw and Cooked: - -- *Raw Mode:* You explicitly specify build artifacts through Wic - command-line arguments. - -- *Cooked Mode:* The current - :term:`MACHINE` setting and image - name are used to automatically locate and provide the build - artifacts. You just supply a kickstart file and the name of the image - from which to use artifacts. - -Regardless of the mode you use, you need to have the build artifacts -ready and available. - -Raw Mode -~~~~~~~~ - -Running Wic in raw mode allows you to specify all the partitions through -the ``wic`` command line. The primary use for raw mode is if you have -built your kernel outside of the Yocto Project -:term:`Build Directory`. In other words, you -can point to arbitrary kernel, root filesystem locations, and so forth. -Contrast this behavior with cooked mode where Wic looks in the Build -Directory (e.g. ``tmp/deploy/images/``\ machine). - -The general form of the ``wic`` command in raw mode is:: - - $ wic create wks_file options ... - - Where: - - wks_file: - An OpenEmbedded kickstart file. You can provide - your own custom file or use a file from a set of - existing files as described by further options. - - optional arguments: - -h, --help show this help message and exit - -o OUTDIR, --outdir OUTDIR - name of directory to create image in - -e IMAGE_NAME, --image-name IMAGE_NAME - name of the image to use the artifacts from e.g. core- - image-sato - -r ROOTFS_DIR, --rootfs-dir ROOTFS_DIR - path to the /rootfs dir to use as the .wks rootfs - source - -b BOOTIMG_DIR, --bootimg-dir BOOTIMG_DIR - path to the dir containing the boot artifacts (e.g. - /EFI or /syslinux dirs) to use as the .wks bootimg - source - -k KERNEL_DIR, --kernel-dir KERNEL_DIR - path to the dir containing the kernel to use in the - .wks bootimg - -n NATIVE_SYSROOT, --native-sysroot NATIVE_SYSROOT - path to the native sysroot containing the tools to use - to build the image - -s, --skip-build-check - skip the build check - -f, --build-rootfs build rootfs - -c {gzip,bzip2,xz}, --compress-with {gzip,bzip2,xz} - compress image with specified compressor - -m, --bmap generate .bmap - --no-fstab-update Do not change fstab file. - -v VARS_DIR, --vars VARS_DIR - directory with <image>.env files that store bitbake - variables - -D, --debug output debug information - -.. note:: - - You do not need root privileges to run Wic. In fact, you should not - run as root when using the utility. - -Cooked Mode -~~~~~~~~~~~ - -Running Wic in cooked mode leverages off artifacts in the Build -Directory. In other words, you do not have to specify kernel or root -filesystem locations as part of the command. All you need to provide is -a kickstart file and the name of the image from which to use artifacts -by using the "-e" option. Wic looks in the Build Directory (e.g. -``tmp/deploy/images/``\ machine) for artifacts. - -The general form of the ``wic`` command using Cooked Mode is as follows:: - - $ wic create wks_file -e IMAGE_NAME - - Where: - - wks_file: - An OpenEmbedded kickstart file. You can provide - your own custom file or use a file from a set of - existing files provided with the Yocto Project - release. - - required argument: - -e IMAGE_NAME, --image-name IMAGE_NAME - name of the image to use the artifacts from e.g. core- - image-sato - -Using an Existing Kickstart File --------------------------------- - -If you do not want to create your own kickstart file, you can use an -existing file provided by the Wic installation. As shipped, kickstart -files can be found in the :ref:`overview-manual/development-environment:yocto project source repositories` in the -following two locations:: - - poky/meta-yocto-bsp/wic - poky/scripts/lib/wic/canned-wks - -Use the following command to list the available kickstart files:: - - $ wic list images - genericx86 Create an EFI disk image for genericx86* - beaglebone-yocto Create SD card image for Beaglebone - edgerouter Create SD card image for Edgerouter - qemux86-directdisk Create a QEMU machine 'pcbios' direct disk image - directdisk-gpt Create a 'pcbios' direct disk image - mkefidisk Create an EFI disk image - directdisk Create a 'pcbios' direct disk image - systemd-bootdisk Create an EFI disk image with systemd-boot - mkhybridiso Create a hybrid ISO image - sdimage-bootpart Create SD card image with a boot partition - directdisk-multi-rootfs Create multi rootfs image using rootfs plugin - directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config - -When you use an existing file, you -do not have to use the ``.wks`` extension. Here is an example in Raw -Mode that uses the ``directdisk`` file:: - - $ wic create directdisk -r rootfs_dir -b bootimg_dir \ - -k kernel_dir -n native_sysroot - -Here are the actual partition language commands used in the -``genericx86.wks`` file to generate an image:: - - # short-description: Create an EFI disk image for genericx86* - # long-description: Creates a partitioned EFI disk image for genericx86* machines - part /boot --source bootimg-efi --sourceparams="loader=grub-efi" --ondisk sda --label msdos --active --align 1024 - part / --source rootfs --ondisk sda --fstype=ext4 --label platform --align 1024 --use-uuid - part swap --ondisk sda --size 44 --label swap1 --fstype=swap - - bootloader --ptable gpt --timeout=5 --append="rootfstype=ext4 console=ttyS0,115200 console=tty0" - -Using the Wic Plugin Interface ------------------------------- - -You can extend and specialize Wic functionality by using Wic plugins. -This section explains the Wic plugin interface. - -.. note:: - - Wic plugins consist of "source" and "imager" plugins. Imager plugins - are beyond the scope of this section. - -Source plugins provide a mechanism to customize partition content during -the Wic image generation process. You can use source plugins to map -values that you specify using ``--source`` commands in kickstart files -(i.e. ``*.wks``) to a plugin implementation used to populate a given -partition. - -.. note:: - - If you use plugins that have build-time dependencies (e.g. native - tools, bootloaders, and so forth) when building a Wic image, you need - to specify those dependencies using the :term:`WKS_FILE_DEPENDS` - variable. - -Source plugins are subclasses defined in plugin files. As shipped, the -Yocto Project provides several plugin files. You can see the source -plugin files that ship with the Yocto Project -:yocto_git:`here </poky/tree/scripts/lib/wic/plugins/source>`. -Each of these plugin files contains source plugins that are designed to -populate a specific Wic image partition. - -Source plugins are subclasses of the ``SourcePlugin`` class, which is -defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example, -the ``BootimgEFIPlugin`` source plugin found in the ``bootimg-efi.py`` -file is a subclass of the ``SourcePlugin`` class, which is found in the -``pluginbase.py`` file. - -You can also implement source plugins in a layer outside of the Source -Repositories (external layer). To do so, be sure that your plugin files -are located in a directory whose path is -``scripts/lib/wic/plugins/source/`` within your external layer. When the -plugin files are located there, the source plugins they contain are made -available to Wic. - -When the Wic implementation needs to invoke a partition-specific -implementation, it looks for the plugin with the same name as the -``--source`` parameter used in the kickstart file given to that -partition. For example, if the partition is set up using the following -command in a kickstart file:: - - part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024 - -The methods defined as class -members of the matching source plugin (i.e. ``bootimg-pcbios``) in the -``bootimg-pcbios.py`` plugin file are used. - -To be more concrete, here is the corresponding plugin definition from -the ``bootimg-pcbios.py`` file for the previous command along with an -example method called by the Wic implementation when it needs to prepare -a partition using an implementation-specific function:: - - . - . - . - class BootimgPcbiosPlugin(SourcePlugin): - """ - Create MBR boot partition and install syslinux on it. - """ - - name = 'bootimg-pcbios' - . - . - . - @classmethod - def do_prepare_partition(cls, part, source_params, creator, cr_workdir, - oe_builddir, bootimg_dir, kernel_dir, - rootfs_dir, native_sysroot): - """ - Called to do the actual content population for a partition i.e. it - 'prepares' the partition to be incorporated into the image. - In this case, prepare content for legacy bios boot partition. - """ - . - . - . - -If a -subclass (plugin) itself does not implement a particular function, Wic -locates and uses the default version in the superclass. It is for this -reason that all source plugins are derived from the ``SourcePlugin`` -class. - -The ``SourcePlugin`` class defined in the ``pluginbase.py`` file defines -a set of methods that source plugins can implement or override. Any -plugins (subclass of ``SourcePlugin``) that do not implement a -particular method inherit the implementation of the method from the -``SourcePlugin`` class. For more information, see the ``SourcePlugin`` -class in the ``pluginbase.py`` file for details: - -The following list describes the methods implemented in the -``SourcePlugin`` class: - -- ``do_prepare_partition()``: Called to populate a partition with - actual content. In other words, the method prepares the final - partition image that is incorporated into the disk image. - -- ``do_configure_partition()``: Called before - ``do_prepare_partition()`` to create custom configuration files for a - partition (e.g. syslinux or grub configuration files). - -- ``do_install_disk()``: Called after all partitions have been - prepared and assembled into a disk image. This method provides a hook - to allow finalization of a disk image (e.g. writing an MBR). - -- ``do_stage_partition()``: Special content-staging hook called - before ``do_prepare_partition()``. This method is normally empty. - - Typically, a partition just uses the passed-in parameters (e.g. the - unmodified value of ``bootimg_dir``). However, in some cases, things - might need to be more tailored. As an example, certain files might - additionally need to be taken from ``bootimg_dir + /boot``. This hook - allows those files to be staged in a customized fashion. - - .. note:: - - ``get_bitbake_var()`` allows you to access non-standard variables that - you might want to use for this behavior. - -You can extend the source plugin mechanism. To add more hooks, create -more source plugin methods within ``SourcePlugin`` and the corresponding -derived subclasses. The code that calls the plugin methods uses the -``plugin.get_source_plugin_methods()`` function to find the method or -methods needed by the call. Retrieval of those methods is accomplished -by filling up a dict with keys that contain the method names of -interest. On success, these will be filled in with the actual methods. -See the Wic implementation for examples and details. - -Wic Examples ------------- - -This section provides several examples that show how to use the Wic -utility. All the examples assume the list of requirements in the -":ref:`dev-manual/common-tasks:requirements`" section have been met. The -examples assume the previously generated image is -``core-image-minimal``. - -Generate an Image using an Existing Kickstart File -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This example runs in Cooked Mode and uses the ``mkefidisk`` kickstart -file:: - - $ wic create mkefidisk -e core-image-minimal - INFO: Building wic-tools... - . - . - . - INFO: The new image(s) can be found here: - ./mkefidisk-201804191017-sda.direct - - The following build artifacts were used to create the image(s): - ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs - BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share - KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 - NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native - - INFO: The image(s) were created using OE kickstart file: - /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/mkefidisk.wks - -The previous example shows the easiest way to create an image by running -in cooked mode and supplying a kickstart file and the "-e" option to -point to the existing build artifacts. Your ``local.conf`` file needs to -have the :term:`MACHINE` variable set -to the machine you are using, which is "qemux86" in this example. - -Once the image builds, the output provides image location, artifact use, -and kickstart file information. - -.. note:: - - You should always verify the details provided in the output to make - sure that the image was indeed created exactly as expected. - -Continuing with the example, you can now write the image from the Build -Directory onto a USB stick, or whatever media for which you built your -image, and boot from the media. You can write the image by using -``bmaptool`` or ``dd``:: - - $ oe-run-native bmaptool copy mkefidisk-201804191017-sda.direct /dev/sdX - -or :: - - $ sudo dd if=mkefidisk-201804191017-sda.direct of=/dev/sdX - -.. note:: - - For more information on how to use the ``bmaptool`` - to flash a device with an image, see the - ":ref:`dev-manual/common-tasks:flashing images using \`\`bmaptool\`\``" - section. - -Using a Modified Kickstart File -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Because partitioned image creation is driven by the kickstart file, it -is easy to affect image creation by changing the parameters in the file. -This next example demonstrates that through modification of the -``directdisk-gpt`` kickstart file. - -As mentioned earlier, you can use the command ``wic list images`` to -show the list of existing kickstart files. The directory in which the -``directdisk-gpt.wks`` file resides is -``scripts/lib/image/canned-wks/``, which is located in the -:term:`Source Directory` (e.g. ``poky``). -Because available files reside in this directory, you can create and add -your own custom files to the directory. Subsequent use of the -``wic list images`` command would then include your kickstart files. - -In this example, the existing ``directdisk-gpt`` file already does most -of what is needed. However, for the hardware in this example, the image -will need to boot from ``sdb`` instead of ``sda``, which is what the -``directdisk-gpt`` kickstart file uses. - -The example begins by making a copy of the ``directdisk-gpt.wks`` file -in the ``scripts/lib/image/canned-wks`` directory and then by changing -the lines that specify the target disk from which to boot. -:: - - $ cp /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisk-gpt.wks \ - /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks - -Next, the example modifies the ``directdisksdb-gpt.wks`` file and -changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The -example changes the following two lines and leaves the remaining lines -untouched:: - - part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024 - part / --source rootfs --ondisk sdb --fstype=ext4 --label platform --align 1024 --use-uuid - -Once the lines are changed, the -example generates the ``directdisksdb-gpt`` image. The command points -the process at the ``core-image-minimal`` artifacts for the Next Unit of -Computing (nuc) :term:`MACHINE` the -``local.conf``. -:: - - $ wic create directdisksdb-gpt -e core-image-minimal - INFO: Building wic-tools... - . - . - . - Initialising tasks: 100% |#######################################| Time: 0:00:01 - NOTE: Executing SetScene Tasks - NOTE: Executing RunQueue Tasks - NOTE: Tasks Summary: Attempted 1161 tasks of which 1157 didn't need to be rerun and all succeeded. - INFO: Creating image(s)... - - INFO: The new image(s) can be found here: - ./directdisksdb-gpt-201710090938-sdb.direct - - The following build artifacts were used to create the image(s): - ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs - BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share - KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 - NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native - - INFO: The image(s) were created using OE kickstart file: - /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks - -Continuing with the example, you can now directly ``dd`` the image to a -USB stick, or whatever media for which you built your image, and boot -the resulting media:: - - $ sudo dd if=directdisksdb-gpt-201710090938-sdb.direct of=/dev/sdb - 140966+0 records in - 140966+0 records out - 72174592 bytes (72 MB, 69 MiB) copied, 78.0282 s, 925 kB/s - $ sudo eject /dev/sdb - -Using a Modified Kickstart File and Running in Raw Mode -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This next example manually specifies each build artifact (runs in Raw -Mode) and uses a modified kickstart file. The example also uses the -``-o`` option to cause Wic to create the output somewhere other than the -default output directory, which is the current directory:: - - $ wic create test.wks -o /home/stephano/testwic \ - --rootfs-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/rootfs \ - --bootimg-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share \ - --kernel-dir /home/stephano/yocto/build/tmp/deploy/images/qemux86 \ - --native-sysroot /home/stephano/yocto/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native - - INFO: Creating image(s)... - - INFO: The new image(s) can be found here: - /home/stephano/testwic/test-201710091445-sdb.direct - - The following build artifacts were used to create the image(s): - ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs - BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share - KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 - NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native - - INFO: The image(s) were created using OE kickstart file: - test.wks - -For this example, -:term:`MACHINE` did not have to be -specified in the ``local.conf`` file since the artifact is manually -specified. - -Using Wic to Manipulate an Image -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Wic image manipulation allows you to shorten turnaround time during -image development. For example, you can use Wic to delete the kernel -partition of a Wic image and then insert a newly built kernel. This -saves you time from having to rebuild the entire image each time you -modify the kernel. - -.. note:: - - In order to use Wic to manipulate a Wic image as in this example, - your development machine must have the ``mtools`` package installed. - -The following example examines the contents of the Wic image, deletes -the existing kernel, and then inserts a new kernel: - -1. *List the Partitions:* Use the ``wic ls`` command to list all the - partitions in the Wic image:: - - $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic - Num Start End Size Fstype - 1 1048576 25041919 23993344 fat16 - 2 25165824 72157183 46991360 ext4 - - The previous output shows two partitions in the - ``core-image-minimal-qemux86.wic`` image. - -2. *Examine a Particular Partition:* Use the ``wic ls`` command again - but in a different form to examine a particular partition. - - .. note:: - - You can get command usage on any Wic command using the following - form:: - - $ wic help command - - - For example, the following command shows you the various ways to - use the - wic ls - command:: - - $ wic help ls - - - The following command shows what is in partition one:: - - $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1 - Volume in drive : is boot - Volume Serial Number is E894-1809 - Directory for ::/ - - libcom32 c32 186500 2017-10-09 16:06 - libutil c32 24148 2017-10-09 16:06 - syslinux cfg 220 2017-10-09 16:06 - vesamenu c32 27104 2017-10-09 16:06 - vmlinuz 6904608 2017-10-09 16:06 - 5 files 7 142 580 bytes - 16 582 656 bytes free - - The previous output shows five files, with the - ``vmlinuz`` being the kernel. - - .. note:: - - If you see the following error, you need to update or create a - ``~/.mtoolsrc`` file and be sure to have the line "mtools_skip_check=1" - in the file. Then, run the Wic command again:: - - ERROR: _exec_cmd: /usr/bin/mdir -i /tmp/wic-parttfokuwra ::/ returned '1' instead of 0 - output: Total number of sectors (47824) not a multiple of sectors per track (32)! - Add mtools_skip_check=1 to your .mtoolsrc file to skip this test - - -3. *Remove the Old Kernel:* Use the ``wic rm`` command to remove the - ``vmlinuz`` file (kernel):: - - $ wic rm tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz - -4. *Add In the New Kernel:* Use the ``wic cp`` command to add the - updated kernel to the Wic image. Depending on how you built your - kernel, it could be in different places. If you used ``devtool`` and - an SDK to build your kernel, it resides in the ``tmp/work`` directory - of the extensible SDK. If you used ``make`` to build the kernel, the - kernel will be in the ``workspace/sources`` area. - - The following example assumes ``devtool`` was used to build the - kernel:: - - $ wic cp poky_sdk/tmp/work/qemux86-poky-linux/linux-yocto/4.12.12+git999-r0/linux-yocto-4.12.12+git999/arch/x86/boot/bzImage \ - poky/build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz - - Once the new kernel is added back into the image, you can use the - ``dd`` command or :ref:`bmaptool - <dev-manual/common-tasks:flashing images using \`\`bmaptool\`\`>` - to flash your wic image onto an SD card or USB stick and test your - target. - - .. note:: - - Using ``bmaptool`` is generally 10 to 20 times faster than using ``dd``. - -Flashing Images Using ``bmaptool`` -================================== - -A fast and easy way to flash an image to a bootable device is to use -Bmaptool, which is integrated into the OpenEmbedded build system. -Bmaptool is a generic tool that creates a file's block map (bmap) and -then uses that map to copy the file. As compared to traditional tools -such as dd or cp, Bmaptool can copy (or flash) large files like raw -system image files much faster. - -.. note:: - - - If you are using Ubuntu or Debian distributions, you can install - the ``bmap-tools`` package using the following command and then - use the tool without specifying ``PATH`` even from the root - account:: - - $ sudo apt install bmap-tools - - - If you are unable to install the ``bmap-tools`` package, you will - need to build Bmaptool before using it. Use the following command:: - - $ bitbake bmap-tools-native - -Following, is an example that shows how to flash a Wic image. Realize -that while this example uses a Wic image, you can use Bmaptool to flash -any type of image. Use these steps to flash an image using Bmaptool: - -1. *Update your local.conf File:* You need to have the following set - in your ``local.conf`` file before building your image:: - - IMAGE_FSTYPES += "wic wic.bmap" - -2. *Get Your Image:* Either have your image ready (pre-built with the - :term:`IMAGE_FSTYPES` - setting previously mentioned) or take the step to build the image:: - - $ bitbake image - -3. *Flash the Device:* Flash the device with the image by using Bmaptool - depending on your particular setup. The following commands assume the - image resides in the Build Directory's ``deploy/images/`` area: - - - If you have write access to the media, use this command form:: - - $ oe-run-native bmap-tools-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX - - - If you do not have write access to the media, set your permissions - first and then use the same command form:: - - $ sudo chmod 666 /dev/sdX - $ oe-run-native bmap-tools-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX - -For help on the ``bmaptool`` command, use the following command:: - - $ bmaptool --help - -Making Images More Secure -========================= - -Security is of increasing concern for embedded devices. Consider the -issues and problems discussed in just this sampling of work found across -the Internet: - -- *"*\ `Security Risks of Embedded - Systems <https://www.schneier.com/blog/archives/2014/01/security_risks_9.html>`__\ *"* - by Bruce Schneier - -- *"*\ `Internet Census - 2012 <http://census2012.sourceforge.net/paper.html>`__\ *"* by Carna - Botnet - -- *"*\ `Security Issues for Embedded - Devices <https://elinux.org/images/6/6f/Security-issues.pdf>`__\ *"* - by Jake Edge - -When securing your image is of concern, there are steps, tools, and -variables that you can consider to help you reach the security goals you -need for your particular device. Not all situations are identical when -it comes to making an image secure. Consequently, this section provides -some guidance and suggestions for consideration when you want to make -your image more secure. - -.. note:: - - Because the security requirements and risks are different for every - type of device, this section cannot provide a complete reference on - securing your custom OS. It is strongly recommended that you also - consult other sources of information on embedded Linux system - hardening and on security. - -General Considerations ----------------------- - -There are general considerations that help you create more secure images. -You should consider the following suggestions to make your device -more secure: - -- Scan additional code you are adding to the system (e.g. application - code) by using static analysis tools. Look for buffer overflows and - other potential security problems. - -- Pay particular attention to the security for any web-based - administration interface. - - Web interfaces typically need to perform administrative functions and - tend to need to run with elevated privileges. Thus, the consequences - resulting from the interface's security becoming compromised can be - serious. Look for common web vulnerabilities such as - cross-site-scripting (XSS), unvalidated inputs, and so forth. - - As with system passwords, the default credentials for accessing a - web-based interface should not be the same across all devices. This - is particularly true if the interface is enabled by default as it can - be assumed that many end-users will not change the credentials. - -- Ensure you can update the software on the device to mitigate - vulnerabilities discovered in the future. This consideration - especially applies when your device is network-enabled. - -- Ensure you remove or disable debugging functionality before producing - the final image. For information on how to do this, see the - ":ref:`dev-manual/common-tasks:considerations specific to the openembedded build system`" - section. - -- Ensure you have no network services listening that are not needed. - -- Remove any software from the image that is not needed. - -- Enable hardware support for secure boot functionality when your - device supports this functionality. - -Security Flags --------------- - -The Yocto Project has security flags that you can enable that help make -your build output more secure. The security flags are in the -``meta/conf/distro/include/security_flags.inc`` file in your -:term:`Source Directory` (e.g. ``poky``). - -.. note:: - - Depending on the recipe, certain security flags are enabled and - disabled by default. - -Use the following line in your ``local.conf`` file or in your custom -distribution configuration file to enable the security compiler and -linker flags for your build:: - - require conf/distro/include/security_flags.inc - -Considerations Specific to the OpenEmbedded Build System --------------------------------------------------------- - -You can take some steps that are specific to the OpenEmbedded build -system to make your images more secure: - -- Ensure "debug-tweaks" is not one of your selected - :term:`IMAGE_FEATURES`. - When creating a new project, the default is to provide you with an - initial ``local.conf`` file that enables this feature using the - :term:`EXTRA_IMAGE_FEATURES` - variable with the line:: - - EXTRA_IMAGE_FEATURES = "debug-tweaks" - - To disable that feature, simply comment out that line in your - ``local.conf`` file, or make sure :term:`IMAGE_FEATURES` does not contain - "debug-tweaks" before producing your final image. Among other things, - leaving this in place sets the root password as blank, which makes - logging in for debugging or inspection easy during development but - also means anyone can easily log in during production. - -- It is possible to set a root password for the image and also to set - passwords for any extra users you might add (e.g. administrative or - service type users). When you set up passwords for multiple images or - users, you should not duplicate passwords. - - To set up passwords, use the - :ref:`extrausers <ref-classes-extrausers>` - class, which is the preferred method. For an example on how to set up - both root and user passwords, see the - ":ref:`extrausers.bbclass <ref-classes-extrausers>`" - section. - - .. note:: - - When adding extra user accounts or setting a root password, be - cautious about setting the same password on every device. If you - do this, and the password you have set is exposed, then every - device is now potentially compromised. If you need this access but - want to ensure security, consider setting a different, random - password for each device. Typically, you do this as a separate - step after you deploy the image onto the device. - -- Consider enabling a Mandatory Access Control (MAC) framework such as - SMACK or SELinux and tuning it appropriately for your device's usage. - You can find more information in the - :yocto_git:`meta-selinux </meta-selinux/>` layer. - -Tools for Hardening Your Image ------------------------------- - -The Yocto Project provides tools for making your image more secure. You -can find these tools in the ``meta-security`` layer of the -:yocto_git:`Yocto Project Source Repositories <>`. - -Creating Your Own Distribution -============================== - -When you build an image using the Yocto Project and do not alter any -distribution :term:`Metadata`, you are -creating a Poky distribution. If you wish to gain more control over -package alternative selections, compile-time options, and other -low-level configurations, you can create your own distribution. - -To create your own distribution, the basic steps consist of creating -your own distribution layer, creating your own distribution -configuration file, and then adding any needed code and Metadata to the -layer. The following steps provide some more detail: - -- *Create a layer for your new distro:* Create your distribution layer - so that you can keep your Metadata and code for the distribution - separate. It is strongly recommended that you create and use your own - layer for configuration and code. Using your own layer as compared to - just placing configurations in a ``local.conf`` configuration file - makes it easier to reproduce the same build configuration when using - multiple build machines. See the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" - section for information on how to quickly set up a layer. - -- *Create the distribution configuration file:* The distribution - configuration file needs to be created in the ``conf/distro`` - directory of your layer. You need to name it using your distribution - name (e.g. ``mydistro.conf``). - - .. note:: - - The :term:`DISTRO` variable in your ``local.conf`` file determines the - name of your distribution. - - You can split out parts of your configuration file into include files - and then "require" them from within your distribution configuration - file. Be sure to place the include files in the - ``conf/distro/include`` directory of your layer. A common example - usage of include files would be to separate out the selection of - desired version and revisions for individual recipes. - - Your configuration file needs to set the following required - variables: - - - :term:`DISTRO_NAME` - - - :term:`DISTRO_VERSION` - - These following variables are optional and you typically set them - from the distribution configuration file: - - - :term:`DISTRO_FEATURES` - - - :term:`DISTRO_EXTRA_RDEPENDS` - - - :term:`DISTRO_EXTRA_RRECOMMENDS` - - - :term:`TCLIBC` - - .. tip:: - - If you want to base your distribution configuration file on the - very basic configuration from OE-Core, you can use - ``conf/distro/defaultsetup.conf`` as a reference and just include - variables that differ as compared to ``defaultsetup.conf``. - Alternatively, you can create a distribution configuration file - from scratch using the ``defaultsetup.conf`` file or configuration files - from other distributions such as Poky or Angstrom as references. - -- *Provide miscellaneous variables:* Be sure to define any other - variables for which you want to create a default or enforce as part - of the distribution configuration. You can include nearly any - variable from the ``local.conf`` file. The variables you use are not - limited to the list in the previous bulleted item. - -- *Point to Your distribution configuration file:* In your - ``local.conf`` file in the :term:`Build Directory`, - set your - :term:`DISTRO` variable to point to - your distribution's configuration file. For example, if your - distribution's configuration file is named ``mydistro.conf``, then - you point to it as follows:: - - DISTRO = "mydistro" - -- *Add more to the layer if necessary:* Use your layer to hold other - information needed for the distribution: - - - Add recipes for installing distro-specific configuration files - that are not already installed by another recipe. If you have - distro-specific configuration files that are included by an - existing recipe, you should add an append file (``.bbappend``) for - those. For general information and recommendations on how to add - recipes to your layer, see the - ":ref:`dev-manual/common-tasks:creating your own layer`" and - ":ref:`dev-manual/common-tasks:following best practices when creating layers`" - sections. - - - Add any image recipes that are specific to your distribution. - - - Add a ``psplash`` append file for a branded splash screen. For - information on append files, see the - ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" - section. - - - Add any other append files to make custom changes that are - specific to individual recipes. - -Creating a Custom Template Configuration Directory -================================================== - -If you are producing your own customized version of the build system for -use by other users, you might want to customize the message shown by the -setup script or you might want to change the template configuration -files (i.e. ``local.conf`` and ``bblayers.conf``) that are created in a -new build directory. - -The OpenEmbedded build system uses the environment variable -``TEMPLATECONF`` to locate the directory from which it gathers -configuration information that ultimately ends up in the -:term:`Build Directory` ``conf`` directory. -By default, ``TEMPLATECONF`` is set as follows in the ``poky`` -repository:: - - TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf} - -This is the -directory used by the build system to find templates from which to build -some key configuration files. If you look at this directory, you will -see the ``bblayers.conf.sample``, ``local.conf.sample``, and -``conf-notes.txt`` files. The build system uses these files to form the -respective ``bblayers.conf`` file, ``local.conf`` file, and display the -list of BitBake targets when running the setup script. - -To override these default configuration files with configurations you -want used within every new Build Directory, simply set the -``TEMPLATECONF`` variable to your directory. The ``TEMPLATECONF`` -variable is set in the ``.templateconf`` file, which is in the top-level -:term:`Source Directory` folder -(e.g. ``poky``). Edit the ``.templateconf`` so that it can locate your -directory. - -Best practices dictate that you should keep your template configuration -directory in your custom distribution layer. For example, suppose you -have a layer named ``meta-mylayer`` located in your home directory and -you want your template configuration directory named ``myconf``. -Changing the ``.templateconf`` as follows causes the OpenEmbedded build -system to look in your directory and base its configuration files on the -``*.sample`` configuration files it finds. The final configuration files -(i.e. ``local.conf`` and ``bblayers.conf`` ultimately still end up in -your Build Directory, but they are based on your ``*.sample`` files. -:: - - TEMPLATECONF=${TEMPLATECONF:-meta-mylayer/myconf} - -Aside from the ``*.sample`` configuration files, the ``conf-notes.txt`` -also resides in the default ``meta-poky/conf`` directory. The script -that sets up the build environment (i.e. -:ref:`structure-core-script`) uses this file to -display BitBake targets as part of the script output. Customizing this -``conf-notes.txt`` file is a good way to make sure your list of custom -targets appears as part of the script's output. - -Here is the default list of targets displayed as a result of running -either of the setup scripts:: - - You can now run 'bitbake <target>' - - Common targets are: - core-image-minimal - core-image-sato - meta-toolchain - meta-ide-support - -Changing the listed common targets is as easy as editing your version of -``conf-notes.txt`` in your custom template configuration directory and -making sure you have ``TEMPLATECONF`` set to your directory. - -Conserving Disk Space -===================== - -Conserving Disk Space During Builds ------------------------------------ - -To help conserve disk space during builds, you can add the following -statement to your project's ``local.conf`` configuration file found in -the :term:`Build Directory`:: - - INHERIT += "rm_work" - -Adding this statement deletes the work directory used for -building a recipe once the recipe is built. For more information on -"rm_work", see the -:ref:`rm_work <ref-classes-rm-work>` class in the -Yocto Project Reference Manual. - -Purging Duplicate Shared State Cache Files -------------------------------------------- - -After multiple build iterations, the Shared State (sstate) cache can contain -duplicate cache files for a given package, while only the most recent one -is likely to be reusable. The following command purges all but the -newest sstate cache file for each package:: - - sstate-cache-management.sh --remove-duplicated --cache-dir=build/sstate-cache - -This command will ask you to confirm the deletions it identifies. - -Note:: - - The duplicated sstate cache files of one package must have the same - architecture, which means that sstate cache files with multiple - architectures are not considered as duplicate. - -Run ``sstate-cache-management.sh`` for more details about this script. - -Working with Packages -===================== - -This section describes a few tasks that involve packages: - -- :ref:`dev-manual/common-tasks:excluding packages from an image` - -- :ref:`dev-manual/common-tasks:incrementing a package version` - -- :ref:`dev-manual/common-tasks:handling optional module packaging` - -- :ref:`dev-manual/common-tasks:using runtime package management` - -- :ref:`dev-manual/common-tasks:generating and using signed packages` - -- :ref:`Setting up and running package test - (ptest) <dev-manual/common-tasks:testing packages with ptest>` - -- :ref:`dev-manual/common-tasks:creating node package manager (npm) packages` - -- :ref:`dev-manual/common-tasks:adding custom metadata to packages` - -Excluding Packages from an Image --------------------------------- - -You might find it necessary to prevent specific packages from being -installed into an image. If so, you can use several variables to direct -the build system to essentially ignore installing recommended packages -or to not install a package at all. - -The following list introduces variables you can use to prevent packages -from being installed into your image. Each of these variables only works -with IPK and RPM package types, not for Debian packages. -Also, you can use these variables from your ``local.conf`` file -or attach them to a specific image recipe by using a recipe name -override. For more detail on the variables, see the descriptions in the -Yocto Project Reference Manual's glossary chapter. - -- :term:`BAD_RECOMMENDATIONS`: - Use this variable to specify "recommended-only" packages that you do - not want installed. - -- :term:`NO_RECOMMENDATIONS`: - Use this variable to prevent all "recommended-only" packages from - being installed. - -- :term:`PACKAGE_EXCLUDE`: - Use this variable to prevent specific packages from being installed - regardless of whether they are "recommended-only" or not. You need to - realize that the build process could fail with an error when you - prevent the installation of a package whose presence is required by - an installed package. - -Incrementing a Package Version ------------------------------- - -This section provides some background on how binary package versioning -is accomplished and presents some of the services, variables, and -terminology involved. - -In order to understand binary package versioning, you need to consider -the following: - -- Binary Package: The binary package that is eventually built and - installed into an image. - -- Binary Package Version: The binary package version is composed of two - components - a version and a revision. - - .. note:: - - Technically, a third component, the "epoch" (i.e. :term:`PE`) is involved - but this discussion for the most part ignores :term:`PE`. - - The version and revision are taken from the - :term:`PV` and - :term:`PR` variables, respectively. - -- :term:`PV`: The recipe version. :term:`PV` represents the version of the - software being packaged. Do not confuse :term:`PV` with the binary - package version. - -- :term:`PR`: The recipe revision. - -- :term:`SRCPV`: The OpenEmbedded - build system uses this string to help define the value of :term:`PV` when - the source code revision needs to be included in it. - -- :yocto_wiki:`PR Service </PR_Service>`: A - network-based service that helps automate keeping package feeds - compatible with existing package manager applications such as RPM, - APT, and OPKG. - -Whenever the binary package content changes, the binary package version -must change. Changing the binary package version is accomplished by -changing or "bumping" the :term:`PR` and/or :term:`PV` values. Increasing these -values occurs one of two ways: - -- Automatically using a Package Revision Service (PR Service). - -- Manually incrementing the :term:`PR` and/or :term:`PV` variables. - -Given a primary challenge of any build system and its users is how to -maintain a package feed that is compatible with existing package manager -applications such as RPM, APT, and OPKG, using an automated system is -much preferred over a manual system. In either system, the main -requirement is that binary package version numbering increases in a -linear fashion and that there is a number of version components that -support that linear progression. For information on how to ensure -package revisioning remains linear, see the -":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" -section. - -The following three sections provide related information on the PR -Service, the manual method for "bumping" :term:`PR` and/or :term:`PV`, and on -how to ensure binary package revisioning remains linear. - -Working With a PR Service -~~~~~~~~~~~~~~~~~~~~~~~~~ - -As mentioned, attempting to maintain revision numbers in the -:term:`Metadata` is error prone, inaccurate, -and causes problems for people submitting recipes. Conversely, the PR -Service automatically generates increasing numbers, particularly the -revision field, which removes the human element. - -.. note:: - - For additional information on using a PR Service, you can see the - :yocto_wiki:`PR Service </PR_Service>` wiki page. - -The Yocto Project uses variables in order of decreasing priority to -facilitate revision numbering (i.e. -:term:`PE`, -:term:`PV`, and -:term:`PR` for epoch, version, and -revision, respectively). The values are highly dependent on the policies -and procedures of a given distribution and package feed. - -Because the OpenEmbedded build system uses -":ref:`signatures <overview-manual/concepts:checksums (signatures)>`", which are -unique to a given build, the build system knows when to rebuild -packages. All the inputs into a given task are represented by a -signature, which can trigger a rebuild when different. Thus, the build -system itself does not rely on the :term:`PR`, :term:`PV`, and :term:`PE` numbers to -trigger a rebuild. The signatures, however, can be used to generate -these values. - -The PR Service works with both ``OEBasic`` and ``OEBasicHash`` -generators. The value of :term:`PR` bumps when the checksum changes and the -different generator mechanisms change signatures under different -circumstances. - -As implemented, the build system includes values from the PR Service -into the :term:`PR` field as an addition using the form "``.x``" so ``r0`` -becomes ``r0.1``, ``r0.2`` and so forth. This scheme allows existing -:term:`PR` values to be used for whatever reasons, which include manual -:term:`PR` bumps, should it be necessary. - -By default, the PR Service is not enabled or running. Thus, the packages -generated are just "self consistent". The build system adds and removes -packages and there are no guarantees about upgrade paths but images will -be consistent and correct with the latest changes. - -The simplest form for a PR Service is for a single host -development system that builds the package feed (building system). For -this scenario, you can enable a local PR Service by setting -:term:`PRSERV_HOST` in your -``local.conf`` file in the :term:`Build Directory`:: - - PRSERV_HOST = "localhost:0" - -Once the service is started, packages will automatically -get increasing :term:`PR` values and BitBake takes care of starting and -stopping the server. - -If you have a more complex setup where multiple host development systems -work against a common, shared package feed, you have a single PR Service -running and it is connected to each building system. For this scenario, -you need to start the PR Service using the ``bitbake-prserv`` command:: - - bitbake-prserv --host ip --port port --start - -In addition to -hand-starting the service, you need to update the ``local.conf`` file of -each building system as described earlier so each system points to the -server and port. - -It is also recommended you use build history, which adds some sanity -checks to binary package versions, in conjunction with the server that -is running the PR Service. To enable build history, add the following to -each building system's ``local.conf`` file:: - - # It is recommended to activate "buildhistory" for testing the PR service - INHERIT += "buildhistory" - BUILDHISTORY_COMMIT = "1" - -For information on build -history, see the -":ref:`dev-manual/common-tasks:maintaining build output quality`" section. - -.. note:: - - The OpenEmbedded build system does not maintain :term:`PR` information as - part of the shared state (sstate) packages. If you maintain an sstate - feed, it's expected that either all your building systems that - contribute to the sstate feed use a shared PR Service, or you do not - run a PR Service on any of your building systems. Having some systems - use a PR Service while others do not leads to obvious problems. - - For more information on shared state, see the - ":ref:`overview-manual/concepts:shared state cache`" - section in the Yocto Project Overview and Concepts Manual. - -Manually Bumping PR -~~~~~~~~~~~~~~~~~~~ - -The alternative to setting up a PR Service is to manually "bump" the -:term:`PR` variable. - -If a committed change results in changing the package output, then the -value of the PR variable needs to be increased (or "bumped") as part of -that commit. For new recipes you should add the :term:`PR` variable and set -its initial value equal to "r0", which is the default. Even though the -default value is "r0", the practice of adding it to a new recipe makes -it harder to forget to bump the variable when you make changes to the -recipe in future. - -If you are sharing a common ``.inc`` file with multiple recipes, you can -also use the :term:`INC_PR` variable to ensure that the recipes sharing the -``.inc`` file are rebuilt when the ``.inc`` file itself is changed. The -``.inc`` file must set :term:`INC_PR` (initially to "r0"), and all recipes -referring to it should set :term:`PR` to "${INC_PR}.0" initially, -incrementing the last number when the recipe is changed. If the ``.inc`` -file is changed then its :term:`INC_PR` should be incremented. - -When upgrading the version of a binary package, assuming the :term:`PV` -changes, the :term:`PR` variable should be reset to "r0" (or "${INC_PR}.0" -if you are using :term:`INC_PR`). - -Usually, version increases occur only to binary packages. However, if -for some reason :term:`PV` changes but does not increase, you can increase -the :term:`PE` variable (Package Epoch). The :term:`PE` variable defaults to -"0". - -Binary package version numbering strives to follow the `Debian Version -Field Policy -Guidelines <https://www.debian.org/doc/debian-policy/ch-controlfields.html>`__. -These guidelines define how versions are compared and what "increasing" -a version means. - -Automatically Incrementing a Package Version Number -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When fetching a repository, BitBake uses the -:term:`SRCREV` variable to determine -the specific source code revision from which to build. You set the -:term:`SRCREV` variable to -:term:`AUTOREV` to cause the -OpenEmbedded build system to automatically use the latest revision of -the software:: - - SRCREV = "${AUTOREV}" - -Furthermore, you need to reference :term:`SRCPV` in :term:`PV` in order to -automatically update the version whenever the revision of the source -code changes. Here is an example:: - - PV = "1.0+git${SRCPV}" - -The OpenEmbedded build system substitutes :term:`SRCPV` with the following: - -.. code-block:: none - - AUTOINC+source_code_revision - -The build system replaces the ``AUTOINC`` -with a number. The number used depends on the state of the PR Service: - -- If PR Service is enabled, the build system increments the number, - which is similar to the behavior of - :term:`PR`. This behavior results in - linearly increasing package versions, which is desirable. Here is an - example: - - .. code-block:: none - - hello-world-git_0.0+git0+b6558dd387-r0.0_armv7a-neon.ipk - hello-world-git_0.0+git1+dd2f5c3565-r0.0_armv7a-neon.ipk - -- If PR Service is not enabled, the build system replaces the - ``AUTOINC`` placeholder with zero (i.e. "0"). This results in - changing the package version since the source revision is included. - However, package versions are not increased linearly. Here is an - example: - - .. code-block:: none - - hello-world-git_0.0+git0+b6558dd387-r0.0_armv7a-neon.ipk - hello-world-git_0.0+git0+dd2f5c3565-r0.0_armv7a-neon.ipk - -In summary, the OpenEmbedded build system does not track the history of -binary package versions for this purpose. ``AUTOINC``, in this case, is -comparable to :term:`PR`. If PR server is not enabled, ``AUTOINC`` in the -package version is simply replaced by "0". If PR server is enabled, the -build system keeps track of the package versions and bumps the number -when the package revision changes. - -Handling Optional Module Packaging ----------------------------------- - -Many pieces of software split functionality into optional modules (or -plugins) and the plugins that are built might depend on configuration -options. To avoid having to duplicate the logic that determines what -modules are available in your recipe or to avoid having to package each -module by hand, the OpenEmbedded build system provides functionality to -handle module packaging dynamically. - -To handle optional module packaging, you need to do two things: - -- Ensure the module packaging is actually done. - -- Ensure that any dependencies on optional modules from other recipes - are satisfied by your recipe. - -Making Sure the Packaging is Done -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To ensure the module packaging actually gets done, you use the -``do_split_packages`` function within the ``populate_packages`` Python -function in your recipe. The ``do_split_packages`` function searches for -a pattern of files or directories under a specified path and creates a -package for each one it finds by appending to the -:term:`PACKAGES` variable and -setting the appropriate values for ``FILES:packagename``, -``RDEPENDS:packagename``, ``DESCRIPTION:packagename``, and so forth. -Here is an example from the ``lighttpd`` recipe:: - - python populate_packages:prepend () { - lighttpd_libdir = d.expand('${libdir}') - do_split_packages(d, lighttpd_libdir, '^mod_(.*).so$', - 'lighttpd-module-%s', 'Lighttpd module for %s', - extra_depends='') - } - -The previous example specifies a number of things in the call to -``do_split_packages``. - -- A directory within the files installed by your recipe through - ``do_install`` in which to search. - -- A regular expression used to match module files in that directory. In - the example, note the parentheses () that mark the part of the - expression from which the module name should be derived. - -- A pattern to use for the package names. - -- A description for each package. - -- An empty string for ``extra_depends``, which disables the default - dependency on the main ``lighttpd`` package. Thus, if a file in - ``${libdir}`` called ``mod_alias.so`` is found, a package called - ``lighttpd-module-alias`` is created for it and the - :term:`DESCRIPTION` is set to - "Lighttpd module for alias". - -Often, packaging modules is as simple as the previous example. However, -there are more advanced options that you can use within -``do_split_packages`` to modify its behavior. And, if you need to, you -can add more logic by specifying a hook function that is called for each -package. It is also perfectly acceptable to call ``do_split_packages`` -multiple times if you have more than one set of modules to package. - -For more examples that show how to use ``do_split_packages``, see the -``connman.inc`` file in the ``meta/recipes-connectivity/connman/`` -directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can -also find examples in ``meta/classes/kernel.bbclass``. - -Following is a reference that shows ``do_split_packages`` mandatory and -optional arguments:: - - Mandatory arguments - - root - The path in which to search - file_regex - Regular expression to match searched files. - Use parentheses () to mark the part of this - expression that should be used to derive the - module name (to be substituted where %s is - used in other function arguments as noted below) - output_pattern - Pattern to use for the package names. Must - include %s. - description - Description to set for each package. Must - include %s. - - Optional arguments - - postinst - Postinstall script to use for all packages - (as a string) - recursive - True to perform a recursive search - default - False - hook - A hook function to be called for every match. - The function will be called with the following - arguments (in the order listed): - - f - Full path to the file/directory match - pkg - The package name - file_regex - As above - output_pattern - As above - modulename - The module name derived using file_regex - extra_depends - Extra runtime dependencies (RDEPENDS) to be - set for all packages. The default value of None - causes a dependency on the main package - (${PN}) - if you do not want this, pass empty - string '' for this parameter. - aux_files_pattern - Extra item(s) to be added to FILES for each - package. Can be a single string item or a list - of strings for multiple items. Must include %s. - postrm - postrm script to use for all packages (as a - string) - allow_dirs - True to allow directories to be matched - - default False - prepend - If True, prepend created packages to PACKAGES - instead of the default False which appends them - match_path - match file_regex on the whole relative path to - the root rather than just the filename - aux_files_pattern_verbatim - Extra item(s) to be added to FILES for each - package, using the actual derived module name - rather than converting it to something legal - for a package name. Can be a single string item - or a list of strings for multiple items. Must - include %s. - allow_links - True to allow symlinks to be matched - default - False - summary - Summary to set for each package. Must include %s; - defaults to description if not set. - - - -Satisfying Dependencies -~~~~~~~~~~~~~~~~~~~~~~~ - -The second part for handling optional module packaging is to ensure that -any dependencies on optional modules from other recipes are satisfied by -your recipe. You can be sure these dependencies are satisfied by using -the :term:`PACKAGES_DYNAMIC` -variable. Here is an example that continues with the ``lighttpd`` recipe -shown earlier:: - - PACKAGES_DYNAMIC = "lighttpd-module-.*" - -The name -specified in the regular expression can of course be anything. In this -example, it is ``lighttpd-module-`` and is specified as the prefix to -ensure that any :term:`RDEPENDS` and -:term:`RRECOMMENDS` on a package -name starting with the prefix are satisfied during build time. If you -are using ``do_split_packages`` as described in the previous section, -the value you put in :term:`PACKAGES_DYNAMIC` should correspond to the name -pattern specified in the call to ``do_split_packages``. - -Using Runtime Package Management --------------------------------- - -During a build, BitBake always transforms a recipe into one or more -packages. For example, BitBake takes the ``bash`` recipe and produces a -number of packages (e.g. ``bash``, ``bash-bashbug``, -``bash-completion``, ``bash-completion-dbg``, ``bash-completion-dev``, -``bash-completion-extra``, ``bash-dbg``, and so forth). Not all -generated packages are included in an image. - -In several situations, you might need to update, add, remove, or query -the packages on a target device at runtime (i.e. without having to -generate a new image). Examples of such situations include: - -- You want to provide in-the-field updates to deployed devices (e.g. - security updates). - -- You want to have a fast turn-around development cycle for one or more - applications that run on your device. - -- You want to temporarily install the "debug" packages of various - applications on your device so that debugging can be greatly improved - by allowing access to symbols and source debugging. - -- You want to deploy a more minimal package selection of your device - but allow in-the-field updates to add a larger selection for - customization. - -In all these situations, you have something similar to a more -traditional Linux distribution in that in-field devices are able to -receive pre-compiled packages from a server for installation or update. -Being able to install these packages on a running, in-field device is -what is termed "runtime package management". - -In order to use runtime package management, you need a host or server -machine that serves up the pre-compiled packages plus the required -metadata. You also need package manipulation tools on the target. The -build machine is a likely candidate to act as the server. However, that -machine does not necessarily have to be the package server. The build -machine could push its artifacts to another machine that acts as the -server (e.g. Internet-facing). In fact, doing so is advantageous for a -production environment as getting the packages away from the development -system's build directory prevents accidental overwrites. - -A simple build that targets just one device produces more than one -package database. In other words, the packages produced by a build are -separated out into a couple of different package groupings based on -criteria such as the target's CPU architecture, the target board, or the -C library used on the target. For example, a build targeting the -``qemux86`` device produces the following three package databases: -``noarch``, ``i586``, and ``qemux86``. If you wanted your ``qemux86`` -device to be aware of all the packages that were available to it, you -would need to point it to each of these databases individually. In a -similar way, a traditional Linux distribution usually is configured to -be aware of a number of software repositories from which it retrieves -packages. - -Using runtime package management is completely optional and not required -for a successful build or deployment in any way. But if you want to make -use of runtime package management, you need to do a couple things above -and beyond the basics. The remainder of this section describes what you -need to do. - -Build Considerations -~~~~~~~~~~~~~~~~~~~~ - -This section describes build considerations of which you need to be -aware in order to provide support for runtime package management. - -When BitBake generates packages, it needs to know what format or formats -to use. In your configuration, you use the -:term:`PACKAGE_CLASSES` -variable to specify the format: - -1. Open the ``local.conf`` file inside your - :term:`Build Directory` (e.g. - ``poky/build/conf/local.conf``). - -2. Select the desired package format as follows:: - - PACKAGE_CLASSES ?= "package_packageformat" - - where packageformat can be "ipk", "rpm", - "deb", or "tar" which are the supported package formats. - - .. note:: - - Because the Yocto Project supports four different package formats, - you can set the variable with more than one argument. However, the - OpenEmbedded build system only uses the first argument when - creating an image or Software Development Kit (SDK). - -If you would like your image to start off with a basic package database -containing the packages in your current build as well as to have the -relevant tools available on the target for runtime package management, -you can include "package-management" in the -:term:`IMAGE_FEATURES` -variable. Including "package-management" in this configuration variable -ensures that when the image is assembled for your target, the image -includes the currently-known package databases as well as the -target-specific tools required for runtime package management to be -performed on the target. However, this is not strictly necessary. You -could start your image off without any databases but only include the -required on-target package tool(s). As an example, you could include -"opkg" in your -:term:`IMAGE_INSTALL` variable -if you are using the IPK package format. You can then initialize your -target's package database(s) later once your image is up and running. - -Whenever you perform any sort of build step that can potentially -generate a package or modify existing package, it is always a good idea -to re-generate the package index after the build by using the following -command:: - - $ bitbake package-index - -It might be tempting to build the -package and the package index at the same time with a command such as -the following:: - - $ bitbake some-package package-index - -Do not do this as -BitBake does not schedule the package index for after the completion of -the package you are building. Consequently, you cannot be sure of the -package index including information for the package you just built. -Thus, be sure to run the package update step separately after building -any packages. - -You can use the -:term:`PACKAGE_FEED_ARCHS`, -:term:`PACKAGE_FEED_BASE_PATHS`, -and -:term:`PACKAGE_FEED_URIS` -variables to pre-configure target images to use a package feed. If you -do not define these variables, then manual steps as described in the -subsequent sections are necessary to configure the target. You should -set these variables before building the image in order to produce a -correctly configured image. - -When your build is complete, your packages reside in the -``${TMPDIR}/deploy/packageformat`` directory. For example, if -``${``\ :term:`TMPDIR`\ ``}`` is -``tmp`` and your selected package type is RPM, then your RPM packages -are available in ``tmp/deploy/rpm``. - -Host or Server Machine Setup -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Although other protocols are possible, a server using HTTP typically -serves packages. If you want to use HTTP, then set up and configure a -web server such as Apache 2, lighttpd, or Python web server on the -machine serving the packages. - -To keep things simple, this section describes how to set up a -Python web server to share package feeds from the developer's -machine. Although this server might not be the best for a production -environment, the setup is simple and straight forward. Should you want -to use a different server more suited for production (e.g. Apache 2, -Lighttpd, or Nginx), take the appropriate steps to do so. - -From within the build directory where you have built an image based on -your packaging choice (i.e. the -:term:`PACKAGE_CLASSES` -setting), simply start the server. The following example assumes a build -directory of ``poky/build/tmp/deploy/rpm`` and a :term:`PACKAGE_CLASSES` -setting of "package_rpm":: - - $ cd poky/build/tmp/deploy/rpm - $ python3 -m http.server - -Target Setup -~~~~~~~~~~~~ - -Setting up the target differs depending on the package management -system. This section provides information for RPM, IPK, and DEB. - -Using RPM -^^^^^^^^^ - -The `Dandified Packaging -Tool <https://en.wikipedia.org/wiki/DNF_(software)>`__ (DNF) performs -runtime package management of RPM packages. In order to use DNF for -runtime package management, you must perform an initial setup on the -target machine for cases where the ``PACKAGE_FEED_*`` variables were not -set as part of the image that is running on the target. This means if -you built your image and did not use these variables as part of the -build and your image is now running on the target, you need to perform -the steps in this section if you want to use runtime package management. - -.. note:: - - For information on the ``PACKAGE_FEED_*`` variables, see - :term:`PACKAGE_FEED_ARCHS`, :term:`PACKAGE_FEED_BASE_PATHS`, and - :term:`PACKAGE_FEED_URIS` in the Yocto Project Reference Manual variables - glossary. - -On the target, you must inform DNF that package databases are available. -You do this by creating a file named -``/etc/yum.repos.d/oe-packages.repo`` and defining the ``oe-packages``. - -As an example, assume the target is able to use the following package -databases: ``all``, ``i586``, and ``qemux86`` from a server named -``my.server``. The specifics for setting up the web server are up to -you. The critical requirement is that the URIs in the target repository -configuration point to the correct remote location for the feeds. - -.. note:: - - For development purposes, you can point the web server to the build - system's ``deploy`` directory. However, for production use, it is better to - copy the package directories to a location outside of the build area and use - that location. Doing so avoids situations where the build system - overwrites or changes the ``deploy`` directory. - -When telling DNF where to look for the package databases, you must -declare individual locations per architecture or a single location used -for all architectures. You cannot do both: - -- *Create an Explicit List of Architectures:* Define individual base - URLs to identify where each package database is located: - - .. code-block:: none - - [oe-packages] - baseurl=http://my.server/rpm/i586 http://my.server/rpm/qemux86 http://my.server/rpm/all - - This example - informs DNF about individual package databases for all three - architectures. - -- *Create a Single (Full) Package Index:* Define a single base URL that - identifies where a full package database is located:: - - [oe-packages] - baseurl=http://my.server/rpm - - This example informs DNF about a single - package database that contains all the package index information for - all supported architectures. - -Once you have informed DNF where to find the package databases, you need -to fetch them: - -.. code-block:: none - - # dnf makecache - -DNF is now able to find, install, and -upgrade packages from the specified repository or repositories. - -.. note:: - - See the `DNF documentation <https://dnf.readthedocs.io/en/latest/>`__ for - additional information. - -Using IPK -^^^^^^^^^ - -The ``opkg`` application performs runtime package management of IPK -packages. You must perform an initial setup for ``opkg`` on the target -machine if the -:term:`PACKAGE_FEED_ARCHS`, -:term:`PACKAGE_FEED_BASE_PATHS`, -and -:term:`PACKAGE_FEED_URIS` -variables have not been set or the target image was built before the -variables were set. - -The ``opkg`` application uses configuration files to find available -package databases. Thus, you need to create a configuration file inside -the ``/etc/opkg/`` direction, which informs ``opkg`` of any repository -you want to use. - -As an example, suppose you are serving packages from a ``ipk/`` -directory containing the ``i586``, ``all``, and ``qemux86`` databases -through an HTTP server named ``my.server``. On the target, create a -configuration file (e.g. ``my_repo.conf``) inside the ``/etc/opkg/`` -directory containing the following: - -.. code-block:: none - - src/gz all http://my.server/ipk/all - src/gz i586 http://my.server/ipk/i586 - src/gz qemux86 http://my.server/ipk/qemux86 - -Next, instruct ``opkg`` to fetch the -repository information: - -.. code-block:: none - - # opkg update - -The ``opkg`` application is now able to find, install, and upgrade packages -from the specified repository. - -Using DEB -^^^^^^^^^ - -The ``apt`` application performs runtime package management of DEB -packages. This application uses a source list file to find available -package databases. You must perform an initial setup for ``apt`` on the -target machine if the -:term:`PACKAGE_FEED_ARCHS`, -:term:`PACKAGE_FEED_BASE_PATHS`, -and -:term:`PACKAGE_FEED_URIS` -variables have not been set or the target image was built before the -variables were set. - -To inform ``apt`` of the repository you want to use, you might create a -list file (e.g. ``my_repo.list``) inside the -``/etc/apt/sources.list.d/`` directory. As an example, suppose you are -serving packages from a ``deb/`` directory containing the ``i586``, -``all``, and ``qemux86`` databases through an HTTP server named -``my.server``. The list file should contain: - -.. code-block:: none - - deb http://my.server/deb/all ./ - deb http://my.server/deb/i586 ./ - deb http://my.server/deb/qemux86 ./ - -Next, instruct the ``apt`` application -to fetch the repository information: - -.. code-block:: none - - $ sudo apt update - -After this step, -``apt`` is able to find, install, and upgrade packages from the -specified repository. - -Generating and Using Signed Packages ------------------------------------- - -In order to add security to RPM packages used during a build, you can -take steps to securely sign them. Once a signature is verified, the -OpenEmbedded build system can use the package in the build. If security -fails for a signed package, the build system stops the build. - -This section describes how to sign RPM packages during a build and how -to use signed package feeds (repositories) when doing a build. - -Signing RPM Packages -~~~~~~~~~~~~~~~~~~~~ - -To enable signing RPM packages, you must set up the following -configurations in either your ``local.config`` or ``distro.config`` -file:: - - # Inherit sign_rpm.bbclass to enable signing functionality - INHERIT += " sign_rpm" - # Define the GPG key that will be used for signing. - RPM_GPG_NAME = "key_name" - # Provide passphrase for the key - RPM_GPG_PASSPHRASE = "passphrase" - -.. note:: - - Be sure to supply appropriate values for both `key_name` and - `passphrase`. - -Aside from the ``RPM_GPG_NAME`` and ``RPM_GPG_PASSPHRASE`` variables in -the previous example, two optional variables related to signing are available: - -- *GPG_BIN:* Specifies a ``gpg`` binary/wrapper that is executed - when the package is signed. - -- *GPG_PATH:* Specifies the ``gpg`` home directory used when the - package is signed. - -Processing Package Feeds -~~~~~~~~~~~~~~~~~~~~~~~~ - -In addition to being able to sign RPM packages, you can also enable -signed package feeds for IPK and RPM packages. - -The steps you need to take to enable signed package feed use are similar -to the steps used to sign RPM packages. You must define the following in -your ``local.config`` or ``distro.config`` file:: - - INHERIT += "sign_package_feed" - PACKAGE_FEED_GPG_NAME = "key_name" - PACKAGE_FEED_GPG_PASSPHRASE_FILE = "path_to_file_containing_passphrase" - -For signed package feeds, the passphrase must be specified in a separate file, -which is pointed to by the ``PACKAGE_FEED_GPG_PASSPHRASE_FILE`` -variable. Regarding security, keeping a plain text passphrase out of the -configuration is more secure. - -Aside from the ``PACKAGE_FEED_GPG_NAME`` and -``PACKAGE_FEED_GPG_PASSPHRASE_FILE`` variables, three optional variables -related to signed package feeds are available: - -- *GPG_BIN* Specifies a ``gpg`` binary/wrapper that is executed - when the package is signed. - -- *GPG_PATH:* Specifies the ``gpg`` home directory used when the - package is signed. - -- *PACKAGE_FEED_GPG_SIGNATURE_TYPE:* Specifies the type of ``gpg`` - signature. This variable applies only to RPM and IPK package feeds. - Allowable values for the ``PACKAGE_FEED_GPG_SIGNATURE_TYPE`` are - "ASC", which is the default and specifies ascii armored, and "BIN", - which specifies binary. - -Testing Packages With ptest ---------------------------- - -A Package Test (ptest) runs tests against packages built by the -OpenEmbedded build system on the target machine. A ptest contains at -least two items: the actual test, and a shell script (``run-ptest``) -that starts the test. The shell script that starts the test must not -contain the actual test - the script only starts the test. On the other -hand, the test can be anything from a simple shell script that runs a -binary and checks the output to an elaborate system of test binaries and -data files. - -The test generates output in the format used by Automake:: - - result: testname - -where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and -the testname can be any identifying string. - -For a list of Yocto Project recipes that are already enabled with ptest, -see the :yocto_wiki:`Ptest </Ptest>` wiki page. - -.. note:: - - A recipe is "ptest-enabled" if it inherits the - :ref:`ptest <ref-classes-ptest>` class. - -Adding ptest to Your Build -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To add package testing to your build, add the -:term:`DISTRO_FEATURES` and -:term:`EXTRA_IMAGE_FEATURES` -variables to your ``local.conf`` file, which is found in the -:term:`Build Directory`:: - - DISTRO_FEATURES:append = " ptest" - EXTRA_IMAGE_FEATURES += "ptest-pkgs" - -Once your build is complete, the ptest files are installed into the -``/usr/lib/package/ptest`` directory within the image, where ``package`` -is the name of the package. - -Running ptest -~~~~~~~~~~~~~ - -The ``ptest-runner`` package installs a shell script that loops through -all installed ptest test suites and runs them in sequence. Consequently, -you might want to add this package to your image. - -Getting Your Package Ready -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In order to enable a recipe to run installed ptests on target hardware, -you need to prepare the recipes that build the packages you want to -test. Here is what you have to do for each recipe: - -- *Be sure the recipe inherits - the* :ref:`ptest <ref-classes-ptest>` *class:* - Include the following line in each recipe:: - - inherit ptest - -- *Create run-ptest:* This script starts your test. Locate the - script where you will refer to it using - :term:`SRC_URI`. Here is an - example that starts a test for ``dbus``:: - - #!/bin/sh - cd test - make -k runtest-TESTS - -- *Ensure dependencies are met:* If the test adds build or runtime - dependencies that normally do not exist for the package (such as - requiring "make" to run the test suite), use the - :term:`DEPENDS` and - :term:`RDEPENDS` variables in - your recipe in order for the package to meet the dependencies. Here - is an example where the package has a runtime dependency on "make":: - - RDEPENDS:${PN}-ptest += "make" - -- *Add a function to build the test suite:* Not many packages support - cross-compilation of their test suites. Consequently, you usually - need to add a cross-compilation function to the package. - - Many packages based on Automake compile and run the test suite by - using a single command such as ``make check``. However, the host - ``make check`` builds and runs on the same computer, while - cross-compiling requires that the package is built on the host but - executed for the target architecture (though often, as in the case - for ptest, the execution occurs on the host). The built version of - Automake that ships with the Yocto Project includes a patch that - separates building and execution. Consequently, packages that use the - unaltered, patched version of ``make check`` automatically - cross-compiles. - - Regardless, you still must add a ``do_compile_ptest`` function to - build the test suite. Add a function similar to the following to your - recipe:: - - do_compile_ptest() { - oe_runmake buildtest-TESTS - } - -- *Ensure special configurations are set:* If the package requires - special configurations prior to compiling the test code, you must - insert a ``do_configure_ptest`` function into the recipe. - -- *Install the test suite:* The ``ptest`` class automatically copies - the file ``run-ptest`` to the target and then runs make - ``install-ptest`` to run the tests. If this is not enough, you need - to create a ``do_install_ptest`` function and make sure it gets - called after the "make install-ptest" completes. - -Creating Node Package Manager (NPM) Packages --------------------------------------------- - -`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package -manager for the JavaScript programming language. The Yocto Project -supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can -use this fetcher in combination with -:doc:`devtool </ref-manual/devtool-reference>` to create -recipes that produce NPM packages. - -There are two workflows that allow you to create NPM packages using -``devtool``: the NPM registry modules method and the NPM project code -method. - -.. note:: - - While it is possible to create NPM recipes manually, using - ``devtool`` is far simpler. - -Additionally, some requirements and caveats exist. - -Requirements and Caveats -~~~~~~~~~~~~~~~~~~~~~~~~ - -You need to be aware of the following before using ``devtool`` to create -NPM packages: - -- Of the two methods that you can use ``devtool`` to create NPM - packages, the registry approach is slightly simpler. However, you - might consider the project approach because you do not have to - publish your module in the NPM registry - (`npm-registry <https://docs.npmjs.com/misc/registry>`_), which - is NPM's public registry. - -- Be familiar with - :doc:`devtool </ref-manual/devtool-reference>`. - -- The NPM host tools need the native ``nodejs-npm`` package, which is - part of the OpenEmbedded environment. You need to get the package by - cloning the https://github.com/openembedded/meta-openembedded - repository out of GitHub. Be sure to add the path to your local copy - to your ``bblayers.conf`` file. - -- ``devtool`` cannot detect native libraries in module dependencies. - Consequently, you must manually add packages to your recipe. - -- While deploying NPM packages, ``devtool`` cannot determine which - dependent packages are missing on the target (e.g. the node runtime - ``nodejs``). Consequently, you need to find out what files are - missing and be sure they are on the target. - -- Although you might not need NPM to run your node package, it is - useful to have NPM on your target. The NPM package name is - ``nodejs-npm``. - -Using the Registry Modules Method -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section presents an example that uses the ``cute-files`` module, -which is a file browser web application. - -.. note:: - - You must know the ``cute-files`` module version. - -The first thing you need to do is use ``devtool`` and the NPM fetcher to -create the recipe:: - - $ devtool add "npm://registry.npmjs.org;package=cute-files;version=1.0.2" - -The -``devtool add`` command runs ``recipetool create`` and uses the same -fetch URI to download each dependency and capture license details where -possible. The result is a generated recipe. - -The recipe file is fairly simple and contains every license that -``recipetool`` finds and includes the licenses in the recipe's -:term:`LIC_FILES_CHKSUM` -variables. You need to examine the variables and look for those with -"unknown" in the :term:`LICENSE` -field. You need to track down the license information for "unknown" -modules and manually add the information to the recipe. - -``recipetool`` creates a "shrinkwrap" file for your recipe. Shrinkwrap -files capture the version of all dependent modules. Many packages do not -provide shrinkwrap files. ``recipetool`` create a shrinkwrap file as it -runs. - -.. note:: - - A package is created for each sub-module. This policy is the only - practical way to have the licenses for all of the dependencies - represented in the license manifest of the image. - -The ``devtool edit-recipe`` command lets you take a look at the recipe:: - - $ devtool edit-recipe cute-files - SUMMARY = "Turn any folder on your computer into a cute file browser, available on the local network." - LICENSE = "MIT & ISC & Unknown" - LIC_FILES_CHKSUM = "file://LICENSE;md5=71d98c0a1db42956787b1909c74a86ca \ - file://node_modules/toidentifier/LICENSE;md5=1a261071a044d02eb6f2bb47f51a3502 \ - file://node_modules/debug/LICENSE;md5=ddd815a475e7338b0be7a14d8ee35a99 \ - ... - SRC_URI = " \ - npm://registry.npmjs.org/;package=cute-files;version=${PV} \ - npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \ - " - S = "${WORKDIR}/npm" - inherit npm - LICENSE:${PN} = "MIT" - LICENSE:${PN}-accepts = "MIT" - LICENSE:${PN}-array-flatten = "MIT" - ... - LICENSE:${PN}-vary = "MIT" - -Here are three key points in the previous example: - -- :term:`SRC_URI` uses the NPM - scheme so that the NPM fetcher is used. - -- ``recipetool`` collects all the license information. If a - sub-module's license is unavailable, the sub-module's name appears in - the comments. - -- The ``inherit npm`` statement causes the - :ref:`npm <ref-classes-npm>` class to package - up all the modules. - -You can run the following command to build the ``cute-files`` package:: - - $ devtool build cute-files - -Remember that ``nodejs`` must be installed on -the target before your package. - -Assuming 192.168.7.2 for the target's IP address, use the following -command to deploy your package:: - - $ devtool deploy-target -s cute-files root@192.168.7.2 - -Once the package is installed on the target, you can -test the application: - -.. note:: - - Because of a known issue, you cannot simply run ``cute-files`` as you would - if you had run ``npm install``. - -:: - - $ cd /usr/lib/node_modules/cute-files - $ node cute-files.js - -On a browser, -go to ``http://192.168.7.2:3000`` and you see the following: - -.. image:: figures/cute-files-npm-example.png - :align: center - -You can find the recipe in ``workspace/recipes/cute-files``. You can use -the recipe in any layer you choose. - -Using the NPM Projects Code Method -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Although it is useful to package modules already in the NPM registry, -adding ``node.js`` projects under development is a more common developer -use case. - -This section covers the NPM projects code method, which is very similar -to the "registry" approach described in the previous section. In the NPM -projects method, you provide ``devtool`` with an URL that points to the -source files. - -Replicating the same example, (i.e. ``cute-files``) use the following -command:: - - $ devtool add https://github.com/martinaglv/cute-files.git - -The -recipe this command generates is very similar to the recipe created in -the previous section. However, the :term:`SRC_URI` looks like the following:: - - SRC_URI = " \ - git://github.com/martinaglv/cute-files.git;protocol=https \ - npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \ - " - -In this example, -the main module is taken from the Git repository and dependencies are -taken from the NPM registry. Other than those differences, the recipe is -basically the same between the two methods. You can build and deploy the -package exactly as described in the previous section that uses the -registry modules method. - -Adding custom metadata to packages ----------------------------------- - -The variable -:term:`PACKAGE_ADD_METADATA` -can be used to add additional metadata to packages. This is reflected in -the package control/spec file. To take the ipk format for example, the -CONTROL file stored inside would contain the additional metadata as -additional lines. - -The variable can be used in multiple ways, including using suffixes to -set it for a specific package type and/or package. Note that the order -of precedence is the same as this list: - -- ``PACKAGE_ADD_METADATA_<PKGTYPE>:<PN>`` - -- ``PACKAGE_ADD_METADATA_<PKGTYPE>`` - -- ``PACKAGE_ADD_METADATA:<PN>`` - -- :term:`PACKAGE_ADD_METADATA` - -`<PKGTYPE>` is a parameter and expected to be a distinct name of specific -package type: - -- IPK for .ipk packages - -- DEB for .deb packages - -- RPM for .rpm packages - -`<PN>` is a parameter and expected to be a package name. - -The variable can contain multiple [one-line] metadata fields separated -by the literal sequence '\\n'. The separator can be redefined using the -variable flag ``separator``. - -Here is an example that adds two custom fields for ipk -packages:: - - PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup:Applications/Spreadsheets" - -Efficiently Fetching Source Files During a Build -================================================ - -The OpenEmbedded build system works with source files located through -the :term:`SRC_URI` variable. When -you build something using BitBake, a big part of the operation is -locating and downloading all the source tarballs. For images, -downloading all the source for various packages can take a significant -amount of time. - -This section shows you how you can use mirrors to speed up fetching -source files and how you can pre-fetch files all of which leads to more -efficient use of resources and time. - -Setting up Effective Mirrors ----------------------------- - -A good deal that goes into a Yocto Project build is simply downloading -all of the source tarballs. Maybe you have been working with another -build system (OpenEmbedded or Angstrom) for which you have built up a -sizable directory of source tarballs. Or, perhaps someone else has such -a directory for which you have read access. If so, you can save time by -adding statements to your configuration file so that the build process -checks local directories first for existing tarballs before checking the -Internet. - -Here is an efficient way to set it up in your ``local.conf`` file:: - - SOURCE_MIRROR_URL ?= "file:///home/you/your-download-dir/" - INHERIT += "own-mirrors" - BB_GENERATE_MIRROR_TARBALLS = "1" - # BB_NO_NETWORK = "1" - -In the previous example, the -:term:`BB_GENERATE_MIRROR_TARBALLS` -variable causes the OpenEmbedded build system to generate tarballs of -the Git repositories and store them in the -:term:`DL_DIR` directory. Due to -performance reasons, generating and storing these tarballs is not the -build system's default behavior. - -You can also use the -:term:`PREMIRRORS` variable. For -an example, see the variable's glossary entry in the Yocto Project -Reference Manual. - -Getting Source Files and Suppressing the Build ----------------------------------------------- - -Another technique you can use to ready yourself for a successive string -of build operations, is to pre-fetch all the source files without -actually starting a build. This technique lets you work through any -download issues and ultimately gathers all the source files into your -download directory :ref:`structure-build-downloads`, -which is located with :term:`DL_DIR`. - -Use the following BitBake command form to fetch all the necessary -sources without starting the build:: - - $ bitbake target --runall=fetch - -This -variation of the BitBake command guarantees that you have all the -sources for that BitBake target should you disconnect from the Internet -and want to do the build later offline. - -Selecting an Initialization Manager -=================================== - -By default, the Yocto Project uses SysVinit as the initialization -manager. However, there is also support for systemd, which is a full -replacement for init with parallel starting of services, reduced shell -overhead and other features that are used by many distributions. - -Within the system, SysVinit treats system components as services. These -services are maintained as shell scripts stored in the ``/etc/init.d/`` -directory. Services organize into different run levels. This -organization is maintained by putting links to the services in the -``/etc/rcN.d/`` directories, where `N/` is one of the following options: -"S", "0", "1", "2", "3", "4", "5", or "6". - -.. note:: - - Each runlevel has a dependency on the previous runlevel. This - dependency allows the services to work properly. - -In comparison, systemd treats components as units. Using units is a -broader concept as compared to using a service. A unit includes several -different types of entities. Service is one of the types of entities. -The runlevel concept in SysVinit corresponds to the concept of a target -in systemd, where target is also a type of supported unit. - -In a SysVinit-based system, services load sequentially (i.e. one by one) -during init and parallelization is not supported. With systemd, services -start in parallel. Needless to say, the method can have an impact on -system startup performance. - -If you want to use SysVinit, you do not have to do anything. But, if you -want to use systemd, you must take some steps as described in the -following sections. - -Using systemd Exclusively -------------------------- - -Set these variables in your distribution configuration file as follows:: - - DISTRO_FEATURES:append = " systemd" - VIRTUAL-RUNTIME_init_manager = "systemd" - -You can also prevent the SysVinit distribution feature from -being automatically enabled as follows:: - - DISTRO_FEATURES_BACKFILL_CONSIDERED = "sysvinit" - -Doing so removes any -redundant SysVinit scripts. - -To remove initscripts from your image altogether, set this variable -also:: - - VIRTUAL-RUNTIME_initscripts = "" - -For information on the backfill variable, see -:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`. - -Using systemd for the Main Image and Using SysVinit for the Rescue Image ------------------------------------------------------------------------- - -Set these variables in your distribution configuration file as follows:: - - DISTRO_FEATURES:append = " systemd" - VIRTUAL-RUNTIME_init_manager = "systemd" - -Doing so causes your main image to use the -``packagegroup-core-boot.bb`` recipe and systemd. The rescue/minimal -image cannot use this package group. However, it can install SysVinit -and the appropriate packages will have support for both systemd and -SysVinit. - -Selecting a Device Manager -========================== - -The Yocto Project provides multiple ways to manage the device manager -(``/dev``): - -- Persistent and Pre-Populated ``/dev``: For this case, the ``/dev`` - directory is persistent and the required device nodes are created - during the build. - -- Use ``devtmpfs`` with a Device Manager: For this case, the ``/dev`` - directory is provided by the kernel as an in-memory file system and - is automatically populated by the kernel at runtime. Additional - configuration of device nodes is done in user space by a device - manager like ``udev`` or ``busybox-mdev``. - -Using Persistent and Pre-Populated ``/dev`` --------------------------------------------- - -To use the static method for device population, you need to set the -:term:`USE_DEVFS` variable to "0" -as follows:: - - USE_DEVFS = "0" - -The content of the resulting ``/dev`` directory is defined in a Device -Table file. The -:term:`IMAGE_DEVICE_TABLES` -variable defines the Device Table to use and should be set in the -machine or distro configuration file. Alternatively, you can set this -variable in your ``local.conf`` configuration file. - -If you do not define the :term:`IMAGE_DEVICE_TABLES` variable, the default -``device_table-minimal.txt`` is used:: - - IMAGE_DEVICE_TABLES = "device_table-mymachine.txt" - -The population is handled by the ``makedevs`` utility during image -creation: - -Using ``devtmpfs`` and a Device Manager ---------------------------------------- - -To use the dynamic method for device population, you need to use (or be -sure to set) the :term:`USE_DEVFS` -variable to "1", which is the default:: - - USE_DEVFS = "1" - -With this -setting, the resulting ``/dev`` directory is populated by the kernel -using ``devtmpfs``. Make sure the corresponding kernel configuration -variable ``CONFIG_DEVTMPFS`` is set when building you build a Linux -kernel. - -All devices created by ``devtmpfs`` will be owned by ``root`` and have -permissions ``0600``. - -To have more control over the device nodes, you can use a device manager -like ``udev`` or ``busybox-mdev``. You choose the device manager by -defining the ``VIRTUAL-RUNTIME_dev_manager`` variable in your machine or -distro configuration file. Alternatively, you can set this variable in -your ``local.conf`` configuration file:: - - VIRTUAL-RUNTIME_dev_manager = "udev" - - # Some alternative values - # VIRTUAL-RUNTIME_dev_manager = "busybox-mdev" - # VIRTUAL-RUNTIME_dev_manager = "systemd" - -Using an External SCM -===================== - -If you're working on a recipe that pulls from an external Source Code -Manager (SCM), it is possible to have the OpenEmbedded build system -notice new recipe changes added to the SCM and then build the resulting -packages that depend on the new recipes by using the latest versions. -This only works for SCMs from which it is possible to get a sensible -revision number for changes. Currently, you can do this with Apache -Subversion (SVN), Git, and Bazaar (BZR) repositories. - -To enable this behavior, the :term:`PV` of -the recipe needs to reference -:term:`SRCPV`. Here is an example:: - - PV = "1.2.3+git${SRCPV}" - -Then, you can add the following to your -``local.conf``:: - - SRCREV:pn-PN = "${AUTOREV}" - -:term:`PN` is the name of the recipe for -which you want to enable automatic source revision updating. - -If you do not want to update your local configuration file, you can add -the following directly to the recipe to finish enabling the feature:: - - SRCREV = "${AUTOREV}" - -The Yocto Project provides a distribution named ``poky-bleeding``, whose -configuration file contains the line:: - - require conf/distro/include/poky-floating-revisions.inc - -This line pulls in the -listed include file that contains numerous lines of exactly that form:: - - #SRCREV:pn-opkg-native ?= "${AUTOREV}" - #SRCREV:pn-opkg-sdk ?= "${AUTOREV}" - #SRCREV:pn-opkg ?= "${AUTOREV}" - #SRCREV:pn-opkg-utils-native ?= "${AUTOREV}" - #SRCREV:pn-opkg-utils ?= "${AUTOREV}" - SRCREV:pn-gconf-dbus ?= "${AUTOREV}" - SRCREV:pn-matchbox-common ?= "${AUTOREV}" - SRCREV:pn-matchbox-config-gtk ?= "${AUTOREV}" - SRCREV:pn-matchbox-desktop ?= "${AUTOREV}" - SRCREV:pn-matchbox-keyboard ?= "${AUTOREV}" - SRCREV:pn-matchbox-panel-2 ?= "${AUTOREV}" - SRCREV:pn-matchbox-themes-extra ?= "${AUTOREV}" - SRCREV:pn-matchbox-terminal ?= "${AUTOREV}" - SRCREV:pn-matchbox-wm ?= "${AUTOREV}" - SRCREV:pn-settings-daemon ?= "${AUTOREV}" - SRCREV:pn-screenshot ?= "${AUTOREV}" - . . . - -These lines allow you to -experiment with building a distribution that tracks the latest -development source for numerous packages. - -.. note:: - - The ``poky-bleeding`` distribution is not tested on a regular basis. Keep - this in mind if you use it. - -Creating a Read-Only Root Filesystem -==================================== - -Suppose, for security reasons, you need to disable your target device's -root filesystem's write permissions (i.e. you need a read-only root -filesystem). Or, perhaps you are running the device's operating system -from a read-only storage device. For either case, you can customize your -image for that behavior. - -.. note:: - - Supporting a read-only root filesystem requires that the system and - applications do not try to write to the root filesystem. You must - configure all parts of the target system to write elsewhere, or to - gracefully fail in the event of attempting to write to the root - filesystem. - -Creating the Root Filesystem ----------------------------- - -To create the read-only root filesystem, simply add the -"read-only-rootfs" feature to your image, normally in one of two ways. -The first way is to add the "read-only-rootfs" image feature in the -image's recipe file via the :term:`IMAGE_FEATURES` variable:: - - IMAGE_FEATURES += "read-only-rootfs" - -As an alternative, you can add the same feature -from within your build directory's ``local.conf`` file with the -associated :term:`EXTRA_IMAGE_FEATURES` variable, as in:: - - EXTRA_IMAGE_FEATURES = "read-only-rootfs" - -For more information on how to use these variables, see the -":ref:`dev-manual/common-tasks:Customizing Images Using Custom \`\`IMAGE_FEATURES\`\` and \`\`EXTRA_IMAGE_FEATURES\`\``" -section. For information on the variables, see -:term:`IMAGE_FEATURES` and -:term:`EXTRA_IMAGE_FEATURES`. - -Post-Installation Scripts and Read-Only Root Filesystem -------------------------------------------------------- - -It is very important that you make sure all post-Installation -(``pkg_postinst``) scripts for packages that are installed into the -image can be run at the time when the root filesystem is created during -the build on the host system. These scripts cannot attempt to run during -the first boot on the target device. With the "read-only-rootfs" feature -enabled, the build system makes sure that all post-installation scripts -succeed at file system creation time. If any of these scripts -still need to be run after the root filesystem is created, the build -immediately fails. These build-time checks ensure that the build fails -rather than the target device fails later during its initial boot -operation. - -Most of the common post-installation scripts generated by the build -system for the out-of-the-box Yocto Project are engineered so that they -can run during root filesystem creation (e.g. post-installation scripts -for caching fonts). However, if you create and add custom scripts, you -need to be sure they can be run during this file system creation. - -Here are some common problems that prevent post-installation scripts -from running during root filesystem creation: - -- *Not using $D in front of absolute paths:* The build system defines - ``$``\ :term:`D` when the root - filesystem is created. Furthermore, ``$D`` is blank when the script - is run on the target device. This implies two purposes for ``$D``: - ensuring paths are valid in both the host and target environments, - and checking to determine which environment is being used as a method - for taking appropriate actions. - -- *Attempting to run processes that are specific to or dependent on the - target architecture:* You can work around these attempts by using - native tools, which run on the host system, to accomplish the same - tasks, or by alternatively running the processes under QEMU, which - has the ``qemu_run_binary`` function. For more information, see the - :ref:`qemu <ref-classes-qemu>` class. - -Areas With Write Access ------------------------ - -With the "read-only-rootfs" feature enabled, any attempt by the target -to write to the root filesystem at runtime fails. Consequently, you must -make sure that you configure processes and applications that attempt -these types of writes do so to directories with write access (e.g. -``/tmp`` or ``/var/run``). - -Maintaining Build Output Quality -================================ - -Many factors can influence the quality of a build. For example, if you -upgrade a recipe to use a new version of an upstream software package or -you experiment with some new configuration options, subtle changes can -occur that you might not detect until later. Consider the case where -your recipe is using a newer version of an upstream package. In this -case, a new version of a piece of software might introduce an optional -dependency on another library, which is auto-detected. If that library -has already been built when the software is building, the software will -link to the built library and that library will be pulled into your -image along with the new software even if you did not want the library. - -The :ref:`buildhistory <ref-classes-buildhistory>` -class helps you maintain the quality of your build output. You -can use the class to highlight unexpected and possibly unwanted changes -in the build output. When you enable build history, it records -information about the contents of each package and image and then -commits that information to a local Git repository where you can examine -the information. - -The remainder of this section describes the following: - -- :ref:`How you can enable and disable build history <dev-manual/common-tasks:enabling and disabling build history>` - -- :ref:`How to understand what the build history contains <dev-manual/common-tasks:understanding what the build history contains>` - -- :ref:`How to limit the information used for build history <dev-manual/common-tasks:using build history to gather image information only>` - -- :ref:`How to examine the build history from both a command-line and web interface <dev-manual/common-tasks:examining build history information>` - -Enabling and Disabling Build History ------------------------------------- - -Build history is disabled by default. To enable it, add the following -:term:`INHERIT` statement and set the -:term:`BUILDHISTORY_COMMIT` -variable to "1" at the end of your ``conf/local.conf`` file found in the -:term:`Build Directory`:: - - INHERIT += "buildhistory" - BUILDHISTORY_COMMIT = "1" - -Enabling build history as -previously described causes the OpenEmbedded build system to collect -build output information and commit it as a single commit to a local -:ref:`overview-manual/development-environment:git` repository. - -.. note:: - - Enabling build history increases your build times slightly, - particularly for images, and increases the amount of disk space used - during the build. - -You can disable build history by removing the previous statements from -your ``conf/local.conf`` file. - -Understanding What the Build History Contains ---------------------------------------------- - -Build history information is kept in -``${``\ :term:`TOPDIR`\ ``}/buildhistory`` -in the Build Directory as defined by the -:term:`BUILDHISTORY_DIR` -variable. Here is an example abbreviated listing: - -.. image:: figures/buildhistory.png - :align: center - -At the top level, there is a ``metadata-revs`` file that lists the -revisions of the repositories for the enabled layers when the build was -produced. The rest of the data splits into separate ``packages``, -``images`` and ``sdk`` directories, the contents of which are described -as follows. - -Build History Package Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The history for each package contains a text file that has name-value -pairs with information about the package. For example, -``buildhistory/packages/i586-poky-linux/busybox/busybox/latest`` -contains the following: - -.. code-block:: none - - PV = 1.22.1 - PR = r32 - RPROVIDES = - RDEPENDS = glibc (>= 2.20) update-alternatives-opkg - RRECOMMENDS = busybox-syslog busybox-udhcpc update-rc.d - PKGSIZE = 540168 - FILES = /usr/bin/* /usr/sbin/* /usr/lib/busybox/* /usr/lib/lib*.so.* \ - /etc /com /var /bin/* /sbin/* /lib/*.so.* /lib/udev/rules.d \ - /usr/lib/udev/rules.d /usr/share/busybox /usr/lib/busybox/* \ - /usr/share/pixmaps /usr/share/applications /usr/share/idl \ - /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers - FILELIST = /bin/busybox /bin/busybox.nosuid /bin/busybox.suid /bin/sh \ - /etc/busybox.links.nosuid /etc/busybox.links.suid - -Most of these -name-value pairs correspond to variables used to produce the package. -The exceptions are ``FILELIST``, which is the actual list of files in -the package, and ``PKGSIZE``, which is the total size of files in the -package in bytes. - -There is also a file that corresponds to the recipe from which the package -came (e.g. ``buildhistory/packages/i586-poky-linux/busybox/latest``): - -.. code-block:: none - - PV = 1.22.1 - PR = r32 - DEPENDS = initscripts kern-tools-native update-rc.d-native \ - virtual/i586-poky-linux-compilerlibs virtual/i586-poky-linux-gcc \ - virtual/libc virtual/update-alternatives - PACKAGES = busybox-ptest busybox-httpd busybox-udhcpd busybox-udhcpc \ - busybox-syslog busybox-mdev busybox-hwclock busybox-dbg \ - busybox-staticdev busybox-dev busybox-doc busybox-locale busybox - -Finally, for those recipes fetched from a version control system (e.g., -Git), there is a file that lists source revisions that are specified in -the recipe and the actual revisions used during the build. Listed -and actual revisions might differ when -:term:`SRCREV` is set to -${:term:`AUTOREV`}. Here is an -example assuming -``buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev``):: - - # SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" - SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" - # SRCREV_meta = "a227f20eff056e511d504b2e490f3774ab260d6f" - SRCREV_meta ="a227f20eff056e511d504b2e490f3774ab260d6f" - -You can use the -``buildhistory-collect-srcrevs`` command with the ``-a`` option to -collect the stored :term:`SRCREV` values from build history and report them -in a format suitable for use in global configuration (e.g., -``local.conf`` or a distro include file) to override floating -:term:`AUTOREV` values to a fixed set of revisions. Here is some example -output from this command:: - - $ buildhistory-collect-srcrevs -a - # i586-poky-linux - SRCREV:pn-glibc = "b8079dd0d360648e4e8de48656c5c38972621072" - SRCREV:pn-glibc-initial = "b8079dd0d360648e4e8de48656c5c38972621072" - SRCREV:pn-opkg-utils = "53274f087565fd45d8452c5367997ba6a682a37a" - SRCREV:pn-kmod = "fd56638aed3fe147015bfa10ed4a5f7491303cb4" - # x86_64-linux - SRCREV:pn-gtk-doc-stub-native = "1dea266593edb766d6d898c79451ef193eb17cfa" - SRCREV:pn-dtc-native = "65cc4d2748a2c2e6f27f1cf39e07a5dbabd80ebf" - SRCREV:pn-update-rc.d-native = "eca680ddf28d024954895f59a241a622dd575c11" - SRCREV_glibc:pn-cross-localedef-native = "b8079dd0d360648e4e8de48656c5c38972621072" - SRCREV_localedef:pn-cross-localedef-native = "c833367348d39dad7ba018990bfdaffaec8e9ed3" - SRCREV:pn-prelink-native = "faa069deec99bf61418d0bab831c83d7c1b797ca" - SRCREV:pn-opkg-utils-native = "53274f087565fd45d8452c5367997ba6a682a37a" - SRCREV:pn-kern-tools-native = "23345b8846fe4bd167efdf1bd8a1224b2ba9a5ff" - SRCREV:pn-kmod-native = "fd56638aed3fe147015bfa10ed4a5f7491303cb4" - # qemux86-poky-linux - SRCREV_machine:pn-linux-yocto = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" - SRCREV_meta:pn-linux-yocto = "a227f20eff056e511d504b2e490f3774ab260d6f" - # all-poky-linux - SRCREV:pn-update-rc.d = "eca680ddf28d024954895f59a241a622dd575c11" - -.. note:: - - Here are some notes on using the ``buildhistory-collect-srcrevs`` command: - - - By default, only values where the :term:`SRCREV` was not hardcoded - (usually when :term:`AUTOREV` is used) are reported. Use the ``-a`` - option to see all :term:`SRCREV` values. - - - The output statements might not have any effect if overrides are - applied elsewhere in the build system configuration. Use the - ``-f`` option to add the ``forcevariable`` override to each output - line if you need to work around this restriction. - - - The script does apply special handling when building for multiple - machines. However, the script does place a comment before each set - of values that specifies which triplet to which they belong as - previously shown (e.g., ``i586-poky-linux``). - -Build History Image Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The files produced for each image are as follows: - -- ``image-files:`` A directory containing selected files from the root - filesystem. The files are defined by - :term:`BUILDHISTORY_IMAGE_FILES`. - -- ``build-id.txt:`` Human-readable information about the build - configuration and metadata source revisions. This file contains the - full build header as printed by BitBake. - -- ``*.dot:`` Dependency graphs for the image that are compatible with - ``graphviz``. - -- ``files-in-image.txt:`` A list of files in the image with - permissions, owner, group, size, and symlink information. - -- ``image-info.txt:`` A text file containing name-value pairs with - information about the image. See the following listing example for - more information. - -- ``installed-package-names.txt:`` A list of installed packages by name - only. - -- ``installed-package-sizes.txt:`` A list of installed packages ordered - by size. - -- ``installed-packages.txt:`` A list of installed packages with full - package filenames. - -.. note:: - - Installed package information is able to be gathered and produced - even if package management is disabled for the final image. - -Here is an example of ``image-info.txt``: - -.. code-block:: none - - DISTRO = poky - DISTRO_VERSION = 1.7 - USER_CLASSES = buildstats image-prelink - IMAGE_CLASSES = image_types - IMAGE_FEATURES = debug-tweaks - IMAGE_LINGUAS = - IMAGE_INSTALL = packagegroup-core-boot run-postinsts - BAD_RECOMMENDATIONS = - NO_RECOMMENDATIONS = - PACKAGE_EXCLUDE = - ROOTFS_POSTPROCESS_COMMAND = write_package_manifest; license_create_manifest; \ - write_image_manifest ; buildhistory_list_installed_image ; \ - buildhistory_get_image_installed ; ssh_allow_empty_password; \ - postinst_enable_logging; rootfs_update_timestamp ; ssh_disable_dns_lookup ; - IMAGE_POSTPROCESS_COMMAND = buildhistory_get_imageinfo ; - IMAGESIZE = 6900 - -Other than ``IMAGESIZE``, -which is the total size of the files in the image in Kbytes, the -name-value pairs are variables that may have influenced the content of -the image. This information is often useful when you are trying to -determine why a change in the package or file listings has occurred. - -Using Build History to Gather Image Information Only -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -As you can see, build history produces image information, including -dependency graphs, so you can see why something was pulled into the -image. If you are just interested in this information and not interested -in collecting specific package or SDK information, you can enable -writing only image information without any history by adding the -following to your ``conf/local.conf`` file found in the -:term:`Build Directory`:: - - INHERIT += "buildhistory" - BUILDHISTORY_COMMIT = "0" - BUILDHISTORY_FEATURES = "image" - -Here, you set the -:term:`BUILDHISTORY_FEATURES` -variable to use the image feature only. - -Build History SDK Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Build history collects similar information on the contents of SDKs (e.g. -``bitbake -c populate_sdk imagename``) as compared to information it -collects for images. Furthermore, this information differs depending on -whether an extensible or standard SDK is being produced. - -The following list shows the files produced for SDKs: - -- ``files-in-sdk.txt:`` A list of files in the SDK with permissions, - owner, group, size, and symlink information. This list includes both - the host and target parts of the SDK. - -- ``sdk-info.txt:`` A text file containing name-value pairs with - information about the SDK. See the following listing example for more - information. - -- ``sstate-task-sizes.txt:`` A text file containing name-value pairs - with information about task group sizes (e.g. ``do_populate_sysroot`` - tasks have a total size). The ``sstate-task-sizes.txt`` file exists - only when an extensible SDK is created. - -- ``sstate-package-sizes.txt:`` A text file containing name-value pairs - with information for the shared-state packages and sizes in the SDK. - The ``sstate-package-sizes.txt`` file exists only when an extensible - SDK is created. - -- ``sdk-files:`` A folder that contains copies of the files mentioned - in ``BUILDHISTORY_SDK_FILES`` if the files are present in the output. - Additionally, the default value of ``BUILDHISTORY_SDK_FILES`` is - specific to the extensible SDK although you can set it differently if - you would like to pull in specific files from the standard SDK. - - The default files are ``conf/local.conf``, ``conf/bblayers.conf``, - ``conf/auto.conf``, ``conf/locked-sigs.inc``, and - ``conf/devtool.conf``. Thus, for an extensible SDK, these files get - copied into the ``sdk-files`` directory. - -- The following information appears under each of the ``host`` and - ``target`` directories for the portions of the SDK that run on the - host and on the target, respectively: - - .. note:: - - The following files for the most part are empty when producing an - extensible SDK because this type of SDK is not constructed from - packages as is the standard SDK. - - - ``depends.dot:`` Dependency graph for the SDK that is compatible - with ``graphviz``. - - - ``installed-package-names.txt:`` A list of installed packages by - name only. - - - ``installed-package-sizes.txt:`` A list of installed packages - ordered by size. - - - ``installed-packages.txt:`` A list of installed packages with full - package filenames. - -Here is an example of ``sdk-info.txt``: - -.. code-block:: none - - DISTRO = poky - DISTRO_VERSION = 1.3+snapshot-20130327 - SDK_NAME = poky-glibc-i686-arm - SDK_VERSION = 1.3+snapshot - SDKMACHINE = - SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs - BAD_RECOMMENDATIONS = - SDKSIZE = 352712 - -Other than ``SDKSIZE``, which is -the total size of the files in the SDK in Kbytes, the name-value pairs -are variables that might have influenced the content of the SDK. This -information is often useful when you are trying to determine why a -change in the package or file listings has occurred. - -Examining Build History Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can examine build history output from the command line or from a web -interface. - -To see any changes that have occurred (assuming you have -:term:`BUILDHISTORY_COMMIT` = "1"), -you can simply use any Git command that allows you to view the history -of a repository. Here is one method:: - - $ git log -p - -You need to realize, -however, that this method does show changes that are not significant -(e.g. a package's size changing by a few bytes). - -There is a command-line tool called ``buildhistory-diff``, though, -that queries the Git repository and prints just the differences that -might be significant in human-readable form. Here is an example:: - - $ poky/poky/scripts/buildhistory-diff . HEAD^ - Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): - /etc/anotherpkg.conf was added - /sbin/anotherpkg was added - * (installed-package-names.txt): - * anotherpkg was added - Changes to images/qemux86_64/glibc/core-image-minimal (installed-package-names.txt): - anotherpkg was added - packages/qemux86_64-poky-linux/v86d: PACKAGES: added "v86d-extras" - * PR changed from "r0" to "r1" - * PV changed from "0.1.10" to "0.1.12" - packages/qemux86_64-poky-linux/v86d/v86d: PKGSIZE changed from 110579 to 144381 (+30%) - * PR changed from "r0" to "r1" - * PV changed from "0.1.10" to "0.1.12" - -.. note:: - - The ``buildhistory-diff`` tool requires the ``GitPython`` - package. Be sure to install it using Pip3 as follows:: - - $ pip3 install GitPython --user - - - Alternatively, you can install ``python3-git`` using the appropriate - distribution package manager (e.g. ``apt``, ``dnf``, or ``zipper``). - -To see changes to the build history using a web interface, follow the -instruction in the ``README`` file -:yocto_git:`here </buildhistory-web/>`. - -Here is a sample screenshot of the interface: - -.. image:: figures/buildhistory-web.png - :align: center - -Performing Automated Runtime Testing -==================================== - -The OpenEmbedded build system makes available a series of automated -tests for images to verify runtime functionality. You can run these -tests on either QEMU or actual target hardware. Tests are written in -Python making use of the ``unittest`` module, and the majority of them -run commands on the target system over SSH. This section describes how -you set up the environment to use these tests, run available tests, and -write and add your own tests. - -For information on the test and QA infrastructure available within the -Yocto Project, see the ":ref:`ref-manual/release-process:testing and quality assurance`" -section in the Yocto Project Reference Manual. - -Enabling Tests --------------- - -Depending on whether you are planning to run tests using QEMU or on the -hardware, you have to take different steps to enable the tests. See the -following subsections for information on how to enable both types of -tests. - -Enabling Runtime Tests on QEMU -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In order to run tests, you need to do the following: - -- *Set up to avoid interaction with sudo for networking:* To - accomplish this, you must do one of the following: - - - Add ``NOPASSWD`` for your user in ``/etc/sudoers`` either for all - commands or just for ``runqemu-ifup``. You must provide the full - path as that can change if you are using multiple clones of the - source repository. - - .. note:: - - On some distributions, you also need to comment out "Defaults - requiretty" in ``/etc/sudoers``. - - - Manually configure a tap interface for your system. - - - Run as root the script in ``scripts/runqemu-gen-tapdevs``, which - should generate a list of tap devices. This is the option - typically chosen for Autobuilder-type environments. - - .. note:: - - - Be sure to use an absolute path when calling this script - with sudo. - - - The package recipe ``qemu-helper-native`` is required to run - this script. Build the package using the following command:: - - $ bitbake qemu-helper-native - -- *Set the DISPLAY variable:* You need to set this variable so that - you have an X server available (e.g. start ``vncserver`` for a - headless machine). - -- *Be sure your host's firewall accepts incoming connections from - 192.168.7.0/24:* Some of the tests (in particular DNF tests) start an - HTTP server on a random high number port, which is used to serve - files to the target. The DNF module serves - ``${WORKDIR}/oe-rootfs-repo`` so it can run DNF channel commands. - That means your host's firewall must accept incoming connections from - 192.168.7.0/24, which is the default IP range used for tap devices by - ``runqemu``. - -- *Be sure your host has the correct packages installed:* Depending - your host's distribution, you need to have the following packages - installed: - - - Ubuntu and Debian: ``sysstat`` and ``iproute2`` - - - openSUSE: ``sysstat`` and ``iproute2`` - - - Fedora: ``sysstat`` and ``iproute`` - - - CentOS: ``sysstat`` and ``iproute`` - -Once you start running the tests, the following happens: - -1. A copy of the root filesystem is written to ``${WORKDIR}/testimage``. - -2. The image is booted under QEMU using the standard ``runqemu`` script. - -3. A default timeout of 500 seconds occurs to allow for the boot process - to reach the login prompt. You can change the timeout period by - setting - :term:`TEST_QEMUBOOT_TIMEOUT` - in the ``local.conf`` file. - -4. Once the boot process is reached and the login prompt appears, the - tests run. The full boot log is written to - ``${WORKDIR}/testimage/qemu_boot_log``. - -5. Each test module loads in the order found in :term:`TEST_SUITES`. You can - find the full output of the commands run over SSH in - ``${WORKDIR}/testimgage/ssh_target_log``. - -6. If no failures occur, the task running the tests ends successfully. - You can find the output from the ``unittest`` in the task log at - ``${WORKDIR}/temp/log.do_testimage``. - -Enabling Runtime Tests on Hardware -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The OpenEmbedded build system can run tests on real hardware, and for -certain devices it can also deploy the image to be tested onto the -device beforehand. - -For automated deployment, a "controller image" is installed onto the -hardware once as part of setup. Then, each time tests are to be run, the -following occurs: - -1. The controller image is booted into and used to write the image to be - tested to a second partition. - -2. The device is then rebooted using an external script that you need to - provide. - -3. The device boots into the image to be tested. - -When running tests (independent of whether the image has been deployed -automatically or not), the device is expected to be connected to a -network on a pre-determined IP address. You can either use static IP -addresses written into the image, or set the image to use DHCP and have -your DHCP server on the test network assign a known IP address based on -the MAC address of the device. - -In order to run tests on hardware, you need to set :term:`TEST_TARGET` to an -appropriate value. For QEMU, you do not have to change anything, the -default value is "qemu". For running tests on hardware, the following -options are available: - -- *"simpleremote":* Choose "simpleremote" if you are going to run tests - on a target system that is already running the image to be tested and - is available on the network. You can use "simpleremote" in - conjunction with either real hardware or an image running within a - separately started QEMU or any other virtual machine manager. - -- *"SystemdbootTarget":* Choose "SystemdbootTarget" if your hardware is - an EFI-based machine with ``systemd-boot`` as bootloader and - ``core-image-testmaster`` (or something similar) is installed. Also, - your hardware under test must be in a DHCP-enabled network that gives - it the same IP address for each reboot. - - If you choose "SystemdbootTarget", there are additional requirements - and considerations. See the - ":ref:`dev-manual/common-tasks:selecting systemdboottarget`" section, which - follows, for more information. - -- *"BeagleBoneTarget":* Choose "BeagleBoneTarget" if you are deploying - images and running tests on the BeagleBone "Black" or original - "White" hardware. For information on how to use these tests, see the - comments at the top of the BeagleBoneTarget - ``meta-yocto-bsp/lib/oeqa/controllers/beaglebonetarget.py`` file. - -- *"EdgeRouterTarget":* Choose "EdgeRouterTarget" if you are deploying - images and running tests on the Ubiquiti Networks EdgeRouter Lite. - For information on how to use these tests, see the comments at the - top of the EdgeRouterTarget - ``meta-yocto-bsp/lib/oeqa/controllers/edgeroutertarget.py`` file. - -- *"GrubTarget":* Choose "GrubTarget" if you are deploying images and running - tests on any generic PC that boots using GRUB. For information on how - to use these tests, see the comments at the top of the GrubTarget - ``meta-yocto-bsp/lib/oeqa/controllers/grubtarget.py`` file. - -- *"your-target":* Create your own custom target if you want to run - tests when you are deploying images and running tests on a custom - machine within your BSP layer. To do this, you need to add a Python - unit that defines the target class under ``lib/oeqa/controllers/`` - within your layer. You must also provide an empty ``__init__.py``. - For examples, see files in ``meta-yocto-bsp/lib/oeqa/controllers/``. - -Selecting SystemdbootTarget -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do -not need any information in this section. You can skip down to the -":ref:`dev-manual/common-tasks:running tests`" section. - -If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to -perform a one-time setup of your controller image by doing the following: - -1. *Set EFI_PROVIDER:* Be sure that :term:`EFI_PROVIDER` is as follows:: - - EFI_PROVIDER = "systemd-boot" - -2. *Build the controller image:* Build the ``core-image-testmaster`` image. - The ``core-image-testmaster`` recipe is provided as an example for a - "controller" image and you can customize the image recipe as you would - any other recipe. - - Here are the image recipe requirements: - - - Inherits ``core-image`` so that kernel modules are installed. - - - Installs normal linux utilities not BusyBox ones (e.g. ``bash``, - ``coreutils``, ``tar``, ``gzip``, and ``kmod``). - - - Uses a custom Initial RAM Disk (initramfs) image with a custom - installer. A normal image that you can install usually creates a - single root filesystem partition. This image uses another installer that - creates a specific partition layout. Not all Board Support - Packages (BSPs) can use an installer. For such cases, you need to - manually create the following partition layout on the target: - - - First partition mounted under ``/boot``, labeled "boot". - - - The main root filesystem partition where this image gets installed, - which is mounted under ``/``. - - - Another partition labeled "testrootfs" where test images get - deployed. - -3. *Install image:* Install the image that you just built on the target - system. - -The final thing you need to do when setting :term:`TEST_TARGET` to -"SystemdbootTarget" is to set up the test image: - -1. *Set up your local.conf file:* Make sure you have the following - statements in your ``local.conf`` file:: - - IMAGE_FSTYPES += "tar.gz" - INHERIT += "testimage" - TEST_TARGET = "SystemdbootTarget" - TEST_TARGET_IP = "192.168.2.3" - -2. *Build your test image:* Use BitBake to build the image:: - - $ bitbake core-image-sato - -Power Control -~~~~~~~~~~~~~ - -For most hardware targets other than "simpleremote", you can control -power: - -- You can use :term:`TEST_POWERCONTROL_CMD` together with - :term:`TEST_POWERCONTROL_EXTRA_ARGS` as a command that runs on the host - and does power cycling. The test code passes one argument to that - command: off, on or cycle (off then on). Here is an example that - could appear in your ``local.conf`` file:: - - TEST_POWERCONTROL_CMD = "powercontrol.exp test 10.11.12.1 nuc1" - - In this example, the expect - script does the following: - - .. code-block:: shell - - ssh test@10.11.12.1 "pyctl nuc1 arg" - - It then runs a Python script that controls power for a label called - ``nuc1``. - - .. note:: - - You need to customize :term:`TEST_POWERCONTROL_CMD` and - :term:`TEST_POWERCONTROL_EXTRA_ARGS` for your own setup. The one requirement - is that it accepts "on", "off", and "cycle" as the last argument. - -- When no command is defined, it connects to the device over SSH and - uses the classic reboot command to reboot the device. Classic reboot - is fine as long as the machine actually reboots (i.e. the SSH test - has not failed). It is useful for scenarios where you have a simple - setup, typically with a single board, and where some manual - interaction is okay from time to time. - -If you have no hardware to automatically perform power control but still -wish to experiment with automated hardware testing, you can use the -``dialog-power-control`` script that shows a dialog prompting you to perform -the required power action. This script requires either KDialog or Zenity -to be installed. To use this script, set the -:term:`TEST_POWERCONTROL_CMD` -variable as follows:: - - TEST_POWERCONTROL_CMD = "${COREBASE}/scripts/contrib/dialog-power-control" - -Serial Console Connection -~~~~~~~~~~~~~~~~~~~~~~~~~ - -For test target classes requiring a serial console to interact with the -bootloader (e.g. BeagleBoneTarget, EdgeRouterTarget, and GrubTarget), -you need to specify a command to use to connect to the serial console of -the target machine by using the -:term:`TEST_SERIALCONTROL_CMD` -variable and optionally the -:term:`TEST_SERIALCONTROL_EXTRA_ARGS` -variable. - -These cases could be a serial terminal program if the machine is -connected to a local serial port, or a ``telnet`` or ``ssh`` command -connecting to a remote console server. Regardless of the case, the -command simply needs to connect to the serial console and forward that -connection to standard input and output as any normal terminal program -does. For example, to use the picocom terminal program on serial device -``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows:: - - TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" - -For local -devices where the serial port device disappears when the device reboots, -an additional "serdevtry" wrapper script is provided. To use this -wrapper, simply prefix the terminal command with -``${COREBASE}/scripts/contrib/serdevtry``:: - - TEST_SERIALCONTROL_CMD = "${COREBASE}/scripts/contrib/serdevtry picocom -b 115200 /dev/ttyUSB0" - -Running Tests -------------- - -You can start the tests automatically or manually: - -- *Automatically running tests:* To run the tests automatically after - the OpenEmbedded build system successfully creates an image, first - set the - :term:`TESTIMAGE_AUTO` - variable to "1" in your ``local.conf`` file in the - :term:`Build Directory`:: - - TESTIMAGE_AUTO = "1" - - Next, build your image. If the image successfully builds, the - tests run:: - - bitbake core-image-sato - -- *Manually running tests:* To manually run the tests, first globally - inherit the - :ref:`testimage <ref-classes-testimage*>` class - by editing your ``local.conf`` file:: - - INHERIT += "testimage" - - Next, use BitBake to run the tests:: - - bitbake -c testimage image - -All test files reside in ``meta/lib/oeqa/runtime`` in the -:term:`Source Directory`. A test name maps -directly to a Python module. Each test module may contain a number of -individual tests. Tests are usually grouped together by the area tested -(e.g tests for systemd reside in ``meta/lib/oeqa/runtime/systemd.py``). - -You can add tests to any layer provided you place them in the proper -area and you extend :term:`BBPATH` in -the ``local.conf`` file as normal. Be sure that tests reside in -``layer/lib/oeqa/runtime``. - -.. note:: - - Be sure that module names do not collide with module names used in - the default set of test modules in ``meta/lib/oeqa/runtime``. - -You can change the set of tests run by appending or overriding -:term:`TEST_SUITES` variable in -``local.conf``. Each name in :term:`TEST_SUITES` represents a required test -for the image. Test modules named within :term:`TEST_SUITES` cannot be -skipped even if a test is not suitable for an image (e.g. running the -RPM tests on an image without ``rpm``). Appending "auto" to -:term:`TEST_SUITES` causes the build system to try to run all tests that are -suitable for the image (i.e. each test module may elect to skip itself). - -The order you list tests in :term:`TEST_SUITES` is important and influences -test dependencies. Consequently, tests that depend on other tests should -be added after the test on which they depend. For example, since the -``ssh`` test depends on the ``ping`` test, "ssh" needs to come after -"ping" in the list. The test class provides no re-ordering or dependency -handling. - -.. note:: - - Each module can have multiple classes with multiple test methods. - And, Python ``unittest`` rules apply. - -Here are some things to keep in mind when running tests: - -- The default tests for the image are defined as:: - - DEFAULT_TEST_SUITES:pn-image = "ping ssh df connman syslog xorg scp vnc date rpm dnf dmesg" - -- Add your own test to the list of the by using the following:: - - TEST_SUITES:append = " mytest" - -- Run a specific list of tests as follows:: - - TEST_SUITES = "test1 test2 test3" - - Remember, order is important. Be sure to place a test that is - dependent on another test later in the order. - -Exporting Tests ---------------- - -You can export tests so that they can run independently of the build -system. Exporting tests is required if you want to be able to hand the -test execution off to a scheduler. You can only export tests that are -defined in :term:`TEST_SUITES`. - -If your image is already built, make sure the following are set in your -``local.conf`` file:: - - INHERIT += "testexport" - TEST_TARGET_IP = "IP-address-for-the-test-target" - TEST_SERVER_IP = "IP-address-for-the-test-server" - -You can then export the tests with the -following BitBake command form:: - - $ bitbake image -c testexport - -Exporting the tests places them in the -:term:`Build Directory` in -``tmp/testexport/``\ image, which is controlled by the -:term:`TEST_EXPORT_DIR` variable. - -You can now run the tests outside of the build environment:: - - $ cd tmp/testexport/image - $ ./runexported.py testdata.json - -Here is a complete example that shows IP addresses and uses the -``core-image-sato`` image:: - - INHERIT += "testexport" - TEST_TARGET_IP = "192.168.7.2" - TEST_SERVER_IP = "192.168.7.1" - -Use BitBake to export the tests:: - - $ bitbake core-image-sato -c testexport - -Run the tests outside of -the build environment using the following:: - - $ cd tmp/testexport/core-image-sato - $ ./runexported.py testdata.json - -Writing New Tests ------------------ - -As mentioned previously, all new test files need to be in the proper -place for the build system to find them. New tests for additional -functionality outside of the core should be added to the layer that adds -the functionality, in ``layer/lib/oeqa/runtime`` (as long as -:term:`BBPATH` is extended in the -layer's ``layer.conf`` file as normal). Just remember the following: - -- Filenames need to map directly to test (module) names. - -- Do not use module names that collide with existing core tests. - -- Minimally, an empty ``__init__.py`` file must be present in the runtime - directory. - -To create a new test, start by copying an existing module (e.g. -``syslog.py`` or ``gcc.py`` are good ones to use). Test modules can use -code from ``meta/lib/oeqa/utils``, which are helper classes. - -.. note:: - - Structure shell commands such that you rely on them and they return a - single code for success. Be aware that sometimes you will need to - parse the output. See the ``df.py`` and ``date.py`` modules for examples. - -You will notice that all test classes inherit ``oeRuntimeTest``, which -is found in ``meta/lib/oetest.py``. This base class offers some helper -attributes, which are described in the following sections: - -Class Methods -~~~~~~~~~~~~~ - -Class methods are as follows: - -- *hasPackage(pkg):* Returns "True" if ``pkg`` is in the installed - package list of the image, which is based on the manifest file that - is generated during the ``do_rootfs`` task. - -- *hasFeature(feature):* Returns "True" if the feature is in - :term:`IMAGE_FEATURES` or - :term:`DISTRO_FEATURES`. - -Class Attributes -~~~~~~~~~~~~~~~~ - -Class attributes are as follows: - -- *pscmd:* Equals "ps -ef" if ``procps`` is installed in the image. - Otherwise, ``pscmd`` equals "ps" (busybox). - -- *tc:* The called test context, which gives access to the - following attributes: - - - *d:* The BitBake datastore, which allows you to use stuff such - as ``oeRuntimeTest.tc.d.getVar("VIRTUAL-RUNTIME_init_manager")``. - - - *testslist and testsrequired:* Used internally. The tests - do not need these. - - - *filesdir:* The absolute path to - ``meta/lib/oeqa/runtime/files``, which contains helper files for - tests meant for copying on the target such as small files written - in C for compilation. - - - *target:* The target controller object used to deploy and - start an image on a particular target (e.g. Qemu, SimpleRemote, - and SystemdbootTarget). Tests usually use the following: - - - *ip:* The target's IP address. - - - *server_ip:* The host's IP address, which is usually used - by the DNF test suite. - - - *run(cmd, timeout=None):* The single, most used method. - This command is a wrapper for: ``ssh root@host "cmd"``. The - command returns a tuple: (status, output), which are what their - names imply - the return code of "cmd" and whatever output it - produces. The optional timeout argument represents the number - of seconds the test should wait for "cmd" to return. If the - argument is "None", the test uses the default instance's - timeout period, which is 300 seconds. If the argument is "0", - the test runs until the command returns. - - - *copy_to(localpath, remotepath):* - ``scp localpath root@ip:remotepath``. - - - *copy_from(remotepath, localpath):* - ``scp root@host:remotepath localpath``. - -Instance Attributes -~~~~~~~~~~~~~~~~~~~ - -There is a single instance attribute, which is ``target``. The ``target`` -instance attribute is identical to the class attribute of the same name, -which is described in the previous section. This attribute exists as -both an instance and class attribute so tests can use -``self.target.run(cmd)`` in instance methods instead of -``oeRuntimeTest.tc.target.run(cmd)``. - -Installing Packages in the DUT Without the Package Manager ----------------------------------------------------------- - -When a test requires a package built by BitBake, it is possible to -install that package. Installing the package does not require a package -manager be installed in the device under test (DUT). It does, however, -require an SSH connection and the target must be using the -``sshcontrol`` class. - -.. note:: - - This method uses ``scp`` to copy files from the host to the target, which - causes permissions and special attributes to be lost. - -A JSON file is used to define the packages needed by a test. This file -must be in the same path as the file used to define the tests. -Furthermore, the filename must map directly to the test module name with -a ``.json`` extension. - -The JSON file must include an object with the test name as keys of an -object or an array. This object (or array of objects) uses the following -data: - -- "pkg" - A mandatory string that is the name of the package to be - installed. - -- "rm" - An optional boolean, which defaults to "false", that specifies - to remove the package after the test. - -- "extract" - An optional boolean, which defaults to "false", that - specifies if the package must be extracted from the package format. - When set to "true", the package is not automatically installed into - the DUT. - -Following is an example JSON file that handles test "foo" installing -package "bar" and test "foobar" installing packages "foo" and "bar". -Once the test is complete, the packages are removed from the DUT. -:: - - { - "foo": { - "pkg": "bar" - }, - "foobar": [ - { - "pkg": "foo", - "rm": true - }, - { - "pkg": "bar", - "rm": true - } - ] - } - -Debugging Tools and Techniques -============================== - -The exact method for debugging build failures depends on the nature of -the problem and on the system's area from which the bug originates. -Standard debugging practices such as comparison against the last known -working version with examination of the changes and the re-application -of steps to identify the one causing the problem are valid for the Yocto -Project just as they are for any other system. Even though it is -impossible to detail every possible potential failure, this section -provides some general tips to aid in debugging given a variety of -situations. - -.. note:: - - A useful feature for debugging is the error reporting tool. - Configuring the Yocto Project to use this tool causes the - OpenEmbedded build system to produce error reporting commands as part - of the console output. You can enter the commands after the build - completes to log error information into a common database, that can - help you figure out what might be going wrong. For information on how - to enable and use this feature, see the - ":ref:`dev-manual/common-tasks:using the error reporting tool`" - section. - -The following list shows the debugging topics in the remainder of this -section: - -- ":ref:`dev-manual/common-tasks:viewing logs from failed tasks`" describes - how to find and view logs from tasks that failed during the build - process. - -- ":ref:`dev-manual/common-tasks:viewing variable values`" describes how to - use the BitBake ``-e`` option to examine variable values after a - recipe has been parsed. - -- ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" - describes how to use the ``oe-pkgdata-util`` utility to query - :term:`PKGDATA_DIR` and - display package-related information for built packages. - -- ":ref:`dev-manual/common-tasks:viewing dependencies between recipes and tasks`" - describes how to use the BitBake ``-g`` option to display recipe - dependency information used during the build. - -- ":ref:`dev-manual/common-tasks:viewing task variable dependencies`" describes - how to use the ``bitbake-dumpsig`` command in conjunction with key - subdirectories in the - :term:`Build Directory` to determine - variable dependencies. - -- ":ref:`dev-manual/common-tasks:running specific tasks`" describes - how to use several BitBake options (e.g. ``-c``, ``-C``, and ``-f``) - to run specific tasks in the build chain. It can be useful to run - tasks "out-of-order" when trying isolate build issues. - -- ":ref:`dev-manual/common-tasks:general bitbake problems`" describes how - to use BitBake's ``-D`` debug output option to reveal more about what - BitBake is doing during the build. - -- ":ref:`dev-manual/common-tasks:building with no dependencies`" - describes how to use the BitBake ``-b`` option to build a recipe - while ignoring dependencies. - -- ":ref:`dev-manual/common-tasks:recipe logging mechanisms`" - describes how to use the many recipe logging functions to produce - debugging output and report errors and warnings. - -- ":ref:`dev-manual/common-tasks:debugging parallel make races`" - describes how to debug situations where the build consists of several - parts that are run simultaneously and when the output or result of - one part is not ready for use with a different part of the build that - depends on that output. - -- ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" - describes how to use GDB to allow you to examine running programs, which can - help you fix problems. - -- ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) on the target`" - describes how to use GDB directly on target hardware for debugging. - -- ":ref:`dev-manual/common-tasks:other debugging tips`" describes - miscellaneous debugging tips that can be useful. - -Viewing Logs from Failed Tasks ------------------------------- - -You can find the log for a task in the file -``${``\ :term:`WORKDIR`\ ``}/temp/log.do_``\ `taskname`. -For example, the log for the -:ref:`ref-tasks-compile` task of the -QEMU minimal image for the x86 machine (``qemux86``) might be in -``tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile``. -To see the commands :term:`BitBake` ran -to generate a log, look at the corresponding ``run.do_``\ `taskname` file -in the same directory. - -``log.do_``\ `taskname` and ``run.do_``\ `taskname` are actually symbolic -links to ``log.do_``\ `taskname`\ ``.``\ `pid` and -``log.run_``\ `taskname`\ ``.``\ `pid`, where `pid` is the PID the task had -when it ran. The symlinks always point to the files corresponding to the -most recent run. - -Viewing Variable Values ------------------------ - -Sometimes you need to know the value of a variable as a result of -BitBake's parsing step. This could be because some unexpected behavior -occurred in your project. Perhaps an attempt to :ref:`modify a variable -<bitbake:bitbake-user-manual/bitbake-user-manual-metadata:modifying existing -variables>` did not work out as expected. - -BitBake's ``-e`` option is used to display variable values after -parsing. The following command displays the variable values after the -configuration files (i.e. ``local.conf``, ``bblayers.conf``, -``bitbake.conf`` and so forth) have been parsed:: - - $ bitbake -e - -The following command displays variable values after a specific recipe has -been parsed. The variables include those from the configuration as well:: - - $ bitbake -e recipename - -.. note:: - - Each recipe has its own private set of variables (datastore). - Internally, after parsing the configuration, a copy of the resulting - datastore is made prior to parsing each recipe. This copying implies - that variables set in one recipe will not be visible to other - recipes. - - Likewise, each task within a recipe gets a private datastore based on - the recipe datastore, which means that variables set within one task - will not be visible to other tasks. - -In the output of ``bitbake -e``, each variable is preceded by a -description of how the variable got its value, including temporary -values that were later overridden. This description also includes -variable flags (varflags) set on the variable. The output can be very -helpful during debugging. - -Variables that are exported to the environment are preceded by -``export`` in the output of ``bitbake -e``. See the following example:: - - export CC="i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/ulf/poky/build/tmp/sysroots/qemux86" - -In addition to variable values, the output of the ``bitbake -e`` and -``bitbake -e`` recipe commands includes the following information: - -- The output starts with a tree listing all configuration files and - classes included globally, recursively listing the files they include - or inherit in turn. Much of the behavior of the OpenEmbedded build - system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is - implemented in the - :ref:`base <ref-classes-base>` class and the - classes it inherits, rather than being built into BitBake itself. - -- After the variable values, all functions appear in the output. For - shell functions, variables referenced within the function body are - expanded. If a function has been modified using overrides or using - override-style operators like ``:append`` and ``:prepend``, then the - final assembled function body appears in the output. - -Viewing Package Information with ``oe-pkgdata-util`` ----------------------------------------------------- - -You can use the ``oe-pkgdata-util`` command-line utility to query -:term:`PKGDATA_DIR` and display -various package-related information. When you use the utility, you must -use it to view information on packages that have already been built. - -Following are a few of the available ``oe-pkgdata-util`` subcommands. - -.. note:: - - You can use the standard \* and ? globbing wildcards as part of - package names and paths. - -- ``oe-pkgdata-util list-pkgs [pattern]``: Lists all packages - that have been built, optionally limiting the match to packages that - match pattern. - -- ``oe-pkgdata-util list-pkg-files package ...``: Lists the - files and directories contained in the given packages. - - .. note:: - - A different way to view the contents of a package is to look at - the - ``${``\ :term:`WORKDIR`\ ``}/packages-split`` - directory of the recipe that generates the package. This directory - is created by the - :ref:`ref-tasks-package` task - and has one subdirectory for each package the recipe generates, - which contains the files stored in that package. - - If you want to inspect the ``${WORKDIR}/packages-split`` - directory, make sure that - :ref:`rm_work <ref-classes-rm-work>` is not - enabled when you build the recipe. - -- ``oe-pkgdata-util find-path path ...``: Lists the names of - the packages that contain the given paths. For example, the following - tells us that ``/usr/share/man/man1/make.1`` is contained in the - ``make-doc`` package:: - - $ oe-pkgdata-util find-path /usr/share/man/man1/make.1 - make-doc: /usr/share/man/man1/make.1 - -- ``oe-pkgdata-util lookup-recipe package ...``: Lists the name - of the recipes that produce the given packages. - -For more information on the ``oe-pkgdata-util`` command, use the help -facility:: - - $ oe-pkgdata-util --help - $ oe-pkgdata-util subcommand --help - -Viewing Dependencies Between Recipes and Tasks ----------------------------------------------- - -Sometimes it can be hard to see why BitBake wants to build other recipes -before the one you have specified. Dependency information can help you -understand why a recipe is built. - -To generate dependency information for a recipe, run the following -command:: - - $ bitbake -g recipename - -This command writes the following files in the current directory: - -- ``pn-buildlist``: A list of recipes/targets involved in building - `recipename`. "Involved" here means that at least one task from the - recipe needs to run when building `recipename` from scratch. Targets - that are in - :term:`ASSUME_PROVIDED` - are not listed. - -- ``task-depends.dot``: A graph showing dependencies between tasks. - -The graphs are in -`DOT <https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29>`__ -format and can be converted to images (e.g. using the ``dot`` tool from -`Graphviz <https://www.graphviz.org/>`__). - -.. note:: - - - DOT files use a plain text format. The graphs generated using the - ``bitbake -g`` command are often so large as to be difficult to - read without special pruning (e.g. with Bitbake's ``-I`` option) - and processing. Despite the form and size of the graphs, the - corresponding ``.dot`` files can still be possible to read and - provide useful information. - - As an example, the ``task-depends.dot`` file contains lines such - as the following:: - - "libxslt.do_configure" -> "libxml2.do_populate_sysroot" - - The above example line reveals that the - :ref:`ref-tasks-configure` - task in ``libxslt`` depends on the - :ref:`ref-tasks-populate_sysroot` - task in ``libxml2``, which is a normal - :term:`DEPENDS` dependency - between the two recipes. - - - For an example of how ``.dot`` files can be processed, see the - ``scripts/contrib/graph-tool`` Python script, which finds and - displays paths between graph nodes. - -You can use a different method to view dependency information by using -the following command:: - - $ bitbake -g -u taskexp recipename - -This command -displays a GUI window from which you can view build-time and runtime -dependencies for the recipes involved in building recipename. - -Viewing Task Variable Dependencies ----------------------------------- - -As mentioned in the -":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section of the BitBake -User Manual, BitBake tries to automatically determine what variables a -task depends on so that it can rerun the task if any values of the -variables change. This determination is usually reliable. However, if -you do things like construct variable names at runtime, then you might -have to manually declare dependencies on those variables using -``vardeps`` as described in the -":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section of the BitBake -User Manual. - -If you are unsure whether a variable dependency is being picked up -automatically for a given task, you can list the variable dependencies -BitBake has determined by doing the following: - -1. Build the recipe containing the task:: - - $ bitbake recipename - -2. Inside the :term:`STAMPS_DIR` - directory, find the signature data (``sigdata``) file that - corresponds to the task. The ``sigdata`` files contain a pickled - Python database of all the metadata that went into creating the input - checksum for the task. As an example, for the - :ref:`ref-tasks-fetch` task of the - ``db`` recipe, the ``sigdata`` file might be found in the following - location:: - - ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 - - For tasks that are accelerated through the shared state - (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, an - additional ``siginfo`` file is written into - :term:`SSTATE_DIR` along with - the cached task output. The ``siginfo`` files contain exactly the - same information as ``sigdata`` files. - -3. Run ``bitbake-dumpsig`` on the ``sigdata`` or ``siginfo`` file. Here - is an example:: - - $ bitbake-dumpsig ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 - - In the output of the above command, you will find a line like the - following, which lists all the (inferred) variable dependencies for - the task. This list also includes indirect dependencies from - variables depending on other variables, recursively. - :: - - Task dependencies: ['PV', 'SRCREV', 'SRC_URI', 'SRC_URI[md5sum]', 'SRC_URI[sha256sum]', 'base_do_fetch'] - - .. note:: - - Functions (e.g. ``base_do_fetch``) also count as variable dependencies. - These functions in turn depend on the variables they reference. - - The output of ``bitbake-dumpsig`` also includes the value each - variable had, a list of dependencies for each variable, and - :term:`BB_HASHBASE_WHITELIST` - information. - -There is also a ``bitbake-diffsigs`` command for comparing two -``siginfo`` or ``sigdata`` files. This command can be helpful when -trying to figure out what changed between two versions of a task. If you -call ``bitbake-diffsigs`` with just one file, the command behaves like -``bitbake-dumpsig``. - -You can also use BitBake to dump out the signature construction -information without executing tasks by using either of the following -BitBake command-line options:: - - ‐‐dump-signatures=SIGNATURE_HANDLER - -S SIGNATURE_HANDLER - - -.. note:: - - Two common values for `SIGNATURE_HANDLER` are "none" and "printdiff", which - dump only the signature or compare the dumped signature with the cached one, - respectively. - -Using BitBake with either of these options causes BitBake to dump out -``sigdata`` files in the ``stamps`` directory for every task it would -have executed instead of building the specified target package. - -Viewing Metadata Used to Create the Input Signature of a Shared State Task --------------------------------------------------------------------------- - -Seeing what metadata went into creating the input signature of a shared -state (sstate) task can be a useful debugging aid. This information is -available in signature information (``siginfo``) files in -:term:`SSTATE_DIR`. For -information on how to view and interpret information in ``siginfo`` -files, see the -":ref:`dev-manual/common-tasks:viewing task variable dependencies`" section. - -For conceptual information on shared state, see the -":ref:`overview-manual/concepts:shared state`" -section in the Yocto Project Overview and Concepts Manual. - -Invalidating Shared State to Force a Task to Run ------------------------------------------------- - -The OpenEmbedded build system uses -:ref:`checksums <overview-manual/concepts:checksums (signatures)>` and -:ref:`overview-manual/concepts:shared state` cache to avoid unnecessarily -rebuilding tasks. Collectively, this scheme is known as "shared state -code". - -As with all schemes, this one has some drawbacks. It is possible that -you could make implicit changes to your code that the checksum -calculations do not take into account. These implicit changes affect a -task's output but do not trigger the shared state code into rebuilding a -recipe. Consider an example during which a tool changes its output. -Assume that the output of ``rpmdeps`` changes. The result of the change -should be that all the ``package`` and ``package_write_rpm`` shared -state cache items become invalid. However, because the change to the -output is external to the code and therefore implicit, the associated -shared state cache items do not become invalidated. In this case, the -build process uses the cached items rather than running the task again. -Obviously, these types of implicit changes can cause problems. - -To avoid these problems during the build, you need to understand the -effects of any changes you make. Realize that changes you make directly -to a function are automatically factored into the checksum calculation. -Thus, these explicit changes invalidate the associated area of shared -state cache. However, you need to be aware of any implicit changes that -are not obvious changes to the code and could affect the output of a -given task. - -When you identify an implicit change, you can easily take steps to -invalidate the cache and force the tasks to run. The steps you can take -are as simple as changing a function's comments in the source code. For -example, to invalidate package shared state files, change the comment -statements of -:ref:`ref-tasks-package` or the -comments of one of the functions it calls. Even though the change is -purely cosmetic, it causes the checksum to be recalculated and forces -the build system to run the task again. - -.. note:: - - For an example of a commit that makes a cosmetic change to invalidate - shared state, see this - :yocto_git:`commit </poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54>`. - -Running Specific Tasks ----------------------- - -Any given recipe consists of a set of tasks. The standard BitBake -behavior in most cases is: ``do_fetch``, ``do_unpack``, ``do_patch``, -``do_configure``, ``do_compile``, ``do_install``, ``do_package``, -``do_package_write_*``, and ``do_build``. The default task is -``do_build`` and any tasks on which it depends build first. Some tasks, -such as ``do_devshell``, are not part of the default build chain. If you -wish to run a task that is not part of the default build chain, you can -use the ``-c`` option in BitBake. Here is an example:: - - $ bitbake matchbox-desktop -c devshell - -The ``-c`` option respects task dependencies, which means that all other -tasks (including tasks from other recipes) that the specified task -depends on will be run before the task. Even when you manually specify a -task to run with ``-c``, BitBake will only run the task if it considers -it "out of date". See the -":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" -section in the Yocto Project Overview and Concepts Manual for how -BitBake determines whether a task is "out of date". - -If you want to force an up-to-date task to be rerun (e.g. because you -made manual modifications to the recipe's -:term:`WORKDIR` that you want to try -out), then you can use the ``-f`` option. - -.. note:: - - The reason ``-f`` is never required when running the - :ref:`ref-tasks-devshell` task is because the - [\ :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ] - variable flag is already set for the task. - -The following example shows one way you can use the ``-f`` option:: - - $ bitbake matchbox-desktop - . - . - make some changes to the source code in the work directory - . - . - $ bitbake matchbox-desktop -c compile -f - $ bitbake matchbox-desktop - -This sequence first builds and then recompiles ``matchbox-desktop``. The -last command reruns all tasks (basically the packaging tasks) after the -compile. BitBake recognizes that the ``do_compile`` task was rerun and -therefore understands that the other tasks also need to be run again. - -Another, shorter way to rerun a task and all -:ref:`ref-manual/tasks:normal recipe build tasks` -that depend on it is to use the ``-C`` option. - -.. note:: - - This option is upper-cased and is separate from the ``-c`` - option, which is lower-cased. - -Using this option invalidates the given task and then runs the -:ref:`ref-tasks-build` task, which is -the default task if no task is given, and the tasks on which it depends. -You could replace the final two commands in the previous example with -the following single command:: - - $ bitbake matchbox-desktop -C compile - -Internally, the ``-f`` and ``-C`` options work by tainting (modifying) -the input checksum of the specified task. This tainting indirectly -causes the task and its dependent tasks to be rerun through the normal -task dependency mechanisms. - -.. note:: - - BitBake explicitly keeps track of which tasks have been tainted in - this fashion, and will print warnings such as the following for - builds involving such tasks: - - .. code-block:: none - - WARNING: /home/ulf/poky/meta/recipes-sato/matchbox-desktop/matchbox-desktop_2.1.bb.do_compile is tainted from a forced run - - - The purpose of the warning is to let you know that the work directory - and build output might not be in the clean state they would be in for - a "normal" build, depending on what actions you took. To get rid of - such warnings, you can remove the work directory and rebuild the - recipe, as follows:: - - $ bitbake matchbox-desktop -c clean - $ bitbake matchbox-desktop - - -You can view a list of tasks in a given package by running the -``do_listtasks`` task as follows:: - - $ bitbake matchbox-desktop -c listtasks - -The results appear as output to the console and are also in -the file ``${WORKDIR}/temp/log.do_listtasks``. - -General BitBake Problems ------------------------- - -You can see debug output from BitBake by using the ``-D`` option. The -debug output gives more information about what BitBake is doing and the -reason behind it. Each ``-D`` option you use increases the logging -level. The most common usage is ``-DDD``. - -The output from ``bitbake -DDD -v targetname`` can reveal why BitBake -chose a certain version of a package or why BitBake picked a certain -provider. This command could also help you in a situation where you -think BitBake did something unexpected. - -Building with No Dependencies ------------------------------ - -To build a specific recipe (``.bb`` file), you can use the following -command form:: - - $ bitbake -b somepath/somerecipe.bb - -This command form does -not check for dependencies. Consequently, you should use it only when -you know existing dependencies have been met. - -.. note:: - - You can also specify fragments of the filename. In this case, BitBake - checks for a unique match. - -Recipe Logging Mechanisms -------------------------- - -The Yocto Project provides several logging functions for producing -debugging output and reporting errors and warnings. For Python -functions, the following logging functions are available. All of these functions -log to ``${T}/log.do_``\ `task`, and can also log to standard output -(stdout) with the right settings: - -- ``bb.plain(msg)``: Writes msg as is to the log while also - logging to stdout. - -- ``bb.note(msg)``: Writes "NOTE: msg" to the log. Also logs to - stdout if BitBake is called with "-v". - -- ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the - log. Also logs to stdout if the log level is greater than or equal to - level. See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`" option - in the BitBake User Manual for more information. - -- ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also - logging to stdout. - -- ``bb.error(msg)``: Writes "ERROR: msg" to the log while also - logging to standard out (stdout). - - .. note:: - - Calling this function does not cause the task to fail. - -- ``bb.fatal(msg)``: This logging function is similar to - ``bb.error(msg)`` but also causes the calling task to fail. - - .. note:: - - ``bb.fatal()`` raises an exception, which means you do not need to put a - "return" statement after the function. - -The same logging functions are also available in shell functions, under -the names ``bbplain``, ``bbnote``, ``bbdebug``, ``bbwarn``, ``bberror``, -and ``bbfatal``. The -:ref:`logging <ref-classes-logging>` class -implements these functions. See that class in the ``meta/classes`` -folder of the :term:`Source Directory` for information. - -Logging With Python -~~~~~~~~~~~~~~~~~~~ - -When creating recipes using Python and inserting code that handles build -logs, keep in mind the goal is to have informative logs while keeping -the console as "silent" as possible. Also, if you want status messages -in the log, use the "debug" loglevel. - -Following is an example written in Python. The code handles logging for -a function that determines the number of tasks needed to be run. See the -":ref:`ref-tasks-listtasks`" -section for additional information:: - - python do_listtasks() { - bb.debug(2, "Starting to figure out the task list") - if noteworthy_condition: - bb.note("There are 47 tasks to run") - bb.debug(2, "Got to point xyz") - if warning_trigger: - bb.warn("Detected warning_trigger, this might be a problem later.") - if recoverable_error: - bb.error("Hit recoverable_error, you really need to fix this!") - if fatal_error: - bb.fatal("fatal_error detected, unable to print the task list") - bb.plain("The tasks present are abc") - bb.debug(2, "Finished figuring out the tasklist") - } - -Logging With Bash -~~~~~~~~~~~~~~~~~ - -When creating recipes using Bash and inserting code that handles build -logs, you have the same goals - informative with minimal console output. -The syntax you use for recipes written in Bash is similar to that of -recipes written in Python described in the previous section. - -Following is an example written in Bash. The code logs the progress of -the ``do_my_function`` function. -:: - - do_my_function() { - bbdebug 2 "Running do_my_function" - if [ exceptional_condition ]; then - bbnote "Hit exceptional_condition" - fi - bbdebug 2 "Got to point xyz" - if [ warning_trigger ]; then - bbwarn "Detected warning_trigger, this might cause a problem later." - fi - if [ recoverable_error ]; then - bberror "Hit recoverable_error, correcting" - fi - if [ fatal_error ]; then - bbfatal "fatal_error detected" - fi - bbdebug 2 "Completed do_my_function" - } - - -Debugging Parallel Make Races ------------------------------ - -A parallel ``make`` race occurs when the build consists of several parts -that are run simultaneously and a situation occurs when the output or -result of one part is not ready for use with a different part of the -build that depends on that output. Parallel make races are annoying and -can sometimes be difficult to reproduce and fix. However, there are some simple -tips and tricks that can help you debug and fix them. This section -presents a real-world example of an error encountered on the Yocto -Project autobuilder and the process used to fix it. - -.. note:: - - If you cannot properly fix a ``make`` race condition, you can work around it - by clearing either the :term:`PARALLEL_MAKE` or :term:`PARALLEL_MAKEINST` - variables. - -The Failure -~~~~~~~~~~~ - -For this example, assume that you are building an image that depends on -the "neard" package. And, during the build, BitBake runs into problems -and creates the following output. - -.. note:: - - This example log file has longer lines artificially broken to make - the listing easier to read. - -If you examine the output or the log file, you see the failure during -``make``: - -.. code-block:: none - - | DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common'] - | DEBUG: Executing shell function do_compile - | NOTE: make -j 16 - | make --no-print-directory all-am - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/types.h include/near/types.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/log.h include/near/log.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/plugin.h include/near/plugin.h - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/tag.h include/near/tag.h - | /bin/mkdir -p include/near - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/adapter.h include/near/adapter.h - | /bin/mkdir -p include/near - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/ndef.h include/near/ndef.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/tlv.h include/near/tlv.h - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/setting.h include/near/setting.h - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | /bin/mkdir -p include/near - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/device.h include/near/device.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/nfc_copy.h include/near/nfc_copy.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/snep.h include/near/snep.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/version.h include/near/version.h - | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ - 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h - | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h - | i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/pokybuild/yocto-autobuilder/nightly-x86/ - build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/ - yocto-autobuilder/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0 - -I/home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/sysroots/qemux86/usr/ - lib/glib-2.0/include -I/home/pokybuild/yocto-autobuilder/nightly-x86/build/build/ - tmp/sysroots/qemux86/usr/include/dbus-1.0 -I/home/pokybuild/yocto-autobuilder/ - nightly-x86/build/build/tmp/sysroots/qemux86/usr/lib/dbus-1.0/include -I/home/pokybuild/yocto-autobuilder/ - nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/libnl3 - -DNEAR_PLUGIN_BUILTIN -DPLUGINDIR=\""/usr/lib/near/plugins"\" - -DCONFIGDIR=\""/etc/neard\"" -O2 -pipe -g -feliminate-unused-debug-types -c - -o tools/snep-send.o tools/snep-send.c - | In file included from tools/snep-send.c:16:0: - | tools/../src/near.h:41:23: fatal error: near/dbus.h: No such file or directory - | #include <near/dbus.h> - | ^ - | compilation terminated. - | make[1]: *** [tools/snep-send.o] Error 1 - | make[1]: *** Waiting for unfinished jobs.... - | make: *** [all] Error 2 - | ERROR: oe_runmake failed - -Reproducing the Error -~~~~~~~~~~~~~~~~~~~~~ - -Because race conditions are intermittent, they do not manifest -themselves every time you do the build. In fact, most times the build -will complete without problems even though the potential race condition -exists. Thus, once the error surfaces, you need a way to reproduce it. - -In this example, compiling the "neard" package is causing the problem. -So the first thing to do is build "neard" locally. Before you start the -build, set the -:term:`PARALLEL_MAKE` variable -in your ``local.conf`` file to a high number (e.g. "-j 20"). Using a -high value for :term:`PARALLEL_MAKE` increases the chances of the race -condition showing up:: - - $ bitbake neard - -Once the local build for "neard" completes, start a ``devshell`` build:: - - $ bitbake neard -c devshell - -For information on how to use a ``devshell``, see the -":ref:`dev-manual/common-tasks:using a development shell`" section. - -In the ``devshell``, do the following:: - - $ make clean - $ make tools/snep-send.o - -The ``devshell`` commands cause the failure to clearly -be visible. In this case, there is a missing dependency for the ``neard`` -Makefile target. Here is some abbreviated, sample output with the -missing dependency clearly visible at the end:: - - i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/...... - . - . - . - tools/snep-send.c - In file included from tools/snep-send.c:16:0: - tools/../src/near.h:41:23: fatal error: near/dbus.h: No such file or directory - #include <near/dbus.h> - ^ - compilation terminated. - make: *** [tools/snep-send.o] Error 1 - $ - - -Creating a Patch for the Fix -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Because there is a missing dependency for the Makefile target, you need -to patch the ``Makefile.am`` file, which is generated from -``Makefile.in``. You can use Quilt to create the patch:: - - $ quilt new parallelmake.patch - Patch patches/parallelmake.patch is now on top - $ quilt add Makefile.am - File Makefile.am added to patch patches/parallelmake.patch - -For more information on using Quilt, see the -":ref:`dev-manual/common-tasks:using quilt in your workflow`" section. - -At this point you need to make the edits to ``Makefile.am`` to add the -missing dependency. For our example, you have to add the following line -to the file:: - - tools/snep-send.$(OBJEXT): include/near/dbus.h - -Once you have edited the file, use the ``refresh`` command to create the -patch:: - - $ quilt refresh - Refreshed patch patches/parallelmake.patch - -Once the patch file is created, you need to add it back to the originating -recipe folder. Here is an example assuming a top-level -:term:`Source Directory` named ``poky``:: - - $ cp patches/parallelmake.patch poky/meta/recipes-connectivity/neard/neard - -The final thing you need to do to implement the fix in the build is to -update the "neard" recipe (i.e. ``neard-0.14.bb``) so that the -:term:`SRC_URI` statement includes -the patch file. The recipe file is in the folder above the patch. Here -is what the edited :term:`SRC_URI` statement would look like:: - - SRC_URI = "${KERNELORG_MIRROR}/linux/network/nfc/${BPN}-${PV}.tar.xz \ - file://neard.in \ - file://neard.service.in \ - file://parallelmake.patch \ - " - -With the patch complete and moved to the correct folder and the -:term:`SRC_URI` statement updated, you can exit the ``devshell``:: - - $ exit - -Testing the Build -~~~~~~~~~~~~~~~~~ - -With everything in place, you can get back to trying the build again -locally:: - - $ bitbake neard - -This build should succeed. - -Now you can open up a ``devshell`` again and repeat the clean and make -operations as follows:: - - $ bitbake neard -c devshell - $ make clean - $ make tools/snep-send.o - -The build should work without issue. - -As with all solved problems, if they originated upstream, you need to -submit the fix for the recipe in OE-Core and upstream so that the -problem is taken care of at its source. See the -":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" -section for more information. - -Debugging With the GNU Project Debugger (GDB) Remotely ------------------------------------------------------- - -GDB allows you to examine running programs, which in turn helps you to -understand and fix problems. It also allows you to perform post-mortem -style analysis of program crashes. GDB is available as a package within -the Yocto Project and is installed in SDK images by default. See the -":ref:`ref-manual/images:Images`" chapter in the Yocto -Project Reference Manual for a description of these images. You can find -information on GDB at https://sourceware.org/gdb/. - -.. note:: - - For best results, install debug (``-dbg``) packages for the applications you - are going to debug. Doing so makes extra debug symbols available that give - you more meaningful output. - -Sometimes, due to memory or disk space constraints, it is not possible -to use GDB directly on the remote target to debug applications. These -constraints arise because GDB needs to load the debugging information -and the binaries of the process being debugged. Additionally, GDB needs -to perform many computations to locate information such as function -names, variable names and values, stack traces and so forth - even -before starting the debugging process. These extra computations place -more load on the target system and can alter the characteristics of the -program being debugged. - -To help get past the previously mentioned constraints, there are two -methods you can use: running a debuginfod server and using gdbserver. - -Using the debuginfod server method -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -``debuginfod`` from ``elfutils`` is a way to distribute ``debuginfo`` files. -Running a ``debuginfod`` server makes debug symbols readily available, -which means you don't need to download debugging information -and the binaries of the process being debugged. You can just fetch -debug symbols from the server. - -To run a ``debuginfod`` server, you need to do the following: - -- Ensure that ``debuginfod`` is present in :term:`DISTRO_FEATURES` - (it already is in ``OpenEmbedded-core`` defaults and ``poky`` reference distribution). - If not, set in your distro config file or in ``local.conf``:: - - DISTRO_FEATURES:append = " debuginfod" - - This distro feature enables the server and client library in ``elfutils``, - and enables ``debuginfod`` support in clients (at the moment, ``gdb`` and ``binutils``). - -- Run the following commands to launch the ``debuginfod`` server on the host:: - - $ oe-debuginfod - -- To use ``debuginfod`` on the target, you need to know the ip:port where - ``debuginfod`` is listening on the host (port defaults to 8002), and export - that into the shell environment, for example in ``qemu``:: - - root@qemux86-64:~# export DEBUGINFOD_URLS="http://192.168.7.1:8002/" - -- Then debug info fetching should simply work when running the target ``gdb``, - ``readelf`` or ``objdump``, for example:: - - root@qemux86-64:~# gdb /bin/cat - ... - Reading symbols from /bin/cat... - Downloading separate debug info for /bin/cat... - Reading symbols from /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo... - -- It's also possible to use ``debuginfod-find`` to just query the server:: - - root@qemux86-64:~# debuginfod-find debuginfo /bin/ls - /home/root/.cache/debuginfod_client/356edc585f7f82d46f94fcb87a86a3fe2d2e60bd/debuginfo - - -Using the gdbserver method -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -gdbserver, which runs on the remote target and does not load any -debugging information from the debugged process. Instead, a GDB instance -processes the debugging information that is run on a remote computer - -the host GDB. The host GDB then sends control commands to gdbserver to -make it stop or start the debugged program, as well as read or write -memory regions of that debugged program. All the debugging information -loaded and processed as well as all the heavy debugging is done by the -host GDB. Offloading these processes gives the gdbserver running on the -target a chance to remain small and fast. - -Because the host GDB is responsible for loading the debugging -information and for doing the necessary processing to make actual -debugging happen, you have to make sure the host can access the -unstripped binaries complete with their debugging information and also -be sure the target is compiled with no optimizations. The host GDB must -also have local access to all the libraries used by the debugged -program. Because gdbserver does not need any local debugging -information, the binaries on the remote target can remain stripped. -However, the binaries must also be compiled without optimization so they -match the host's binaries. - -To remain consistent with GDB documentation and terminology, the binary -being debugged on the remote target machine is referred to as the -"inferior" binary. For documentation on GDB see the `GDB -site <https://sourceware.org/gdb/documentation/>`__. - -The following steps show you how to debug using the GNU project -debugger. - -1. *Configure your build system to construct the companion debug - filesystem:* - - In your ``local.conf`` file, set the following:: - - IMAGE_GEN_DEBUGFS = "1" - IMAGE_FSTYPES_DEBUGFS = "tar.bz2" - - These options cause the - OpenEmbedded build system to generate a special companion filesystem - fragment, which contains the matching source and debug symbols to - your deployable filesystem. The build system does this by looking at - what is in the deployed filesystem, and pulling the corresponding - ``-dbg`` packages. - - The companion debug filesystem is not a complete filesystem, but only - contains the debug fragments. This filesystem must be combined with - the full filesystem for debugging. Subsequent steps in this procedure - show how to combine the partial filesystem with the full filesystem. - -2. *Configure the system to include gdbserver in the target filesystem:* - - Make the following addition in either your ``local.conf`` file or in - an image recipe:: - - IMAGE_INSTALL:append = " gdbserver" - - The change makes - sure the ``gdbserver`` package is included. - -3. *Build the environment:* - - Use the following command to construct the image and the companion - Debug Filesystem:: - - $ bitbake image - - Build the cross GDB component and - make it available for debugging. Build the SDK that matches the - image. Building the SDK is best for a production build that can be - used later for debugging, especially during long term maintenance:: - - $ bitbake -c populate_sdk image - - Alternatively, you can build the minimal toolchain components that - match the target. Doing so creates a smaller than typical SDK and - only contains a minimal set of components with which to build simple - test applications, as well as run the debugger:: - - $ bitbake meta-toolchain - - A final method is to build Gdb itself within the build system:: - - $ bitbake gdb-cross-<architecture> - - Doing so produces a temporary copy of - ``cross-gdb`` you can use for debugging during development. While - this is the quickest approach, the two previous methods in this step - are better when considering long-term maintenance strategies. - - .. note:: - - If you run ``bitbake gdb-cross``, the OpenEmbedded build system suggests - the actual image (e.g. ``gdb-cross-i586``). The suggestion is usually the - actual name you want to use. - -4. *Set up the* ``debugfs``\ *:* - - Run the following commands to set up the ``debugfs``:: - - $ mkdir debugfs - $ cd debugfs - $ tar xvfj build-dir/tmp-glibc/deploy/images/machine/image.rootfs.tar.bz2 - $ tar xvfj build-dir/tmp-glibc/deploy/images/machine/image-dbg.rootfs.tar.bz2 - -5. *Set up GDB:* - - Install the SDK (if you built one) and then source the correct - environment file. Sourcing the environment file puts the SDK in your - ``PATH`` environment variable. - - If you are using the build system, Gdb is located in - `build-dir`\ ``/tmp/sysroots/``\ `host`\ ``/usr/bin/``\ `architecture`\ ``/``\ `architecture`\ ``-gdb`` - -6. *Boot the target:* - - For information on how to run QEMU, see the `QEMU - Documentation <https://wiki.qemu.org/Documentation/GettingStartedDevelopers>`__. - - .. note:: - - Be sure to verify that your host can access the target via TCP. - -7. *Debug a program:* - - Debugging a program involves running gdbserver on the target and then - running Gdb on the host. The example in this step debugs ``gzip``: - - .. code-block:: shell - - root@qemux86:~# gdbserver localhost:1234 /bin/gzip —help - - For - additional gdbserver options, see the `GDB Server - Documentation <https://www.gnu.org/software/gdb/documentation/>`__. - - After running gdbserver on the target, you need to run Gdb on the - host and configure it and connect to the target. Use these commands:: - - $ cd directory-holding-the-debugfs-directory - $ arch-gdb - (gdb) set sysroot debugfs - (gdb) set substitute-path /usr/src/debug debugfs/usr/src/debug - (gdb) target remote IP-of-target:1234 - - At this - point, everything should automatically load (i.e. matching binaries, - symbols and headers). - - .. note:: - - The Gdb ``set`` commands in the previous example can be placed into the - users ``~/.gdbinit`` file. Upon starting, Gdb automatically runs whatever - commands are in that file. - -8. *Deploying without a full image rebuild:* - - In many cases, during development you want a quick method to deploy a - new binary to the target and debug it, without waiting for a full - image build. - - One approach to solving this situation is to just build the component - you want to debug. Once you have built the component, copy the - executable directly to both the target and the host ``debugfs``. - - If the binary is processed through the debug splitting in - OpenEmbedded, you should also copy the debug items (i.e. ``.debug`` - contents and corresponding ``/usr/src/debug`` files) from the work - directory. Here is an example:: - - $ bitbake bash - $ bitbake -c devshell bash - $ cd .. - $ scp packages-split/bash/bin/bash target:/bin/bash - $ cp -a packages-split/bash-dbg/\* path/debugfs - -Debugging with the GNU Project Debugger (GDB) on the Target ------------------------------------------------------------ - -The previous section addressed using GDB remotely for debugging -purposes, which is the most usual case due to the inherent hardware -limitations on many embedded devices. However, debugging in the target -hardware itself is also possible with more powerful devices. This -section describes what you need to do in order to support using GDB to -debug on the target hardware. - -To support this kind of debugging, you need do the following: - -- Ensure that GDB is on the target. You can do this by adding "gdb" to - :term:`IMAGE_INSTALL`:: - - IMAGE_INSTALL:append = " gdb" - - Alternatively, you can add "tools-debug" to :term:`IMAGE_FEATURES`:: - - IMAGE_FEATURES:append = " tools-debug" - -- Ensure that debug symbols are present. You can make sure these - symbols are present by installing ``-dbg``:: - - IMAGE_INSTALL:append = "packagename-dbg" - - Alternatively, you can do the following to include - all the debug symbols:: - - IMAGE_FEATURES:append = " dbg-pkgs" - -.. note:: - - To improve the debug information accuracy, you can reduce the level - of optimization used by the compiler. For example, when adding the - following line to your ``local.conf`` file, you will reduce optimization - from :term:`FULL_OPTIMIZATION` of "-O2" to :term:`DEBUG_OPTIMIZATION` - of "-O -fno-omit-frame-pointer":: - - DEBUG_BUILD = "1" - - Consider that this will reduce the application's performance and is - recommended only for debugging purposes. - -Other Debugging Tips --------------------- - -Here are some other tips that you might find useful: - -- When adding new packages, it is worth watching for undesirable items - making their way into compiler command lines. For example, you do not - want references to local system files like ``/usr/lib/`` or - ``/usr/include/``. - -- If you want to remove the ``psplash`` boot splashscreen, add - ``psplash=false`` to the kernel command line. Doing so prevents - ``psplash`` from loading and thus allows you to see the console. It - is also possible to switch out of the splashscreen by switching the - virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). - -- Removing :term:`TMPDIR` (usually - ``tmp/``, within the - :term:`Build Directory`) can often fix - temporary build issues. Removing :term:`TMPDIR` is usually a relatively - cheap operation, because task output will be cached in - :term:`SSTATE_DIR` (usually - ``sstate-cache/``, which is also in the Build Directory). - - .. note:: - - Removing :term:`TMPDIR` might be a workaround rather than a fix. - Consequently, trying to determine the underlying cause of an issue before - removing the directory is a good idea. - -- Understanding how a feature is used in practice within existing - recipes can be very helpful. It is recommended that you configure - some method that allows you to quickly search through files. - - Using GNU Grep, you can use the following shell function to - recursively search through common recipe-related files, skipping - binary files, ``.git`` directories, and the Build Directory (assuming - its name starts with "build"):: - - g() { - grep -Ir \ - --exclude-dir=.git \ - --exclude-dir='build*' \ - --include='*.bb*' \ - --include='*.inc*' \ - --include='*.conf*' \ - --include='*.py*' \ - "$@" - } - - Following are some usage examples:: - - $ g FOO # Search recursively for "FOO" - $ g -i foo # Search recursively for "foo", ignoring case - $ g -w FOO # Search recursively for "FOO" as a word, ignoring e.g. "FOOBAR" - - If figuring - out how some feature works requires a lot of searching, it might - indicate that the documentation should be extended or improved. In - such cases, consider filing a documentation bug using the Yocto - Project implementation of - :yocto_bugs:`Bugzilla <>`. For information on - how to submit a bug against the Yocto Project, see the Yocto Project - Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` - and the - ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" - section. - - .. note:: - - The manuals might not be the right place to document variables - that are purely internal and have a limited scope (e.g. internal - variables used to implement a single ``.bbclass`` file). - -Making Changes to the Yocto Project -=================================== - -Because the Yocto Project is an open-source, community-based project, -you can effect changes to the project. This section presents procedures -that show you how to submit a defect against the project and how to -submit a change. - -Submitting a Defect Against the Yocto Project ---------------------------------------------- - -Use the Yocto Project implementation of -`Bugzilla <https://www.bugzilla.org/about/>`__ to submit a defect (bug) -against the Yocto Project. For additional information on this -implementation of Bugzilla see the ":ref:`Yocto Project -Bugzilla <resources-bugtracker>`" section in the -Yocto Project Reference Manual. For more detail on any of the following -steps, see the Yocto Project -:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. - -Use the following general steps to submit a bug: - -1. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. - -2. Click "File a Bug" to enter a new bug. - -3. Choose the appropriate "Classification", "Product", and "Component" - for which the bug was found. Bugs for the Yocto Project fall into - one of several classifications, which in turn break down into - several products and components. For example, for a bug against the - ``meta-intel`` layer, you would choose "Build System, Metadata & - Runtime", "BSPs", and "bsps-meta-intel", respectively. - -4. Choose the "Version" of the Yocto Project for which you found the - bug (e.g. &DISTRO;). - -5. Determine and select the "Severity" of the bug. The severity - indicates how the bug impacted your work. - -6. Choose the "Hardware" that the bug impacts. - -7. Choose the "Architecture" that the bug impacts. - -8. Choose a "Documentation change" item for the bug. Fixing a bug might - or might not affect the Yocto Project documentation. If you are - unsure of the impact to the documentation, select "Don't Know". - -9. Provide a brief "Summary" of the bug. Try to limit your summary to - just a line or two and be sure to capture the essence of the bug. - -10. Provide a detailed "Description" of the bug. You should provide as - much detail as you can about the context, behavior, output, and so - forth that surrounds the bug. You can even attach supporting files - for output from logs by using the "Add an attachment" button. - -11. Click the "Submit Bug" button submit the bug. A new Bugzilla number - is assigned to the bug and the defect is logged in the bug tracking - system. - -Once you file a bug, the bug is processed by the Yocto Project Bug -Triage Team and further details concerning the bug are assigned (e.g. -priority and owner). You are the "Submitter" of the bug and any further -categorization, progress, or comments on the bug result in Bugzilla -sending you an automated email concerning the particular change or -progress to the bug. - -Submitting a Change to the Yocto Project ----------------------------------------- - -Contributions to the Yocto Project and OpenEmbedded are very welcome. -Because the system is extremely configurable and flexible, we recognize -that developers will want to extend, configure or optimize it for their -specific uses. - -The Yocto Project uses a mailing list and a patch-based workflow that is -similar to the Linux kernel but contains important differences. In -general, there is a mailing list through which you can submit patches. You -should send patches to the appropriate mailing list so that they can be -reviewed and merged by the appropriate maintainer. The specific mailing -list you need to use depends on the location of the code you are -changing. Each component (e.g. layer) should have a ``README`` file that -indicates where to send the changes and which process to follow. - -You can send the patch to the mailing list using whichever approach you -feel comfortable with to generate the patch. Once sent, the patch is -usually reviewed by the community at large. If somebody has concerns -with the patch, they will usually voice their concern over the mailing -list. If a patch does not receive any negative reviews, the maintainer -of the affected layer typically takes the patch, tests it, and then -based on successful testing, merges the patch. - -The "poky" repository, which is the Yocto Project's reference build -environment, is a hybrid repository that contains several individual -pieces (e.g. BitBake, Metadata, documentation, and so forth) built using -the combo-layer tool. The upstream location used for submitting changes -varies by component: - -- *Core Metadata:* Send your patch to the - :oe_lists:`openembedded-core </g/openembedded-core>` - mailing list. For example, a change to anything under the ``meta`` or - ``scripts`` directories should be sent to this mailing list. - -- *BitBake:* For changes to BitBake (i.e. anything under the - ``bitbake`` directory), send your patch to the - :oe_lists:`bitbake-devel </g/bitbake-devel>` - mailing list. - -- *"meta-\*" trees:* These trees contain Metadata. Use the - :yocto_lists:`poky </g/poky>` mailing list. - -- *Documentation*: For changes to the Yocto Project documentation, use the - :yocto_lists:`docs </g/docs>` mailing list. - -For changes to other layers hosted in the Yocto Project source -repositories (i.e. ``yoctoproject.org``) and tools use the -:yocto_lists:`Yocto Project </g/yocto/>` general mailing list. - -.. note:: - - Sometimes a layer's documentation specifies to use a particular - mailing list. If so, use that list. - -For additional recipes that do not fit into the core Metadata, you -should determine which layer the recipe should go into and submit the -change in the manner recommended by the documentation (e.g. the -``README`` file) supplied with the layer. If in doubt, please ask on the -Yocto general mailing list or on the openembedded-devel mailing list. - -You can also push a change upstream and request a maintainer to pull the -change into the component's upstream repository. You do this by pushing -to a contribution repository that is upstream. See the -":ref:`overview-manual/development-environment:git workflows and the yocto project`" -section in the Yocto Project Overview and Concepts Manual for additional -concepts on working in the Yocto Project development environment. - -Maintainers commonly use ``-next`` branches to test submissions prior to -merging patches. Thus, you can get an idea of the status of a patch based on -whether the patch has been merged into one of these branches. The commonly -used testing branches for OpenEmbedded-Core are as follows: - -- *openembedded-core "master-next" branch:* This branch is part of the - :oe_git:`openembedded-core </openembedded-core/>` repository and contains - proposed changes to the core metadata. - -- *poky "master-next" branch:* This branch is part of the - :yocto_git:`poky </poky/>` repository and combines proposed - changes to bitbake, the core metadata and the poky distro. - -Similarly, stable branches maintained by the project may have corresponding -``-next`` branches which collect proposed changes. For example, -``&DISTRO_NAME_NO_CAP;-next`` and ``&DISTRO_NAME_NO_CAP_MINUS_ONE;-next`` -branches in both the "openembdedded-core" and "poky" repositories. - -Other layers may have similar testing branches but there is no formal -requirement or standard for these so please check the documentation for the -layers you are contributing to. - -The following sections provide procedures for submitting a change. - -Preparing Changes for Submission -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. *Make Your Changes Locally:* Make your changes in your local Git - repository. You should make small, controlled, isolated changes. - Keeping changes small and isolated aids review, makes - merging/rebasing easier and keeps the change history clean should - anyone need to refer to it in future. - -2. *Stage Your Changes:* Stage your changes by using the ``git add`` - command on each file you changed. - -3. *Commit Your Changes:* Commit the change by using the ``git commit`` - command. Make sure your commit information follows standards by - following these accepted conventions: - - - Be sure to include a "Signed-off-by:" line in the same style as - required by the Linux kernel. Adding this line signifies that you, - the submitter, have agreed to the Developer's Certificate of - Origin 1.1 as follows: - - .. code-block:: none - - Developer's Certificate of Origin 1.1 - - By making a contribution to this project, I certify that: - - (a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - - (b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - - (c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. - - - Provide a single-line summary of the change and, if more - explanation is needed, provide more detail in the body of the - commit. This summary is typically viewable in the "shortlist" of - changes. Thus, providing something short and descriptive that - gives the reader a summary of the change is useful when viewing a - list of many commits. You should prefix this short description - with the recipe name (if changing a recipe), or else with the - short form path to the file being changed. - - - For the body of the commit message, provide detailed information - that describes what you changed, why you made the change, and the - approach you used. It might also be helpful if you mention how you - tested the change. Provide as much detail as you can in the body - of the commit message. - - .. note:: - - You do not need to provide a more detailed explanation of a - change if the change is minor to the point of the single line - summary providing all the information. - - - If the change addresses a specific bug or issue that is associated - with a bug-tracking ID, include a reference to that ID in your - detailed description. For example, the Yocto Project uses a - specific convention for bug references - any commit that addresses - a specific bug should use the following form for the detailed - description. Be sure to use the actual bug-tracking ID from - Bugzilla for bug-id:: - - Fixes [YOCTO #bug-id] - - detailed description of change - -Using Email to Submit a Patch -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Depending on the components changed, you need to submit the email to a -specific mailing list. For some guidance on which mailing list to use, -see the -:ref:`list <dev-manual/common-tasks:submitting a change to the yocto project>` -at the beginning of this section. For a description of all the available -mailing lists, see the ":ref:`Mailing Lists <resources-mailinglist>`" section in the -Yocto Project Reference Manual. - -Here is the general procedure on how to submit a patch through email -without using the scripts once the steps in -:ref:`dev-manual/common-tasks:preparing changes for submission` have been followed: - -1. *Format the Commit:* Format the commit into an email message. To - format commits, use the ``git format-patch`` command. When you - provide the command, you must include a revision list or a number of - patches as part of the command. For example, either of these two - commands takes your most recent single commit and formats it as an - email message in the current directory:: - - $ git format-patch -1 - - or :: - - $ git format-patch HEAD~ - - After the command is run, the current directory contains a numbered - ``.patch`` file for the commit. - - If you provide several commits as part of the command, the - ``git format-patch`` command produces a series of numbered files in - the current directory – one for each commit. If you have more than - one patch, you should also use the ``--cover`` option with the - command, which generates a cover letter as the first "patch" in the - series. You can then edit the cover letter to provide a description - for the series of patches. For information on the - ``git format-patch`` command, see ``GIT_FORMAT_PATCH(1)`` displayed - using the ``man git-format-patch`` command. - - .. note:: - - If you are or will be a frequent contributor to the Yocto Project - or to OpenEmbedded, you might consider requesting a contrib area - and the necessary associated rights. - -2. *Send the patches via email:* Send the patches to the recipients and - relevant mailing lists by using the ``git send-email`` command. - - .. note:: - - In order to use ``git send-email``, you must have the proper Git packages - installed on your host. - For Ubuntu, Debian, and Fedora the package is ``git-email``. - - The ``git send-email`` command sends email by using a local or remote - Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or - through a direct ``smtp`` configuration in your Git ``~/.gitconfig`` - file. If you are submitting patches through email only, it is very - important that you submit them without any whitespace or HTML - formatting that either you or your mailer introduces. The maintainer - that receives your patches needs to be able to save and apply them - directly from your emails. A good way to verify that what you are - sending will be applicable by the maintainer is to do a dry run and - send them to yourself and then save and apply them as the maintainer - would. - - The ``git send-email`` command is the preferred method for sending - your patches using email since there is no risk of compromising - whitespace in the body of the message, which can occur when you use - your own mail client. The command also has several options that let - you specify recipients and perform further editing of the email - message. For information on how to use the ``git send-email`` - command, see ``GIT-SEND-EMAIL(1)`` displayed using the - ``man git-send-email`` command. - -The Yocto Project uses a `Patchwork instance <https://patchwork.openembedded.org/>`__ -to track the status of patches submitted to the various mailing lists and to -support automated patch testing. Each submitted patch is checked for common -mistakes and deviations from the expected patch format and submitters are -notified by patchtest if such mistakes are found. This process helps to -reduce the burden of patch review on maintainers. - -.. note:: - - This system is imperfect and changes can sometimes get lost in the flow. - Asking about the status of a patch or change is reasonable if the change - has been idle for a while with no feedback. - -Using Scripts to Push a Change Upstream and Request a Pull -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For larger patch series it is preferable to send a pull request which not -only includes the patch but also a pointer to a branch that can be pulled -from. This involves making a local branch for your changes, pushing this -branch to an accessible repository and then using the ``create-pull-request`` -and ``send-pull-request`` scripts from openembedded-core to create and send a -patch series with a link to the branch for review. - -Follow this procedure to push a change to an upstream "contrib" Git -repository once the steps in :ref:`dev-manual/common-tasks:preparing changes for submission` have -been followed: - -.. note:: - - You can find general Git information on how to push a change upstream - in the - `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__. - -1. *Push Your Commits to a "Contrib" Upstream:* If you have arranged for - permissions to push to an upstream contrib repository, push the - change to that repository:: - - $ git push upstream_remote_repo local_branch_name - - For example, suppose you have permissions to push - into the upstream ``meta-intel-contrib`` repository and you are - working in a local branch named `your_name`\ ``/README``. The following - command pushes your local commits to the ``meta-intel-contrib`` - upstream repository and puts the commit in a branch named - `your_name`\ ``/README``:: - - $ git push meta-intel-contrib your_name/README - -2. *Determine Who to Notify:* Determine the maintainer or the mailing - list that you need to notify for the change. - - Before submitting any change, you need to be sure who the maintainer - is or what mailing list that you need to notify. Use either these - methods to find out: - - - *Maintenance File:* Examine the ``maintainers.inc`` file, which is - located in the :term:`Source Directory` at - ``meta/conf/distro/include``, to see who is responsible for code. - - - *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can - enter the following command to bring up a short list of all - commits against a specific file:: - - git shortlog -- filename - - Just provide the name of the file for which you are interested. The - information returned is not ordered by history but does include a - list of everyone who has committed grouped by name. From the list, - you can see who is responsible for the bulk of the changes against - the file. - - - *Examine the List of Mailing Lists:* For a list of the Yocto - Project and related mailing lists, see the ":ref:`Mailing - lists <resources-mailinglist>`" section in - the Yocto Project Reference Manual. - -3. *Make a Pull Request:* Notify the maintainer or the mailing list that - you have pushed a change by making a pull request. - - The Yocto Project provides two scripts that conveniently let you - generate and send pull requests to the Yocto Project. These scripts - are ``create-pull-request`` and ``send-pull-request``. You can find - these scripts in the ``scripts`` directory within the - :term:`Source Directory` (e.g. - ``poky/scripts``). - - Using these scripts correctly formats the requests without - introducing any whitespace or HTML formatting. The maintainer that - receives your patches either directly or through the mailing list - needs to be able to save and apply them directly from your emails. - Using these scripts is the preferred method for sending patches. - - First, create the pull request. For example, the following command - runs the script, specifies the upstream repository in the contrib - directory into which you pushed the change, and provides a subject - line in the created patch files:: - - $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" - - Running this script forms ``*.patch`` files in a folder named - ``pull-``\ `PID` in the current directory. One of the patch files is a - cover letter. - - Before running the ``send-pull-request`` script, you must edit the - cover letter patch to insert information about your change. After - editing the cover letter, send the pull request. For example, the - following command runs the script and specifies the patch directory - and email address. In this example, the email address is a mailing - list:: - - $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@lists.yoctoproject.org - - You need to follow the prompts as the script is interactive. - - .. note:: - - For help on using these scripts, simply provide the ``-h`` - argument as follows:: - - $ poky/scripts/create-pull-request -h - $ poky/scripts/send-pull-request -h - -Responding to Patch Review -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You may get feedback on your submitted patches from other community members -or from the automated patchtest service. If issues are identified in your -patch then it is usually necessary to address these before the patch will be -accepted into the project. In this case you should amend the patch according -to the feedback and submit an updated version to the relevant mailing list, -copying in the reviewers who provided feedback to the previous version of the -patch. - -The patch should be amended using ``git commit --amend`` or perhaps ``git -rebase`` for more expert git users. You should also modify the ``[PATCH]`` -tag in the email subject line when sending the revised patch to mark the new -iteration as ``[PATCH v2]``, ``[PATCH v3]``, etc as appropriate. This can be -done by passing the ``-v`` argument to ``git format-patch`` with a version -number. - -Lastly please ensure that you also test your revised changes. In particular -please don't just edit the patch file written out by ``git format-patch`` and -resend it. - -Submitting Changes to Stable Release Branches -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The process for proposing changes to a Yocto Project stable branch differs -from the steps described above. Changes to a stable branch must address -identified bugs or CVEs and should be made carefully in order to avoid the -risk of introducing new bugs or breaking backwards compatibility. Typically -bug fixes must already be accepted into the master branch before they can be -backported to a stable branch unless the bug in question does not affect the -master branch or the fix on the master branch is unsuitable for backporting. - -The list of stable branches along with the status and maintainer for each -branch can be obtained from the -:yocto_wiki:`Releases wiki page </Releases>`. - -.. note:: - - Changes will not typically be accepted for branches which are marked as - End-Of-Life (EOL). - -With this in mind, the steps to submit a change for a stable branch are as -follows: - -1. *Identify the bug or CVE to be fixed:* This information should be - collected so that it can be included in your submission. - - See :ref:`dev-manual/common-tasks:checking for vulnerabilities` - for details about CVE tracking. - -2. *Check if the fix is already present in the master branch:* This will - result in the most straightforward path into the stable branch for the - fix. - - a. *If the fix is present in the master branch - Submit a backport request - by email:* You should send an email to the relevant stable branch - maintainer and the mailing list with details of the bug or CVE to be - fixed, the commit hash on the master branch that fixes the issue and - the stable branches which you would like this fix to be backported to. - - b. *If the fix is not present in the master branch - Submit the fix to the - master branch first:* This will ensure that the fix passes through the - project's usual patch review and test processes before being accepted. - It will also ensure that bugs are not left unresolved in the master - branch itself. Once the fix is accepted in the master branch a backport - request can be submitted as above. - - c. *If the fix is unsuitable for the master branch - Submit a patch - directly for the stable branch:* This method should be considered as a - last resort. It is typically necessary when the master branch is using - a newer version of the software which includes an upstream fix for the - issue or when the issue has been fixed on the master branch in a way - that introduces backwards incompatible changes. In this case follow the - steps in :ref:`dev-manual/common-tasks:preparing changes for submission` and - :ref:`dev-manual/common-tasks:using email to submit a patch` but modify the subject header of your patch - email to include the name of the stable branch which you are - targetting. This can be done using the ``--subject-prefix`` argument to - ``git format-patch``, for example to submit a patch to the dunfell - branch use - ``git format-patch --subject-prefix='&DISTRO_NAME_NO_CAP_MINUS_ONE;][PATCH' ...``. - -Working With Licenses -===================== - -As mentioned in the ":ref:`overview-manual/development-environment:licensing`" -section in the Yocto Project Overview and Concepts Manual, open source -projects are open to the public and they consequently have different -licensing structures in place. This section describes the mechanism by -which the :term:`OpenEmbedded Build System` -tracks changes to -licensing text and covers how to maintain open source license compliance -during your project's lifecycle. The section also describes how to -enable commercially licensed recipes, which by default are disabled. - -Tracking License Changes ------------------------- - -The license of an upstream project might change in the future. In order -to prevent these changes going unnoticed, the -:term:`LIC_FILES_CHKSUM` -variable tracks changes to the license text. The checksums are validated -at the end of the configure step, and if the checksums do not match, the -build will fail. - -Specifying the ``LIC_FILES_CHKSUM`` Variable -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The :term:`LIC_FILES_CHKSUM` variable contains checksums of the license text -in the source code for the recipe. Following is an example of how to -specify :term:`LIC_FILES_CHKSUM`:: - - LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ - file://licfile1.txt;beginline=5;endline=29;md5=yyyy \ - file://licfile2.txt;endline=50;md5=zzzz \ - ..." - -.. note:: - - - When using "beginline" and "endline", realize that line numbering - begins with one and not zero. Also, the included lines are - inclusive (i.e. lines five through and including 29 in the - previous example for ``licfile1.txt``). - - - When a license check fails, the selected license text is included - as part of the QA message. Using this output, you can determine - the exact start and finish for the needed license text. - -The build system uses the :term:`S` -variable as the default directory when searching files listed in -:term:`LIC_FILES_CHKSUM`. The previous example employs the default -directory. - -Consider this next example:: - - LIC_FILES_CHKSUM = "file://src/ls.c;beginline=5;endline=16;\ - md5=bb14ed3c4cda583abc85401304b5cd4e" - LIC_FILES_CHKSUM = "file://${WORKDIR}/license.html;md5=5c94767cedb5d6987c902ac850ded2c6" - -The first line locates a file in ``${S}/src/ls.c`` and isolates lines -five through 16 as license text. The second line refers to a file in -:term:`WORKDIR`. - -Note that :term:`LIC_FILES_CHKSUM` variable is mandatory for all recipes, -unless the :term:`LICENSE` variable is set to "CLOSED". - -Explanation of Syntax -~~~~~~~~~~~~~~~~~~~~~ - -As mentioned in the previous section, the :term:`LIC_FILES_CHKSUM` variable -lists all the important files that contain the license text for the -source code. It is possible to specify a checksum for an entire file, or -a specific section of a file (specified by beginning and ending line -numbers with the "beginline" and "endline" parameters, respectively). -The latter is useful for source files with a license notice header, -README documents, and so forth. If you do not use the "beginline" -parameter, then it is assumed that the text begins on the first line of -the file. Similarly, if you do not use the "endline" parameter, it is -assumed that the license text ends with the last line of the file. - -The "md5" parameter stores the md5 checksum of the license text. If the -license text changes in any way as compared to this parameter then a -mismatch occurs. This mismatch triggers a build failure and notifies the -developer. Notification allows the developer to review and address the -license text changes. Also note that if a mismatch occurs during the -build, the correct md5 checksum is placed in the build log and can be -easily copied to the recipe. - -There is no limit to how many files you can specify using the -:term:`LIC_FILES_CHKSUM` variable. Generally, however, every project -requires a few specifications for license tracking. Many projects have a -"COPYING" file that stores the license information for all the source -code files. This practice allows you to just track the "COPYING" file as -long as it is kept up to date. - -.. note:: - - - If you specify an empty or invalid "md5" parameter, - :term:`BitBake` returns an md5 - mis-match error and displays the correct "md5" parameter value - during the build. The correct parameter is also captured in the - build log. - - - If the whole file contains only license text, you do not need to - use the "beginline" and "endline" parameters. - -Enabling Commercially Licensed Recipes --------------------------------------- - -By default, the OpenEmbedded build system disables components that have -commercial or other special licensing requirements. Such requirements -are defined on a recipe-by-recipe basis through the -:term:`LICENSE_FLAGS` variable -definition in the affected recipe. For instance, the -``poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly`` recipe -contains the following statement:: - - LICENSE_FLAGS = "commercial" - -Here is a -slightly more complicated example that contains both an explicit recipe -name and version (after variable expansion):: - - LICENSE_FLAGS = "license_${PN}_${PV}" - -In order for a component restricted by a -:term:`LICENSE_FLAGS` definition to be enabled and included in an image, it -needs to have a matching entry in the global -:term:`LICENSE_FLAGS_WHITELIST` -variable, which is a variable typically defined in your ``local.conf`` -file. For example, to enable the -``poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly`` package, you -could add either the string "commercial_gst-plugins-ugly" or the more -general string "commercial" to :term:`LICENSE_FLAGS_WHITELIST`. See the -":ref:`dev-manual/common-tasks:license flag matching`" section for a full -explanation of how :term:`LICENSE_FLAGS` matching works. Here is the -example:: - - LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly" - -Likewise, to additionally enable the package built from the recipe -containing ``LICENSE_FLAGS = "license_${PN}_${PV}"``, and assuming that -the actual recipe name was ``emgd_1.10.bb``, the following string would -enable that package as well as the original ``gst-plugins-ugly`` -package:: - - LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly license_emgd_1.10" - -As a convenience, you do not need to specify the -complete license string for every package. You can use -an abbreviated form, which consists of just the first portion or -portions of the license string before the initial underscore character -or characters. A partial string will match any license that contains the -given string as the first portion of its license. For example, the -following value will also match both of the packages -previously mentioned as well as any other packages that have licenses -starting with "commercial" or "license". -:: - - LICENSE_FLAGS_WHITELIST = "commercial license" - -License Flag Matching -~~~~~~~~~~~~~~~~~~~~~ - -License flag matching allows you to control what recipes the -OpenEmbedded build system includes in the build. Fundamentally, the -build system attempts to match :term:`LICENSE_FLAGS` strings found in -recipes against strings found in :term:`LICENSE_FLAGS_WHITELIST`. -A match causes the build system to include a recipe in the -build, while failure to find a match causes the build system to exclude -a recipe. - -In general, license flag matching is simple. However, understanding some -concepts will help you correctly and effectively use matching. - -Before a flag defined by a particular recipe is tested against the -entries of :term:`LICENSE_FLAGS_WHITELIST`, the expanded -string ``_${PN}`` is appended to the flag. This expansion makes each -:term:`LICENSE_FLAGS` value recipe-specific. After expansion, the -string is then matched against the entries. Thus, specifying -``LICENSE_FLAGS = "commercial"`` in recipe "foo", for example, results -in the string ``"commercial_foo"``. And, to create a match, that string -must appear among the entries of :term:`LICENSE_FLAGS_WHITELIST`. - -Judicious use of the :term:`LICENSE_FLAGS` strings and the contents of the -:term:`LICENSE_FLAGS_WHITELIST` variable allows you a lot of flexibility for -including or excluding recipes based on licensing. For example, you can -broaden the matching capabilities by using license flags string subsets -in :term:`LICENSE_FLAGS_WHITELIST`. - -.. note:: - - When using a string subset, be sure to use the part of the expanded - string that precedes the appended underscore character (e.g. - ``usethispart_1.3``, ``usethispart_1.4``, and so forth). - -For example, simply specifying the string "commercial" in the -:term:`LICENSE_FLAGS_WHITELIST` variable matches any expanded -:term:`LICENSE_FLAGS` definition that starts with the string -"commercial" such as "commercial_foo" and "commercial_bar", which -are the strings the build system automatically generates for -hypothetical recipes named "foo" and "bar" assuming those recipes simply -specify the following:: - - LICENSE_FLAGS = "commercial" - -Thus, you can choose to exhaustively enumerate each license flag in the -list and allow only specific recipes into the image, or you can use a -string subset that causes a broader range of matches to allow a range of -recipes into the image. - -This scheme works even if the :term:`LICENSE_FLAGS` string already has -``_${PN}`` appended. For example, the build system turns the license -flag "commercial_1.2_foo" into "commercial_1.2_foo_foo" and would match -both the general "commercial" and the specific "commercial_1.2_foo" -strings found in the :term:`LICENSE_FLAGS_WHITELIST` variable, as expected. - -Here are some other scenarios: - -- You can specify a versioned string in the recipe such as - "commercial_foo_1.2" in a "foo" recipe. The build system expands this - string to "commercial_foo_1.2_foo". Combine this license flag with a - :term:`LICENSE_FLAGS_WHITELIST` variable that has the string - "commercial" and you match the flag along with any other flag that - starts with the string "commercial". - -- Under the same circumstances, you can add "commercial_foo" in the - :term:`LICENSE_FLAGS_WHITELIST` variable and the build system not only - matches "commercial_foo_1.2" but also matches any license flag with - the string "commercial_foo", regardless of the version. - -- You can be very specific and use both the package and version parts - in the :term:`LICENSE_FLAGS_WHITELIST` list (e.g. - "commercial_foo_1.2") to specifically match a versioned recipe. - -Other Variables Related to Commercial Licenses -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -There are other helpful variables related to commercial license handling, -defined in the -``poky/meta/conf/distro/include/default-distrovars.inc`` file:: - - COMMERCIAL_AUDIO_PLUGINS ?= "" - COMMERCIAL_VIDEO_PLUGINS ?= "" - -If you -want to enable these components, you can do so by making sure you have -statements similar to the following in your ``local.conf`` configuration -file:: - - COMMERCIAL_AUDIO_PLUGINS = "gst-plugins-ugly-mad \ - gst-plugins-ugly-mpegaudioparse" - COMMERCIAL_VIDEO_PLUGINS = "gst-plugins-ugly-mpeg2dec \ - gst-plugins-ugly-mpegstream gst-plugins-bad-mpegvideoparse" - LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" - - -Of course, you could also create a matching list for those -components using the more general "commercial" in the -:term:`LICENSE_FLAGS_WHITELIST` variable, but that would also enable all -the other packages with :term:`LICENSE_FLAGS` -containing "commercial", which you may or may not want:: - - LICENSE_FLAGS_WHITELIST = "commercial" - -Specifying audio and video plugins as part of the -``COMMERCIAL_AUDIO_PLUGINS`` and ``COMMERCIAL_VIDEO_PLUGINS`` statements -(along with the enabling :term:`LICENSE_FLAGS_WHITELIST`) includes the -plugins or components into built images, thus adding support for media -formats or components. - -Maintaining Open Source License Compliance During Your Product's Lifecycle --------------------------------------------------------------------------- - -One of the concerns for a development organization using open source -software is how to maintain compliance with various open source -licensing during the lifecycle of the product. While this section does -not provide legal advice or comprehensively cover all scenarios, it does -present methods that you can use to assist you in meeting the compliance -requirements during a software release. - -With hundreds of different open source licenses that the Yocto Project -tracks, it is difficult to know the requirements of each and every -license. However, the requirements of the major FLOSS licenses can begin -to be covered by assuming that there are three main areas of concern: - -- Source code must be provided. - -- License text for the software must be provided. - -- Compilation scripts and modifications to the source code must be - provided. - -- spdx files can be provided. - -There are other requirements beyond the scope of these three and the -methods described in this section (e.g. the mechanism through which -source code is distributed). - -As different organizations have different methods of complying with open -source licensing, this section is not meant to imply that there is only -one single way to meet your compliance obligations, but rather to -describe one method of achieving compliance. The remainder of this -section describes methods supported to meet the previously mentioned -three requirements. Once you take steps to meet these requirements, and -prior to releasing images, sources, and the build system, you should -audit all artifacts to ensure completeness. - -.. note:: - - The Yocto Project generates a license manifest during image creation - that is located in ``${DEPLOY_DIR}/licenses/``\ `image_name`\ ``-``\ `datestamp` - to assist with any audits. - -Providing the Source Code -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Compliance activities should begin before you generate the final image. -The first thing you should look at is the requirement that tops the list -for most compliance groups - providing the source. The Yocto Project has -a few ways of meeting this requirement. - -One of the easiest ways to meet this requirement is to provide the -entire :term:`DL_DIR` used by the -build. This method, however, has a few issues. The most obvious is the -size of the directory since it includes all sources used in the build -and not just the source used in the released image. It will include -toolchain source, and other artifacts, which you would not generally -release. However, the more serious issue for most companies is -accidental release of proprietary software. The Yocto Project provides -an :ref:`archiver <ref-classes-archiver>` class to -help avoid some of these concerns. - -Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to -decide how you choose to provide source. The source ``archiver`` class -can generate tarballs and SRPMs and can create them with various levels -of compliance in mind. - -One way of doing this (but certainly not the only way) is to release -just the source as a tarball. You can do this by adding the following to -the ``local.conf`` file found in the -:term:`Build Directory`:: - - INHERIT += "archiver" - ARCHIVER_MODE[src] = "original" - -During the creation of your -image, the source from all recipes that deploy packages to the image is -placed within subdirectories of ``DEPLOY_DIR/sources`` based on the -:term:`LICENSE` for each recipe. -Releasing the entire directory enables you to comply with requirements -concerning providing the unmodified source. It is important to note that -the size of the directory can get large. - -A way to help mitigate the size issue is to only release tarballs for -licenses that require the release of source. Let us assume you are only -concerned with GPL code as identified by running the following script: - -.. code-block:: shell - - # Script to archive a subset of packages matching specific license(s) - # Source and license files are copied into sub folders of package folder - # Must be run from build folder - #!/bin/bash - src_release_dir="source-release" - mkdir -p $src_release_dir - for a in tmp/deploy/sources/*; do - for d in $a/*; do - # Get package name from path - p=`basename $d` - p=${p%-*} - p=${p%-*} - # Only archive GPL packages (update *GPL* regex for your license check) - numfiles=`ls tmp/deploy/licenses/$p/*GPL* 2> /dev/null | wc -l` - if [ $numfiles -ge 1 ]; then - echo Archiving $p - mkdir -p $src_release_dir/$p/source - cp $d/* $src_release_dir/$p/source 2> /dev/null - mkdir -p $src_release_dir/$p/license - cp tmp/deploy/licenses/$p/* $src_release_dir/$p/license 2> /dev/null - fi - done - done - -At this point, you -could create a tarball from the ``gpl_source_release`` directory and -provide that to the end user. This method would be a step toward -achieving compliance with section 3a of GPLv2 and with section 6 of -GPLv3. - -Providing License Text -~~~~~~~~~~~~~~~~~~~~~~ - -One requirement that is often overlooked is inclusion of license text. -This requirement also needs to be dealt with prior to generating the -final image. Some licenses require the license text to accompany the -binary. You can achieve this by adding the following to your -``local.conf`` file:: - - COPY_LIC_MANIFEST = "1" - COPY_LIC_DIRS = "1" - LICENSE_CREATE_PACKAGE = "1" - -Adding these statements to the -configuration file ensures that the licenses collected during package -generation are included on your image. - -.. note:: - - Setting all three variables to "1" results in the image having two - copies of the same license file. One copy resides in - ``/usr/share/common-licenses`` and the other resides in - ``/usr/share/license``. - - The reason for this behavior is because - :term:`COPY_LIC_DIRS` and - :term:`COPY_LIC_MANIFEST` - add a copy of the license when the image is built but do not offer a - path for adding licenses for newly installed packages to an image. - :term:`LICENSE_CREATE_PACKAGE` - adds a separate package and an upgrade path for adding licenses to an - image. - -As the source ``archiver`` class has already archived the original -unmodified source that contains the license files, you would have -already met the requirements for inclusion of the license information -with source as defined by the GPL and other open source licenses. - -Providing Compilation Scripts and Source Code Modifications -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -At this point, we have addressed all we need to prior to generating the -image. The next two requirements are addressed during the final -packaging of the release. - -By releasing the version of the OpenEmbedded build system and the layers -used during the build, you will be providing both compilation scripts -and the source code modifications in one step. - -If the deployment team has a :ref:`overview-manual/concepts:bsp layer` -and a distro layer, and those -those layers are used to patch, compile, package, or modify (in any way) -any open source software included in your released images, you might be -required to release those layers under section 3 of GPLv2 or section 1 -of GPLv3. One way of doing that is with a clean checkout of the version -of the Yocto Project and layers used during your build. Here is an -example: - -.. code-block:: shell - - # We built using the dunfell branch of the poky repo - $ git clone -b dunfell git://git.yoctoproject.org/poky - $ cd poky - # We built using the release_branch for our layers - $ git clone -b release_branch git://git.mycompany.com/meta-my-bsp-layer - $ git clone -b release_branch git://git.mycompany.com/meta-my-software-layer - # clean up the .git repos - $ find . -name ".git" -type d -exec rm -rf {} \; - -One -thing a development organization might want to consider for end-user -convenience is to modify ``meta-poky/conf/bblayers.conf.sample`` to -ensure that when the end user utilizes the released build system to -build an image, the development organization's layers are included in -the ``bblayers.conf`` file automatically:: - - # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf - # changes incompatibly - POKY_BBLAYERS_CONF_VERSION = "2" - - BBPATH = "${TOPDIR}" - BBFILES ?= "" - - BBLAYERS ?= " \ - ##OEROOT##/meta \ - ##OEROOT##/meta-poky \ - ##OEROOT##/meta-yocto-bsp \ - ##OEROOT##/meta-mylayer \ - " - -Creating and -providing an archive of the :term:`Metadata` -layers (recipes, configuration files, and so forth) enables you to meet -your requirements to include the scripts to control compilation as well -as any modifications to the original source. - -Providing spdx files -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The spdx module has been integrated to a layer named meta-spdxscanner. -meta-spdxscanner provides several kinds of scanner. If you want to enable -this function, you have to follow the following steps: - -1. Add meta-spdxscanner layer into ``bblayers.conf``. - -2. Refer to the README in meta-spdxscanner to setup the environment (e.g, - setup a fossology server) needed for the scanner. - -3. Meta-spdxscanner provides several methods within the bbclass to create spdx files. - Please choose one that you want to use and enable the spdx task. You have to - add some config options in ``local.conf`` file in your :term:`Build - Directory`. Here is an example showing how to generate spdx files - during bitbake using the fossology-python.bbclass:: - - # Select fossology-python.bbclass. - INHERIT += "fossology-python" - # For fossology-python.bbclass, TOKEN is necessary, so, after setup a - # Fossology server, you have to create a token. - TOKEN = "eyJ0eXAiO..." - # The fossology server is necessary for fossology-python.bbclass. - FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo" - # If you want to upload the source code to a special folder: - FOLDER_NAME = "xxxx" //Optional - # If you don't want to put spdx files in tmp/deploy/spdx, you can enable: - SPDX_DEPLOY_DIR = "${DEPLOY_DIR}" //Optional - -For more usage information refer to :yocto_git:`the meta-spdxscanner repository -</meta-spdxscanner/>`. - -Compliance Limitations with Executables Built from Static Libraries -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When package A is added to an image via the :term:`RDEPENDS` or :term:`RRECOMMENDS` -mechanisms as well as explicitly included in the image recipe with -:term:`IMAGE_INSTALL`, and depends on a static linked library recipe B -(``DEPENDS += "B"``), package B will neither appear in the generated license -manifest nor in the generated source tarballs. This occurs as the -:ref:`license <ref-classes-license>` and :ref:`archiver <ref-classes-archiver>` -classes assume that only packages included via :term:`RDEPENDS` or :term:`RRECOMMENDS` -end up in the image. - -As a result, potential obligations regarding license compliance for package B -may not be met. - -The Yocto Project doesn't enable static libraries by default, in part because -of this issue. Before a solution to this limitation is found, you need to -keep in mind that if your root filesystem is built from static libraries, -you will need to manually ensure that your deliveries are compliant -with the licenses of these libraries. - -Copying Non Standard Licenses ------------------------------ - -Some packages, such as the linux-firmware package, have many licenses -that are not in any way common. You can avoid adding a lot of these -types of common license files, which are only applicable to a specific -package, by using the -:term:`NO_GENERIC_LICENSE` -variable. Using this variable also avoids QA errors when you use a -non-common, non-CLOSED license in a recipe. - -Here is an example that uses the ``LICENSE.Abilis.txt`` file as -the license from the fetched source:: - - NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" - -Checking for Vulnerabilities -============================ - -Vulnerabilities in images -------------------------- - -The Yocto Project has an infrastructure to track and address unfixed -known security vulnerabilities, as tracked by the public -`Common Vulnerabilities and Exposures (CVE) <https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures>`__ -database. - -To know which packages are vulnerable to known security vulnerabilities, -add the following setting to your configuration:: - - INHERIT += "cve-check" - -This way, at build time, BitBake will warn you about known CVEs -as in the example below:: - - WARNING: flex-2.6.4-r0 do_cve_check: Found unpatched CVE (CVE-2019-6293), for more information check /poky/build/tmp/work/core2-64-poky-linux/flex/2.6.4-r0/temp/cve.log - WARNING: libarchive-3.5.1-r0 do_cve_check: Found unpatched CVE (CVE-2021-36976), for more information check /poky/build/tmp/work/core2-64-poky-linux/libarchive/3.5.1-r0/temp/cve.log - -It is also possible to check the CVE status of individual packages as follows:: - - bitbake -c cve_check flex libarchive - -Note that OpenEmbedded-Core keeps a list of known unfixed CVE issues which can -be ignored. You can pass this list to the check as follows:: - - bitbake -c cve_check libarchive -R conf/distro/include/cve-extra-exclusions.inc - -Enabling vulnerabily tracking in recipes ----------------------------------------- - -The :term:`CVE_PRODUCT` variable defines the name used to match the recipe name -against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__. - -Editing recipes to fix vulnerabilities --------------------------------------- - -To fix a given known vulnerability, you need to add a patch file to your recipe. Here's -an example from the :oe_layerindex:`ffmpeg recipe</layerindex/recipe/47350>`:: - - SRC_URI = "https://www.ffmpeg.org/releases/${BP}.tar.xz \ - file://0001-libavutil-include-assembly-with-full-path-from-sourc.patch \ - file://fix-CVE-2020-20446.patch \ - file://fix-CVE-2020-20453.patch \ - file://fix-CVE-2020-22015.patch \ - file://fix-CVE-2020-22021.patch \ - file://fix-CVE-2020-22033-CVE-2020-22019.patch \ - file://fix-CVE-2021-33815.patch \ - -The :ref:`cve-check <ref-classes-cve-check>` class defines two ways of -supplying a patch for a given CVE. The first -way is to use a patch filename that matches the below pattern:: - - cve_file_name_match = re.compile(".*([Cc][Vv][Ee]\-\d{4}\-\d+)") - -As shown in the example above, multiple CVE IDs can appear in a patch filename, -but the :ref:`cve-check <ref-classes-cve-check>` class will only consider -the last CVE ID in the filename as patched. - -The second way to recognize a patched CVE ID is when a line matching the -below pattern is found in any patch file provided by the recipe:: - - cve_match = re.compile("CVE:( CVE\-\d{4}\-\d+)+") - -This allows a single patch file to address multiple CVE IDs at the same time. - -Of course, another way to fix vulnerabilities is to upgrade to a version -of the package which is not impacted, typically a more recent one. -The NIST database knows which versions are vulnerable and which ones -are not. - -Last but not least, you can choose to ignore vulnerabilities through -the :term:`CVE_CHECK_PN_WHITELIST` and :term:`CVE_CHECK_WHITELIST` -variables. - -Implementation details ----------------------- - -Here's what the :ref:`cve-check <ref-classes-cve-check>` class does to -find unpatched CVE IDs. - -First the code goes through each patch file provided by a recipe. If a valid CVE ID -is found in the name of the file, the corresponding CVE is considered as patched. -Don't forget that if multiple CVE IDs are found in the filename, only the last -one is considered. Then, the code looks for ``CVE: CVE-ID`` lines in the patch -file. The found CVE IDs are also considered as patched. - -Then, the code looks up all the CVE IDs in the NIST database for all the -products defined in :term:`CVE_PRODUCT`. Then, for each found CVE: - - - If the package name (:term:`PN`) is part of - :term:`CVE_CHECK_PN_WHITELIST`, it is considered as patched. - - - If the CVE ID is part of :term:`CVE_CHECK_WHITELIST`, it is - considered as patched too. - - - If the CVE ID is part of the patched CVE for the recipe, it is - already considered as patched. - - - Otherwise, the code checks whether the recipe version (:term:`PV`) - is within the range of versions impacted by the CVE. If so, the CVE - is considered as unpatched. - -The CVE database is stored in :term:`DL_DIR` and can be inspected using -``sqlite3`` command as follows:: - - sqlite3 downloads/CVE_CHECK/nvdcve_1.1.db .dump | grep CVE-2021-37462 - -Using the Error Reporting Tool -============================== - -The error reporting tool allows you to submit errors encountered during -builds to a central database. Outside of the build environment, you can -use a web interface to browse errors, view statistics, and query for -errors. The tool works using a client-server system where the client -portion is integrated with the installed Yocto Project -:term:`Source Directory` (e.g. ``poky``). -The server receives the information collected and saves it in a -database. - -There is a live instance of the error reporting server at -https://errors.yoctoproject.org. -When you want to get help with build failures, you can submit all of the -information on the failure easily and then point to the URL in your bug -report or send an email to the mailing list. - -.. note:: - - If you send error reports to this server, the reports become publicly - visible. - -Enabling and Using the Tool ---------------------------- - -By default, the error reporting tool is disabled. You can enable it by -inheriting the -:ref:`report-error <ref-classes-report-error>` -class by adding the following statement to the end of your -``local.conf`` file in your -:term:`Build Directory`. -:: - - INHERIT += "report-error" - -By default, the error reporting feature stores information in -``${``\ :term:`LOG_DIR`\ ``}/error-report``. -However, you can specify a directory to use by adding the following to -your ``local.conf`` file:: - - ERR_REPORT_DIR = "path" - -Enabling error -reporting causes the build process to collect the errors and store them -in a file as previously described. When the build system encounters an -error, it includes a command as part of the console output. You can run -the command to send the error file to the server. For example, the -following command sends the errors to an upstream server:: - - $ send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt - -In the previous example, the errors are sent to a public database -available at https://errors.yoctoproject.org, which is used by the -entire community. If you specify a particular server, you can send the -errors to a different database. Use the following command for more -information on available options:: - - $ send-error-report --help - -When sending the error file, you are prompted to review the data being -sent as well as to provide a name and optional email address. Once you -satisfy these prompts, the command returns a link from the server that -corresponds to your entry in the database. For example, here is a -typical link: https://errors.yoctoproject.org/Errors/Details/9522/ - -Following the link takes you to a web interface where you can browse, -query the errors, and view statistics. - -Disabling the Tool ------------------- - -To disable the error reporting feature, simply remove or comment out the -following statement from the end of your ``local.conf`` file in your -:term:`Build Directory`. -:: - - INHERIT += "report-error" - -Setting Up Your Own Error Reporting Server ------------------------------------------- - -If you want to set up your own error reporting server, you can obtain -the code from the Git repository at :yocto_git:`/error-report-web/`. -Instructions on how to set it up are in the README document. - -Using Wayland and Weston -======================== - -`Wayland <https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)>`__ -is a computer display server protocol that provides a method for -compositing window managers to communicate directly with applications -and video hardware and expects them to communicate with input hardware -using other libraries. Using Wayland with supporting targets can result -in better control over graphics frame rendering than an application -might otherwise achieve. - -The Yocto Project provides the Wayland protocol libraries and the -reference -`Weston <https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston>`__ -compositor as part of its release. You can find the integrated packages -in the ``meta`` layer of the :term:`Source Directory`. -Specifically, you -can find the recipes that build both Wayland and Weston at -``meta/recipes-graphics/wayland``. - -You can build both the Wayland and Weston packages for use only with -targets that accept the `Mesa 3D and Direct Rendering -Infrastructure <https://en.wikipedia.org/wiki/Mesa_(computer_graphics)>`__, -which is also known as Mesa DRI. This implies that you cannot build and -use the packages if your target uses, for example, the Intel Embedded -Media and Graphics Driver (Intel EMGD) that overrides Mesa DRI. - -.. note:: - - Due to lack of EGL support, Weston 1.0.3 will not run directly on the - emulated QEMU hardware. However, this version of Weston will run - under X emulation without issues. - -This section describes what you need to do to implement Wayland and use -the Weston compositor when building an image for a supporting target. - -Enabling Wayland in an Image ----------------------------- - -To enable Wayland, you need to enable it to be built and enable it to be -included (installed) in the image. - -Building Wayland -~~~~~~~~~~~~~~~~ - -To cause Mesa to build the ``wayland-egl`` platform and Weston to build -Wayland with Kernel Mode Setting -(`KMS <https://wiki.archlinux.org/index.php/Kernel_Mode_Setting>`__) -support, include the "wayland" flag in the -:term:`DISTRO_FEATURES` -statement in your ``local.conf`` file:: - - DISTRO_FEATURES:append = " wayland" - -.. note:: - - If X11 has been enabled elsewhere, Weston will build Wayland with X11 - support - -Installing Wayland and Weston -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To install the Wayland feature into an image, you must include the -following -:term:`CORE_IMAGE_EXTRA_INSTALL` -statement in your ``local.conf`` file:: - - CORE_IMAGE_EXTRA_INSTALL += "wayland weston" - -Running Weston --------------- - -To run Weston inside X11, enabling it as described earlier and building -a Sato image is sufficient. If you are running your image under Sato, a -Weston Launcher appears in the "Utility" category. - -Alternatively, you can run Weston through the command-line interpretor -(CLI), which is better suited for development work. To run Weston under -the CLI, you need to do the following after your image is built: - -1. Run these commands to export ``XDG_RUNTIME_DIR``:: - - mkdir -p /tmp/$USER-weston - chmod 0700 /tmp/$USER-weston - export XDG_RUNTIME_DIR=/tmp/$USER-weston - -2. Launch Weston in the shell:: - - weston diff --git a/documentation/dev-manual/custom-distribution.rst b/documentation/dev-manual/custom-distribution.rst new file mode 100644 index 0000000000..0bc386d606 --- /dev/null +++ b/documentation/dev-manual/custom-distribution.rst @@ -0,0 +1,135 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Creating Your Own Distribution +****************************** + +When you build an image using the Yocto Project and do not alter any +distribution :term:`Metadata`, you are using the Poky distribution. +Poky is explicitly a *reference* distribution for testing and +development purposes. It enables most hardware and software features +so that they can be tested, but this also means that from a security +point of view the attack surface is very large. Additionally, at some +point it is likely that you will want to gain more control over package +alternative selections, compile-time options, and other low-level +configurations. For both of these reasons, if you are using the Yocto +Project for production use then you are strongly encouraged to create +your own distribution. + +To create your own distribution, the basic steps consist of creating +your own distribution layer, creating your own distribution +configuration file, and then adding any needed code and Metadata to the +layer. The following steps provide some more detail: + +- *Create a layer for your new distro:* Create your distribution layer + so that you can keep your Metadata and code for the distribution + separate. It is strongly recommended that you create and use your own + layer for configuration and code. Using your own layer as compared to + just placing configurations in a ``local.conf`` configuration file + makes it easier to reproduce the same build configuration when using + multiple build machines. See the + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" + section for information on how to quickly set up a layer. + +- *Create the distribution configuration file:* The distribution + configuration file needs to be created in the ``conf/distro`` + directory of your layer. You need to name it using your distribution + name (e.g. ``mydistro.conf``). + + .. note:: + + The :term:`DISTRO` variable in your ``local.conf`` file determines the + name of your distribution. + + You can split out parts of your configuration file into include files + and then "require" them from within your distribution configuration + file. Be sure to place the include files in the + ``conf/distro/include`` directory of your layer. A common example + usage of include files would be to separate out the selection of + desired version and revisions for individual recipes. + + Your configuration file needs to set the following required + variables: + + - :term:`DISTRO_NAME` + + - :term:`DISTRO_VERSION` + + These following variables are optional and you typically set them + from the distribution configuration file: + + - :term:`DISTRO_FEATURES` + + - :term:`DISTRO_EXTRA_RDEPENDS` + + - :term:`DISTRO_EXTRA_RRECOMMENDS` + + - :term:`TCLIBC` + + .. tip:: + + If you want to base your distribution configuration file on the + very basic configuration from OE-Core, you can use + ``conf/distro/defaultsetup.conf`` as a reference and just include + variables that differ as compared to ``defaultsetup.conf``. + Alternatively, you can create a distribution configuration file + from scratch using the ``defaultsetup.conf`` file or configuration files + from another distribution such as Poky as a reference. + +- *Provide miscellaneous variables:* Be sure to define any other + variables for which you want to create a default or enforce as part + of the distribution configuration. You can include nearly any + variable from the ``local.conf`` file. The variables you use are not + limited to the list in the previous bulleted item. + +- *Point to Your distribution configuration file:* In your ``local.conf`` + file in the :term:`Build Directory`, set your :term:`DISTRO` variable to + point to your distribution's configuration file. For example, if your + distribution's configuration file is named ``mydistro.conf``, then + you point to it as follows:: + + DISTRO = "mydistro" + +- *Add more to the layer if necessary:* Use your layer to hold other + information needed for the distribution: + + - Add recipes for installing distro-specific configuration files + that are not already installed by another recipe. If you have + distro-specific configuration files that are included by an + existing recipe, you should add an append file (``.bbappend``) for + those. For general information and recommendations on how to add + recipes to your layer, see the + ":ref:`dev-manual/layers:creating your own layer`" and + ":ref:`dev-manual/layers:following best practices when creating layers`" + sections. + + - Add any image recipes that are specific to your distribution. + + - Add a ``psplash`` append file for a branded splash screen, using + the :term:`SPLASH_IMAGES` variable. + + - Add any other append files to make custom changes that are + specific to individual recipes. + + For information on append files, see the + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" + section. + +Copying and modifying the Poky distribution +=========================================== + +Instead of creating a custom distribution from scratch as per above, you may +wish to start your custom distribution configuration by copying the Poky +distribution provided within the ``meta-poky`` layer and then modifying it. +This is fine, however if you do this you should keep the following in mind: + +- Every reference to Poky needs to be updated in your copy so that it + will still apply. This includes override usage within files (e.g. ``:poky``) + and in directory names. This is a good opportunity to evaluate each one of + these customizations to see if they are needed for your use case. + +- Unless you also intend to use them, the ``poky-tiny``, ``poky-altcfg`` and + ``poky-bleeding`` variants and any references to them can be removed. + +- More generally, the Poky distribution configuration enables a lot more + than you likely need for your production use case. You should evaluate *every* + configuration choice made in your copy to determine if it is needed. diff --git a/documentation/dev-manual/custom-template-configuration-directory.rst b/documentation/dev-manual/custom-template-configuration-directory.rst new file mode 100644 index 0000000000..06fcada822 --- /dev/null +++ b/documentation/dev-manual/custom-template-configuration-directory.rst @@ -0,0 +1,52 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Creating a Custom Template Configuration Directory +************************************************** + +If you are producing your own customized version of the build system for +use by other users, you might want to provide a custom build configuration +that includes all the necessary settings and layers (i.e. ``local.conf`` and +``bblayers.conf`` that are created in a new :term:`Build Directory`) and a custom +message that is shown when setting up the build. This can be done by +creating one or more template configuration directories in your +custom distribution layer. + +This can be done by using ``bitbake-layers save-build-conf``:: + + $ bitbake-layers save-build-conf ../../meta-alex/ test-1 + NOTE: Starting bitbake server... + NOTE: Configuration template placed into /srv/work/alex/meta-alex/conf/templates/test-1 + Please review the files in there, and particularly provide a configuration description in /srv/work/alex/meta-alex/conf/templates/test-1/conf-notes.txt + You can try out the configuration with + TEMPLATECONF=/srv/work/alex/meta-alex/conf/templates/test-1 . /srv/work/alex/poky/oe-init-build-env build-try-test-1 + +The above command takes the config files from the currently active :term:`Build Directory` under ``conf``, +replaces site-specific paths in ``bblayers.conf`` with ``##OECORE##``-relative paths, and copies +the config files into a specified layer under a specified template name. + +To use those saved templates as a starting point for a build, users should point +to one of them with :term:`TEMPLATECONF` environment variable:: + + TEMPLATECONF=/srv/work/alex/meta-alex/conf/templates/test-1 . /srv/work/alex/poky/oe-init-build-env build-try-test-1 + +The OpenEmbedded build system uses the environment variable +:term:`TEMPLATECONF` to locate the directory from which it gathers +configuration information that ultimately ends up in the +:term:`Build Directory` ``conf`` directory. + +If :term:`TEMPLATECONF` is not set, the default value is obtained +from ``.templateconf`` file that is read from the same directory as +``oe-init-build-env`` script. For the Poky reference distribution this +would be:: + + TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default} + +If you look at a configuration template directory, you will +see the ``bblayers.conf.sample``, ``local.conf.sample``, ``conf-summary.txt`` and +``conf-notes.txt`` files. The build system uses these files to form the +respective ``bblayers.conf`` file, ``local.conf`` file, and show +users usage information about the build they're setting up +when running the ``oe-init-build-env`` setup script. These can be +edited further if needed to improve or change the build configurations +available to the users, and provide useful summaries and detailed usage notes. + diff --git a/documentation/dev-manual/customizing-images.rst b/documentation/dev-manual/customizing-images.rst new file mode 100644 index 0000000000..5b18958ade --- /dev/null +++ b/documentation/dev-manual/customizing-images.rst @@ -0,0 +1,223 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Customizing Images +****************** + +You can customize images to satisfy particular requirements. This +section describes several methods and provides guidelines for each. + +Customizing Images Using ``local.conf`` +======================================= + +Probably the easiest way to customize an image is to add a package by +way of the ``local.conf`` configuration file. Because it is limited to +local use, this method generally only allows you to add packages and is +not as flexible as creating your own customized image. When you add +packages using local variables this way, you need to realize that these +variable changes are in effect for every build and consequently affect +all images, which might not be what you require. + +To add a package to your image using the local configuration file, use +the :term:`IMAGE_INSTALL` variable with the ``:append`` operator:: + + IMAGE_INSTALL:append = " strace" + +Use of the syntax is important; specifically, the leading space +after the opening quote and before the package name, which is +``strace`` in this example. This space is required since the ``:append`` +operator does not add the space. + +Furthermore, you must use ``:append`` instead of the ``+=`` operator if +you want to avoid ordering issues. The reason for this is because doing +so unconditionally appends to the variable and avoids ordering problems +due to the variable being set in image recipes and ``.bbclass`` files +with operators like ``?=``. Using ``:append`` ensures the operation +takes effect. + +As shown in its simplest use, ``IMAGE_INSTALL:append`` affects all +images. It is possible to extend the syntax so that the variable applies +to a specific image only. Here is an example:: + + IMAGE_INSTALL:append:pn-core-image-minimal = " strace" + +This example adds ``strace`` to the ``core-image-minimal`` image only. + +You can add packages using a similar approach through the +:term:`CORE_IMAGE_EXTRA_INSTALL` variable. If you use this variable, only +``core-image-*`` images are affected. + +Customizing Images Using Custom ``IMAGE_FEATURES`` and ``EXTRA_IMAGE_FEATURES`` +=============================================================================== + +Another method for customizing your image is to enable or disable +high-level image features by using the +:term:`IMAGE_FEATURES` and +:term:`EXTRA_IMAGE_FEATURES` +variables. Although the functions for both variables are nearly +equivalent, best practices dictate using :term:`IMAGE_FEATURES` from within +a recipe and using :term:`EXTRA_IMAGE_FEATURES` from within your +``local.conf`` file, which is found in the :term:`Build Directory`. + +To understand how these features work, the best reference is +:ref:`meta/classes-recipe/image.bbclass <ref-classes-image>`. +This class lists out the available +:term:`IMAGE_FEATURES` of which most map to package groups while some, such +as ``debug-tweaks`` and ``read-only-rootfs``, resolve as general +configuration settings. + +In summary, the file looks at the contents of the :term:`IMAGE_FEATURES` +variable and then maps or configures the feature accordingly. Based on +this information, the build system automatically adds the appropriate +packages or configurations to the +:term:`IMAGE_INSTALL` variable. +Effectively, you are enabling extra features by extending the class or +creating a custom class for use with specialized image ``.bb`` files. + +Use the :term:`EXTRA_IMAGE_FEATURES` variable from within your local +configuration file. Using a separate area from which to enable features +with this variable helps you avoid overwriting the features in the image +recipe that are enabled with :term:`IMAGE_FEATURES`. The value of +:term:`EXTRA_IMAGE_FEATURES` is added to :term:`IMAGE_FEATURES` within +``meta/conf/bitbake.conf``. + +To illustrate how you can use these variables to modify your image, +consider an example that selects the SSH server. The Yocto Project ships +with two SSH servers you can use with your images: Dropbear and OpenSSH. +Dropbear is a minimal SSH server appropriate for resource-constrained +environments, while OpenSSH is a well-known standard SSH server +implementation. By default, the ``core-image-sato`` image is configured +to use Dropbear. The ``core-image-full-cmdline`` and ``core-image-lsb`` +images both include OpenSSH. The ``core-image-minimal`` image does not +contain an SSH server. + +You can customize your image and change these defaults. Edit the +:term:`IMAGE_FEATURES` variable in your recipe or use the +:term:`EXTRA_IMAGE_FEATURES` in your ``local.conf`` file so that it +configures the image you are working with to include +``ssh-server-dropbear`` or ``ssh-server-openssh``. + +.. note:: + + See the ":ref:`ref-manual/features:image features`" section in the Yocto + Project Reference Manual for a complete list of image features that ship + with the Yocto Project. + +Customizing Images Using Custom .bb Files +========================================= + +You can also customize an image by creating a custom recipe that defines +additional software as part of the image. The following example shows +the form for the two lines you need:: + + IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2" + inherit core-image + +Defining the software using a custom recipe gives you total control over +the contents of the image. It is important to use the correct names of +packages in the :term:`IMAGE_INSTALL` variable. You must use the +OpenEmbedded notation and not the Debian notation for the names (e.g. +``glibc-dev`` instead of ``libc6-dev``). + +The other method for creating a custom image is to base it on an +existing image. For example, if you want to create an image based on +``core-image-sato`` but add the additional package ``strace`` to the +image, copy the ``meta/recipes-sato/images/core-image-sato.bb`` to a new +``.bb`` and add the following line to the end of the copy:: + + IMAGE_INSTALL += "strace" + +Customizing Images Using Custom Package Groups +============================================== + +For complex custom images, the best approach for customizing an image is +to create a custom package group recipe that is used to build the image +or images. A good example of a package group recipe is +``meta/recipes-core/packagegroups/packagegroup-base.bb``. + +If you examine that recipe, you see that the :term:`PACKAGES` variable lists +the package group packages to produce. The ``inherit packagegroup`` +statement sets appropriate default values and automatically adds +``-dev``, ``-dbg``, and ``-ptest`` complementary packages for each +package specified in the :term:`PACKAGES` statement. + +.. note:: + + The ``inherit packagegroup`` line should be located near the top of the + recipe, certainly before the :term:`PACKAGES` statement. + +For each package you specify in :term:`PACKAGES`, you can use :term:`RDEPENDS` +and :term:`RRECOMMENDS` entries to provide a list of packages the parent +task package should contain. You can see examples of these further down +in the ``packagegroup-base.bb`` recipe. + +Here is a short, fabricated example showing the same basic pieces for a +hypothetical packagegroup defined in ``packagegroup-custom.bb``, where +the variable :term:`PN` is the standard way to abbreviate the reference to +the full packagegroup name ``packagegroup-custom``:: + + DESCRIPTION = "My Custom Package Groups" + + inherit packagegroup + + PACKAGES = "\ + ${PN}-apps \ + ${PN}-tools \ + " + + RDEPENDS:${PN}-apps = "\ + dropbear \ + portmap \ + psplash" + + RDEPENDS:${PN}-tools = "\ + oprofile \ + oprofileui-server \ + lttng-tools" + + RRECOMMENDS:${PN}-tools = "\ + kernel-module-oprofile" + +In the previous example, two package group packages are created with +their dependencies and their recommended package dependencies listed: +``packagegroup-custom-apps``, and ``packagegroup-custom-tools``. To +build an image using these package group packages, you need to add +``packagegroup-custom-apps`` and/or ``packagegroup-custom-tools`` to +:term:`IMAGE_INSTALL`. For other forms of image dependencies see the other +areas of this section. + +Customizing an Image Hostname +============================= + +By default, the configured hostname (i.e. ``/etc/hostname``) in an image +is the same as the machine name. For example, if +:term:`MACHINE` equals "qemux86", the +configured hostname written to ``/etc/hostname`` is "qemux86". + +You can customize this name by altering the value of the "hostname" +variable in the ``base-files`` recipe using either an append file or a +configuration file. Use the following in an append file:: + + hostname = "myhostname" + +Use the following in a configuration file:: + + hostname:pn-base-files = "myhostname" + +Changing the default value of the variable "hostname" can be useful in +certain situations. For example, suppose you need to do extensive +testing on an image and you would like to easily identify the image +under test from existing images with typical default hostnames. In this +situation, you could change the default hostname to "testme", which +results in all the images using the name "testme". Once testing is +complete and you do not need to rebuild the image for test any longer, +you can easily reset the default hostname. + +Another point of interest is that if you unset the variable, the image +will have no default hostname in the filesystem. Here is an example that +unsets the variable in a configuration file:: + + hostname:pn-base-files = "" + +Having no default hostname in the filesystem is suitable for +environments that use dynamic hostnames such as virtual machines. + diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst new file mode 100644 index 0000000000..92458a0c37 --- /dev/null +++ b/documentation/dev-manual/debugging.rst @@ -0,0 +1,1271 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Debugging Tools and Techniques +****************************** + +The exact method for debugging build failures depends on the nature of +the problem and on the system's area from which the bug originates. +Standard debugging practices such as comparison against the last known +working version with examination of the changes and the re-application +of steps to identify the one causing the problem are valid for the Yocto +Project just as they are for any other system. Even though it is +impossible to detail every possible potential failure, this section +provides some general tips to aid in debugging given a variety of +situations. + +.. note:: + + A useful feature for debugging is the error reporting tool. + Configuring the Yocto Project to use this tool causes the + OpenEmbedded build system to produce error reporting commands as part + of the console output. You can enter the commands after the build + completes to log error information into a common database, that can + help you figure out what might be going wrong. For information on how + to enable and use this feature, see the + ":ref:`dev-manual/error-reporting-tool:using the error reporting tool`" + section. + +The following list shows the debugging topics in the remainder of this +section: + +- ":ref:`dev-manual/debugging:viewing logs from failed tasks`" describes + how to find and view logs from tasks that failed during the build + process. + +- ":ref:`dev-manual/debugging:viewing variable values`" describes how to + use the BitBake ``-e`` option to examine variable values after a + recipe has been parsed. + +- ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" + describes how to use the ``oe-pkgdata-util`` utility to query + :term:`PKGDATA_DIR` and + display package-related information for built packages. + +- ":ref:`dev-manual/debugging:viewing dependencies between recipes and tasks`" + describes how to use the BitBake ``-g`` option to display recipe + dependency information used during the build. + +- ":ref:`dev-manual/debugging:viewing task variable dependencies`" describes + how to use the ``bitbake-dumpsig`` command in conjunction with key + subdirectories in the :term:`Build Directory` to determine variable + dependencies. + +- ":ref:`dev-manual/debugging:running specific tasks`" describes + how to use several BitBake options (e.g. ``-c``, ``-C``, and ``-f``) + to run specific tasks in the build chain. It can be useful to run + tasks "out-of-order" when trying isolate build issues. + +- ":ref:`dev-manual/debugging:general BitBake problems`" describes how + to use BitBake's ``-D`` debug output option to reveal more about what + BitBake is doing during the build. + +- ":ref:`dev-manual/debugging:building with no dependencies`" + describes how to use the BitBake ``-b`` option to build a recipe + while ignoring dependencies. + +- ":ref:`dev-manual/debugging:recipe logging mechanisms`" + describes how to use the many recipe logging functions to produce + debugging output and report errors and warnings. + +- ":ref:`dev-manual/debugging:debugging parallel make races`" + describes how to debug situations where the build consists of several + parts that are run simultaneously and when the output or result of + one part is not ready for use with a different part of the build that + depends on that output. + +- ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" + describes how to use GDB to allow you to examine running programs, which can + help you fix problems. + +- ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) on the target`" + describes how to use GDB directly on target hardware for debugging. + +- ":ref:`dev-manual/debugging:other debugging tips`" describes + miscellaneous debugging tips that can be useful. + +Viewing Logs from Failed Tasks +============================== + +You can find the log for a task in the file +``${``\ :term:`WORKDIR`\ ``}/temp/log.do_``\ `taskname`. +For example, the log for the +:ref:`ref-tasks-compile` task of the +QEMU minimal image for the x86 machine (``qemux86``) might be in +``tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile``. +To see the commands :term:`BitBake` ran +to generate a log, look at the corresponding ``run.do_``\ `taskname` file +in the same directory. + +``log.do_``\ `taskname` and ``run.do_``\ `taskname` are actually symbolic +links to ``log.do_``\ `taskname`\ ``.``\ `pid` and +``log.run_``\ `taskname`\ ``.``\ `pid`, where `pid` is the PID the task had +when it ran. The symlinks always point to the files corresponding to the +most recent run. + +Viewing Variable Values +======================= + +Sometimes you need to know the value of a variable as a result of +BitBake's parsing step. This could be because some unexpected behavior +occurred in your project. Perhaps an attempt to :ref:`modify a variable +<bitbake-user-manual/bitbake-user-manual-metadata:modifying existing +variables>` did not work out as expected. + +BitBake's ``-e`` option is used to display variable values after +parsing. The following command displays the variable values after the +configuration files (i.e. ``local.conf``, ``bblayers.conf``, +``bitbake.conf`` and so forth) have been parsed:: + + $ bitbake -e + +The following command displays variable values after a specific recipe has +been parsed. The variables include those from the configuration as well:: + + $ bitbake -e recipename + +.. note:: + + Each recipe has its own private set of variables (datastore). + Internally, after parsing the configuration, a copy of the resulting + datastore is made prior to parsing each recipe. This copying implies + that variables set in one recipe will not be visible to other + recipes. + + Likewise, each task within a recipe gets a private datastore based on + the recipe datastore, which means that variables set within one task + will not be visible to other tasks. + +In the output of ``bitbake -e``, each variable is preceded by a +description of how the variable got its value, including temporary +values that were later overridden. This description also includes +variable flags (varflags) set on the variable. The output can be very +helpful during debugging. + +Variables that are exported to the environment are preceded by +``export`` in the output of ``bitbake -e``. See the following example:: + + export CC="i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/ulf/poky/build/tmp/sysroots/qemux86" + +In addition to variable values, the output of the ``bitbake -e`` and +``bitbake -e`` recipe commands includes the following information: + +- The output starts with a tree listing all configuration files and + classes included globally, recursively listing the files they include + or inherit in turn. Much of the behavior of the OpenEmbedded build + system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is + implemented in the :ref:`ref-classes-base` class and the + classes it inherits, rather than being built into BitBake itself. + +- After the variable values, all functions appear in the output. For + shell functions, variables referenced within the function body are + expanded. If a function has been modified using overrides or using + override-style operators like ``:append`` and ``:prepend``, then the + final assembled function body appears in the output. + +Viewing Package Information with ``oe-pkgdata-util`` +==================================================== + +You can use the ``oe-pkgdata-util`` command-line utility to query +:term:`PKGDATA_DIR` and display +various package-related information. When you use the utility, you must +use it to view information on packages that have already been built. + +Here are a few of the available ``oe-pkgdata-util`` subcommands. + +.. note:: + + You can use the standard \* and ? globbing wildcards as part of + package names and paths. + +- ``oe-pkgdata-util list-pkgs [pattern]``: Lists all packages + that have been built, optionally limiting the match to packages that + match pattern. + +- ``oe-pkgdata-util list-pkg-files package ...``: Lists the + files and directories contained in the given packages. + + .. note:: + + A different way to view the contents of a package is to look at + the + ``${``\ :term:`WORKDIR`\ ``}/packages-split`` + directory of the recipe that generates the package. This directory + is created by the + :ref:`ref-tasks-package` task + and has one subdirectory for each package the recipe generates, + which contains the files stored in that package. + + If you want to inspect the ``${WORKDIR}/packages-split`` + directory, make sure that :ref:`ref-classes-rm-work` is not + enabled when you build the recipe. + +- ``oe-pkgdata-util find-path path ...``: Lists the names of + the packages that contain the given paths. For example, the following + tells us that ``/usr/share/man/man1/make.1`` is contained in the + ``make-doc`` package:: + + $ oe-pkgdata-util find-path /usr/share/man/man1/make.1 + make-doc: /usr/share/man/man1/make.1 + +- ``oe-pkgdata-util lookup-recipe package ...``: Lists the name + of the recipes that produce the given packages. + +For more information on the ``oe-pkgdata-util`` command, use the help +facility:: + + $ oe-pkgdata-util --help + $ oe-pkgdata-util subcommand --help + +Viewing Dependencies Between Recipes and Tasks +============================================== + +Sometimes it can be hard to see why BitBake wants to build other recipes +before the one you have specified. Dependency information can help you +understand why a recipe is built. + +To generate dependency information for a recipe, run the following +command:: + + $ bitbake -g recipename + +This command writes the following files in the current directory: + +- ``pn-buildlist``: A list of recipes/targets involved in building + `recipename`. "Involved" here means that at least one task from the + recipe needs to run when building `recipename` from scratch. Targets + that are in + :term:`ASSUME_PROVIDED` + are not listed. + +- ``task-depends.dot``: A graph showing dependencies between tasks. + +The graphs are in :wikipedia:`DOT <DOT_%28graph_description_language%29>` +format and can be converted to images (e.g. using the ``dot`` tool from +`Graphviz <https://www.graphviz.org/>`__). + +.. note:: + + - DOT files use a plain text format. The graphs generated using the + ``bitbake -g`` command are often so large as to be difficult to + read without special pruning (e.g. with BitBake's ``-I`` option) + and processing. Despite the form and size of the graphs, the + corresponding ``.dot`` files can still be possible to read and + provide useful information. + + As an example, the ``task-depends.dot`` file contains lines such + as the following:: + + "libxslt.do_configure" -> "libxml2.do_populate_sysroot" + + The above example line reveals that the + :ref:`ref-tasks-configure` + task in ``libxslt`` depends on the + :ref:`ref-tasks-populate_sysroot` + task in ``libxml2``, which is a normal + :term:`DEPENDS` dependency + between the two recipes. + + - For an example of how ``.dot`` files can be processed, see the + ``scripts/contrib/graph-tool`` Python script, which finds and + displays paths between graph nodes. + +You can use a different method to view dependency information by using +either:: + + $ bitbake -g -u taskexp recipename + +or:: + + $ bitbake -g -u taskexp_ncurses recipename + +The ``-u taskdep`` option GUI window from which you can view build-time and +runtime dependencies for the recipes involved in building recipename. The +``-u taskexp_ncurses`` option uses ncurses instead of GTK to render the UI. + +Viewing Task Variable Dependencies +================================== + +As mentioned in the +":ref:`bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" +section of the BitBake User Manual, BitBake tries to automatically determine +what variables a task depends on so that it can rerun the task if any values of +the variables change. This determination is usually reliable. However, if you +do things like construct variable names at runtime, then you might have to +manually declare dependencies on those variables using ``vardeps`` as described +in the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" +section of the BitBake User Manual. + +If you are unsure whether a variable dependency is being picked up +automatically for a given task, you can list the variable dependencies +BitBake has determined by doing the following: + +#. Build the recipe containing the task:: + + $ bitbake recipename + +#. Inside the :term:`STAMPS_DIR` + directory, find the signature data (``sigdata``) file that + corresponds to the task. The ``sigdata`` files contain a pickled + Python database of all the metadata that went into creating the input + checksum for the task. As an example, for the + :ref:`ref-tasks-fetch` task of the + ``db`` recipe, the ``sigdata`` file might be found in the following + location:: + + ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 + + For tasks that are accelerated through the shared state + (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, an + additional ``siginfo`` file is written into + :term:`SSTATE_DIR` along with + the cached task output. The ``siginfo`` files contain exactly the + same information as ``sigdata`` files. + +#. Run ``bitbake-dumpsig`` on the ``sigdata`` or ``siginfo`` file. Here + is an example:: + + $ bitbake-dumpsig ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 + + In the output of the above command, you will find a line like the + following, which lists all the (inferred) variable dependencies for + the task. This list also includes indirect dependencies from + variables depending on other variables, recursively:: + + Task dependencies: ['PV', 'SRCREV', 'SRC_URI', 'SRC_URI[sha256sum]', 'base_do_fetch'] + + .. note:: + + Functions (e.g. ``base_do_fetch``) also count as variable dependencies. + These functions in turn depend on the variables they reference. + + The output of ``bitbake-dumpsig`` also includes the value each + variable had, a list of dependencies for each variable, and + :term:`BB_BASEHASH_IGNORE_VARS` + information. + +Debugging signature construction and unexpected task executions +=============================================================== + +There is a ``bitbake-diffsigs`` command for comparing two +``siginfo`` or ``sigdata`` files. This command can be helpful when +trying to figure out what changed between two versions of a task. If you +call ``bitbake-diffsigs`` with just one file, the command behaves like +``bitbake-dumpsig``. + +You can also use BitBake to dump out the signature construction +information without executing tasks by using either of the following +BitBake command-line options:: + + ‐‐dump-signatures=SIGNATURE_HANDLER + -S SIGNATURE_HANDLER + + +.. note:: + + Two common values for `SIGNATURE_HANDLER` are "none" and "printdiff", which + dump only the signature or compare the dumped signature with the most recent one, + respectively. "printdiff" will try to establish the most recent + signature match (e.g. in the sstate cache) and then + compare the matched signatures to determine the stamps and delta + where these two stamp trees diverge. This can be used to determine why + tasks need to be re-run in situations where that is not expected. + +Using BitBake with either of these options causes BitBake to dump out +``sigdata`` files in the ``stamps`` directory for every task it would +have executed instead of building the specified target package. + +Viewing Metadata Used to Create the Input Signature of a Shared State Task +========================================================================== + +Seeing what metadata went into creating the input signature of a shared +state (sstate) task can be a useful debugging aid. This information is +available in signature information (``siginfo``) files in +:term:`SSTATE_DIR`. For +information on how to view and interpret information in ``siginfo`` +files, see the +":ref:`dev-manual/debugging:viewing task variable dependencies`" section. + +For conceptual information on shared state, see the +":ref:`overview-manual/concepts:shared state`" +section in the Yocto Project Overview and Concepts Manual. + +Invalidating Shared State to Force a Task to Run +================================================ + +The OpenEmbedded build system uses +:ref:`checksums <overview-manual/concepts:checksums (signatures)>` and +:ref:`overview-manual/concepts:shared state` cache to avoid unnecessarily +rebuilding tasks. Collectively, this scheme is known as "shared state +code". + +As with all schemes, this one has some drawbacks. It is possible that +you could make implicit changes to your code that the checksum +calculations do not take into account. These implicit changes affect a +task's output but do not trigger the shared state code into rebuilding a +recipe. Consider an example during which a tool changes its output. +Assume that the output of ``rpmdeps`` changes. The result of the change +should be that all the ``package`` and ``package_write_rpm`` shared +state cache items become invalid. However, because the change to the +output is external to the code and therefore implicit, the associated +shared state cache items do not become invalidated. In this case, the +build process uses the cached items rather than running the task again. +Obviously, these types of implicit changes can cause problems. + +To avoid these problems during the build, you need to understand the +effects of any changes you make. Realize that changes you make directly +to a function are automatically factored into the checksum calculation. +Thus, these explicit changes invalidate the associated area of shared +state cache. However, you need to be aware of any implicit changes that +are not obvious changes to the code and could affect the output of a +given task. + +When you identify an implicit change, you can easily take steps to +invalidate the cache and force the tasks to run. The steps you can take +are as simple as changing a function's comments in the source code. For +example, to invalidate package shared state files, change the comment +statements of +:ref:`ref-tasks-package` or the +comments of one of the functions it calls. Even though the change is +purely cosmetic, it causes the checksum to be recalculated and forces +the build system to run the task again. + +.. note:: + + For an example of a commit that makes a cosmetic change to invalidate + shared state, see this + :yocto_git:`commit </poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54>`. + +Running Specific Tasks +====================== + +Any given recipe consists of a set of tasks. The standard BitBake +behavior in most cases is: :ref:`ref-tasks-fetch`, :ref:`ref-tasks-unpack`, :ref:`ref-tasks-patch`, +:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, :ref:`ref-tasks-package`, +:ref:`do_package_write_* <ref-tasks-package_write_deb>`, and :ref:`ref-tasks-build`. The default task is +:ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks, +such as :ref:`ref-tasks-devshell`, are not part of the default build chain. If you +wish to run a task that is not part of the default build chain, you can +use the ``-c`` option in BitBake. Here is an example:: + + $ bitbake matchbox-desktop -c devshell + +The ``-c`` option respects task dependencies, which means that all other +tasks (including tasks from other recipes) that the specified task +depends on will be run before the task. Even when you manually specify a +task to run with ``-c``, BitBake will only run the task if it considers +it "out of date". See the +":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" +section in the Yocto Project Overview and Concepts Manual for how +BitBake determines whether a task is "out of date". + +If you want to force an up-to-date task to be rerun (e.g. because you +made manual modifications to the recipe's +:term:`WORKDIR` that you want to try +out), then you can use the ``-f`` option. + +.. note:: + + The reason ``-f`` is never required when running the + :ref:`ref-tasks-devshell` task is because the + [\ :ref:`nostamp <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ] + variable flag is already set for the task. + +The following example shows one way you can use the ``-f`` option:: + + $ bitbake matchbox-desktop + . + . + make some changes to the source code in the work directory + . + . + $ bitbake matchbox-desktop -c compile -f + $ bitbake matchbox-desktop + +This sequence first builds and then recompiles ``matchbox-desktop``. The +last command reruns all tasks (basically the packaging tasks) after the +compile. BitBake recognizes that the :ref:`ref-tasks-compile` task was rerun and +therefore understands that the other tasks also need to be run again. + +Another, shorter way to rerun a task and all +:ref:`ref-manual/tasks:normal recipe build tasks` +that depend on it is to use the ``-C`` option. + +.. note:: + + This option is upper-cased and is separate from the ``-c`` + option, which is lower-cased. + +Using this option invalidates the given task and then runs the +:ref:`ref-tasks-build` task, which is +the default task if no task is given, and the tasks on which it depends. +You could replace the final two commands in the previous example with +the following single command:: + + $ bitbake matchbox-desktop -C compile + +Internally, the ``-f`` and ``-C`` options work by tainting (modifying) +the input checksum of the specified task. This tainting indirectly +causes the task and its dependent tasks to be rerun through the normal +task dependency mechanisms. + +.. note:: + + BitBake explicitly keeps track of which tasks have been tainted in + this fashion, and will print warnings such as the following for + builds involving such tasks: + + .. code-block:: none + + WARNING: /home/ulf/poky/meta/recipes-sato/matchbox-desktop/matchbox-desktop_2.1.bb.do_compile is tainted from a forced run + + + The purpose of the warning is to let you know that the work directory + and build output might not be in the clean state they would be in for + a "normal" build, depending on what actions you took. To get rid of + such warnings, you can remove the work directory and rebuild the + recipe, as follows:: + + $ bitbake matchbox-desktop -c clean + $ bitbake matchbox-desktop + + +You can view a list of tasks in a given package by running the +:ref:`ref-tasks-listtasks` task as follows:: + + $ bitbake matchbox-desktop -c listtasks + +The results appear as output to the console and are also in +the file ``${WORKDIR}/temp/log.do_listtasks``. + +General BitBake Problems +======================== + +You can see debug output from BitBake by using the ``-D`` option. The +debug output gives more information about what BitBake is doing and the +reason behind it. Each ``-D`` option you use increases the logging +level. The most common usage is ``-DDD``. + +The output from ``bitbake -DDD -v targetname`` can reveal why BitBake +chose a certain version of a package or why BitBake picked a certain +provider. This command could also help you in a situation where you +think BitBake did something unexpected. + +Building with No Dependencies +============================= + +To build a specific recipe (``.bb`` file), you can use the following +command form:: + + $ bitbake -b somepath/somerecipe.bb + +This command form does +not check for dependencies. Consequently, you should use it only when +you know existing dependencies have been met. + +.. note:: + + You can also specify fragments of the filename. In this case, BitBake + checks for a unique match. + +Recipe Logging Mechanisms +========================= + +The Yocto Project provides several logging functions for producing +debugging output and reporting errors and warnings. For Python +functions, the following logging functions are available. All of these functions +log to ``${T}/log.do_``\ `task`, and can also log to standard output +(stdout) with the right settings: + +- ``bb.plain(msg)``: Writes msg as is to the log while also + logging to stdout. + +- ``bb.note(msg)``: Writes "NOTE: msg" to the log. Also logs to + stdout if BitBake is called with "-v". + +- ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the log. Also logs to + stdout if the log level is greater than or equal to level. See the + ":ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`" + option in the BitBake User Manual for more information. + +- ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also + logging to stdout. + +- ``bb.error(msg)``: Writes "ERROR: msg" to the log while also + logging to standard out (stdout). + + .. note:: + + Calling this function does not cause the task to fail. + +- ``bb.fatal(msg)``: This logging function is similar to + ``bb.error(msg)`` but also causes the calling task to fail. + + .. note:: + + ``bb.fatal()`` raises an exception, which means you do not need to put a + "return" statement after the function. + +The same logging functions are also available in shell functions, under +the names ``bbplain``, ``bbnote``, ``bbdebug``, ``bbwarn``, ``bberror``, +and ``bbfatal``. The :ref:`ref-classes-logging` class +implements these functions. See that class in the ``meta/classes`` +folder of the :term:`Source Directory` for information. + +Logging With Python +------------------- + +When creating recipes using Python and inserting code that handles build +logs, keep in mind the goal is to have informative logs while keeping +the console as "silent" as possible. Also, if you want status messages +in the log, use the "debug" loglevel. + +Here is an example written in Python. The code handles logging for +a function that determines the number of tasks needed to be run. See the +":ref:`ref-tasks-listtasks`" +section for additional information:: + + python do_listtasks() { + bb.debug(2, "Starting to figure out the task list") + if noteworthy_condition: + bb.note("There are 47 tasks to run") + bb.debug(2, "Got to point xyz") + if warning_trigger: + bb.warn("Detected warning_trigger, this might be a problem later.") + if recoverable_error: + bb.error("Hit recoverable_error, you really need to fix this!") + if fatal_error: + bb.fatal("fatal_error detected, unable to print the task list") + bb.plain("The tasks present are abc") + bb.debug(2, "Finished figuring out the tasklist") + } + +Logging With Bash +----------------- + +When creating recipes using Bash and inserting code that handles build +logs, you have the same goals --- informative with minimal console output. +The syntax you use for recipes written in Bash is similar to that of +recipes written in Python described in the previous section. + +Here is an example written in Bash. The code logs the progress of +the ``do_my_function`` function:: + + do_my_function() { + bbdebug 2 "Running do_my_function" + if [ exceptional_condition ]; then + bbnote "Hit exceptional_condition" + fi + bbdebug 2 "Got to point xyz" + if [ warning_trigger ]; then + bbwarn "Detected warning_trigger, this might cause a problem later." + fi + if [ recoverable_error ]; then + bberror "Hit recoverable_error, correcting" + fi + if [ fatal_error ]; then + bbfatal "fatal_error detected" + fi + bbdebug 2 "Completed do_my_function" + } + + +Debugging Parallel Make Races +============================= + +A parallel ``make`` race occurs when the build consists of several parts +that are run simultaneously and a situation occurs when the output or +result of one part is not ready for use with a different part of the +build that depends on that output. Parallel make races are annoying and +can sometimes be difficult to reproduce and fix. However, there are some simple +tips and tricks that can help you debug and fix them. This section +presents a real-world example of an error encountered on the Yocto +Project autobuilder and the process used to fix it. + +.. note:: + + If you cannot properly fix a ``make`` race condition, you can work around it + by clearing either the :term:`PARALLEL_MAKE` or :term:`PARALLEL_MAKEINST` + variables. + +The Failure +----------- + +For this example, assume that you are building an image that depends on +the "neard" package. And, during the build, BitBake runs into problems +and creates the following output. + +.. note:: + + This example log file has longer lines artificially broken to make + the listing easier to read. + +If you examine the output or the log file, you see the failure during +``make``: + +.. code-block:: none + + | DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common'] + | DEBUG: Executing shell function do_compile + | NOTE: make -j 16 + | make --no-print-directory all-am + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/types.h include/near/types.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/log.h include/near/log.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/plugin.h include/near/plugin.h + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/tag.h include/near/tag.h + | /bin/mkdir -p include/near + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/adapter.h include/near/adapter.h + | /bin/mkdir -p include/near + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/ndef.h include/near/ndef.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/tlv.h include/near/tlv.h + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/setting.h include/near/setting.h + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | /bin/mkdir -p include/near + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/device.h include/near/device.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/nfc_copy.h include/near/nfc_copy.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/snep.h include/near/snep.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/version.h include/near/version.h + | ln -s /home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ + 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h + | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h + | i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/pokybuild/yocto-autobuilder/nightly-x86/ + build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/ + yocto-autobuilder/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0 + -I/home/pokybuild/yocto-autobuilder/nightly-x86/build/build/tmp/sysroots/qemux86/usr/ + lib/glib-2.0/include -I/home/pokybuild/yocto-autobuilder/nightly-x86/build/build/ + tmp/sysroots/qemux86/usr/include/dbus-1.0 -I/home/pokybuild/yocto-autobuilder/ + nightly-x86/build/build/tmp/sysroots/qemux86/usr/lib/dbus-1.0/include -I/home/pokybuild/yocto-autobuilder/ + nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/libnl3 + -DNEAR_PLUGIN_BUILTIN -DPLUGINDIR=\""/usr/lib/near/plugins"\" + -DCONFIGDIR=\""/etc/neard\"" -O2 -pipe -g -feliminate-unused-debug-types -c + -o tools/snep-send.o tools/snep-send.c + | In file included from tools/snep-send.c:16:0: + | tools/../src/near.h:41:23: fatal error: near/dbus.h: No such file or directory + | #include <near/dbus.h> + | ^ + | compilation terminated. + | make[1]: *** [tools/snep-send.o] Error 1 + | make[1]: *** Waiting for unfinished jobs.... + | make: *** [all] Error 2 + | ERROR: oe_runmake failed + +Reproducing the Error +--------------------- + +Because race conditions are intermittent, they do not manifest +themselves every time you do the build. In fact, most times the build +will complete without problems even though the potential race condition +exists. Thus, once the error surfaces, you need a way to reproduce it. + +In this example, compiling the "neard" package is causing the problem. +So the first thing to do is build "neard" locally. Before you start the +build, set the +:term:`PARALLEL_MAKE` variable +in your ``local.conf`` file to a high number (e.g. "-j 20"). Using a +high value for :term:`PARALLEL_MAKE` increases the chances of the race +condition showing up:: + + $ bitbake neard + +Once the local build for "neard" completes, start a ``devshell`` build:: + + $ bitbake neard -c devshell + +For information on how to use a ``devshell``, see the +":ref:`dev-manual/development-shell:using a development shell`" section. + +In the ``devshell``, do the following:: + + $ make clean + $ make tools/snep-send.o + +The ``devshell`` commands cause the failure to clearly +be visible. In this case, there is a missing dependency for the ``neard`` +Makefile target. Here is some abbreviated, sample output with the +missing dependency clearly visible at the end:: + + i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/...... + . + . + . + tools/snep-send.c + In file included from tools/snep-send.c:16:0: + tools/../src/near.h:41:23: fatal error: near/dbus.h: No such file or directory + #include <near/dbus.h> + ^ + compilation terminated. + make: *** [tools/snep-send.o] Error 1 + $ + + +Creating a Patch for the Fix +---------------------------- + +Because there is a missing dependency for the Makefile target, you need +to patch the ``Makefile.am`` file, which is generated from +``Makefile.in``. You can use Quilt to create the patch:: + + $ quilt new parallelmake.patch + Patch patches/parallelmake.patch is now on top + $ quilt add Makefile.am + File Makefile.am added to patch patches/parallelmake.patch + +For more information on using Quilt, see the +":ref:`dev-manual/quilt:using quilt in your workflow`" section. + +At this point you need to make the edits to ``Makefile.am`` to add the +missing dependency. For our example, you have to add the following line +to the file:: + + tools/snep-send.$(OBJEXT): include/near/dbus.h + +Once you have edited the file, use the ``refresh`` command to create the +patch:: + + $ quilt refresh + Refreshed patch patches/parallelmake.patch + +Once the patch file is created, you need to add it back to the originating +recipe folder. Here is an example assuming a top-level +:term:`Source Directory` named ``poky``:: + + $ cp patches/parallelmake.patch poky/meta/recipes-connectivity/neard/neard + +The final thing you need to do to implement the fix in the build is to +update the "neard" recipe (i.e. ``neard-0.14.bb``) so that the +:term:`SRC_URI` statement includes +the patch file. The recipe file is in the folder above the patch. Here +is what the edited :term:`SRC_URI` statement would look like:: + + SRC_URI = "${KERNELORG_MIRROR}/linux/network/nfc/${BPN}-${PV}.tar.xz \ + file://neard.in \ + file://neard.service.in \ + file://parallelmake.patch \ + " + +With the patch complete and moved to the correct folder and the +:term:`SRC_URI` statement updated, you can exit the ``devshell``:: + + $ exit + +Testing the Build +----------------- + +With everything in place, you can get back to trying the build again +locally:: + + $ bitbake neard + +This build should succeed. + +Now you can open up a ``devshell`` again and repeat the clean and make +operations as follows:: + + $ bitbake neard -c devshell + $ make clean + $ make tools/snep-send.o + +The build should work without issue. + +As with all solved problems, if they originated upstream, you need to +submit the fix for the recipe in OE-Core and upstream so that the +problem is taken care of at its source. See the +":doc:`../contributor-guide/submit-changes`" section for more information. + +Debugging With the GNU Project Debugger (GDB) Remotely +====================================================== + +GDB allows you to examine running programs, which in turn helps you to +understand and fix problems. It also allows you to perform post-mortem +style analysis of program crashes. GDB is available as a package within +the Yocto Project and is installed in SDK images by default. See the +":ref:`ref-manual/images:Images`" chapter in the Yocto +Project Reference Manual for a description of these images. You can find +information on GDB at https://sourceware.org/gdb/. + +.. note:: + + For best results, install debug (``-dbg``) packages for the applications you + are going to debug. Doing so makes extra debug symbols available that give + you more meaningful output. + +Sometimes, due to memory or disk space constraints, it is not possible +to use GDB directly on the remote target to debug applications. These +constraints arise because GDB needs to load the debugging information +and the binaries of the process being debugged. Additionally, GDB needs +to perform many computations to locate information such as function +names, variable names and values, stack traces and so forth --- even +before starting the debugging process. These extra computations place +more load on the target system and can alter the characteristics of the +program being debugged. + +To help get past the previously mentioned constraints, there are two +methods you can use: running a debuginfod server and using gdbserver. + +Using the debuginfod server method +---------------------------------- + +``debuginfod`` from ``elfutils`` is a way to distribute ``debuginfo`` files. +Running a ``debuginfod`` server makes debug symbols readily available, +which means you don't need to download debugging information +and the binaries of the process being debugged. You can just fetch +debug symbols from the server. + +To run a ``debuginfod`` server, you need to do the following: + +- Ensure that ``debuginfod`` is present in :term:`DISTRO_FEATURES` + (it already is in ``OpenEmbedded-core`` defaults and ``poky`` reference distribution). + If not, set in your distro config file or in ``local.conf``:: + + DISTRO_FEATURES:append = " debuginfod" + + This distro feature enables the server and client library in ``elfutils``, + and enables ``debuginfod`` support in clients (at the moment, ``gdb`` and ``binutils``). + +- Run the following commands to launch the ``debuginfod`` server on the host:: + + $ oe-debuginfod + +- To use ``debuginfod`` on the target, you need to know the ip:port where + ``debuginfod`` is listening on the host (port defaults to 8002), and export + that into the shell environment, for example in ``qemu``:: + + root@qemux86-64:~# export DEBUGINFOD_URLS="http://192.168.7.1:8002/" + +- Then debug info fetching should simply work when running the target ``gdb``, + ``readelf`` or ``objdump``, for example:: + + root@qemux86-64:~# gdb /bin/cat + ... + Reading symbols from /bin/cat... + Downloading separate debug info for /bin/cat... + Reading symbols from /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo... + +- It's also possible to use ``debuginfod-find`` to just query the server:: + + root@qemux86-64:~# debuginfod-find debuginfo /bin/ls + /home/root/.cache/debuginfod_client/356edc585f7f82d46f94fcb87a86a3fe2d2e60bd/debuginfo + + +Using the gdbserver method +-------------------------- + +gdbserver, which runs on the remote target and does not load any +debugging information from the debugged process. Instead, a GDB instance +processes the debugging information that is run on a remote computer - +the host GDB. The host GDB then sends control commands to gdbserver to +make it stop or start the debugged program, as well as read or write +memory regions of that debugged program. All the debugging information +loaded and processed as well as all the heavy debugging is done by the +host GDB. Offloading these processes gives the gdbserver running on the +target a chance to remain small and fast. + +Because the host GDB is responsible for loading the debugging +information and for doing the necessary processing to make actual +debugging happen, you have to make sure the host can access the +unstripped binaries complete with their debugging information and also +be sure the target is compiled with no optimizations. The host GDB must +also have local access to all the libraries used by the debugged +program. Because gdbserver does not need any local debugging +information, the binaries on the remote target can remain stripped. +However, the binaries must also be compiled without optimization so they +match the host's binaries. + +To remain consistent with GDB documentation and terminology, the binary +being debugged on the remote target machine is referred to as the +"inferior" binary. For documentation on GDB see the `GDB +site <https://sourceware.org/gdb/documentation/>`__. + +The following steps show you how to debug using the GNU project +debugger. + +#. *Configure your build system to construct the companion debug + filesystem:* + + In your ``local.conf`` file, set the following:: + + IMAGE_GEN_DEBUGFS = "1" + IMAGE_FSTYPES_DEBUGFS = "tar.bz2" + + These options cause the + OpenEmbedded build system to generate a special companion filesystem + fragment, which contains the matching source and debug symbols to + your deployable filesystem. The build system does this by looking at + what is in the deployed filesystem, and pulling the corresponding + ``-dbg`` packages. + + The companion debug filesystem is not a complete filesystem, but only + contains the debug fragments. This filesystem must be combined with + the full filesystem for debugging. Subsequent steps in this procedure + show how to combine the partial filesystem with the full filesystem. + +#. *Configure the system to include gdbserver in the target filesystem:* + + Make the following addition in your ``local.conf`` file:: + + EXTRA_IMAGE_FEATURES:append = " tools-debug" + + The change makes + sure the ``gdbserver`` package is included. + +#. *Build the environment:* + + Use the following command to construct the image and the companion + Debug Filesystem:: + + $ bitbake image + + Build the cross GDB component and + make it available for debugging. Build the SDK that matches the + image. Building the SDK is best for a production build that can be + used later for debugging, especially during long term maintenance:: + + $ bitbake -c populate_sdk image + + Alternatively, you can build the minimal toolchain components that + match the target. Doing so creates a smaller than typical SDK and + only contains a minimal set of components with which to build simple + test applications, as well as run the debugger:: + + $ bitbake meta-toolchain + + A final method is to build Gdb itself within the build system:: + + $ bitbake gdb-cross-<architecture> + + Doing so produces a temporary copy of + ``cross-gdb`` you can use for debugging during development. While + this is the quickest approach, the two previous methods in this step + are better when considering long-term maintenance strategies. + + .. note:: + + If you run ``bitbake gdb-cross``, the OpenEmbedded build system suggests + the actual image (e.g. ``gdb-cross-i586``). The suggestion is usually the + actual name you want to use. + +#. *Set up the* ``debugfs``\ *:* + + Run the following commands to set up the ``debugfs``:: + + $ mkdir debugfs + $ cd debugfs + $ tar xvfj build-dir/tmp/deploy/images/machine/image.rootfs.tar.bz2 + $ tar xvfj build-dir/tmp/deploy/images/machine/image-dbg.rootfs.tar.bz2 + +#. *Set up GDB:* + + Install the SDK (if you built one) and then source the correct + environment file. Sourcing the environment file puts the SDK in your + ``PATH`` environment variable and sets ``$GDB`` to the SDK's debugger. + + If you are using the build system, Gdb is located in + `build-dir`\ ``/tmp/sysroots/``\ `host`\ ``/usr/bin/``\ `architecture`\ ``/``\ `architecture`\ ``-gdb`` + +#. *Boot the target:* + + For information on how to run QEMU, see the `QEMU + Documentation <https://wiki.qemu.org/Documentation/GettingStartedDevelopers>`__. + + .. note:: + + Be sure to verify that your host can access the target via TCP. + +#. *Debug a program:* + + Debugging a program involves running gdbserver on the target and then + running Gdb on the host. The example in this step debugs ``gzip``: + + .. code-block:: shell + + root@qemux86:~# gdbserver localhost:1234 /bin/gzip —help + + For + additional gdbserver options, see the `GDB Server + Documentation <https://www.gnu.org/software/gdb/documentation/>`__. + + After running gdbserver on the target, you need to run Gdb on the + host and configure it and connect to the target. Use these commands:: + + $ cd directory-holding-the-debugfs-directory + $ arch-gdb + (gdb) set sysroot debugfs + (gdb) set substitute-path /usr/src/debug debugfs/usr/src/debug + (gdb) target remote IP-of-target:1234 + + At this + point, everything should automatically load (i.e. matching binaries, + symbols and headers). + + .. note:: + + The Gdb ``set`` commands in the previous example can be placed into the + users ``~/.gdbinit`` file. Upon starting, Gdb automatically runs whatever + commands are in that file. + +#. *Deploying without a full image rebuild:* + + In many cases, during development you want a quick method to deploy a + new binary to the target and debug it, without waiting for a full + image build. + + One approach to solving this situation is to just build the component + you want to debug. Once you have built the component, copy the + executable directly to both the target and the host ``debugfs``. + + If the binary is processed through the debug splitting in + OpenEmbedded, you should also copy the debug items (i.e. ``.debug`` + contents and corresponding ``/usr/src/debug`` files) from the work + directory. Here is an example:: + + $ bitbake bash + $ bitbake -c devshell bash + $ cd .. + $ scp packages-split/bash/bin/bash target:/bin/bash + $ cp -a packages-split/bash-dbg/\* path/debugfs + +Debugging with the GNU Project Debugger (GDB) on the Target +=========================================================== + +The previous section addressed using GDB remotely for debugging +purposes, which is the most usual case due to the inherent hardware +limitations on many embedded devices. However, debugging in the target +hardware itself is also possible with more powerful devices. This +section describes what you need to do in order to support using GDB to +debug on the target hardware. + +To support this kind of debugging, you need do the following: + +- Ensure that GDB is on the target. You can do this by making + the following addition to your ``local.conf`` file:: + + EXTRA_IMAGE_FEATURES:append = " tools-debug" + +- Ensure that debug symbols are present. You can do so by adding the + corresponding ``-dbg`` package to :term:`IMAGE_INSTALL`:: + + IMAGE_INSTALL:append = " packagename-dbg" + + Alternatively, you can add the following to ``local.conf`` to include + all the debug symbols:: + + EXTRA_IMAGE_FEATURES:append = " dbg-pkgs" + +.. note:: + + To improve the debug information accuracy, you can reduce the level + of optimization used by the compiler. For example, when adding the + following line to your ``local.conf`` file, you will reduce optimization + from :term:`FULL_OPTIMIZATION` of "-O2" to :term:`DEBUG_OPTIMIZATION` + of "-O -fno-omit-frame-pointer":: + + DEBUG_BUILD = "1" + + Consider that this will reduce the application's performance and is + recommended only for debugging purposes. + +Enabling Minidebuginfo +====================== + +Enabling the :term:`DISTRO_FEATURES` minidebuginfo adds a compressed ELF section ``.gnu_debugdata`` +to all binary files, containing only function names, and thus increasing the size of the +binaries only by 5 to 10%. For comparison, full debug symbols can be 10 times as big as +a stripped binary, and it is thus not always possible to deploy full debug symbols. +Minidebuginfo data allows, on the one side, to retrieve a call-stack using +GDB (command backtrace) without deploying full debug symbols to the target. It also +allows to retrieve a symbolicated call-stack when using ``systemd-coredump`` to manage +coredumps (commands ``coredumpctl list`` and ``coredumpctl info``). + +This feature was created by Fedora, see https://fedoraproject.org/wiki/Features/MiniDebugInfo for +more details. + +Other Debugging Tips +==================== + +Here are some other tips that you might find useful: + +- When adding new packages, it is worth watching for undesirable items + making their way into compiler command lines. For example, you do not + want references to local system files like ``/usr/lib/`` or + ``/usr/include/``. + +- If you want to remove the ``psplash`` boot splashscreen, add + ``psplash=false`` to the kernel command line. Doing so prevents + ``psplash`` from loading and thus allows you to see the console. It + is also possible to switch out of the splashscreen by switching the + virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). + +- Removing :term:`TMPDIR` (usually ``tmp/``, within the + :term:`Build Directory`) can often fix temporary build issues. Removing + :term:`TMPDIR` is usually a relatively cheap operation, because task output + will be cached in :term:`SSTATE_DIR` (usually ``sstate-cache/``, which is + also in the :term:`Build Directory`). + + .. note:: + + Removing :term:`TMPDIR` might be a workaround rather than a fix. + Consequently, trying to determine the underlying cause of an issue before + removing the directory is a good idea. + +- Understanding how a feature is used in practice within existing + recipes can be very helpful. It is recommended that you configure + some method that allows you to quickly search through files. + + Using GNU Grep, you can use the following shell function to + recursively search through common recipe-related files, skipping + binary files, ``.git`` directories, and the :term:`Build Directory` + (assuming its name starts with "build"):: + + g() { + grep -Ir \ + --exclude-dir=.git \ + --exclude-dir='build*' \ + --include='*.bb*' \ + --include='*.inc*' \ + --include='*.conf*' \ + --include='*.py*' \ + "$@" + } + + Here are some usage examples:: + + $ g FOO # Search recursively for "FOO" + $ g -i foo # Search recursively for "foo", ignoring case + $ g -w FOO # Search recursively for "FOO" as a word, ignoring e.g. "FOOBAR" + + If figuring + out how some feature works requires a lot of searching, it might + indicate that the documentation should be extended or improved. In + such cases, consider filing a documentation bug using the Yocto + Project implementation of + :yocto_bugs:`Bugzilla <>`. For information on + how to submit a bug against the Yocto Project, see the Yocto Project + Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` + and the ":doc:`../contributor-guide/report-defect`" section. + + .. note:: + + The manuals might not be the right place to document variables + that are purely internal and have a limited scope (e.g. internal + variables used to implement a single ``.bbclass`` file). + diff --git a/documentation/dev-manual/development-shell.rst b/documentation/dev-manual/development-shell.rst new file mode 100644 index 0000000000..be26bcffc7 --- /dev/null +++ b/documentation/dev-manual/development-shell.rst @@ -0,0 +1,82 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using a Development Shell +************************* + +When debugging certain commands or even when just editing packages, +``devshell`` can be a useful tool. When you invoke ``devshell``, all +tasks up to and including +:ref:`ref-tasks-patch` are run for the +specified target. Then, a new terminal is opened and you are placed in +``${``\ :term:`S`\ ``}``, the source +directory. In the new terminal, all the OpenEmbedded build-related +environment variables are still defined so you can use commands such as +``configure`` and ``make``. The commands execute just as if the +OpenEmbedded build system were executing them. Consequently, working +this way can be helpful when debugging a build or preparing software to +be used with the OpenEmbedded build system. + +Here is an example that uses ``devshell`` on a target named +``matchbox-desktop``:: + + $ bitbake matchbox-desktop -c devshell + +This command spawns a terminal with a shell prompt within the +OpenEmbedded build environment. The +:term:`OE_TERMINAL` variable +controls what type of shell is opened. + +For spawned terminals, the following occurs: + +- The ``PATH`` variable includes the cross-toolchain. + +- The ``pkgconfig`` variables find the correct ``.pc`` files. + +- The ``configure`` command finds the Yocto Project site files as well + as any other necessary files. + +Within this environment, you can run configure or compile commands as if +they were being run by the OpenEmbedded build system itself. As noted +earlier, the working directory also automatically changes to the Source +Directory (:term:`S`). + +To manually run a specific task using ``devshell``, run the +corresponding ``run.*`` script in the +``${``\ :term:`WORKDIR`\ ``}/temp`` +directory (e.g., ``run.do_configure.``\ `pid`). If a task's script does +not exist, which would be the case if the task was skipped by way of the +sstate cache, you can create the task by first running it outside of the +``devshell``:: + + $ bitbake -c task + +.. note:: + + - Execution of a task's ``run.*`` script and BitBake's execution of + a task are identical. In other words, running the script re-runs + the task just as it would be run using the ``bitbake -c`` command. + + - Any ``run.*`` file that does not have a ``.pid`` extension is a + symbolic link (symlink) to the most recent version of that file. + +Remember, that the ``devshell`` is a mechanism that allows you to get +into the BitBake task execution environment. And as such, all commands +must be called just as BitBake would call them. That means you need to +provide the appropriate options for cross-compilation and so forth as +applicable. + +When you are finished using ``devshell``, exit the shell or close the +terminal window. + +.. note:: + + - It is worth remembering that when using ``devshell`` you need to + use the full compiler name such as ``arm-poky-linux-gnueabi-gcc`` + instead of just using ``gcc``. The same applies to other + applications such as ``binutils``, ``libtool`` and so forth. + BitBake sets up environment variables such as :term:`CC` to assist + applications, such as ``make`` to find the correct tools. + + - It is also worth noting that ``devshell`` still works over X11 + forwarding and similar situations. + diff --git a/documentation/dev-manual/device-manager.rst b/documentation/dev-manual/device-manager.rst new file mode 100644 index 0000000000..49fc785fec --- /dev/null +++ b/documentation/dev-manual/device-manager.rst @@ -0,0 +1,74 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +.. _device-manager: + +Selecting a Device Manager +************************** + +The Yocto Project provides multiple ways to manage the device manager +(``/dev``): + +- Persistent and Pre-Populated ``/dev``: For this case, the ``/dev`` + directory is persistent and the required device nodes are created + during the build. + +- Use ``devtmpfs`` with a Device Manager: For this case, the ``/dev`` + directory is provided by the kernel as an in-memory file system and + is automatically populated by the kernel at runtime. Additional + configuration of device nodes is done in user space by a device + manager like ``udev`` or ``busybox-mdev``. + +Using Persistent and Pre-Populated ``/dev`` +=========================================== + +To use the static method for device population, you need to set the +:term:`USE_DEVFS` variable to "0" +as follows:: + + USE_DEVFS = "0" + +The content of the resulting ``/dev`` directory is defined in a Device +Table file. The +:term:`IMAGE_DEVICE_TABLES` +variable defines the Device Table to use and should be set in the +machine or distro configuration file. Alternatively, you can set this +variable in your ``local.conf`` configuration file. + +If you do not define the :term:`IMAGE_DEVICE_TABLES` variable, the default +``device_table-minimal.txt`` is used:: + + IMAGE_DEVICE_TABLES = "device_table-mymachine.txt" + +The population is handled by the ``makedevs`` utility during image +creation: + +Using ``devtmpfs`` and a Device Manager +======================================= + +To use the dynamic method for device population, you need to use (or be +sure to set) the :term:`USE_DEVFS` +variable to "1", which is the default:: + + USE_DEVFS = "1" + +With this +setting, the resulting ``/dev`` directory is populated by the kernel +using ``devtmpfs``. Make sure the corresponding kernel configuration +variable ``CONFIG_DEVTMPFS`` is set when building you build a Linux +kernel. + +All devices created by ``devtmpfs`` will be owned by ``root`` and have +permissions ``0600``. + +To have more control over the device nodes, you can use a device manager like +``udev`` or ``busybox-mdev``. You choose the device manager by defining the +:term:`VIRTUAL-RUNTIME_dev_manager <VIRTUAL-RUNTIME>` variable in your machine +or distro configuration file. Alternatively, you can set this variable in +your ``local.conf`` configuration file:: + + VIRTUAL-RUNTIME_dev_manager = "udev" + + # Some alternative values + # VIRTUAL-RUNTIME_dev_manager = "busybox-mdev" + # VIRTUAL-RUNTIME_dev_manager = "systemd" + diff --git a/documentation/dev-manual/disk-space.rst b/documentation/dev-manual/disk-space.rst new file mode 100644 index 0000000000..efca82601d --- /dev/null +++ b/documentation/dev-manual/disk-space.rst @@ -0,0 +1,61 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Conserving Disk Space +********************* + +Conserving Disk Space During Builds +=================================== + +To help conserve disk space during builds, you can add the following +statement to your project's ``local.conf`` configuration file found in +the :term:`Build Directory`:: + + INHERIT += "rm_work" + +Adding this statement deletes the work directory used for +building a recipe once the recipe is built. For more information on +"rm_work", see the :ref:`ref-classes-rm-work` class in the +Yocto Project Reference Manual. + +When you inherit this class and build a ``core-image-sato`` image for a +``qemux86-64`` machine from an Ubuntu 22.04 x86-64 system, you end up with a +final disk usage of 22 Gbytes instead of &MIN_DISK_SPACE; Gbytes. However, +&MIN_DISK_SPACE_RM_WORK; Gbytes of initial free disk space are still needed to +create temporary files before they can be deleted. + +Purging Obsolete Shared State Cache Files +========================================= + +After multiple build iterations, the Shared State (sstate) cache can contain +multiple cache files for a given package, consuming a substantial amount of +disk space. However, only the most recent ones are likely to be reused. + +The following command is a quick way to purge all the cache files which +haven't been used for a least a specified number of days:: + + find build/sstate-cache -type f -mtime +$DAYS -delete + +The above command relies on the fact that BitBake touches the sstate cache +files as it accesses them, when it has write access to the cache. + +You could use ``-atime`` instead of ``-mtime`` if the partition isn't mounted +with the ``noatime`` option for a read only cache. + +For more advanced needs, OpenEmbedded-Core also offers a more elaborate +command. It has the ability to purge all but the newest cache files on each +architecture, and also to remove files that it considers unreachable by +exploring a set of build configurations. However, this command +requires a full build environment to be available and doesn't work well +covering multiple releases. It won't work either on limited environments +such as BSD based NAS:: + + sstate-cache-management.py --remove-duplicated --cache-dir=sstate-cache + +This command will ask you to confirm the deletions it identifies. +Run ``sstate-cache-management.sh`` for more details about this script. + +.. note:: + + As this command is much more cautious and selective, removing only cache files, + it will execute much slower than the simple ``find`` command described above. + Therefore, it may not be your best option to trim huge cache directories. diff --git a/documentation/dev-manual/efficiently-fetching-sources.rst b/documentation/dev-manual/efficiently-fetching-sources.rst new file mode 100644 index 0000000000..a15f0a92ce --- /dev/null +++ b/documentation/dev-manual/efficiently-fetching-sources.rst @@ -0,0 +1,68 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Efficiently Fetching Source Files During a Build +************************************************ + +The OpenEmbedded build system works with source files located through +the :term:`SRC_URI` variable. When +you build something using BitBake, a big part of the operation is +locating and downloading all the source tarballs. For images, +downloading all the source for various packages can take a significant +amount of time. + +This section shows you how you can use mirrors to speed up fetching +source files and how you can pre-fetch files all of which leads to more +efficient use of resources and time. + +Setting up Effective Mirrors +============================ + +A good deal that goes into a Yocto Project build is simply downloading +all of the source tarballs. Maybe you have been working with another +build system for which you have built up a +sizable directory of source tarballs. Or, perhaps someone else has such +a directory for which you have read access. If so, you can save time by +adding statements to your configuration file so that the build process +checks local directories first for existing tarballs before checking the +Internet. + +Here is an efficient way to set it up in your ``local.conf`` file:: + + SOURCE_MIRROR_URL ?= "file:///home/you/your-download-dir/" + INHERIT += "own-mirrors" + BB_GENERATE_MIRROR_TARBALLS = "1" + # BB_NO_NETWORK = "1" + +In the previous example, the +:term:`BB_GENERATE_MIRROR_TARBALLS` +variable causes the OpenEmbedded build system to generate tarballs of +the Git repositories and store them in the +:term:`DL_DIR` directory. Due to +performance reasons, generating and storing these tarballs is not the +build system's default behavior. + +You can also use the +:term:`PREMIRRORS` variable. For +an example, see the variable's glossary entry in the Yocto Project +Reference Manual. + +Getting Source Files and Suppressing the Build +============================================== + +Another technique you can use to ready yourself for a successive string +of build operations, is to pre-fetch all the source files without +actually starting a build. This technique lets you work through any +download issues and ultimately gathers all the source files into your +download directory :ref:`structure-build-downloads`, +which is located with :term:`DL_DIR`. + +Use the following BitBake command form to fetch all the necessary +sources without starting the build:: + + $ bitbake target --runall=fetch + +This +variation of the BitBake command guarantees that you have all the +sources for that BitBake target should you disconnect from the Internet +and want to do the build later offline. + diff --git a/documentation/dev-manual/error-reporting-tool.rst b/documentation/dev-manual/error-reporting-tool.rst new file mode 100644 index 0000000000..84f3d9cd1e --- /dev/null +++ b/documentation/dev-manual/error-reporting-tool.rst @@ -0,0 +1,84 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using the Error Reporting Tool +****************************** + +The error reporting tool allows you to submit errors encountered during +builds to a central database. Outside of the build environment, you can +use a web interface to browse errors, view statistics, and query for +errors. The tool works using a client-server system where the client +portion is integrated with the installed Yocto Project +:term:`Source Directory` (e.g. ``poky``). +The server receives the information collected and saves it in a +database. + +There is a live instance of the error reporting server at +https://errors.yoctoproject.org. +When you want to get help with build failures, you can submit all of the +information on the failure easily and then point to the URL in your bug +report or send an email to the mailing list. + +.. note:: + + If you send error reports to this server, the reports become publicly + visible. + +Enabling and Using the Tool +=========================== + +By default, the error reporting tool is disabled. You can enable it by +inheriting the :ref:`ref-classes-report-error` class by adding the +following statement to the end of your ``local.conf`` file in your +:term:`Build Directory`:: + + INHERIT += "report-error" + +By default, the error reporting feature stores information in +``${``\ :term:`LOG_DIR`\ ``}/error-report``. +However, you can specify a directory to use by adding the following to +your ``local.conf`` file:: + + ERR_REPORT_DIR = "path" + +Enabling error +reporting causes the build process to collect the errors and store them +in a file as previously described. When the build system encounters an +error, it includes a command as part of the console output. You can run +the command to send the error file to the server. For example, the +following command sends the errors to an upstream server:: + + $ send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt + +In the previous example, the errors are sent to a public database +available at https://errors.yoctoproject.org, which is used by the +entire community. If you specify a particular server, you can send the +errors to a different database. Use the following command for more +information on available options:: + + $ send-error-report --help + +When sending the error file, you are prompted to review the data being +sent as well as to provide a name and optional email address. Once you +satisfy these prompts, the command returns a link from the server that +corresponds to your entry in the database. For example, here is a +typical link: https://errors.yoctoproject.org/Errors/Details/9522/ + +Following the link takes you to a web interface where you can browse, +query the errors, and view statistics. + +Disabling the Tool +================== + +To disable the error reporting feature, simply remove or comment out the +following statement from the end of your ``local.conf`` file in your +:term:`Build Directory`:: + + INHERIT += "report-error" + +Setting Up Your Own Error Reporting Server +========================================== + +If you want to set up your own error reporting server, you can obtain +the code from the Git repository at :yocto_git:`/error-report-web/`. +Instructions on how to set it up are in the README document. + diff --git a/documentation/dev-manual/external-scm.rst b/documentation/dev-manual/external-scm.rst new file mode 100644 index 0000000000..97a7e63e36 --- /dev/null +++ b/documentation/dev-manual/external-scm.rst @@ -0,0 +1,67 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using an External SCM +********************* + +If you're working on a recipe that pulls from an external Source Code +Manager (SCM), it is possible to have the OpenEmbedded build system +notice new recipe changes added to the SCM and then build the resulting +packages that depend on the new recipes by using the latest versions. +This only works for SCMs from which it is possible to get a sensible +revision number for changes. Currently, you can do this with Apache +Subversion (SVN), Git, and Bazaar (BZR) repositories. + +To enable this behavior, the :term:`PV` of +the recipe needs to reference +:term:`SRCPV`. Here is an example:: + + PV = "1.2.3+git${SRCPV}" + +Then, you can add the following to your +``local.conf``:: + + SRCREV:pn-PN = "${AUTOREV}" + +:term:`PN` is the name of the recipe for +which you want to enable automatic source revision updating. + +If you do not want to update your local configuration file, you can add +the following directly to the recipe to finish enabling the feature:: + + SRCREV = "${AUTOREV}" + +The Yocto Project provides a distribution named ``poky-bleeding``, whose +configuration file contains the line:: + + require conf/distro/include/poky-floating-revisions.inc + +This line pulls in the +listed include file that contains numerous lines of exactly that form:: + + #SRCREV:pn-opkg-native ?= "${AUTOREV}" + #SRCREV:pn-opkg-sdk ?= "${AUTOREV}" + #SRCREV:pn-opkg ?= "${AUTOREV}" + #SRCREV:pn-opkg-utils-native ?= "${AUTOREV}" + #SRCREV:pn-opkg-utils ?= "${AUTOREV}" + SRCREV:pn-gconf-dbus ?= "${AUTOREV}" + SRCREV:pn-matchbox-common ?= "${AUTOREV}" + SRCREV:pn-matchbox-config-gtk ?= "${AUTOREV}" + SRCREV:pn-matchbox-desktop ?= "${AUTOREV}" + SRCREV:pn-matchbox-keyboard ?= "${AUTOREV}" + SRCREV:pn-matchbox-panel-2 ?= "${AUTOREV}" + SRCREV:pn-matchbox-themes-extra ?= "${AUTOREV}" + SRCREV:pn-matchbox-terminal ?= "${AUTOREV}" + SRCREV:pn-matchbox-wm ?= "${AUTOREV}" + SRCREV:pn-settings-daemon ?= "${AUTOREV}" + SRCREV:pn-screenshot ?= "${AUTOREV}" + . . . + +These lines allow you to +experiment with building a distribution that tracks the latest +development source for numerous packages. + +.. note:: + + The ``poky-bleeding`` distribution is not tested on a regular basis. Keep + this in mind if you use it. + diff --git a/documentation/dev-manual/external-toolchain.rst b/documentation/dev-manual/external-toolchain.rst new file mode 100644 index 0000000000..238f8cf467 --- /dev/null +++ b/documentation/dev-manual/external-toolchain.rst @@ -0,0 +1,40 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Optionally Using an External Toolchain +************************************** + +You might want to use an external toolchain as part of your development. +If this is the case, the fundamental steps you need to accomplish are as +follows: + +- Understand where the installed toolchain resides. For cases where you + need to build the external toolchain, you would need to take separate + steps to build and install the toolchain. + +- Make sure you add the layer that contains the toolchain to your + ``bblayers.conf`` file through the + :term:`BBLAYERS` variable. + +- Set the :term:`EXTERNAL_TOOLCHAIN` variable in your ``local.conf`` file + to the location in which you installed the toolchain. + +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`. + +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 Mentor Graphics Sourcery G++ Toolchain. Support for this toolchain resides +in the separate ``meta-sourcery`` layer at +https://github.com/MentorEmbedded/meta-sourcery/. +See its ``README`` file for details about how to use this layer. + +Another example of external toolchain layer is +:yocto_git:`meta-arm-toolchain </meta-arm/tree/meta-arm-toolchain/>` +supporting GNU toolchains released by ARM. + +You can find further information by reading about the :term:`TCMODE` variable +in the Yocto Project Reference Manual's variable glossary. diff --git a/documentation/dev-manual/figures/cute-files-npm-example.png b/documentation/dev-manual/figures/cute-files-npm-example.png Binary files differindex 1ebe74f535..a02cca097f 100644 --- a/documentation/dev-manual/figures/cute-files-npm-example.png +++ b/documentation/dev-manual/figures/cute-files-npm-example.png diff --git a/documentation/dev-manual/gobject-introspection.rst b/documentation/dev-manual/gobject-introspection.rst new file mode 100644 index 0000000000..f7206e6fae --- /dev/null +++ b/documentation/dev-manual/gobject-introspection.rst @@ -0,0 +1,155 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Enabling GObject Introspection Support +************************************** + +`GObject introspection <https://gi.readthedocs.io/en/latest/>`__ +is the standard mechanism for accessing GObject-based software from +runtime environments. GObject is a feature of the GLib library that +provides an object framework for the GNOME desktop and related software. +GObject Introspection adds information to GObject that allows objects +created within it to be represented across different programming +languages. If you want to construct GStreamer pipelines using Python, or +control UPnP infrastructure using Javascript and GUPnP, GObject +introspection is the only way to do it. + +This section describes the Yocto Project support for generating and +packaging GObject introspection data. GObject introspection data is a +description of the API provided by libraries built on top of the GLib +framework, and, in particular, that framework's GObject mechanism. +GObject Introspection Repository (GIR) files go to ``-dev`` packages, +``typelib`` files go to main packages as they are packaged together with +libraries that are introspected. + +The data is generated when building such a library, by linking the +library with a small executable binary that asks the library to describe +itself, and then executing the binary and processing its output. + +Generating this data in a cross-compilation environment is difficult +because the library is produced for the target architecture, but its +code needs to be executed on the build host. This problem is solved with +the OpenEmbedded build system by running the code through QEMU, which +allows precisely that. Unfortunately, QEMU does not always work +perfectly as mentioned in the ":ref:`dev-manual/gobject-introspection:known issues`" +section. + +Enabling the Generation of Introspection Data +============================================= + +Enabling the generation of introspection data (GIR files) in your +library package involves the following: + +#. Inherit the :ref:`ref-classes-gobject-introspection` class. + +#. Make sure introspection is not disabled anywhere in the recipe or + from anything the recipe includes. Also, make sure that + "gobject-introspection-data" is not in + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` + and that "qemu-usermode" is not in + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. + In either of these conditions, nothing will happen. + +#. Try to build the recipe. If you encounter build errors that look like + something is unable to find ``.so`` libraries, check where these + libraries are located in the source tree and add the following to the + recipe:: + + GIR_EXTRA_LIBS_PATH = "${B}/something/.libs" + + .. note:: + + See recipes in the ``oe-core`` repository that use that + :term:`GIR_EXTRA_LIBS_PATH` variable as an example. + +#. Look for any other errors, which probably mean that introspection + support in a package is not entirely standard, and thus breaks down + in a cross-compilation environment. For such cases, custom-made fixes + are needed. A good place to ask and receive help in these cases is + the :ref:`Yocto Project mailing + lists <resources-mailinglist>`. + +.. note:: + + Using a library that no longer builds against the latest Yocto + Project release and prints introspection related errors is a good + candidate for the previous procedure. + +Disabling the Generation of Introspection Data +============================================== + +You might find that you do not want to generate introspection data. Or, +perhaps QEMU does not work on your build host and target architecture +combination. If so, you can use either of the following methods to +disable GIR file generations: + +- Add the following to your distro configuration:: + + DISTRO_FEATURES_BACKFILL_CONSIDERED = "gobject-introspection-data" + + Adding this statement disables generating introspection data using + QEMU but will still enable building introspection tools and libraries + (i.e. building them does not require the use of QEMU). + +- Add the following to your machine configuration:: + + MACHINE_FEATURES_BACKFILL_CONSIDERED = "qemu-usermode" + + Adding this statement disables the use of QEMU when building packages for your + machine. Currently, this feature is used only by introspection + recipes and has the same effect as the previously described option. + + .. note:: + + Future releases of the Yocto Project might have other features + affected by this option. + +If you disable introspection data, you can still obtain it through other +means such as copying the data from a suitable sysroot, or by generating +it on the target hardware. The OpenEmbedded build system does not +currently provide specific support for these techniques. + +Testing that Introspection Works in an Image +============================================ + +Use the following procedure to test if generating introspection data is +working in an image: + +#. Make sure that "gobject-introspection-data" is not in + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` + and that "qemu-usermode" is not in + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. + +#. Build ``core-image-sato``. + +#. Launch a Terminal and then start Python in the terminal. + +#. Enter the following in the terminal:: + + >>> from gi.repository import GLib + >>> GLib.get_host_name() + +#. For something a little more advanced, enter the following see: + https://python-gtk-3-tutorial.readthedocs.io/en/latest/introduction.html + +Known Issues +============ + +Here are know issues in GObject Introspection Support: + +- ``qemu-ppc64`` immediately crashes. Consequently, you cannot build + introspection data on that architecture. + +- x32 is not supported by QEMU. Consequently, introspection data is + disabled. + +- musl causes transient GLib binaries to crash on assertion failures. + Consequently, generating introspection data is disabled. + +- Because QEMU is not able to run the binaries correctly, introspection + is disabled for some specific packages under specific architectures + (e.g. ``gcr``, ``libsecret``, and ``webkit``). + +- QEMU usermode might not work properly when running 64-bit binaries + under 32-bit host machines. In particular, "qemumips64" is known to + not work under i686. + diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst index f16b135c4d..9ccf60f701 100644 --- a/documentation/dev-manual/index.rst +++ b/documentation/dev-manual/index.rst @@ -4,15 +4,49 @@ Yocto Project Development Tasks Manual ====================================== -| - .. toctree:: :caption: Table of Contents :numbered: intro start - common-tasks + layers + customizing-images + new-recipe + new-machine + upgrading-recipes + temporary-source-code + quilt.rst + development-shell + python-development-shell + building + speeding-up-build + libraries + prebuilt-libraries + x32-psabi + gobject-introspection + external-toolchain + wic + bmaptool + securing-images + custom-distribution + custom-template-configuration-directory + disk-space + packages + efficiently-fetching-sources + init-manager + device-manager + external-scm + read-only-rootfs + build-quality + runtime-testing + debugging + licenses + security-subjects + vulnerabilities + sbom + error-reporting-tool + wayland qemu .. include:: /boilerplate.rst diff --git a/documentation/dev-manual/init-manager.rst b/documentation/dev-manual/init-manager.rst new file mode 100644 index 0000000000..ddce82b81f --- /dev/null +++ b/documentation/dev-manual/init-manager.rst @@ -0,0 +1,162 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +.. _init-manager: + +Selecting an Initialization Manager +*********************************** + +By default, the Yocto Project uses :wikipedia:`SysVinit <Init#SysV-style>` as +the initialization manager. There is also support for BusyBox init, a simpler +implementation, as well as support for :wikipedia:`systemd <Systemd>`, which +is a full replacement for init with parallel starting of services, reduced +shell overhead, increased security and resource limits for services, and other +features that are used by many distributions. + +Within the system, SysVinit and BusyBox init treat system components as +services. These services are maintained as shell scripts stored in the +``/etc/init.d/`` directory. + +SysVinit is more elaborate than BusyBox init and organizes services in +different run levels. This organization is maintained by putting links +to the services in the ``/etc/rcN.d/`` directories, where `N/` is one +of the following options: "S", "0", "1", "2", "3", "4", "5", or "6". + +.. note:: + + Each runlevel has a dependency on the previous runlevel. This + dependency allows the services to work properly. + +Both SysVinit and BusyBox init are configured through the ``/etc/inittab`` +file, with a very similar syntax, though of course BusyBox init features +are more limited. + +In comparison, systemd treats components as units. Using units is a +broader concept as compared to using a service. A unit includes several +different types of entities. ``Service`` is one of the types of entities. +The runlevel concept in SysVinit corresponds to the concept of a target +in systemd, where target is also a type of supported unit. + +In systems with SysVinit or BusyBox init, services load sequentially (i.e. one +by one) during init and parallelization is not supported. With systemd, services +start in parallel. This method can have an impact on the startup performance +of a given service, though systemd will also provide more services by default, +therefore increasing the total system boot time. systemd also substantially +increases system size because of its multiple components and the extra +dependencies it pulls. + +On the contrary, BusyBox init is the simplest and the lightest solution and +also comes with BusyBox mdev as device manager, a lighter replacement to +:wikipedia:`udev <Udev>`, which SysVinit and systemd both use. + +The ":ref:`device-manager`" chapter has more details about device managers. + +Using SysVinit with udev +========================= + +SysVinit with the udev device manager corresponds to the +default setting in Poky. This corresponds to setting:: + + INIT_MANAGER = "sysvinit" + +Using BusyBox init with BusyBox mdev +==================================== + +BusyBox init with BusyBox mdev is the simplest and lightest solution +for small root filesystems. All you need is BusyBox, which most systems +have anyway:: + + INIT_MANAGER = "mdev-busybox" + +Using systemd +============= + +The last option is to use systemd together with the udev device +manager. This is the most powerful and versatile solution, especially +for more complex systems:: + + INIT_MANAGER = "systemd" + +This will enable systemd and remove sysvinit components from the image. +See :yocto_git:`meta/conf/distro/include/init-manager-systemd.inc +</poky/tree/meta/conf/distro/include/init-manager-systemd.inc>` for exact +details on what this does. + +Controling systemd from the target command line +----------------------------------------------- + +Here is a quick reference for controling systemd from the command line on the +target. Instead of opening and sometimes modifying files, most interaction +happens through the ``systemctl`` and ``journalctl`` commands: + +- ``systemctl status``: show the status of all services +- ``systemctl status <service>``: show the status of one service +- ``systemctl [start|stop] <service>``: start or stop a service +- ``systemctl [enable|disable] <service>``: enable or disable a service at boot time +- ``systemctl list-units``: list all available units +- ``journalctl -a``: show all logs for all services +- ``journalctl -f``: show only the last log entries, and keep printing updates as they arrive +- ``journalctl -u``: show only logs from a particular service + +Using systemd-journald without a traditional syslog daemon +---------------------------------------------------------- + +Counter-intuitively, ``systemd-journald`` is not a syslog runtime or provider, +and the proper way to use ``systemd-journald`` as your sole logging mechanism is to +effectively disable syslog entirely by setting these variables in your distribution +configuration file:: + + VIRTUAL-RUNTIME_syslog = "" + VIRTUAL-RUNTIME_base-utils-syslog = "" + +Doing so will prevent ``rsyslog`` / ``busybox-syslog`` from being pulled in by +default, leaving only ``systemd-journald``. + +Summary +------- + +The Yocto Project supports three different initialization managers, offering +increasing levels of complexity and functionality: + +.. list-table:: + :widths: 40 20 20 20 + :header-rows: 1 + + * - + - BusyBox init + - SysVinit + - systemd + * - Size + - Small + - Small + - Big [#footnote-systemd-size]_ + * - Complexity + - Small + - Medium + - High + * - Support for boot profiles + - No + - Yes ("runlevels") + - Yes ("targets") + * - Services defined as + - Shell scripts + - Shell scripts + - Description files + * - Starting services in parallel + - No + - No + - Yes + * - Setting service resource limits + - No + - No + - Yes + * - Support service isolation + - No + - No + - Yes + * - Integrated logging + - No + - No + - Yes + +.. [#footnote-systemd-size] Using systemd increases the ``core-image-minimal`` + image size by 160\% for ``qemux86-64`` on Mickledore (4.2), compared to SysVinit. diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst new file mode 100644 index 0000000000..91889bd0ae --- /dev/null +++ b/documentation/dev-manual/layers.rst @@ -0,0 +1,919 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Understanding and Creating Layers +********************************* + +The OpenEmbedded build system supports organizing +:term:`Metadata` into multiple layers. +Layers allow you to isolate different types of customizations from each +other. For introductory information on the Yocto Project Layer Model, +see the +":ref:`overview-manual/yp-intro:the yocto project layer model`" +section in the Yocto Project Overview and Concepts Manual. + +Creating Your Own Layer +======================= + +.. note:: + + It is very easy to create your own layers to use with the OpenEmbedded + build system, as the Yocto Project ships with tools that speed up creating + layers. This section describes the steps you perform by hand to create + layers so that you can better understand them. For information about the + layer-creation tools, see the + ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" + section in the Yocto Project Board Support Package (BSP) Developer's + Guide and the ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" + section further down in this manual. + +Follow these general steps to create your layer without using tools: + +#. *Check Existing Layers:* Before creating a new layer, you should be + sure someone has not already created a layer containing the Metadata + you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>` + for a list of layers from the OpenEmbedded community that can be used in + the Yocto Project. You could find a layer that is identical or close + to what you need. + +#. *Create a Directory:* Create the directory for your layer. When you + create the layer, be sure to create the directory in an area not + associated with the Yocto Project :term:`Source Directory` + (e.g. the cloned ``poky`` repository). + + While not strictly required, prepend the name of the directory with + the string "meta-". For example:: + + meta-mylayer + meta-GUI_xyz + meta-mymachine + + With rare exceptions, a layer's name follows this form:: + + meta-root_name + + Following this layer naming convention can save + you trouble later when tools, components, or variables "assume" your + layer name begins with "meta-". A notable example is in configuration + files as shown in the following step where layer names without the + "meta-" string are appended to several variables used in the + configuration. + +#. *Create a Layer Configuration File:* Inside your new layer folder, + you need to create a ``conf/layer.conf`` file. It is easiest to take + an existing layer configuration file and copy that to your layer's + ``conf`` directory and then modify the file as needed. + + The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project + :yocto_git:`Source Repositories </poky/tree/meta-yocto-bsp/conf>` + demonstrates the required syntax. For your layer, you need to replace + "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" + for a layer named "meta-machinexyz"):: + + # We have a conf and classes directory, add to BBPATH + BBPATH .= ":${LAYERDIR}" + + # We have recipes-* directories, add to BBFILES + BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ + ${LAYERDIR}/recipes-*/*/*.bbappend" + + BBFILE_COLLECTIONS += "yoctobsp" + BBFILE_PATTERN_yoctobsp = "^${LAYERDIR}/" + BBFILE_PRIORITY_yoctobsp = "5" + LAYERVERSION_yoctobsp = "4" + LAYERSERIES_COMPAT_yoctobsp = "dunfell" + + Here is an explanation of the layer configuration file: + + - :term:`BBPATH`: Adds the layer's + root directory to BitBake's search path. Through the use of the + :term:`BBPATH` variable, BitBake locates class files (``.bbclass``), + configuration files, and files that are included with ``include`` + and ``require`` statements. For these cases, BitBake uses the + first file that matches the name found in :term:`BBPATH`. This is + similar to the way the ``PATH`` variable is used for binaries. It + is recommended, therefore, that you use unique class and + configuration filenames in your custom layer. + + - :term:`BBFILES`: Defines the + location for all recipes in the layer. + + - :term:`BBFILE_COLLECTIONS`: + Establishes the current layer through a unique identifier that is + used throughout the OpenEmbedded build system to refer to the + layer. In this example, the identifier "yoctobsp" is the + representation for the container layer named "meta-yocto-bsp". + + - :term:`BBFILE_PATTERN`: + Expands immediately during parsing to provide the directory of the + layer. + + - :term:`BBFILE_PRIORITY`: + Establishes a priority to use for recipes in the layer when the + OpenEmbedded build finds recipes of the same name in different + layers. + + - :term:`LAYERVERSION`: + Establishes a version number for the layer. You can use this + version number to specify this exact version of the layer as a + dependency when using the + :term:`LAYERDEPENDS` + variable. + + - :term:`LAYERDEPENDS`: + Lists all layers on which this layer depends (if any). + + - :term:`LAYERSERIES_COMPAT`: + Lists the :yocto_wiki:`Yocto Project </Releases>` + releases for which the current version is compatible. This + variable is a good way to indicate if your particular layer is + current. + + + .. note:: + + A layer does not have to contain only recipes ``.bb`` or append files + ``.bbappend``. Generally, developers create layers using + ``bitbake-layers create-layer``. + See ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`", + explaining how the ``layer.conf`` file is created from a template located in + ``meta/lib/bblayers/templates/layer.conf``. + In fact, none of the variables set in ``layer.conf`` are mandatory, + except when :term:`BBFILE_COLLECTIONS` is present. In this case + :term:`LAYERSERIES_COMPAT` and :term:`BBFILE_PATTERN` have to be + defined too. + +#. *Add Content:* Depending on the type of layer, add the content. If + the layer adds support for a machine, add the machine configuration + in a ``conf/machine/`` file within the layer. If the layer adds + distro policy, add the distro configuration in a ``conf/distro/`` + file within the layer. If the layer introduces new recipes, put the + recipes you need in ``recipes-*`` subdirectories within the layer. + + .. note:: + + For an explanation of layer hierarchy that is compliant with the + Yocto Project, see the ":ref:`bsp-guide/bsp:example filesystem layout`" + section in the Yocto Project Board Support Package (BSP) Developer's Guide. + +#. *Optionally Test for Compatibility:* If you want permission to use + the Yocto Project Compatibility logo with your layer or application + that uses your layer, perform the steps to apply for compatibility. + See the + ":ref:`dev-manual/layers:making sure your layer is compatible with yocto project`" + section for more information. + +Following Best Practices When Creating Layers +============================================= + +To create layers that are easier to maintain and that will not impact +builds for other machines, you should consider the information in the +following list: + +- *Avoid "Overlaying" Entire Recipes from Other Layers in Your + Configuration:* In other words, do not copy an entire recipe into + your layer and then modify it. Rather, use an append file + (``.bbappend``) to override only those parts of the original recipe + you need to modify. + +- *Avoid Duplicating Include Files:* Use append files (``.bbappend``) + for each recipe that uses an include file. Or, if you are introducing + a new recipe that requires the included file, use the path relative + to the original layer directory to refer to the file. For example, + use ``require recipes-core/``\ `package`\ ``/``\ `file`\ ``.inc`` instead + of ``require`` `file`\ ``.inc``. If you're finding you have to overlay + the include file, it could indicate a deficiency in the include file + in the layer to which it originally belongs. If this is the case, you + should try to address that deficiency instead of overlaying the + include file. For example, you could address this by getting the + maintainer of the include file to add a variable or variables to make + it easy to override the parts needing to be overridden. + +- *Structure Your Layers:* Proper use of overrides within append files + and placement of machine-specific files within your layer can ensure + that a build is not using the wrong Metadata and negatively impacting + a build for a different machine. Here are some examples: + + - *Modify Variables to Support a Different Machine:* Suppose you + have a layer named ``meta-one`` that adds support for building + machine "one". To do so, you use an append file named + ``base-files.bbappend`` and create a dependency on "foo" by + altering the :term:`DEPENDS` + variable:: + + DEPENDS = "foo" + + The dependency is created during any + build that includes the layer ``meta-one``. However, you might not + want this dependency for all machines. For example, suppose you + are building for machine "two" but your ``bblayers.conf`` file has + the ``meta-one`` layer included. During the build, the + ``base-files`` for machine "two" will also have the dependency on + ``foo``. + + To make sure your changes apply only when building machine "one", + use a machine override with the :term:`DEPENDS` statement:: + + DEPENDS:one = "foo" + + You should follow the same strategy when using ``:append`` + and ``:prepend`` operations:: + + DEPENDS:append:one = " foo" + DEPENDS:prepend:one = "foo " + + As an actual example, here's a + snippet from the generic kernel include file ``linux-yocto.inc``, + wherein the kernel compile and link options are adjusted in the + case of a subset of the supported architectures:: + + DEPENDS:append:aarch64 = " libgcc" + KERNEL_CC:append:aarch64 = " ${TOOLCHAIN_OPTIONS}" + KERNEL_LD:append:aarch64 = " ${TOOLCHAIN_OPTIONS}" + + DEPENDS:append:nios2 = " libgcc" + KERNEL_CC:append:nios2 = " ${TOOLCHAIN_OPTIONS}" + KERNEL_LD:append:nios2 = " ${TOOLCHAIN_OPTIONS}" + + DEPENDS:append:arc = " libgcc" + KERNEL_CC:append:arc = " ${TOOLCHAIN_OPTIONS}" + KERNEL_LD:append:arc = " ${TOOLCHAIN_OPTIONS}" + + KERNEL_FEATURES:append:qemuall=" features/debug/printk.scc" + + - *Place Machine-Specific Files in Machine-Specific Locations:* When + you have a base recipe, such as ``base-files.bb``, that contains a + :term:`SRC_URI` statement to a + file, you can use an append file to cause the build to use your + own version of the file. For example, an append file in your layer + at ``meta-one/recipes-core/base-files/base-files.bbappend`` could + extend :term:`FILESPATH` using :term:`FILESEXTRAPATHS` as follows:: + + FILESEXTRAPATHS:prepend := "${THISDIR}/${BPN}:" + + The build for machine "one" will pick up your machine-specific file as + long as you have the file in + ``meta-one/recipes-core/base-files/base-files/``. However, if you + are building for a different machine and the ``bblayers.conf`` + file includes the ``meta-one`` layer and the location of your + machine-specific file is the first location where that file is + found according to :term:`FILESPATH`, builds for all machines will + also use that machine-specific file. + + You can make sure that a machine-specific file is used for a + particular machine by putting the file in a subdirectory specific + to the machine. For example, rather than placing the file in + ``meta-one/recipes-core/base-files/base-files/`` as shown above, + put it in ``meta-one/recipes-core/base-files/base-files/one/``. + Not only does this make sure the file is used only when building + for machine "one", but the build process locates the file more + quickly. + + In summary, you need to place all files referenced from + :term:`SRC_URI` in a machine-specific subdirectory within the layer in + order to restrict those files to machine-specific builds. + +- *Perform Steps to Apply for Yocto Project Compatibility:* If you want + permission to use the Yocto Project Compatibility logo with your + layer or application that uses your layer, perform the steps to apply + for compatibility. See the + ":ref:`dev-manual/layers:making sure your layer is compatible with yocto project`" + section for more information. + +- *Follow the Layer Naming Convention:* Store custom layers in a Git + repository that use the ``meta-layer_name`` format. + +- *Group Your Layers Locally:* Clone your repository alongside other + cloned ``meta`` directories from the :term:`Source Directory`. + +Making Sure Your Layer is Compatible With Yocto Project +======================================================= + +When you create a layer used with the Yocto Project, it is advantageous +to make sure that the layer interacts well with existing Yocto Project +layers (i.e. the layer is compatible with the Yocto Project). Ensuring +compatibility makes the layer easy to be consumed by others in the Yocto +Project community and could allow you permission to use the Yocto +Project Compatible Logo. + +.. note:: + + Only Yocto Project member organizations are permitted to use the + Yocto Project Compatible Logo. The logo is not available for general + use. For information on how to become a Yocto Project member + organization, see the :yocto_home:`Yocto Project Website <>`. + +The Yocto Project Compatibility Program consists of a layer application +process that requests permission to use the Yocto Project Compatibility +Logo for your layer and application. The process consists of two parts: + +#. Successfully passing a script (``yocto-check-layer``) that when run + against your layer, tests it against constraints based on experiences + of how layers have worked in the real world and where pitfalls have + been found. Getting a "PASS" result from the script is required for + successful compatibility registration. + +#. Completion of an application acceptance form, which you can find at + :yocto_home:`/compatible-registration/`. + +To be granted permission to use the logo, you need to satisfy the +following: + +- Be able to check the box indicating that you got a "PASS" when + running the script against your layer. + +- Answer "Yes" to the questions on the form or have an acceptable + explanation for any questions answered "No". + +- Be a Yocto Project Member Organization. + +The remainder of this section presents information on the registration +form and on the ``yocto-check-layer`` script. + +Yocto Project Compatible Program Application +-------------------------------------------- + +Use the form to apply for your layer's approval. Upon successful +application, you can use the Yocto Project Compatibility Logo with your +layer and the application that uses your layer. + +To access the form, use this link: +:yocto_home:`/compatible-registration`. +Follow the instructions on the form to complete your application. + +The application consists of the following sections: + +- *Contact Information:* Provide your contact information as the fields + require. Along with your information, provide the released versions + of the Yocto Project for which your layer is compatible. + +- *Acceptance Criteria:* Provide "Yes" or "No" answers for each of the + items in the checklist. There is space at the bottom of the form for + any explanations for items for which you answered "No". + +- *Recommendations:* Provide answers for the questions regarding Linux + kernel use and build success. + +``yocto-check-layer`` Script +---------------------------- + +The ``yocto-check-layer`` script provides you a way to assess how +compatible your layer is with the Yocto Project. You should run this +script prior to using the form to apply for compatibility as described +in the previous section. You need to achieve a "PASS" result in order to +have your application form successfully processed. + +The script divides tests into three areas: COMMON, BSP, and DISTRO. For +example, given a distribution layer (DISTRO), the layer must pass both +the COMMON and DISTRO related tests. Furthermore, if your layer is a BSP +layer, the layer must pass the COMMON and BSP set of tests. + +To execute the script, enter the following commands from your build +directory:: + + $ source oe-init-build-env + $ yocto-check-layer your_layer_directory + +Be sure to provide the actual directory for your +layer as part of the command. + +Entering the command causes the script to determine the type of layer +and then to execute a set of specific tests against the layer. The +following list overviews the test: + +- ``common.test_readme``: Tests if a ``README`` file exists in the + layer and the file is not empty. + +- ``common.test_parse``: Tests to make sure that BitBake can parse the + files without error (i.e. ``bitbake -p``). + +- ``common.test_show_environment``: Tests that the global or per-recipe + environment is in order without errors (i.e. ``bitbake -e``). + +- ``common.test_world``: Verifies that ``bitbake world`` works. + +- ``common.test_signatures``: Tests to be sure that BSP and DISTRO + layers do not come with recipes that change signatures. + +- ``common.test_layerseries_compat``: Verifies layer compatibility is + set properly. + +- ``bsp.test_bsp_defines_machines``: Tests if a BSP layer has machine + configurations. + +- ``bsp.test_bsp_no_set_machine``: Tests to ensure a BSP layer does not + set the machine when the layer is added. + +- ``bsp.test_machine_world``: Verifies that ``bitbake world`` works + regardless of which machine is selected. + +- ``bsp.test_machine_signatures``: Verifies that building for a + particular machine affects only the signature of tasks specific to + that machine. + +- ``distro.test_distro_defines_distros``: Tests if a DISTRO layer has + distro configurations. + +- ``distro.test_distro_no_set_distros``: Tests to ensure a DISTRO layer + does not set the distribution when the layer is added. + +Enabling Your Layer +=================== + +Before the OpenEmbedded build system can use your new layer, you need to +enable it. To enable your layer, simply add your layer's path to the +:term:`BBLAYERS` variable in your ``conf/bblayers.conf`` file, which is +found in the :term:`Build Directory`. The following example shows how to +enable your new ``meta-mylayer`` layer (note how your new layer exists +outside of the official ``poky`` repository which you would have checked +out earlier):: + + # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf + # changes incompatibly + POKY_BBLAYERS_CONF_VERSION = "2" + BBPATH = "${TOPDIR}" + BBFILES ?= "" + BBLAYERS ?= " \ + /home/user/poky/meta \ + /home/user/poky/meta-poky \ + /home/user/poky/meta-yocto-bsp \ + /home/user/mystuff/meta-mylayer \ + " + +BitBake parses each ``conf/layer.conf`` file from the top down as +specified in the :term:`BBLAYERS` variable within the ``conf/bblayers.conf`` +file. During the processing of each ``conf/layer.conf`` file, BitBake +adds the recipes, classes and configurations contained within the +particular layer to the source directory. + +Appending Other Layers Metadata With Your Layer +=============================================== + +A recipe that appends Metadata to another recipe is called a BitBake +append file. A BitBake append file uses the ``.bbappend`` file type +suffix, while the corresponding recipe to which Metadata is being +appended uses the ``.bb`` file type suffix. + +You can use a ``.bbappend`` file in your layer to make additions or +changes to the content of another layer's recipe without having to copy +the other layer's recipe into your layer. Your ``.bbappend`` file +resides in your layer, while the main ``.bb`` recipe file to which you +are appending Metadata resides in a different layer. + +Being able to append information to an existing recipe not only avoids +duplication, but also automatically applies recipe changes from a +different layer into your layer. If you were copying recipes, you would +have to manually merge changes as they occur. + +When you create an append file, you must use the same root name as the +corresponding recipe file. For example, the append file +``someapp_3.1.bbappend`` must apply to ``someapp_3.1.bb``. This +means the original recipe and append filenames are version +number-specific. If the corresponding recipe is renamed to update to a +newer version, you must also rename and possibly update the +corresponding ``.bbappend`` as well. During the build process, BitBake +displays an error on starting if it detects a ``.bbappend`` file that +does not have a corresponding recipe with a matching name. See the +:term:`BB_DANGLINGAPPENDS_WARNONLY` +variable for information on how to handle this error. + +Overlaying a File Using Your Layer +---------------------------------- + +As an example, consider the main formfactor recipe and a corresponding +formfactor append file both from the :term:`Source Directory`. +Here is the main +formfactor recipe, which is named ``formfactor_0.0.bb`` and located in +the "meta" layer at ``meta/recipes-bsp/formfactor``:: + + SUMMARY = "Device formfactor information" + DESCRIPTION = "A formfactor configuration file provides information about the \ + target hardware for which the image is being built and information that the \ + build system cannot obtain from other sources such as the kernel." + SECTION = "base" + LICENSE = "MIT" + LIC_FILES_CHKSUM = "file://${COREBASE}/meta/COPYING.MIT;md5=3da9cfbcb788c80a0384361b4de20420" + PR = "r45" + + SRC_URI = "file://config file://machconfig" + S = "${WORKDIR}" + + PACKAGE_ARCH = "${MACHINE_ARCH}" + INHIBIT_DEFAULT_DEPS = "1" + + do_install() { + # Install file only if it has contents + install -d ${D}${sysconfdir}/formfactor/ + install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/ + if [ -s "${S}/machconfig" ]; then + install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/ + fi + } + +In the main recipe, note the :term:`SRC_URI` +variable, which tells the OpenEmbedded build system where to find files +during the build. + +Here is the append file, which is named ``formfactor_0.0.bbappend`` +and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The +file is in the layer at ``recipes-bsp/formfactor``:: + + FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:" + +By default, the build system uses the +:term:`FILESPATH` variable to +locate files. This append file extends the locations by setting the +:term:`FILESEXTRAPATHS` +variable. Setting this variable in the ``.bbappend`` file is the most +reliable and recommended method for adding directories to the search +path used by the build system to find files. + +The statement in this example extends the directories to include +``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``, +which resolves to a directory named ``formfactor`` in the same directory +in which the append file resides (i.e. +``meta-raspberrypi/recipes-bsp/formfactor``. This implies that you must +have the supporting directory structure set up that will contain any +files or patches you will be including from the layer. + +Using the immediate expansion assignment operator ``:=`` is important +because of the reference to :term:`THISDIR`. The trailing colon character is +important as it ensures that items in the list remain colon-separated. + +.. note:: + + BitBake automatically defines the :term:`THISDIR` variable. You should + never set this variable yourself. Using ":prepend" as part of the + :term:`FILESEXTRAPATHS` ensures your path will be searched prior to other + paths in the final list. + + Also, not all append files add extra files. Many append files simply + allow to add build options (e.g. ``systemd``). For these cases, your + append file would not even use the :term:`FILESEXTRAPATHS` statement. + +The end result of this ``.bbappend`` file is that on a Raspberry Pi, where +``rpi`` will exist in the list of :term:`OVERRIDES`, the file +``meta-raspberrypi/recipes-bsp/formfactor/formfactor/rpi/machconfig`` will be +used during :ref:`ref-tasks-fetch` and the test for a non-zero file size in +:ref:`ref-tasks-install` will return true, and the file will be installed. + +Installing Additional Files Using Your Layer +-------------------------------------------- + +As another example, consider the main ``xserver-xf86-config`` recipe and a +corresponding ``xserver-xf86-config`` append file both from the :term:`Source +Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named +``xserver-xf86-config_0.1.bb`` and located in the "meta" layer at +``meta/recipes-graphics/xorg-xserver``:: + + SUMMARY = "X.Org X server configuration file" + HOMEPAGE = "http://www.x.org" + SECTION = "x11/base" + LICENSE = "MIT" + LIC_FILES_CHKSUM = "file://${COREBASE}/meta/COPYING.MIT;md5=3da9cfbcb788c80a0384361b4de20420" + PR = "r33" + + SRC_URI = "file://xorg.conf" + + S = "${WORKDIR}" + + CONFFILES:${PN} = "${sysconfdir}/X11/xorg.conf" + + PACKAGE_ARCH = "${MACHINE_ARCH}" + ALLOW_EMPTY:${PN} = "1" + + do_install () { + if test -s ${WORKDIR}/xorg.conf; then + install -d ${D}/${sysconfdir}/X11 + install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/ + fi + } + +Here is the append file, which is named ``xserver-xf86-config_%.bbappend`` +and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The +file is in the layer at ``recipes-graphics/xorg-xserver``:: + + FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:" + + SRC_URI:append:rpi = " \ + file://xorg.conf.d/98-pitft.conf \ + file://xorg.conf.d/99-calibration.conf \ + " + do_install:append:rpi () { + PITFT="${@bb.utils.contains("MACHINE_FEATURES", "pitft", "1", "0", d)}" + if [ "${PITFT}" = "1" ]; then + install -d ${D}/${sysconfdir}/X11/xorg.conf.d/ + install -m 0644 ${WORKDIR}/xorg.conf.d/98-pitft.conf ${D}/${sysconfdir}/X11/xorg.conf.d/ + install -m 0644 ${WORKDIR}/xorg.conf.d/99-calibration.conf ${D}/${sysconfdir}/X11/xorg.conf.d/ + fi + } + + FILES:${PN}:append:rpi = " ${sysconfdir}/X11/xorg.conf.d/*" + +Building off of the previous example, we once again are setting the +:term:`FILESEXTRAPATHS` variable. In this case we are also using +:term:`SRC_URI` to list additional source files to use when ``rpi`` is found in +the list of :term:`OVERRIDES`. The :ref:`ref-tasks-install` task will then perform a +check for an additional :term:`MACHINE_FEATURES` that if set will cause these +additional files to be installed. These additional files are listed in +:term:`FILES` so that they will be packaged. + +Prioritizing Your Layer +======================= + +Each layer is assigned a priority value. Priority values control which +layer takes precedence if there are recipe files with the same name in +multiple layers. For these cases, the recipe file from the layer with a +higher priority number takes precedence. Priority values also affect the +order in which multiple ``.bbappend`` files for the same recipe are +applied. You can either specify the priority manually, or allow the +build system to calculate it based on the layer's dependencies. + +To specify the layer's priority manually, use the +:term:`BBFILE_PRIORITY` +variable and append the layer's root name:: + + BBFILE_PRIORITY_mylayer = "1" + +.. note:: + + It is possible for a recipe with a lower version number + :term:`PV` in a layer that has a higher + priority to take precedence. + + Also, the layer priority does not currently affect the precedence + order of ``.conf`` or ``.bbclass`` files. Future versions of BitBake + might address this. + +Managing Layers +=============== + +You can use the BitBake layer management tool ``bitbake-layers`` to +provide a view into the structure of recipes across a multi-layer +project. Being able to generate output that reports on configured layers +with their paths and priorities and on ``.bbappend`` files and their +applicable recipes can help to reveal potential problems. + +For help on the BitBake layer management tool, use the following +command:: + + $ bitbake-layers --help + +The following list describes the available commands: + +- ``help:`` Displays general help or help on a specified command. + +- ``show-layers:`` Shows the current configured layers. + +- ``show-overlayed:`` Lists overlayed recipes. A recipe is overlayed + when a recipe with the same name exists in another layer that has a + higher layer priority. + +- ``show-recipes:`` Lists available recipes and the layers that + provide them. + +- ``show-appends:`` Lists ``.bbappend`` files and the recipe files to + which they apply. + +- ``show-cross-depends:`` Lists dependency relationships between + recipes that cross layer boundaries. + +- ``add-layer:`` Adds a layer to ``bblayers.conf``. + +- ``remove-layer:`` Removes a layer from ``bblayers.conf`` + +- ``flatten:`` Flattens the layer configuration into a separate + output directory. Flattening your layer configuration builds a + "flattened" directory that contains the contents of all layers, with + any overlayed recipes removed and any ``.bbappend`` files appended to + the corresponding recipes. You might have to perform some manual + cleanup of the flattened layer as follows: + + - Non-recipe files (such as patches) are overwritten. The flatten + command shows a warning for these files. + + - Anything beyond the normal layer setup has been added to the + ``layer.conf`` file. Only the lowest priority layer's + ``layer.conf`` is used. + + - Overridden and appended items from ``.bbappend`` files need to be + cleaned up. The contents of each ``.bbappend`` end up in the + flattened recipe. However, if there are appended or changed + variable values, you need to tidy these up yourself. Consider the + following example. Here, the ``bitbake-layers`` command adds the + line ``#### bbappended ...`` so that you know where the following + lines originate:: + + ... + DESCRIPTION = "A useful utility" + ... + EXTRA_OECONF = "--enable-something" + ... + + #### bbappended from meta-anotherlayer #### + + DESCRIPTION = "Customized utility" + EXTRA_OECONF += "--enable-somethingelse" + + + Ideally, you would tidy up these utilities as follows:: + + ... + DESCRIPTION = "Customized utility" + ... + EXTRA_OECONF = "--enable-something --enable-somethingelse" + ... + +- ``layerindex-fetch``: Fetches a layer from a layer index, along + with its dependent layers, and adds the layers to the + ``conf/bblayers.conf`` file. + +- ``layerindex-show-depends``: Finds layer dependencies from the + layer index. + +- ``save-build-conf``: Saves the currently active build configuration + (``conf/local.conf``, ``conf/bblayers.conf``) as a template into a layer. + This template can later be used for setting up builds via :term:`TEMPLATECONF`. + For information about saving and using configuration templates, see + ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`". + +- ``create-layer``: Creates a basic layer. + +- ``create-layers-setup``: Writes out a configuration file and/or a script that + can replicate the directory structure and revisions of the layers in a current build. + For more information, see ":ref:`dev-manual/layers:saving and restoring the layers setup`". + +Creating a General Layer Using the ``bitbake-layers`` Script +============================================================ + +The ``bitbake-layers`` script with the ``create-layer`` subcommand +simplifies creating a new general layer. + +.. note:: + + - For information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" + section in the Yocto + Project Board Specific (BSP) Developer's Guide. + + - In order to use a layer with the OpenEmbedded build system, you + need to add the layer to your ``bblayers.conf`` configuration + file. See the ":ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script`" + section for more information. + +The default mode of the script's operation with this subcommand is to +create a layer with the following: + +- A layer priority of 6. + +- A ``conf`` subdirectory that contains a ``layer.conf`` file. + +- A ``recipes-example`` subdirectory that contains a further + subdirectory named ``example``, which contains an ``example.bb`` + recipe file. + +- A ``COPYING.MIT``, which is the license statement for the layer. The + script assumes you want to use the MIT license, which is typical for + most layers, for the contents of the layer itself. + +- A ``README`` file, which is a file describing the contents of your + new layer. + +In its simplest form, you can use the following command form to create a +layer. The command creates a layer whose name corresponds to +"your_layer_name" in the current directory:: + + $ bitbake-layers create-layer your_layer_name + +As an example, the following command creates a layer named ``meta-scottrif`` +in your home directory:: + + $ cd /usr/home + $ bitbake-layers create-layer meta-scottrif + NOTE: Starting bitbake server... + Add your new layer with 'bitbake-layers add-layer meta-scottrif' + +If you want to set the priority of the layer to other than the default +value of "6", you can either use the ``--priority`` option or you +can edit the +:term:`BBFILE_PRIORITY` value +in the ``conf/layer.conf`` after the script creates it. Furthermore, if +you want to give the example recipe file some name other than the +default, you can use the ``--example-recipe-name`` option. + +The easiest way to see how the ``bitbake-layers create-layer`` command +works is to experiment with the script. You can also read the usage +information by entering the following:: + + $ bitbake-layers create-layer --help + NOTE: Starting bitbake server... + usage: bitbake-layers create-layer [-h] [--priority PRIORITY] + [--example-recipe-name EXAMPLERECIPE] + layerdir + + Create a basic layer + + positional arguments: + layerdir Layer directory to create + + optional arguments: + -h, --help show this help message and exit + --priority PRIORITY, -p PRIORITY + Layer directory to create + --example-recipe-name EXAMPLERECIPE, -e EXAMPLERECIPE + Filename of the example recipe + +Adding a Layer Using the ``bitbake-layers`` Script +================================================== + +Once you create your general layer, you must add it to your +``bblayers.conf`` file. Adding the layer to this configuration file +makes the OpenEmbedded build system aware of your layer so that it can +search it for metadata. + +Add your layer by using the ``bitbake-layers add-layer`` command:: + + $ bitbake-layers add-layer your_layer_name + +Here is an example that adds a +layer named ``meta-scottrif`` to the configuration file. Following the +command that adds the layer is another ``bitbake-layers`` command that +shows the layers that are in your ``bblayers.conf`` file:: + + $ bitbake-layers add-layer meta-scottrif + NOTE: Starting bitbake server... + Parsing recipes: 100% |##########################################################| Time: 0:00:49 + Parsing of 1441 .bb files complete (0 cached, 1441 parsed). 2055 targets, 56 skipped, 0 masked, 0 errors. + $ bitbake-layers show-layers + NOTE: Starting bitbake server... + layer path priority + ========================================================================== + meta /home/scottrif/poky/meta 5 + meta-poky /home/scottrif/poky/meta-poky 5 + meta-yocto-bsp /home/scottrif/poky/meta-yocto-bsp 5 + workspace /home/scottrif/poky/build/workspace 99 + meta-scottrif /home/scottrif/poky/build/meta-scottrif 6 + + +Adding the layer to this file +enables the build system to locate the layer during the build. + +.. note:: + + During a build, the OpenEmbedded build system looks in the layers + from the top of the list down to the bottom in that order. + +Saving and restoring the layers setup +===================================== + +Once you have a working build with the correct set of layers, it is beneficial +to capture the layer setup --- what they are, which repositories they come from +and which SCM revisions they're at --- into a configuration file, so that this +setup can be easily replicated later, perhaps on a different machine. Here's +how to do this:: + + $ bitbake-layers create-layers-setup /srv/work/alex/meta-alex/ + NOTE: Starting bitbake server... + NOTE: Created /srv/work/alex/meta-alex/setup-layers.json + NOTE: Created /srv/work/alex/meta-alex/setup-layers + +The tool needs a single argument which tells where to place the output, consisting +of a json formatted layer configuration, and a ``setup-layers`` script that can use that configuration +to restore the layers in a different location, or on a different host machine. The argument +can point to a custom layer (which is then deemed a "bootstrap" layer that needs to be +checked out first), or into a completely independent location. + +The replication of the layers is performed by running the ``setup-layers`` script provided +above: + +#. Clone the bootstrap layer or some other repository to obtain + the json config and the setup script that can use it. + +#. Run the script directly with no options:: + + alex@Zen2:/srv/work/alex/my-build$ meta-alex/setup-layers + Note: not checking out source meta-alex, use --force-bootstraplayer-checkout to override. + + Setting up source meta-intel, revision 15.0-hardknott-3.3-310-g0a96edae, branch master + Running 'git init -q /srv/work/alex/my-build/meta-intel' + Running 'git remote remove origin > /dev/null 2>&1; git remote add origin git://git.yoctoproject.org/meta-intel' in /srv/work/alex/my-build/meta-intel + Running 'git fetch -q origin || true' in /srv/work/alex/my-build/meta-intel + Running 'git checkout -q 0a96edae609a3f48befac36af82cf1eed6786b4a' in /srv/work/alex/my-build/meta-intel + + Setting up source poky, revision 4.1_M1-372-g55483d28f2, branch akanavin/setup-layers + Running 'git init -q /srv/work/alex/my-build/poky' + Running 'git remote remove origin > /dev/null 2>&1; git remote add origin git://git.yoctoproject.org/poky' in /srv/work/alex/my-build/poky + Running 'git fetch -q origin || true' in /srv/work/alex/my-build/poky + Running 'git remote remove poky-contrib > /dev/null 2>&1; git remote add poky-contrib ssh://git@push.yoctoproject.org/poky-contrib' in /srv/work/alex/my-build/poky + Running 'git fetch -q poky-contrib || true' in /srv/work/alex/my-build/poky + Running 'git checkout -q 11db0390b02acac1324e0f827beb0e2e3d0d1d63' in /srv/work/alex/my-build/poky + +.. note:: + This will work to update an existing checkout as well. + +.. note:: + The script is self-sufficient and requires only python3 + and git on the build machine. + +.. note:: + Both the ``create-layers-setup`` and the ``setup-layers`` provided several additional options + that customize their behavior - you are welcome to study them via ``--help`` command line parameter. + diff --git a/documentation/dev-manual/libraries.rst b/documentation/dev-manual/libraries.rst new file mode 100644 index 0000000000..521dbb9a7c --- /dev/null +++ b/documentation/dev-manual/libraries.rst @@ -0,0 +1,267 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Working With Libraries +********************** + +Libraries are an integral part of your system. This section describes +some common practices you might find helpful when working with libraries +to build your system: + +- :ref:`How to include static library files + <dev-manual/libraries:including static library files>` + +- :ref:`How to use the Multilib feature to combine multiple versions of + library files into a single image + <dev-manual/libraries:combining multiple versions of library files into one image>` + +- :ref:`How to install multiple versions of the same library in parallel on + the same system + <dev-manual/libraries:installing multiple versions of the same library>` + +Including Static Library Files +============================== + +If you are building a library and the library offers static linking, you +can control which static library files (``*.a`` files) get included in +the built library. + +The :term:`PACKAGES` and +:term:`FILES:* <FILES>` variables in the +``meta/conf/bitbake.conf`` configuration file define how files installed +by the :ref:`ref-tasks-install` task are packaged. By default, the :term:`PACKAGES` +variable includes ``${PN}-staticdev``, which represents all static +library files. + +.. note:: + + Some previously released versions of the Yocto Project defined the + static library files through ``${PN}-dev``. + +Here is the part of the BitBake configuration file, where you can see +how the static library files are defined:: + + PACKAGE_BEFORE_PN ?= "" + PACKAGES = "${PN}-src ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}" + PACKAGES_DYNAMIC = "^${PN}-locale-.*" + FILES = "" + + FILES:${PN} = "${bindir}/* ${sbindir}/* ${libexecdir}/* ${libdir}/lib*${SOLIBS} \ + ${sysconfdir} ${sharedstatedir} ${localstatedir} \ + ${base_bindir}/* ${base_sbindir}/* \ + ${base_libdir}/*${SOLIBS} \ + ${base_prefix}/lib/udev ${prefix}/lib/udev \ + ${base_libdir}/udev ${libdir}/udev \ + ${datadir}/${BPN} ${libdir}/${BPN}/* \ + ${datadir}/pixmaps ${datadir}/applications \ + ${datadir}/idl ${datadir}/omf ${datadir}/sounds \ + ${libdir}/bonobo/servers" + + FILES:${PN}-bin = "${bindir}/* ${sbindir}/*" + + FILES:${PN}-doc = "${docdir} ${mandir} ${infodir} ${datadir}/gtk-doc \ + ${datadir}/gnome/help" + SECTION:${PN}-doc = "doc" + + FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" + FILES:${PN}-dev = "${includedir} ${FILES_SOLIBSDEV} ${libdir}/*.la \ + ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \ + ${datadir}/aclocal ${base_libdir}/*.o \ + ${libdir}/${BPN}/*.la ${base_libdir}/*.la \ + ${libdir}/cmake ${datadir}/cmake" + SECTION:${PN}-dev = "devel" + ALLOW_EMPTY:${PN}-dev = "1" + RDEPENDS:${PN}-dev = "${PN} (= ${EXTENDPKGV})" + + FILES:${PN}-staticdev = "${libdir}/*.a ${base_libdir}/*.a ${libdir}/${BPN}/*.a" + SECTION:${PN}-staticdev = "devel" + RDEPENDS:${PN}-staticdev = "${PN}-dev (= ${EXTENDPKGV})" + +Combining Multiple Versions of Library Files into One Image +=========================================================== + +The build system offers the ability to build libraries with different +target optimizations or architecture formats and combine these together +into one system image. You can link different binaries in the image +against the different libraries as needed for specific use cases. This +feature is called "Multilib". + +An example would be where you have most of a system compiled in 32-bit +mode using 32-bit libraries, but you have something large, like a +database engine, that needs to be a 64-bit application and uses 64-bit +libraries. Multilib allows you to get the best of both 32-bit and 64-bit +libraries. + +While the Multilib feature is most commonly used for 32 and 64-bit +differences, the approach the build system uses facilitates different +target optimizations. You could compile some binaries to use one set of +libraries and other binaries to use a different set of libraries. The +libraries could differ in architecture, compiler options, or other +optimizations. + +There are several examples in the ``meta-skeleton`` layer found in the +:term:`Source Directory`: + +- :oe_git:`conf/multilib-example.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example.conf>` + configuration file. + +- :oe_git:`conf/multilib-example2.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example2.conf>` + configuration file. + +- :oe_git:`recipes-multilib/images/core-image-multilib-example.bb </openembedded-core/tree/meta-skeleton/recipes-multilib/images/core-image-multilib-example.bb>` + recipe + +Preparing to Use Multilib +------------------------- + +User-specific requirements drive the Multilib feature. Consequently, +there is no one "out-of-the-box" configuration that would +meet your needs. + +In order to enable Multilib, you first need to ensure your recipe is +extended to support multiple libraries. Many standard recipes are +already extended and support multiple libraries. You can check in the +``meta/conf/multilib.conf`` configuration file in the +:term:`Source Directory` to see how this is +done using the +:term:`BBCLASSEXTEND` variable. +Eventually, all recipes will be covered and this list will not be +needed. + +For the most part, the :ref:`Multilib <ref-classes-multilib*>` +class extension works automatically to +extend the package name from ``${PN}`` to ``${MLPREFIX}${PN}``, where +:term:`MLPREFIX` is the particular multilib (e.g. "lib32-" or "lib64-"). +Standard variables such as +:term:`DEPENDS`, +:term:`RDEPENDS`, +:term:`RPROVIDES`, +:term:`RRECOMMENDS`, +:term:`PACKAGES`, and +:term:`PACKAGES_DYNAMIC` are +automatically extended by the system. If you are extending any manual +code in the recipe, you can use the ``${MLPREFIX}`` variable to ensure +those names are extended correctly. + +Using Multilib +-------------- + +After you have set up the recipes, you need to define the actual +combination of multiple libraries you want to build. You accomplish this +through your ``local.conf`` configuration file in the +:term:`Build Directory`. An example configuration would be as follows:: + + MACHINE = "qemux86-64" + require conf/multilib.conf + MULTILIBS = "multilib:lib32" + DEFAULTTUNE:virtclass-multilib-lib32 = "x86" + IMAGE_INSTALL:append = " lib32-glib-2.0" + +This example enables an additional library named +``lib32`` alongside the normal target packages. When combining these +"lib32" alternatives, the example uses "x86" for tuning. For information +on this particular tuning, see +``meta/conf/machine/include/ia32/arch-ia32.inc``. + +The example then includes ``lib32-glib-2.0`` in all the images, which +illustrates one method of including a multiple library dependency. You +can use a normal image build to include this dependency, for example:: + + $ bitbake core-image-sato + +You can also build Multilib packages +specifically with a command like this:: + + $ bitbake lib32-glib-2.0 + +Additional Implementation Details +--------------------------------- + +There are generic implementation details as well as details that are specific to +package management systems. Here are implementation details +that exist regardless of the package management system: + +- The typical convention used for the class extension code as used by + Multilib assumes that all package names specified in + :term:`PACKAGES` that contain + ``${PN}`` have ``${PN}`` at the start of the name. When that + convention is not followed and ``${PN}`` appears at the middle or the + end of a name, problems occur. + +- The :term:`TARGET_VENDOR` + value under Multilib will be extended to "-vendormlmultilib" (e.g. + "-pokymllib32" for a "lib32" Multilib with Poky). The reason for this + slightly unwieldy contraction is that any "-" characters in the + vendor string presently break Autoconf's ``config.sub``, and other + separators are problematic for different reasons. + +Here are the implementation details for the RPM Package Management System: + +- A unique architecture is defined for the Multilib packages, along + with creating a unique deploy folder under ``tmp/deploy/rpm`` in the + :term:`Build Directory`. For example, consider ``lib32`` in a + ``qemux86-64`` image. The possible architectures in the system are "all", + "qemux86_64", "lib32:qemux86_64", and "lib32:x86". + +- The ``${MLPREFIX}`` variable is stripped from ``${PN}`` during RPM + packaging. The naming for a normal RPM package and a Multilib RPM + package in a ``qemux86-64`` system resolves to something similar to + ``bash-4.1-r2.x86_64.rpm`` and ``bash-4.1.r2.lib32_x86.rpm``, + respectively. + +- When installing a Multilib image, the RPM backend first installs the + base image and then installs the Multilib libraries. + +- The build system relies on RPM to resolve the identical files in the + two (or more) Multilib packages. + +Here are the implementation details for the IPK Package Management System: + +- The ``${MLPREFIX}`` is not stripped from ``${PN}`` during IPK + packaging. The naming for a normal RPM package and a Multilib IPK + package in a ``qemux86-64`` system resolves to something like + ``bash_4.1-r2.x86_64.ipk`` and ``lib32-bash_4.1-rw:x86.ipk``, + respectively. + +- The IPK deploy folder is not modified with ``${MLPREFIX}`` because + packages with and without the Multilib feature can exist in the same + folder due to the ``${PN}`` differences. + +- IPK defines a sanity check for Multilib installation using certain + rules for file comparison, overridden, etc. + +Installing Multiple Versions of the Same Library +================================================ + +There are be situations where you need to install and use multiple versions +of the same library on the same system at the same time. This +almost always happens when a library API changes and you have +multiple pieces of software that depend on the separate versions of the +library. To accommodate these situations, you can install multiple +versions of the same library in parallel on the same system. + +The process is straightforward as long as the libraries use proper +versioning. With properly versioned libraries, all you need to do to +individually specify the libraries is create separate, appropriately +named recipes where the :term:`PN` part of +the name includes a portion that differentiates each library version +(e.g. the major part of the version number). Thus, instead of having a +single recipe that loads one version of a library (e.g. ``clutter``), +you provide multiple recipes that result in different versions of the +libraries you want. As an example, the following two recipes would allow +the two separate versions of the ``clutter`` library to co-exist on the +same system: + +.. code-block:: none + + clutter-1.6_1.6.20.bb + clutter-1.8_1.8.4.bb + +Additionally, if +you have other recipes that depend on a given library, you need to use +the :term:`DEPENDS` variable to +create the dependency. Continuing with the same example, if you want to +have a recipe depend on the 1.8 version of the ``clutter`` library, use +the following in your recipe:: + + DEPENDS = "clutter-1.8" + diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst new file mode 100644 index 0000000000..bffff3675f --- /dev/null +++ b/documentation/dev-manual/licenses.rst @@ -0,0 +1,544 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Working With Licenses +********************* + +As mentioned in the ":ref:`overview-manual/development-environment:licensing`" +section in the Yocto Project Overview and Concepts Manual, open source +projects are open to the public and they consequently have different +licensing structures in place. This section describes the mechanism by +which the :term:`OpenEmbedded Build System` +tracks changes to +licensing text and covers how to maintain open source license compliance +during your project's lifecycle. The section also describes how to +enable commercially licensed recipes, which by default are disabled. + +Tracking License Changes +======================== + +The license of an upstream project might change in the future. In order +to prevent these changes going unnoticed, the +:term:`LIC_FILES_CHKSUM` +variable tracks changes to the license text. The checksums are validated +at the end of the configure step, and if the checksums do not match, the +build will fail. + +Specifying the ``LIC_FILES_CHKSUM`` Variable +-------------------------------------------- + +The :term:`LIC_FILES_CHKSUM` variable contains checksums of the license text +in the source code for the recipe. Here is an example of how to +specify :term:`LIC_FILES_CHKSUM`:: + + LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ + file://licfile1.txt;beginline=5;endline=29;md5=yyyy \ + file://licfile2.txt;endline=50;md5=zzzz \ + ..." + +.. note:: + + - When using "beginline" and "endline", realize that line numbering + begins with one and not zero. Also, the included lines are + inclusive (i.e. lines five through and including 29 in the + previous example for ``licfile1.txt``). + + - When a license check fails, the selected license text is included + as part of the QA message. Using this output, you can determine + the exact start and finish for the needed license text. + +The build system uses the :term:`S` +variable as the default directory when searching files listed in +:term:`LIC_FILES_CHKSUM`. The previous example employs the default +directory. + +Consider this next example:: + + LIC_FILES_CHKSUM = "file://src/ls.c;beginline=5;endline=16;\ + md5=bb14ed3c4cda583abc85401304b5cd4e" + LIC_FILES_CHKSUM = "file://${WORKDIR}/license.html;md5=5c94767cedb5d6987c902ac850ded2c6" + +The first line locates a file in ``${S}/src/ls.c`` and isolates lines +five through 16 as license text. The second line refers to a file in +:term:`WORKDIR`. + +Note that :term:`LIC_FILES_CHKSUM` variable is mandatory for all recipes, +unless the :term:`LICENSE` variable is set to "CLOSED". + +Explanation of Syntax +--------------------- + +As mentioned in the previous section, the :term:`LIC_FILES_CHKSUM` variable +lists all the important files that contain the license text for the +source code. It is possible to specify a checksum for an entire file, or +a specific section of a file (specified by beginning and ending line +numbers with the "beginline" and "endline" parameters, respectively). +The latter is useful for source files with a license notice header, +README documents, and so forth. If you do not use the "beginline" +parameter, then it is assumed that the text begins on the first line of +the file. Similarly, if you do not use the "endline" parameter, it is +assumed that the license text ends with the last line of the file. + +The "md5" parameter stores the md5 checksum of the license text. If the +license text changes in any way as compared to this parameter then a +mismatch occurs. This mismatch triggers a build failure and notifies the +developer. Notification allows the developer to review and address the +license text changes. Also note that if a mismatch occurs during the +build, the correct md5 checksum is placed in the build log and can be +easily copied to the recipe. + +There is no limit to how many files you can specify using the +:term:`LIC_FILES_CHKSUM` variable. Generally, however, every project +requires a few specifications for license tracking. Many projects have a +"COPYING" file that stores the license information for all the source +code files. This practice allows you to just track the "COPYING" file as +long as it is kept up to date. + +.. note:: + + - If you specify an empty or invalid "md5" parameter, + :term:`BitBake` returns an md5 + mis-match error and displays the correct "md5" parameter value + during the build. The correct parameter is also captured in the + build log. + + - If the whole file contains only license text, you do not need to + use the "beginline" and "endline" parameters. + +Enabling Commercially Licensed Recipes +====================================== + +By default, the OpenEmbedded build system disables components that have +commercial or other special licensing requirements. Such requirements +are defined on a recipe-by-recipe basis through the +:term:`LICENSE_FLAGS` variable +definition in the affected recipe. For instance, the +``poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly`` recipe +contains the following statement:: + + LICENSE_FLAGS = "commercial" + +Here is a +slightly more complicated example that contains both an explicit recipe +name and version (after variable expansion):: + + LICENSE_FLAGS = "license_${PN}_${PV}" + +It is possible to give more details about a specific license +using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:: + + LICENSE_FLAGS_DETAILS[my-eula-license] = "For further details, see https://example.com/eula." + +If set, this will be displayed to the user if the license hasn't been accepted. + +In order for a component restricted by a +:term:`LICENSE_FLAGS` definition to be enabled and included in an image, it +needs to have a matching entry in the global +:term:`LICENSE_FLAGS_ACCEPTED` +variable, which is a variable typically defined in your ``local.conf`` +file. For example, to enable the +``poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly`` package, you +could add either the string "commercial_gst-plugins-ugly" or the more +general string "commercial" to :term:`LICENSE_FLAGS_ACCEPTED`. See the +":ref:`dev-manual/licenses:license flag matching`" section for a full +explanation of how :term:`LICENSE_FLAGS` matching works. Here is the +example:: + + LICENSE_FLAGS_ACCEPTED = "commercial_gst-plugins-ugly" + +Likewise, to additionally enable the package built from the recipe +containing ``LICENSE_FLAGS = "license_${PN}_${PV}"``, and assuming that +the actual recipe name was ``emgd_1.10.bb``, the following string would +enable that package as well as the original ``gst-plugins-ugly`` +package:: + + LICENSE_FLAGS_ACCEPTED = "commercial_gst-plugins-ugly license_emgd_1.10" + +As a convenience, you do not need to specify the +complete license string for every package. You can use +an abbreviated form, which consists of just the first portion or +portions of the license string before the initial underscore character +or characters. A partial string will match any license that contains the +given string as the first portion of its license. For example, the +following value will also match both of the packages +previously mentioned as well as any other packages that have licenses +starting with "commercial" or "license":: + + LICENSE_FLAGS_ACCEPTED = "commercial license" + +License Flag Matching +--------------------- + +License flag matching allows you to control what recipes the +OpenEmbedded build system includes in the build. Fundamentally, the +build system attempts to match :term:`LICENSE_FLAGS` strings found in +recipes against strings found in :term:`LICENSE_FLAGS_ACCEPTED`. +A match causes the build system to include a recipe in the +build, while failure to find a match causes the build system to exclude +a recipe. + +In general, license flag matching is simple. However, understanding some +concepts will help you correctly and effectively use matching. + +Before a flag defined by a particular recipe is tested against the +entries of :term:`LICENSE_FLAGS_ACCEPTED`, the expanded +string ``_${PN}`` is appended to the flag. This expansion makes each +:term:`LICENSE_FLAGS` value recipe-specific. After expansion, the +string is then matched against the entries. Thus, specifying +``LICENSE_FLAGS = "commercial"`` in recipe "foo", for example, results +in the string ``"commercial_foo"``. And, to create a match, that string +must appear among the entries of :term:`LICENSE_FLAGS_ACCEPTED`. + +Judicious use of the :term:`LICENSE_FLAGS` strings and the contents of the +:term:`LICENSE_FLAGS_ACCEPTED` variable allows you a lot of flexibility for +including or excluding recipes based on licensing. For example, you can +broaden the matching capabilities by using license flags string subsets +in :term:`LICENSE_FLAGS_ACCEPTED`. + +.. note:: + + When using a string subset, be sure to use the part of the expanded + string that precedes the appended underscore character (e.g. + ``usethispart_1.3``, ``usethispart_1.4``, and so forth). + +For example, simply specifying the string "commercial" in the +:term:`LICENSE_FLAGS_ACCEPTED` variable matches any expanded +:term:`LICENSE_FLAGS` definition that starts with the string +"commercial" such as "commercial_foo" and "commercial_bar", which +are the strings the build system automatically generates for +hypothetical recipes named "foo" and "bar" assuming those recipes simply +specify the following:: + + LICENSE_FLAGS = "commercial" + +Thus, you can choose to exhaustively enumerate each license flag in the +list and allow only specific recipes into the image, or you can use a +string subset that causes a broader range of matches to allow a range of +recipes into the image. + +This scheme works even if the :term:`LICENSE_FLAGS` string already has +``_${PN}`` appended. For example, the build system turns the license +flag "commercial_1.2_foo" into "commercial_1.2_foo_foo" and would match +both the general "commercial" and the specific "commercial_1.2_foo" +strings found in the :term:`LICENSE_FLAGS_ACCEPTED` variable, as expected. + +Here are some other scenarios: + +- You can specify a versioned string in the recipe such as + "commercial_foo_1.2" in a "foo" recipe. The build system expands this + string to "commercial_foo_1.2_foo". Combine this license flag with a + :term:`LICENSE_FLAGS_ACCEPTED` variable that has the string + "commercial" and you match the flag along with any other flag that + starts with the string "commercial". + +- Under the same circumstances, you can add "commercial_foo" in the + :term:`LICENSE_FLAGS_ACCEPTED` variable and the build system not only + matches "commercial_foo_1.2" but also matches any license flag with + the string "commercial_foo", regardless of the version. + +- You can be very specific and use both the package and version parts + in the :term:`LICENSE_FLAGS_ACCEPTED` list (e.g. + "commercial_foo_1.2") to specifically match a versioned recipe. + +Other Variables Related to Commercial Licenses +---------------------------------------------- + +There are other helpful variables related to commercial license handling, +defined in the +``poky/meta/conf/distro/include/default-distrovars.inc`` file:: + + COMMERCIAL_AUDIO_PLUGINS ?= "" + COMMERCIAL_VIDEO_PLUGINS ?= "" + +If you want to enable these components, you can do so by making sure you have +statements similar to the following in your ``local.conf`` configuration file:: + + COMMERCIAL_AUDIO_PLUGINS = "gst-plugins-ugly-mad \ + gst-plugins-ugly-mpegaudioparse" + COMMERCIAL_VIDEO_PLUGINS = "gst-plugins-ugly-mpeg2dec \ + gst-plugins-ugly-mpegstream gst-plugins-bad-mpegvideoparse" + LICENSE_FLAGS_ACCEPTED = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" + +Of course, you could also create a matching list for those components using the +more general "commercial" string in the :term:`LICENSE_FLAGS_ACCEPTED` variable, +but that would also enable all the other packages with :term:`LICENSE_FLAGS` +containing "commercial", which you may or may not want:: + + LICENSE_FLAGS_ACCEPTED = "commercial" + +Specifying audio and video plugins as part of the +:term:`COMMERCIAL_AUDIO_PLUGINS` and :term:`COMMERCIAL_VIDEO_PLUGINS` statements +(along with :term:`LICENSE_FLAGS_ACCEPTED`) includes the plugins or +components into built images, thus adding support for media formats or +components. + +.. note:: + + GStreamer "ugly" and "bad" plugins are actually available through + open source licenses. However, the "ugly" ones can be subject to software + patents in some countries, making it necessary to pay licensing fees + to distribute them. The "bad" ones are just deemed unreliable by the + GStreamer community and should therefore be used with care. + +Maintaining Open Source License Compliance During Your Product's Lifecycle +========================================================================== + +One of the concerns for a development organization using open source +software is how to maintain compliance with various open source +licensing during the lifecycle of the product. While this section does +not provide legal advice or comprehensively cover all scenarios, it does +present methods that you can use to assist you in meeting the compliance +requirements during a software release. + +With hundreds of different open source licenses that the Yocto Project +tracks, it is difficult to know the requirements of each and every +license. However, the requirements of the major FLOSS licenses can begin +to be covered by assuming that there are three main areas of concern: + +- Source code must be provided. + +- License text for the software must be provided. + +- Compilation scripts and modifications to the source code must be + provided. + +There are other requirements beyond the scope of these three and the +methods described in this section (e.g. the mechanism through which +source code is distributed). + +As different organizations have different ways of releasing software, +there can be multiple ways of meeting license obligations. At +least, we describe here two methods for achieving compliance: + +- The first method is to use OpenEmbedded's ability to provide + the source code, provide a list of licenses, as well as + compilation scripts and source code modifications. + + The remainder of this section describes supported methods to meet + the previously mentioned three requirements. + +- The second method is to generate a *Software Bill of Materials* + (:term:`SBoM`), as described in the ":doc:`/dev-manual/sbom`" section. + Not only do you generate :term:`SPDX` output which can be used meet + license compliance requirements (except for sharing the build system + and layers sources for the time being), but this output also includes + component version and patch information which can be used + for vulnerability assessment. + +Whatever method you choose, prior to releasing images, sources, +and the build system, you should audit all artifacts to ensure +completeness. + +.. note:: + + The Yocto Project generates a license manifest during image creation + that is located in + ``${DEPLOY_DIR}/licenses/${SSTATE_PKGARCH}/<image-name>-<machine>.rootfs-<datestamp>/`` + to assist with any audits. + +Providing the Source Code +------------------------- + +Compliance activities should begin before you generate the final image. +The first thing you should look at is the requirement that tops the list +for most compliance groups --- providing the source. The Yocto Project has +a few ways of meeting this requirement. + +One of the easiest ways to meet this requirement is to provide the +entire :term:`DL_DIR` used by the +build. This method, however, has a few issues. The most obvious is the +size of the directory since it includes all sources used in the build +and not just the source used in the released image. It will include +toolchain source, and other artifacts, which you would not generally +release. However, the more serious issue for most companies is +accidental release of proprietary software. The Yocto Project provides +an :ref:`ref-classes-archiver` class to help avoid some of these concerns. + +Before you employ :term:`DL_DIR` or the :ref:`ref-classes-archiver` class, you +need to decide how you choose to provide source. The source +:ref:`ref-classes-archiver` class can generate tarballs and SRPMs and can +create them with various levels of compliance in mind. + +One way of doing this (but certainly not the only way) is to release +just the source as a tarball. You can do this by adding the following to +the ``local.conf`` file found in the :term:`Build Directory`:: + + INHERIT += "archiver" + ARCHIVER_MODE[src] = "original" + +During the creation of your +image, the source from all recipes that deploy packages to the image is +placed within subdirectories of ``DEPLOY_DIR/sources`` based on the +:term:`LICENSE` for each recipe. +Releasing the entire directory enables you to comply with requirements +concerning providing the unmodified source. It is important to note that +the size of the directory can get large. + +A way to help mitigate the size issue is to only release tarballs for +licenses that require the release of source. Let us assume you are only +concerned with GPL code as identified by running the following script: + +.. code-block:: shell + + # Script to archive a subset of packages matching specific license(s) + # Source and license files are copied into sub folders of package folder + # Must be run from build folder + #!/bin/bash + src_release_dir="source-release" + mkdir -p $src_release_dir + for a in tmp/deploy/sources/*; do + for d in $a/*; do + # Get package name from path + p=`basename $d` + p=${p%-*} + p=${p%-*} + # Only archive GPL packages (update *GPL* regex for your license check) + numfiles=`ls tmp/deploy/licenses/$p/*GPL* 2> /dev/null | wc -l` + if [ $numfiles -ge 1 ]; then + echo Archiving $p + mkdir -p $src_release_dir/$p/source + cp $d/* $src_release_dir/$p/source 2> /dev/null + mkdir -p $src_release_dir/$p/license + cp tmp/deploy/licenses/$p/* $src_release_dir/$p/license 2> /dev/null + fi + done + done + +At this point, you +could create a tarball from the ``gpl_source_release`` directory and +provide that to the end user. This method would be a step toward +achieving compliance with section 3a of GPLv2 and with section 6 of +GPLv3. + +Providing License Text +---------------------- + +One requirement that is often overlooked is inclusion of license text. +This requirement also needs to be dealt with prior to generating the +final image. Some licenses require the license text to accompany the +binary. You can achieve this by adding the following to your +``local.conf`` file:: + + COPY_LIC_MANIFEST = "1" + COPY_LIC_DIRS = "1" + LICENSE_CREATE_PACKAGE = "1" + +Adding these statements to the +configuration file ensures that the licenses collected during package +generation are included on your image. + +.. note:: + + Setting all three variables to "1" results in the image having two + copies of the same license file. One copy resides in + ``/usr/share/common-licenses`` and the other resides in + ``/usr/share/license``. + + The reason for this behavior is because + :term:`COPY_LIC_DIRS` and + :term:`COPY_LIC_MANIFEST` + add a copy of the license when the image is built but do not offer a + path for adding licenses for newly installed packages to an image. + :term:`LICENSE_CREATE_PACKAGE` + adds a separate package and an upgrade path for adding licenses to an + image. + +As the source :ref:`ref-classes-archiver` class has already archived the +original unmodified source that contains the license files, you would have +already met the requirements for inclusion of the license information +with source as defined by the GPL and other open source licenses. + +Providing Compilation Scripts and Source Code Modifications +----------------------------------------------------------- + +At this point, we have addressed all we need prior to generating the +image. The next two requirements are addressed during the final +packaging of the release. + +By releasing the version of the OpenEmbedded build system and the layers +used during the build, you will be providing both compilation scripts +and the source code modifications in one step. + +If the deployment team has a :ref:`overview-manual/concepts:bsp layer` +and a distro layer, and those +those layers are used to patch, compile, package, or modify (in any way) +any open source software included in your released images, you might be +required to release those layers under section 3 of GPLv2 or section 1 +of GPLv3. One way of doing that is with a clean checkout of the version +of the Yocto Project and layers used during your build. Here is an +example: + +.. code-block:: shell + + # We built using the dunfell branch of the poky repo + $ git clone -b dunfell git://git.yoctoproject.org/poky + $ cd poky + # We built using the release_branch for our layers + $ git clone -b release_branch git://git.mycompany.com/meta-my-bsp-layer + $ git clone -b release_branch git://git.mycompany.com/meta-my-software-layer + # clean up the .git repos + $ find . -name ".git" -type d -exec rm -rf {} \; + +One thing a development organization might want to consider for end-user +convenience is to modify +``meta-poky/conf/templates/default/bblayers.conf.sample`` to ensure that when +the end user utilizes the released build system to build an image, the +development organization's layers are included in the ``bblayers.conf`` file +automatically:: + + # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf + # changes incompatibly + POKY_BBLAYERS_CONF_VERSION = "2" + + BBPATH = "${TOPDIR}" + BBFILES ?= "" + + BBLAYERS ?= " \ + ##OEROOT##/meta \ + ##OEROOT##/meta-poky \ + ##OEROOT##/meta-yocto-bsp \ + ##OEROOT##/meta-mylayer \ + " + +Creating and +providing an archive of the :term:`Metadata` +layers (recipes, configuration files, and so forth) enables you to meet +your requirements to include the scripts to control compilation as well +as any modifications to the original source. + +Compliance Limitations with Executables Built from Static Libraries +------------------------------------------------------------------- + +When package A is added to an image via the :term:`RDEPENDS` or :term:`RRECOMMENDS` +mechanisms as well as explicitly included in the image recipe with +:term:`IMAGE_INSTALL`, and depends on a static linked library recipe B +(``DEPENDS += "B"``), package B will neither appear in the generated license +manifest nor in the generated source tarballs. This occurs as the +:ref:`ref-classes-license` and :ref:`ref-classes-archiver` classes assume that +only packages included via :term:`RDEPENDS` or :term:`RRECOMMENDS` +end up in the image. + +As a result, potential obligations regarding license compliance for package B +may not be met. + +The Yocto Project doesn't enable static libraries by default, in part because +of this issue. Before a solution to this limitation is found, you need to +keep in mind that if your root filesystem is built from static libraries, +you will need to manually ensure that your deliveries are compliant +with the licenses of these libraries. + +Copying Non Standard Licenses +============================= + +Some packages, such as the linux-firmware package, have many licenses +that are not in any way common. You can avoid adding a lot of these +types of common license files, which are only applicable to a specific +package, by using the +:term:`NO_GENERIC_LICENSE` +variable. Using this variable also avoids QA errors when you use a +non-common, non-CLOSED license in a recipe. + +Here is an example that uses the ``LICENSE.Abilis.txt`` file as +the license from the fetched source:: + + NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" + diff --git a/documentation/dev-manual/new-machine.rst b/documentation/dev-manual/new-machine.rst new file mode 100644 index 0000000000..469b2d395a --- /dev/null +++ b/documentation/dev-manual/new-machine.rst @@ -0,0 +1,118 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Adding a New Machine +******************** + +Adding a new machine to the Yocto Project is a straightforward process. +This section describes how to add machines that are similar to those +that the Yocto Project already supports. + +.. note:: + + Although well within the capabilities of the Yocto Project, adding a + totally new architecture might require changes to ``gcc``/``glibc`` + and to the site information, which is beyond the scope of this + manual. + +For a complete example that shows how to add a new machine, see the +":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" +section in the Yocto Project Board Support Package (BSP) Developer's +Guide. + +Adding the Machine Configuration File +===================================== + +To add a new machine, you need to add a new machine configuration file +to the layer's ``conf/machine`` directory. This configuration file +provides details about the device you are adding. + +The OpenEmbedded build system uses the root name of the machine +configuration file to reference the new machine. For example, given a +machine configuration file named ``crownbay.conf``, the build system +recognizes the machine as "crownbay". + +The most important variables you must set in your machine configuration +file or include from a lower-level configuration file are as follows: + +- :term:`TARGET_ARCH` (e.g. "arm") + +- ``PREFERRED_PROVIDER_virtual/kernel`` + +- :term:`MACHINE_FEATURES` (e.g. "screen wifi") + +You might also need these variables: + +- :term:`SERIAL_CONSOLES` (e.g. "115200;ttyS0 115200;ttyS1") + +- :term:`KERNEL_IMAGETYPE` (e.g. "zImage") + +- :term:`IMAGE_FSTYPES` (e.g. "tar.gz jffs2") + +You can find full details on these variables in the reference section. +You can leverage existing machine ``.conf`` files from +``meta-yocto-bsp/conf/machine/``. + +Adding a Kernel for the Machine +=============================== + +The OpenEmbedded build system needs to be able to build a kernel for the +machine. You need to either create a new kernel recipe for this machine, +or extend an existing kernel recipe. You can find several kernel recipe +examples in the Source Directory at ``meta/recipes-kernel/linux`` that +you can use as references. + +If you are creating a new kernel recipe, normal recipe-writing rules +apply for setting up a :term:`SRC_URI`. Thus, you need to specify any +necessary patches and set :term:`S` to point at the source code. You need to +create a :ref:`ref-tasks-configure` task that configures the unpacked kernel with +a ``defconfig`` file. You can do this by using a ``make defconfig`` +command or, more commonly, by copying in a suitable ``defconfig`` file +and then running ``make oldconfig``. By making use of ``inherit kernel`` +and potentially some of the ``linux-*.inc`` files, most other +functionality is centralized and the defaults of the class normally work +well. + +If you are extending an existing kernel recipe, it is usually a matter +of adding a suitable ``defconfig`` file. The file needs to be added into +a location similar to ``defconfig`` files used for other machines in a +given kernel recipe. A possible way to do this is by listing the file in +the :term:`SRC_URI` and adding the machine to the expression in +:term:`COMPATIBLE_MACHINE`:: + + COMPATIBLE_MACHINE = '(qemux86|qemumips)' + +For more information on ``defconfig`` files, see the +":ref:`kernel-dev/common:changing the configuration`" +section in the Yocto Project Linux Kernel Development Manual. + +Adding a Formfactor Configuration File +====================================== + +A formfactor configuration file provides information about the target +hardware for which the image is being built and information that the +build system cannot obtain from other sources such as the kernel. Some +examples of information contained in a formfactor configuration file +include framebuffer orientation, whether or not the system has a +keyboard, the positioning of the keyboard in relation to the screen, and +the screen resolution. + +The build system uses reasonable defaults in most cases. However, if +customization is necessary, you need to create a ``machconfig`` file in +the ``meta/recipes-bsp/formfactor/files`` directory. This directory +contains directories for specific machines such as ``qemuarm`` and +``qemux86``. For information about the settings available and the +defaults, see the ``meta/recipes-bsp/formfactor/files/config`` file +found in the same area. + +Here is an example for "qemuarm" machine:: + + HAVE_TOUCHSCREEN=1 + HAVE_KEYBOARD=1 + DISPLAY_CAN_ROTATE=0 + DISPLAY_ORIENTATION=0 + #DISPLAY_WIDTH_PIXELS=640 + #DISPLAY_HEIGHT_PIXELS=480 + #DISPLAY_BPP=16 + DISPLAY_DPI=150 + DISPLAY_SUBPIXEL_ORDER=vrgb + diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst new file mode 100644 index 0000000000..61fc2eb122 --- /dev/null +++ b/documentation/dev-manual/new-recipe.rst @@ -0,0 +1,1639 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Writing a New Recipe +******************** + +Recipes (``.bb`` files) are fundamental components in the Yocto Project +environment. Each software component built by the OpenEmbedded build +system requires a recipe to define the component. This section describes +how to create, write, and test a new recipe. + +.. note:: + + For information on variables that are useful for recipes and for + information about recipe naming issues, see the + ":ref:`ref-manual/varlocality:recipes`" section of the Yocto Project + Reference Manual. + +Overview +======== + +The following figure shows the basic process for creating a new recipe. +The remainder of the section provides details for the steps. + +.. image:: figures/recipe-workflow.png + :align: center + :width: 50% + +Locate or Automatically Create a Base Recipe +============================================ + +You can always write a recipe from scratch. However, there are three choices +that can help you quickly get started with a new recipe: + +- ``devtool add``: A command that assists in creating a recipe and an + environment conducive to development. + +- ``recipetool create``: A command provided by the Yocto Project that + automates creation of a base recipe based on the source files. + +- *Existing Recipes:* Location and modification of an existing recipe + that is similar in function to the recipe you need. + +.. note:: + + For information on recipe syntax, see the + ":ref:`dev-manual/new-recipe:recipe syntax`" section. + +Creating the Base Recipe Using ``devtool add`` +---------------------------------------------- + +The ``devtool add`` command uses the same logic for auto-creating the +recipe as ``recipetool create``, which is listed below. Additionally, +however, ``devtool add`` sets up an environment that makes it easy for +you to patch the source and to make changes to the recipe as is often +necessary when adding a recipe to build a new piece of software to be +included in a build. + +You can find a complete description of the ``devtool add`` command in +the ":ref:`sdk-manual/extensible:a closer look at \`\`devtool add\`\``" section +in the Yocto Project Application Development and the Extensible Software +Development Kit (eSDK) manual. + +Creating the Base Recipe Using ``recipetool create`` +---------------------------------------------------- + +``recipetool create`` automates creation of a base recipe given a set of +source code files. As long as you can extract or point to the source +files, the tool will construct a recipe and automatically configure all +pre-build information into the recipe. For example, suppose you have an +application that builds using Autotools. Creating the base recipe using +``recipetool`` results in a recipe that has the pre-build dependencies, +license requirements, and checksums configured. + +To run the tool, you just need to be in your :term:`Build Directory` and +have sourced the build environment setup script (i.e. +:ref:`structure-core-script`). To get help on the tool, use the following +command:: + + $ recipetool -h + NOTE: Starting bitbake server... + usage: recipetool [-d] [-q] [--color COLOR] [-h] <subcommand> ... + + OpenEmbedded recipe tool + + options: + -d, --debug Enable debug output + -q, --quiet Print only errors + --color COLOR Colorize output (where COLOR is auto, always, never) + -h, --help show this help message and exit + + subcommands: + create Create a new recipe + newappend Create a bbappend for the specified target in the specified + layer + setvar Set a variable within a recipe + appendfile Create/update a bbappend to replace a target file + appendsrcfiles Create/update a bbappend to add or replace source files + appendsrcfile Create/update a bbappend to add or replace a source file + Use recipetool <subcommand> --help to get help on a specific command + +Running ``recipetool create -o OUTFILE`` creates the base recipe and +locates it properly in the layer that contains your source files. +Here are some syntax examples: + + - Use this syntax to generate a recipe based on source. Once generated, + the recipe resides in the existing source code layer:: + + recipetool create -o OUTFILE source + + - Use this syntax to generate a recipe using code that + you extract from source. The extracted code is placed in its own layer + defined by :term:`EXTERNALSRC`:: + + recipetool create -o OUTFILE -x EXTERNALSRC source + + - Use this syntax to generate a recipe based on source. The options + direct ``recipetool`` to generate debugging information. Once generated, + the recipe resides in the existing source code layer:: + + recipetool create -d -o OUTFILE source + +Locating and Using a Similar Recipe +----------------------------------- + +Before writing a recipe from scratch, it is often useful to discover +whether someone else has already written one that meets (or comes close +to meeting) your needs. The Yocto Project and OpenEmbedded communities +maintain many recipes that might be candidates for what you are doing. +You can find a good central index of these recipes in the +:oe_layerindex:`OpenEmbedded Layer Index <>`. + +Working from an existing recipe or a skeleton recipe is the best way to +get started. Here are some points on both methods: + +- *Locate and modify a recipe that is close to what you want to do:* + This method works when you are familiar with the current recipe + space. The method does not work so well for those new to the Yocto + Project or writing recipes. + + Some risks associated with this method are using a recipe that has + areas totally unrelated to what you are trying to accomplish with + your recipe, not recognizing areas of the recipe that you might have + to add from scratch, and so forth. All these risks stem from + unfamiliarity with the existing recipe space. + +- *Use and modify the following skeleton recipe:* If for some reason + you do not want to use ``recipetool`` and you cannot find an existing + recipe that is close to meeting your needs, you can use the following + structure to provide the fundamental areas of a new recipe:: + + DESCRIPTION = "" + HOMEPAGE = "" + LICENSE = "" + SECTION = "" + DEPENDS = "" + LIC_FILES_CHKSUM = "" + + SRC_URI = "" + +Storing and Naming the Recipe +============================= + +Once you have your base recipe, you should put it in your own layer and +name it appropriately. Locating it correctly ensures that the +OpenEmbedded build system can find it when you use BitBake to process +the recipe. + +- *Storing Your Recipe:* The OpenEmbedded build system locates your + recipe through the layer's ``conf/layer.conf`` file and the + :term:`BBFILES` variable. This + variable sets up a path from which the build system can locate + recipes. Here is the typical use:: + + BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ + ${LAYERDIR}/recipes-*/*/*.bbappend" + + Consequently, you need to be sure you locate your new recipe inside + your layer such that it can be found. + + You can find more information on how layers are structured in the + ":ref:`dev-manual/layers:understanding and creating layers`" section. + +- *Naming Your Recipe:* When you name your recipe, you need to follow + this naming convention:: + + basename_version.bb + + Use lower-cased characters and do not include the reserved suffixes + ``-native``, ``-cross``, ``-initial``, or ``-dev`` casually (i.e. do not use + them as part of your recipe name unless the string applies). Here are some + examples: + + .. code-block:: none + + cups_1.7.0.bb + gawk_4.0.2.bb + irssi_0.8.16-rc1.bb + +Running a Build on the Recipe +============================= + +Creating a new recipe is usually an iterative process that requires +using BitBake to process the recipe multiple times in order to +progressively discover and add information to the recipe file. + +Assuming you have sourced the build environment setup script (i.e. +:ref:`structure-core-script`) and you are in the :term:`Build Directory`, use +BitBake to process your recipe. All you need to provide is the +``basename`` of the recipe as described in the previous section:: + + $ bitbake basename + +During the build, the OpenEmbedded build system creates a temporary work +directory for each recipe +(``${``\ :term:`WORKDIR`\ ``}``) +where it keeps extracted source files, log files, intermediate +compilation and packaging files, and so forth. + +The path to the per-recipe temporary work directory depends on the +context in which it is being built. The quickest way to find this path +is to have BitBake return it by running the following:: + + $ bitbake -e basename | grep ^WORKDIR= + +As an example, assume a Source Directory +top-level folder named ``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.bb``. In this +case, the work directory the build system uses to build the package +would be as follows:: + + poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 + +Inside this directory you can find sub-directories such as ``image``, +``packages-split``, and ``temp``. After the build, you can examine these +to determine how well the build went. + +.. note:: + + You can find log files for each task in the recipe's ``temp`` + directory (e.g. ``poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0/temp``). + Log files are named ``log.taskname`` (e.g. ``log.do_configure``, + ``log.do_fetch``, and ``log.do_compile``). + +You can find more information about the build process in +":doc:`/overview-manual/development-environment`" +chapter of the Yocto Project Overview and Concepts Manual. + +Fetching Code +============= + +The first thing your recipe must do is specify how to fetch the source +files. Fetching is controlled mainly through the +:term:`SRC_URI` variable. Your recipe +must have a :term:`SRC_URI` variable that points to where the source is +located. For a graphical representation of source locations, see the +":ref:`overview-manual/concepts:sources`" section in +the Yocto Project Overview and Concepts Manual. + +The :ref:`ref-tasks-fetch` task uses the prefix of each entry in the +:term:`SRC_URI` variable value to determine which +:ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` +to use to get your source files. It is the :term:`SRC_URI` variable that triggers +the fetcher. The :ref:`ref-tasks-patch` task uses the variable after source is +fetched to apply patches. The OpenEmbedded build system uses +:term:`FILESOVERRIDES` for scanning directory locations for local files in +:term:`SRC_URI`. + +The :term:`SRC_URI` variable in your recipe must define each unique location +for your source files. It is good practice to not hard-code version +numbers in a URL used in :term:`SRC_URI`. Rather than hard-code these +values, use ``${``\ :term:`PV`\ ``}``, +which causes the fetch process to use the version specified in the +recipe filename. Specifying the version in this manner means that +upgrading the recipe to a future version is as simple as renaming the +recipe to match the new version. + +Here is a simple example from the +``meta/recipes-devtools/strace/strace_5.5.bb`` recipe where the source +comes from a single tarball. Notice the use of the +:term:`PV` variable:: + + SRC_URI = "https://strace.io/files/${PV}/strace-${PV}.tar.xz \ + +Files mentioned in :term:`SRC_URI` whose names end in a typical archive +extension (e.g. ``.tar``, ``.tar.gz``, ``.tar.bz2``, ``.zip``, and so +forth), are automatically extracted during the +:ref:`ref-tasks-unpack` task. For +another example that specifies these types of files, see the +":ref:`dev-manual/new-recipe:building an autotooled package`" section. + +Another way of specifying source is from an SCM. For Git repositories, +you must specify :term:`SRCREV` and you should specify :term:`PV` to include +the revision with :term:`SRCPV`. Here is an example from the recipe +``meta/recipes-core/musl/gcompat_git.bb``:: + + SRC_URI = "git://git.adelielinux.org/adelie/gcompat.git;protocol=https;branch=current" + + PV = "1.0.0+1.1+git${SRCPV}" + SRCREV = "af5a49e489fdc04b9cf02547650d7aeaccd43793" + +If your :term:`SRC_URI` statement includes URLs pointing to individual files +fetched from a remote server other than a version control system, +BitBake attempts to verify the files against checksums defined in your +recipe to ensure they have not been tampered with or otherwise modified +since the recipe was written. Multiple checksums are supported: +``SRC_URI[md5sum]``, ``SRC_URI[sha1sum]``, ``SRC_URI[sha256sum]``. +``SRC_URI[sha384sum]`` and ``SRC_URI[sha512sum]``, but only +``SRC_URI[sha256sum]`` is commonly used. + +.. note:: + + ``SRC_URI[md5sum]`` used to also be commonly used, but it is deprecated + and should be replaced by ``SRC_URI[sha256sum]`` when updating existing + recipes. + +If your :term:`SRC_URI` variable points to more than a single URL (excluding +SCM URLs), you need to provide the ``sha256`` checksum for each URL. For these +cases, you provide a name for each URL as part of the :term:`SRC_URI` and then +reference that name in the subsequent checksum statements. Here is an example +combining lines from the files ``git.inc`` and ``git_2.24.1.bb``:: + + SRC_URI = "${KERNELORG_MIRROR}/software/scm/git/git-${PV}.tar.gz;name=tarball \ + ${KERNELORG_MIRROR}/software/scm/git/git-manpages-${PV}.tar.gz;name=manpages" + + SRC_URI[tarball.sha256sum] = "ad5334956301c86841eb1e5b1bb20884a6bad89a10a6762c958220c7cf64da02" + SRC_URI[manpages.sha256sum] = "9a7ae3a093bea39770eb96ca3e5b40bff7af0b9f6123f089d7821d0e5b8e1230" + +The proper value for the ``sha256`` checksum might be available together +with other signatures on the download page for the upstream source (e.g. +``md5``, ``sha1``, ``sha256``, ``GPG``, and so forth). Because the +OpenEmbedded build system typically only deals with ``sha256sum``, +you should verify all the signatures you find by hand. + +If no :term:`SRC_URI` checksums are specified when you attempt to build the +recipe, or you provide an incorrect checksum, the build will produce an +error for each missing or incorrect checksum. As part of the error +message, the build system provides the checksum string corresponding to +the fetched file. Once you have the correct checksums, you can copy and +paste them into your recipe and then run the build again to continue. + +.. note:: + + As mentioned, if the upstream source provides signatures for + verifying the downloaded source code, you should verify those + manually before setting the checksum values in the recipe and + continuing with the build. + +This final example is a bit more complicated and is from the +``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The +example's :term:`SRC_URI` statement identifies multiple files as the source +files for the recipe: a tarball, a patch file, a desktop file, and an icon:: + + SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \ + file://xwc.patch \ + file://rxvt.desktop \ + file://rxvt.png" + +When you specify local files using the ``file://`` URI protocol, the +build system fetches files from the local machine. The path is relative +to the :term:`FILESPATH` variable +and searches specific directories in a certain order: +``${``\ :term:`BP`\ ``}``, +``${``\ :term:`BPN`\ ``}``, and +``files``. The directories are assumed to be subdirectories of the +directory in which the recipe or append file resides. For another +example that specifies these types of files, see the +"`building a single .c file package`_" section. + +The previous example also specifies a patch file. Patch files are files +whose names usually end in ``.patch`` or ``.diff`` but can end with +compressed suffixes such as ``diff.gz`` and ``patch.bz2``, for example. +The build system automatically applies patches as described in the +":ref:`dev-manual/new-recipe:patching code`" section. + +Fetching Code Through Firewalls +------------------------------- + +Some users are behind firewalls and need to fetch code through a proxy. +See the ":doc:`/ref-manual/faq`" chapter for advice. + +Limiting the Number of Parallel Connections +------------------------------------------- + +Some users are behind firewalls or use servers where the number of parallel +connections is limited. In such cases, you can limit the number of fetch +tasks being run in parallel by adding the following to your ``local.conf`` +file:: + + do_fetch[number_threads] = "4" + +Unpacking Code +============== + +During the build, the +:ref:`ref-tasks-unpack` task unpacks +the source with ``${``\ :term:`S`\ ``}`` +pointing to where it is unpacked. + +If you are fetching your source files from an upstream source archived +tarball and the tarball's internal structure matches the common +convention of a top-level subdirectory named +``${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, +then you do not need to set :term:`S`. However, if :term:`SRC_URI` specifies to +fetch source from an archive that does not use this convention, or from +an SCM like Git or Subversion, your recipe needs to define :term:`S`. + +If processing your recipe using BitBake successfully unpacks the source +files, you need to be sure that the directory pointed to by ``${S}`` +matches the structure of the source. + +Patching Code +============= + +Sometimes it is necessary to patch code after it has been fetched. Any +files mentioned in :term:`SRC_URI` whose names end in ``.patch`` or +``.diff`` or compressed versions of these suffixes (e.g. ``diff.gz``, +``patch.bz2``, etc.) are treated as patches. The +:ref:`ref-tasks-patch` task +automatically applies these patches. + +The build system should be able to apply patches with the "-p1" option +(i.e. one directory level in the path will be stripped off). If your +patch needs to have more directory levels stripped off, specify the +number of levels using the "striplevel" option in the :term:`SRC_URI` entry +for the patch. Alternatively, if your patch needs to be applied in a +specific subdirectory that is not specified in the patch file, use the +"patchdir" option in the entry. + +As with all local files referenced in +:term:`SRC_URI` using ``file://``, +you should place patch files in a directory next to the recipe either +named the same as the base name of the recipe +(:term:`BP` and +:term:`BPN`) or "files". + +Licensing +========= + +Your recipe needs to define variables related to the license +under whith the software is distributed. See the +:ref:`contributor-guide/recipe-style-guide:recipe license fields` +section in the Contributor Guide for details. + +Dependencies +============ + +Most software packages have a short list of other packages that they +require, which are called dependencies. These dependencies fall into two +main categories: build-time dependencies, which are required when the +software is built; and runtime dependencies, which are required to be +installed on the target in order for the software to run. + +Within a recipe, you specify build-time dependencies using the +:term:`DEPENDS` variable. Although there are nuances, +items specified in :term:`DEPENDS` should be names of other +recipes. It is important that you specify all build-time dependencies +explicitly. + +Another consideration is that configure scripts might automatically +check for optional dependencies and enable corresponding functionality +if those dependencies are found. If you wish to make a recipe that is +more generally useful (e.g. publish the recipe in a layer for others to +use), instead of hard-disabling the functionality, you can use the +:term:`PACKAGECONFIG` variable to allow functionality and the +corresponding dependencies to be enabled and disabled easily by other +users of the recipe. + +Similar to build-time dependencies, you specify runtime dependencies +through a variable - +:term:`RDEPENDS`, which is +package-specific. All variables that are package-specific need to have +the name of the package added to the end as an override. Since the main +package for a recipe has the same name as the recipe, and the recipe's +name can be found through the +``${``\ :term:`PN`\ ``}`` variable, then +you specify the dependencies for the main package by setting +``RDEPENDS:${PN}``. If the package were named ``${PN}-tools``, then you +would set ``RDEPENDS:${PN}-tools``, and so forth. + +Some runtime dependencies will be set automatically at packaging time. +These dependencies include any shared library dependencies (i.e. if a +package "example" contains "libexample" and another package "mypackage" +contains a binary that links to "libexample" then the OpenEmbedded build +system will automatically add a runtime dependency to "mypackage" on +"example"). See the +":ref:`overview-manual/concepts:automatically added runtime dependencies`" +section in the Yocto Project Overview and Concepts Manual for further +details. + +Configuring the Recipe +====================== + +Most software provides some means of setting build-time configuration +options before compilation. Typically, setting these options is +accomplished by running a configure script with options, or by modifying +a build configuration file. + +.. note:: + + As of Yocto Project Release 1.7, some of the core recipes that + package binary configuration scripts now disable the scripts due to + the scripts previously requiring error-prone path substitution. The + OpenEmbedded build system uses ``pkg-config`` now, which is much more + robust. You can find a list of the ``*-config`` scripts that are disabled + in the ":ref:`migration-1.7-binary-configuration-scripts-disabled`" section + in the Yocto Project Reference Manual. + +A major part of build-time configuration is about checking for +build-time dependencies and possibly enabling optional functionality as +a result. You need to specify any build-time dependencies for the +software you are building in your recipe's +:term:`DEPENDS` value, in terms of +other recipes that satisfy those dependencies. You can often find +build-time or runtime dependencies described in the software's +documentation. + +The following list provides configuration items of note based on how +your software is built: + +- *Autotools:* If your source files have a ``configure.ac`` file, then + your software is built using Autotools. If this is the case, you just + need to modify the configuration. + + When using Autotools, your recipe needs to inherit the + :ref:`ref-classes-autotools` class and it does not have to + contain a :ref:`ref-tasks-configure` task. However, you might still want to + make some adjustments. For example, you can set :term:`EXTRA_OECONF` or + :term:`PACKAGECONFIG_CONFARGS` to pass any needed configure options that + are specific to the recipe. + +- *CMake:* If your source files have a ``CMakeLists.txt`` file, then + your software is built using CMake. If this is the case, you just + need to modify the configuration. + + When you use CMake, your recipe needs to inherit the + :ref:`ref-classes-cmake` class and it does not have to contain a + :ref:`ref-tasks-configure` task. You can make some adjustments by setting + :term:`EXTRA_OECMAKE` to pass any needed configure options that are + specific to the recipe. + + .. note:: + + If you need to install one or more custom CMake toolchain files + that are supplied by the application you are building, install the + files to ``${D}${datadir}/cmake/Modules`` during :ref:`ref-tasks-install`. + +- *Other:* If your source files do not have a ``configure.ac`` or + ``CMakeLists.txt`` file, then your software is built using some + method other than Autotools or CMake. If this is the case, you + normally need to provide a + :ref:`ref-tasks-configure` task + in your recipe unless, of course, there is nothing to configure. + + Even if your software is not being built by Autotools or CMake, you + still might not need to deal with any configuration issues. You need + to determine if configuration is even a required step. You might need + to modify a Makefile or some configuration file used for the build to + specify necessary build options. Or, perhaps you might need to run a + provided, custom configure script with the appropriate options. + + For the case involving a custom configure script, you would run + ``./configure --help`` and look for the options you need to set. + +Once configuration succeeds, it is always good practice to look at the +``log.do_configure`` file to ensure that the appropriate options have +been enabled and no additional build-time dependencies need to be added +to :term:`DEPENDS`. For example, if the configure script reports that it +found something not mentioned in :term:`DEPENDS`, or that it did not find +something that it needed for some desired optional functionality, then +you would need to add those to :term:`DEPENDS`. Looking at the log might +also reveal items being checked for, enabled, or both that you do not +want, or items not being found that are in :term:`DEPENDS`, in which case +you would need to look at passing extra options to the configure script +as needed. For reference information on configure options specific to +the software you are building, you can consult the output of the +``./configure --help`` command within ``${S}`` or consult the software's +upstream documentation. + +Using Headers to Interface with Devices +======================================= + +If your recipe builds an application that needs to communicate with some +device or needs an API into a custom kernel, you will need to provide +appropriate header files. Under no circumstances should you ever modify +the existing +``meta/recipes-kernel/linux-libc-headers/linux-libc-headers.inc`` file. +These headers are used to build ``libc`` and must not be compromised +with custom or machine-specific header information. If you customize +``libc`` through modified headers all other applications that use +``libc`` thus become affected. + +.. note:: + + Never copy and customize the ``libc`` header file (i.e. + ``meta/recipes-kernel/linux-libc-headers/linux-libc-headers.inc``). + +The correct way to interface to a device or custom kernel is to use a +separate package that provides the additional headers for the driver or +other unique interfaces. When doing so, your application also becomes +responsible for creating a dependency on that specific provider. + +Consider the following: + +- Never modify ``linux-libc-headers.inc``. Consider that file to be + part of the ``libc`` system, and not something you use to access the + kernel directly. You should access ``libc`` through specific ``libc`` + calls. + +- Applications that must talk directly to devices should either provide + necessary headers themselves, or establish a dependency on a special + headers package that is specific to that driver. + +For example, suppose you want to modify an existing header that adds I/O +control or network support. If the modifications are used by a small +number programs, providing a unique version of a header is easy and has +little impact. When doing so, bear in mind the guidelines in the +previous list. + +.. note:: + + If for some reason your changes need to modify the behavior of the ``libc``, + and subsequently all other applications on the system, use a ``.bbappend`` + to modify the ``linux-kernel-headers.inc`` file. However, take care to not + make the changes machine specific. + +Consider a case where your kernel is older and you need an older +``libc`` ABI. The headers installed by your recipe should still be a +standard mainline kernel, not your own custom one. + +When you use custom kernel headers you need to get them from +:term:`STAGING_KERNEL_DIR`, +which is the directory with kernel headers that are required to build +out-of-tree modules. Your recipe will also need the following:: + + do_configure[depends] += "virtual/kernel:do_shared_workdir" + +Compilation +=========== + +During a build, the :ref:`ref-tasks-compile` task happens after source is fetched, +unpacked, and configured. If the recipe passes through :ref:`ref-tasks-compile` +successfully, nothing needs to be done. + +However, if the compile step fails, you need to diagnose the failure. +Here are some common issues that cause failures. + +.. note:: + + For cases where improper paths are detected for configuration files + or for when libraries/headers cannot be found, be sure you are using + the more robust ``pkg-config``. See the note in section + ":ref:`dev-manual/new-recipe:Configuring the Recipe`" for additional information. + +- *Parallel build failures:* These failures manifest themselves as + intermittent errors, or errors reporting that a file or directory + that should be created by some other part of the build process could + not be found. This type of failure can occur even if, upon + inspection, the file or directory does exist after the build has + failed, because that part of the build process happened in the wrong + order. + + To fix the problem, you need to either satisfy the missing dependency + in the Makefile or whatever script produced the Makefile, or (as a + workaround) set :term:`PARALLEL_MAKE` to an empty string:: + + PARALLEL_MAKE = "" + + For information on parallel Makefile issues, see the + ":ref:`dev-manual/debugging:debugging parallel make races`" section. + +- *Improper host path usage:* This failure applies to recipes building + for the target or ":ref:`ref-classes-nativesdk`" only. The + failure occurs when the compilation process uses improper headers, + libraries, or other files from the host system when cross-compiling for + the target. + + To fix the problem, examine the ``log.do_compile`` file to identify + the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and + so forth) and then either add configure options, apply a patch, or do + both. + +- *Failure to find required libraries/headers:* If a build-time + dependency is missing because it has not been declared in + :term:`DEPENDS`, or because the + dependency exists but the path used by the build process to find the + file is incorrect and the configure step did not detect it, the + compilation process could fail. For either of these failures, the + compilation process notes that files could not be found. In these + cases, you need to go back and add additional options to the + configure script as well as possibly add additional build-time + dependencies to :term:`DEPENDS`. + + Occasionally, it is necessary to apply a patch to the source to + ensure the correct paths are used. If you need to specify paths to + find files staged into the sysroot from other recipes, use the + variables that the OpenEmbedded build system provides (e.g. + :term:`STAGING_BINDIR`, :term:`STAGING_INCDIR`, :term:`STAGING_DATADIR`, and so + forth). + +Installing +========== + +During :ref:`ref-tasks-install`, the task copies the built files along with their +hierarchy to locations that would mirror their locations on the target +device. The installation process copies files from the +``${``\ :term:`S`\ ``}``, +``${``\ :term:`B`\ ``}``, and +``${``\ :term:`WORKDIR`\ ``}`` +directories to the ``${``\ :term:`D`\ ``}`` +directory to create the structure as it should appear on the target +system. + +How your software is built affects what you must do to be sure your +software is installed correctly. The following list describes what you +must do for installation depending on the type of build system used by +the software being built: + +- *Autotools and CMake:* If the software your recipe is building uses + Autotools or CMake, the OpenEmbedded build system understands how to + install the software. Consequently, you do not have to have a + :ref:`ref-tasks-install` task as part of your recipe. You just need to make + sure the install portion of the build completes with no issues. + However, if you wish to install additional files not already being + installed by ``make install``, you should do this using a + ``do_install:append`` function using the install command as described + in the "Manual" bulleted item later in this list. + +- *Other (using* ``make install``\ *)*: You need to define a :ref:`ref-tasks-install` + function in your recipe. The function should call + ``oe_runmake install`` and will likely need to pass in the + destination directory as well. How you pass that path is dependent on + how the ``Makefile`` being run is written (e.g. ``DESTDIR=${D}``, + ``PREFIX=${D}``, ``INSTALLROOT=${D}``, and so forth). + + For an example recipe using ``make install``, see the + ":ref:`dev-manual/new-recipe:building a makefile-based package`" section. + +- *Manual:* You need to define a :ref:`ref-tasks-install` function in your + recipe. The function must first use ``install -d`` to create the + directories under + ``${``\ :term:`D`\ ``}``. Once the + directories exist, your function can use ``install`` to manually + install the built software into the directories. + + You can find more information on ``install`` at + https://www.gnu.org/software/coreutils/manual/html_node/install-invocation.html. + +For the scenarios that do not use Autotools or CMake, you need to track +the installation and diagnose and fix any issues until everything +installs correctly. You need to look in the default location of +``${D}``, which is ``${WORKDIR}/image``, to be sure your files have been +installed correctly. + +.. note:: + + - During the installation process, you might need to modify some of + the installed files to suit the target layout. For example, you + might need to replace hard-coded paths in an initscript with + values of variables provided by the build system, such as + replacing ``/usr/bin/`` with ``${bindir}``. If you do perform such + modifications during :ref:`ref-tasks-install`, be sure to modify the + destination file after copying rather than before copying. + Modifying after copying ensures that the build system can + re-execute :ref:`ref-tasks-install` if needed. + + - ``oe_runmake install``, which can be run directly or can be run + indirectly by the :ref:`ref-classes-autotools` and + :ref:`ref-classes-cmake` classes, runs ``make install`` in parallel. + Sometimes, a Makefile can have missing dependencies between targets that + can result in race conditions. If you experience intermittent failures + during :ref:`ref-tasks-install`, you might be able to work around them by + disabling parallel Makefile installs by adding the following to the + recipe:: + + PARALLEL_MAKEINST = "" + + See :term:`PARALLEL_MAKEINST` for additional information. + + - If you need to install one or more custom CMake toolchain files + that are supplied by the application you are building, install the + files to ``${D}${datadir}/cmake/Modules`` during + :ref:`ref-tasks-install`. + +Enabling System Services +======================== + +If you want to install a service, which is a process that usually starts +on boot and runs in the background, then you must include some +additional definitions in your recipe. + +If you are adding services and the service initialization script or the +service file itself is not installed, you must provide for that +installation in your recipe using a ``do_install:append`` function. If +your recipe already has a :ref:`ref-tasks-install` function, update the function +near its end rather than adding an additional ``do_install:append`` +function. + +When you create the installation for your services, you need to +accomplish what is normally done by ``make install``. In other words, +make sure your installation arranges the output similar to how it is +arranged on the target system. + +The OpenEmbedded build system provides support for starting services two +different ways: + +- *SysVinit:* SysVinit is a system and service manager that manages the + init system used to control the very basic functions of your system. + The init program is the first program started by the Linux kernel + when the system boots. Init then controls the startup, running and + shutdown of all other programs. + + To enable a service using SysVinit, your recipe needs to inherit the + :ref:`ref-classes-update-rc.d` class. The class helps + facilitate safely installing the package on the target. + + You will need to set the + :term:`INITSCRIPT_PACKAGES`, + :term:`INITSCRIPT_NAME`, + and + :term:`INITSCRIPT_PARAMS` + variables within your recipe. + +- *systemd:* System Management Daemon (systemd) was designed to replace + SysVinit and to provide enhanced management of services. For more + information on systemd, see the systemd homepage at + https://freedesktop.org/wiki/Software/systemd/. + + To enable a service using systemd, your recipe needs to inherit the + :ref:`ref-classes-systemd` class. See the ``systemd.bbclass`` file + located in your :term:`Source Directory` section for more information. + +Packaging +========= + +Successful packaging is a combination of automated processes performed +by the OpenEmbedded build system and some specific steps you need to +take. The following list describes the process: + +- *Splitting Files*: The :ref:`ref-tasks-package` task splits the files produced + by the recipe into logical components. Even software that produces a + single binary might still have debug symbols, documentation, and + other logical components that should be split out. The :ref:`ref-tasks-package` + task ensures that files are split up and packaged correctly. + +- *Running QA Checks*: 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. This + step performs a range of checks to be sure the build's output is free + of common problems that show up during runtime. For information on + these checks, see the :ref:`ref-classes-insane` class and + the ":ref:`ref-manual/qa-checks:qa error and warning messages`" + chapter in the Yocto Project Reference Manual. + +- *Hand-Checking Your Packages*: After you build your software, you + need to be sure your packages are correct. Examine the + ``${``\ :term:`WORKDIR`\ ``}/packages-split`` + directory and make sure files are where you expect them to be. If you + discover problems, you can set + :term:`PACKAGES`, + :term:`FILES`, + ``do_install(:append)``, and so forth as needed. + +- *Splitting an Application into Multiple Packages*: If you need to + split an application into several packages, see the + ":ref:`dev-manual/new-recipe:splitting an application into multiple packages`" + section for an example. + +- *Installing a Post-Installation Script*: For an example showing how + to install a post-installation script, see the + ":ref:`dev-manual/new-recipe:post-installation scripts`" section. + +- *Marking Package Architecture*: Depending on what your recipe is + building and how it is configured, it might be important to mark the + packages produced as being specific to a particular machine, or to + mark them as not being specific to a particular machine or + architecture at all. + + By default, packages apply to any machine with the same architecture + as the target machine. When a recipe produces packages that are + machine-specific (e.g. the + :term:`MACHINE` value is passed + into the configure script or a patch is applied only for a particular + machine), you should mark them as such by adding the following to the + recipe:: + + PACKAGE_ARCH = "${MACHINE_ARCH}" + + On the other hand, if the recipe produces packages that do not + contain anything specific to the target machine or architecture at + all (e.g. recipes that simply package script files or configuration + files), you should use the :ref:`ref-classes-allarch` class to + do this for you by adding this to your recipe:: + + inherit allarch + + Ensuring that the package architecture is correct is not critical + while you are doing the first few builds of your recipe. However, it + is important in order to ensure that your recipe rebuilds (or does + not rebuild) appropriately in response to changes in configuration, + and to ensure that you get the appropriate packages installed on the + target machine, particularly if you run separate builds for more than + one target machine. + +Sharing Files Between Recipes +============================= + +Recipes often need to use files provided by other recipes on the build +host. For example, an application linking to a common library needs +access to the library itself and its associated headers. The way this +access is accomplished is by populating a sysroot with files. Each +recipe has two sysroots in its work directory, one for target files +(``recipe-sysroot``) and one for files that are native to the build host +(``recipe-sysroot-native``). + +.. note:: + + You could find the term "staging" used within the Yocto project + regarding files populating sysroots (e.g. the :term:`STAGING_DIR` + variable). + +Recipes should never populate the sysroot directly (i.e. write files +into sysroot). Instead, files should be installed into standard +locations during the +:ref:`ref-tasks-install` task within +the ``${``\ :term:`D`\ ``}`` directory. The +reason for this limitation is that almost all files that populate the +sysroot are cataloged in manifests in order to ensure the files can be +removed later when a recipe is either modified or removed. Thus, the +sysroot is able to remain free from stale files. + +A subset of the files installed by the :ref:`ref-tasks-install` task are +used by the :ref:`ref-tasks-populate_sysroot` task as defined by the +:term:`SYSROOT_DIRS` variable to automatically populate the sysroot. It +is possible to modify the list of directories that populate the sysroot. +The following example shows how you could add the ``/opt`` directory to +the list of directories within a recipe:: + + SYSROOT_DIRS += "/opt" + +.. note:: + + The `/sysroot-only` is to be used by recipes that generate artifacts + that are not included in the target filesystem, allowing them to share + these artifacts without needing to use the :term:`DEPLOY_DIR`. + +For a more complete description of the :ref:`ref-tasks-populate_sysroot` +task and its associated functions, see the +:ref:`staging <ref-classes-staging>` class. + +Using Virtual Providers +======================= + +Prior to a build, if you know that several different recipes provide the +same functionality, you can use a virtual provider (i.e. ``virtual/*``) +as a placeholder for the actual provider. The actual provider is +determined at build-time. + +A common scenario where a virtual provider is used would be for the kernel +recipe. Suppose you have three kernel recipes whose :term:`PN` values map to +``kernel-big``, ``kernel-mid``, and ``kernel-small``. Furthermore, each of +these recipes in some way uses a :term:`PROVIDES` statement that essentially +identifies itself as being able to provide ``virtual/kernel``. Here is one way +through the :ref:`ref-classes-kernel` class:: + + PROVIDES += "virtual/kernel" + +Any recipe that inherits the :ref:`ref-classes-kernel` class is +going to utilize a :term:`PROVIDES` statement that identifies that recipe as +being able to provide the ``virtual/kernel`` item. + +Now comes the time to actually build an image and you need a kernel +recipe, but which one? You can configure your build to call out the +kernel recipe you want by using the :term:`PREFERRED_PROVIDER` variable. As +an example, consider the :yocto_git:`x86-base.inc +</poky/tree/meta/conf/machine/include/x86/x86-base.inc>` include file, which is a +machine (i.e. :term:`MACHINE`) configuration file. This include file is the +reason all x86-based machines use the ``linux-yocto`` kernel. Here are the +relevant lines from the include file:: + + PREFERRED_PROVIDER_virtual/kernel ??= "linux-yocto" + PREFERRED_VERSION_linux-yocto ??= "4.15%" + +When you use a virtual provider, you do not have to "hard code" a recipe +name as a build dependency. You can use the +:term:`DEPENDS` variable to state the +build is dependent on ``virtual/kernel`` for example:: + + DEPENDS = "virtual/kernel" + +During the build, the OpenEmbedded build system picks +the correct recipe needed for the ``virtual/kernel`` dependency based on +the :term:`PREFERRED_PROVIDER` variable. If you want to use the small kernel +mentioned at the beginning of this section, configure your build as +follows:: + + PREFERRED_PROVIDER_virtual/kernel ??= "kernel-small" + +.. note:: + + Any recipe that :term:`PROVIDES` a ``virtual/*`` item that is ultimately not + selected through :term:`PREFERRED_PROVIDER` does not get built. Preventing these + recipes from building is usually the desired behavior since this mechanism's + purpose is to select between mutually exclusive alternative providers. + +The following lists specific examples of virtual providers: + +- ``virtual/kernel``: Provides the name of the kernel recipe to use + when building a kernel image. + +- ``virtual/bootloader``: Provides the name of the bootloader to use + when building an image. + +- ``virtual/libgbm``: Provides ``gbm.pc``. + +- ``virtual/egl``: Provides ``egl.pc`` and possibly ``wayland-egl.pc``. + +- ``virtual/libgl``: Provides ``gl.pc`` (i.e. libGL). + +- ``virtual/libgles1``: Provides ``glesv1_cm.pc`` (i.e. libGLESv1_CM). + +- ``virtual/libgles2``: Provides ``glesv2.pc`` (i.e. libGLESv2). + +.. note:: + + Virtual providers only apply to build time dependencies specified with + :term:`PROVIDES` and :term:`DEPENDS`. They do not apply to runtime + dependencies specified with :term:`RPROVIDES` and :term:`RDEPENDS`. + +Properly Versioning Pre-Release Recipes +======================================= + +Sometimes the name of a recipe can lead to versioning problems when the +recipe is upgraded to a final release. For example, consider the +``irssi_0.8.16-rc1.bb`` recipe file in the list of example recipes in +the ":ref:`dev-manual/new-recipe:storing and naming the recipe`" section. +This recipe is at a release candidate stage (i.e. "rc1"). When the recipe is +released, the recipe filename becomes ``irssi_0.8.16.bb``. The version +change from ``0.8.16-rc1`` to ``0.8.16`` is seen as a decrease by the +build system and package managers, so the resulting packages will not +correctly trigger an upgrade. + +In order to ensure the versions compare properly, the recommended +convention is to use a tilde (``~``) character as follows:: + + PV = 0.8.16~rc1 + +This way ``0.8.16~rc1`` sorts before ``0.8.16``. See the +":ref:`contributor-guide/recipe-style-guide:version policy`" section in the +Yocto Project and OpenEmbedded Contributor Guide for more details about +versioning code corresponding to a pre-release or to a specific Git commit. + +Post-Installation Scripts +========================= + +Post-installation scripts run immediately after installing a package on +the target or during image creation when a package is included in an +image. To add a post-installation script to a package, add a +``pkg_postinst:``\ `PACKAGENAME`\ ``()`` function to the recipe file +(``.bb``) and replace `PACKAGENAME` with the name of the package you want +to attach to the ``postinst`` script. To apply the post-installation +script to the main package for the recipe, which is usually what is +required, specify +``${``\ :term:`PN`\ ``}`` in place of +PACKAGENAME. + +A post-installation function has the following structure:: + + pkg_postinst:PACKAGENAME() { + # Commands to carry out + } + +The script defined in the post-installation function is called when the +root filesystem is created. If the script succeeds, the package is +marked as installed. + +.. note:: + + Any RPM post-installation script that runs on the target should + return a 0 exit code. RPM does not allow non-zero exit codes for + these scripts, and the RPM package manager will cause the package to + fail installation on the target. + +Sometimes it is necessary for the execution of a post-installation +script to be delayed until the first boot. For example, the script might +need to be executed on the device itself. To delay script execution +until boot time, you must explicitly mark post installs to defer to the +target. You can use ``pkg_postinst_ontarget()`` or call +``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. Any +failure of a ``pkg_postinst()`` script (including exit 1) triggers an +error during the +:ref:`ref-tasks-rootfs` task. + +If you have recipes that use ``pkg_postinst`` function and they require +the use of non-standard native tools that have dependencies during +root filesystem construction, you need to use the +:term:`PACKAGE_WRITE_DEPS` +variable in your recipe to list these tools. If you do not use this +variable, the tools might be missing and execution of the +post-installation script is deferred until first boot. Deferring the +script to the first boot is undesirable and impossible for read-only +root filesystems. + +.. note:: + + There is equivalent support for pre-install, pre-uninstall, and post-uninstall + scripts by way of ``pkg_preinst``, ``pkg_prerm``, and ``pkg_postrm``, + respectively. These scrips work in exactly the same way as does + ``pkg_postinst`` with the exception that they run at different times. Also, + because of when they run, they are not applicable to being run at image + creation time like ``pkg_postinst``. + +Testing +======= + +The final step for completing your recipe is to be sure that the +software you built runs correctly. To accomplish runtime testing, add +the build's output packages to your image and test them on the target. + +For information on how to customize your image by adding specific +packages, see ":ref:`dev-manual/customizing-images:customizing images`" section. + +Examples +======== + +To help summarize how to write a recipe, this section provides some +recipe examples given various scenarios: + +- `Building a single .c file package`_ + +- `Building a Makefile-based package`_ + +- `Building an Autotooled package`_ + +- `Building a Meson package`_ + +- `Splitting an application into multiple packages`_ + +- `Packaging externally produced binaries`_ + +Building a Single .c File Package +--------------------------------- + +Building an application from a single file that is stored locally (e.g. under +``files``) requires a recipe that has the file listed in the :term:`SRC_URI` +variable. Additionally, you need to manually write the :ref:`ref-tasks-compile` +and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the +directory containing the source code, which is set to :term:`WORKDIR` in this +case --- the directory BitBake uses for the build:: + + SUMMARY = "Simple helloworld application" + SECTION = "examples" + LICENSE = "MIT" + LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302" + + SRC_URI = "file://helloworld.c" + + S = "${WORKDIR}" + + do_compile() { + ${CC} ${LDFLAGS} helloworld.c -o helloworld + } + + do_install() { + install -d ${D}${bindir} + install -m 0755 helloworld ${D}${bindir} + } + +By default, the ``helloworld``, ``helloworld-dbg``, and ``helloworld-dev`` packages +are built. For information on how to customize the packaging process, see the +":ref:`dev-manual/new-recipe:splitting an application into multiple packages`" +section. + +Building a Makefile-Based Package +--------------------------------- + +Applications built with GNU ``make`` require a recipe that has the source archive +listed in :term:`SRC_URI`. You do not need to add a :ref:`ref-tasks-compile` +step since by default BitBake starts the ``make`` command to compile the +application. If you need additional ``make`` options, you should store them in +the :term:`EXTRA_OEMAKE` or :term:`PACKAGECONFIG_CONFARGS` variables. BitBake +passes these options into the GNU ``make`` invocation. Note that a +:ref:`ref-tasks-install` task is still required. Otherwise, BitBake runs an +empty :ref:`ref-tasks-install` task by default. + +Some applications might require extra parameters to be passed to the +compiler. For example, the application might need an additional header +path. You can accomplish this by adding to the :term:`CFLAGS` variable. The +following example shows this:: + + CFLAGS:prepend = "-I ${S}/include " + +In the following example, ``lz4`` is a makefile-based package:: + + SUMMARY = "Extremely Fast Compression algorithm" + DESCRIPTION = "LZ4 is a very fast lossless compression algorithm, providing compression speed at 400 MB/s per core, scalable with multi-cores CPU. It also features an extremely fast decoder, with speed in multiple GB/s per core, typically reaching RAM speed limits on multi-core systems." + HOMEPAGE = "https://github.com/lz4/lz4" + + LICENSE = "BSD-2-Clause | GPL-2.0-only" + LIC_FILES_CHKSUM = "file://lib/LICENSE;md5=ebc2ea4814a64de7708f1571904b32cc \ + file://programs/COPYING;md5=b234ee4d69f5fce4486a80fdaf4a4263 \ + file://LICENSE;md5=d57c0d21cb917fb4e0af2454aa48b956 \ + " + + PE = "1" + + SRCREV = "d44371841a2f1728a3f36839fd4b7e872d0927d3" + + SRC_URI = "git://github.com/lz4/lz4.git;branch=release;protocol=https \ + file://CVE-2021-3520.patch \ + " + UPSTREAM_CHECK_GITTAGREGEX = "v(?P<pver>.*)" + + S = "${WORKDIR}/git" + + CVE_STATUS[CVE-2014-4715] = "fixed-version: Fixed in r118, which is larger than the current version" + + EXTRA_OEMAKE = "PREFIX=${prefix} CC='${CC}' CFLAGS='${CFLAGS}' DESTDIR=${D} LIBDIR=${libdir} INCLUDEDIR=${includedir} BUILD_STATIC=no" + + do_install() { + oe_runmake install + } + + BBCLASSEXTEND = "native nativesdk" + +Building an Autotooled Package +------------------------------ + +Applications built with the Autotools such as ``autoconf`` and ``automake`` +require a recipe that has a source archive listed in :term:`SRC_URI` and also +inherit the :ref:`ref-classes-autotools` class, which contains the definitions +of all the steps needed to build an Autotool-based application. The result of +the build is automatically packaged. And, if the application uses NLS for +localization, packages with local information are generated (one package per +language). Here is one example: (``hello_2.3.bb``):: + + SUMMARY = "GNU Helloworld application" + SECTION = "examples" + LICENSE = "GPL-2.0-or-later" + LIC_FILES_CHKSUM = "file://COPYING;md5=751419260aa954499f7abaabaa882bbe" + + SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz" + + inherit autotools gettext + +The variable :term:`LIC_FILES_CHKSUM` is used to track source license changes +as described in the ":ref:`dev-manual/licenses:tracking license changes`" +section in the Yocto Project Overview and Concepts Manual. You can quickly +create Autotool-based recipes in a manner similar to the previous example. + +.. _ref-building-meson-package: + +Building a Meson Package +------------------------ + +Applications built with the `Meson build system <https://mesonbuild.com/>`__ +just need a recipe that has sources described in :term:`SRC_URI` and inherits +the :ref:`ref-classes-meson` class. + +The :oe_git:`ipcalc recipe </meta-openembedded/tree/meta-networking/recipes-support/ipcalc>` +is a simple example of an application without dependencies:: + + SUMMARY = "Tool to assist in network address calculations for IPv4 and IPv6." + HOMEPAGE = "https://gitlab.com/ipcalc/ipcalc" + + SECTION = "net" + + LICENSE = "GPL-2.0-only" + LIC_FILES_CHKSUM = "file://COPYING;md5=b234ee4d69f5fce4486a80fdaf4a4263" + + SRC_URI = "git://gitlab.com/ipcalc/ipcalc.git;protocol=https;branch=master" + SRCREV = "4c4261a47f355946ee74013d4f5d0494487cc2d6" + + S = "${WORKDIR}/git" + + inherit meson + +Applications with dependencies are likely to inherit the +:ref:`ref-classes-pkgconfig` class, as ``pkg-config`` is the default method +used by Meson to find dependencies and compile applications against them. + +Splitting an Application into Multiple Packages +----------------------------------------------- + +You can use the variables :term:`PACKAGES` and :term:`FILES` to split an +application into multiple packages. + +Here is an example that uses the ``libxpm`` recipe. By default, +this recipe generates a single package that contains the library along +with a few binaries. You can modify the recipe to split the binaries +into separate packages:: + + require xorg-lib-common.inc + + SUMMARY = "Xpm: X Pixmap extension library" + LICENSE = "MIT" + LIC_FILES_CHKSUM = "file://COPYING;md5=51f4270b012ecd4ab1a164f5f4ed6cf7" + DEPENDS += "libxext libsm libxt" + PE = "1" + + XORG_PN = "libXpm" + + PACKAGES =+ "sxpm cxpm" + FILES:cxpm = "${bindir}/cxpm" + FILES:sxpm = "${bindir}/sxpm" + +In the previous example, we want to ship the ``sxpm`` and ``cxpm`` +binaries in separate packages. Since ``bindir`` would be packaged into +the main :term:`PN` package by default, we prepend the :term:`PACKAGES` variable +so additional package names are added to the start of list. This results +in the extra ``FILES:*`` variables then containing information that +define which files and directories go into which packages. Files +included by earlier packages are skipped by latter packages. Thus, the +main :term:`PN` package does not include the above listed files. + +Packaging Externally Produced Binaries +-------------------------------------- + +Sometimes, you need to add pre-compiled binaries to an image. For +example, suppose that there are binaries for proprietary code, +created by a particular division of a company. Your part of the company +needs to use those binaries as part of an image that you are building +using the OpenEmbedded build system. Since you only have the binaries +and not the source code, you cannot use a typical recipe that expects to +fetch the source specified in +:term:`SRC_URI` and then compile it. + +One method is to package the binaries and then install them as part of +the image. Generally, it is not a good idea to package binaries since, +among other things, it can hinder the ability to reproduce builds and +could lead to compatibility problems with ABI in the future. However, +sometimes you have no choice. + +The easiest solution is to create a recipe that uses the +:ref:`ref-classes-bin-package` class and to be sure that you are using default +locations for build artifacts. In most cases, the +:ref:`ref-classes-bin-package` class handles "skipping" the configure and +compile steps as well as sets things up to grab packages from the appropriate +area. In particular, this class sets ``noexec`` on both the +:ref:`ref-tasks-configure` and :ref:`ref-tasks-compile` tasks, sets +``FILES:${PN}`` to "/" so that it picks up all files, and sets up a +:ref:`ref-tasks-install` task, which effectively copies all files from ``${S}`` +to ``${D}``. The :ref:`ref-classes-bin-package` class works well when the files +extracted into ``${S}`` are already laid out in the way they should be laid out +on the target. For more information on these variables, see the :term:`FILES`, +:term:`PN`, :term:`S`, and :term:`D` variables in the Yocto Project Reference +Manual's variable glossary. + +.. note:: + + - Using :term:`DEPENDS` is a good + idea even for components distributed in binary form, and is often + necessary for shared libraries. For a shared library, listing the + library dependencies in :term:`DEPENDS` makes sure that the libraries + are available in the staging sysroot when other recipes link + against the library, which might be necessary for successful + linking. + + - Using :term:`DEPENDS` also allows runtime dependencies between + packages to be added automatically. See the + ":ref:`overview-manual/concepts:automatically added runtime dependencies`" + section in the Yocto Project Overview and Concepts Manual for more + information. + +If you cannot use the :ref:`ref-classes-bin-package` class, you need to be sure you are +doing the following: + +- Create a recipe where the + :ref:`ref-tasks-configure` and + :ref:`ref-tasks-compile` tasks do + nothing: It is usually sufficient to just not define these tasks in + the recipe, because the default implementations do nothing unless a + Makefile is found in + ``${``\ :term:`S`\ ``}``. + + If ``${S}`` might contain a Makefile, or if you inherit some class + that replaces :ref:`ref-tasks-configure` and :ref:`ref-tasks-compile` with custom + versions, then you can use the + ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` + flag to turn the tasks into no-ops, as follows:: + + do_configure[noexec] = "1" + do_compile[noexec] = "1" + + Unlike :ref:`bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`, + using the flag preserves the dependency chain from the :ref:`ref-tasks-fetch`, + :ref:`ref-tasks-unpack`, and :ref:`ref-tasks-patch` tasks to the + :ref:`ref-tasks-install` task. + +- Make sure your :ref:`ref-tasks-install` task installs the binaries + appropriately. + +- Ensure that you set up :term:`FILES` + (usually + ``FILES:${``\ :term:`PN`\ ``}``) to + point to the files you have installed, which of course depends on + where you have installed them and whether those files are in + different locations than the defaults. + +Following Recipe Style Guidelines +================================= + +When writing recipes, it is good to conform to existing style guidelines. +See the ":doc:`../contributor-guide/recipe-style-guide`" in the Yocto Project +and OpenEmbedded Contributor Guide for reference. + +It is common for existing recipes to deviate a bit from this style. +However, aiming for at least a consistent style is a good idea. Some +practices, such as omitting spaces around ``=`` operators in assignments +or ordering recipe components in an erratic way, are widely seen as poor +style. + +Recipe Syntax +============= + +Understanding recipe file syntax is important for writing recipes. The +following list overviews the basic items that make up a BitBake recipe +file. For more complete BitBake syntax descriptions, see the +":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" +chapter of the BitBake User Manual. + +- *Variable Assignments and Manipulations:* Variable assignments allow + a value to be assigned to a variable. The assignment can be static + text or might include the contents of other variables. In addition to + the assignment, appending and prepending operations are also + supported. + + The following example shows some of the ways you can use variables in + recipes:: + + S = "${WORKDIR}/postfix-${PV}" + CFLAGS += "-DNO_ASM" + CFLAGS:append = " --enable-important-feature" + +- *Functions:* Functions provide a series of actions to be performed. + You usually use functions to override the default implementation of a + task function or to complement a default function (i.e. append or + prepend to an existing function). Standard functions use ``sh`` shell + syntax, although access to OpenEmbedded variables and internal + methods are also available. + + Here is an example function from the ``sed`` recipe:: + + do_install () { + autotools_do_install + install -d ${D}${base_bindir} + mv ${D}${bindir}/sed ${D}${base_bindir}/sed + rmdir ${D}${bindir}/ + } + + It is + also possible to implement new functions that are called between + existing tasks as long as the new functions are not replacing or + complementing the default functions. You can implement functions in + Python instead of shell. Both of these options are not seen in the + majority of recipes. + +- *Keywords:* BitBake recipes use only a few keywords. You use keywords + to include common functions (``inherit``), load parts of a recipe + from other files (``include`` and ``require``) and export variables + to the environment (``export``). + + The following example shows the use of some of these keywords:: + + export POSTCONF = "${STAGING_BINDIR}/postconf" + inherit autoconf + require otherfile.inc + +- *Comments (#):* Any lines that begin with the hash character (``#``) + are treated as comment lines and are ignored:: + + # This is a comment + +This next list summarizes the most important and most commonly used +parts of the recipe syntax. For more information on these parts of the +syntax, you can reference the +":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter +in the BitBake User Manual. + +- *Line Continuation (\\):* Use the backward slash (``\``) character to + split a statement over multiple lines. Place the slash character at + the end of the line that is to be continued on the next line:: + + VAR = "A really long \ + line" + + .. note:: + + You cannot have any characters including spaces or tabs after the + slash character. + +- *Using Variables (${VARNAME}):* Use the ``${VARNAME}`` syntax to + access the contents of a variable:: + + SRC_URI = "${SOURCEFORGE_MIRROR}/libpng/zlib-${PV}.tar.gz" + + .. note:: + + It is important to understand that the value of a variable + expressed in this form does not get substituted automatically. The + expansion of these expressions happens on-demand later (e.g. + usually when a function that makes reference to the variable + executes). This behavior ensures that the values are most + appropriate for the context in which they are finally used. On the + rare occasion that you do need the variable expression to be + expanded immediately, you can use the + := + operator instead of + = + when you make the assignment, but this is not generally needed. + +- *Quote All Assignments ("value"):* Use double quotes around values in + all variable assignments (e.g. ``"value"``). Here is an example:: + + VAR1 = "${OTHERVAR}" + VAR2 = "The version is ${PV}" + +- *Conditional Assignment (?=):* Conditional assignment is used to + assign a value to a variable, but only when the variable is currently + unset. Use the question mark followed by the equal sign (``?=``) to + make a "soft" assignment used for conditional assignment. Typically, + "soft" assignments are used in the ``local.conf`` file for variables + that are allowed to come through from the external environment. + + Here is an example where ``VAR1`` is set to "New value" if it is + currently empty. However, if ``VAR1`` has already been set, it + remains unchanged:: + + VAR1 ?= "New value" + + In this next example, ``VAR1`` is left with the value "Original value":: + + VAR1 = "Original value" + VAR1 ?= "New value" + +- *Appending (+=):* Use the plus character followed by the equals sign + (``+=``) to append values to existing variables. + + .. note:: + + This operator adds a space between the existing content of the + variable and the new content. + + Here is an example:: + + SRC_URI += "file://fix-makefile.patch" + +- *Prepending (=+):* Use the equals sign followed by the plus character + (``=+``) to prepend values to existing variables. + + .. note:: + + This operator adds a space between the new content and the + existing content of the variable. + + Here is an example:: + + VAR =+ "Starts" + +- *Appending (:append):* Use the ``:append`` operator to append values + to existing variables. This operator does not add any additional + space. Also, the operator is applied after all the ``+=``, and ``=+`` + operators have been applied and after all ``=`` assignments have + occurred. This means that if ``:append`` is used in a recipe, it can + only be overridden by another layer using the special ``:remove`` + operator, which in turn will prevent further layers from adding it back. + + The following example shows the space being explicitly added to the + start to ensure the appended value is not merged with the existing + value:: + + CFLAGS:append = " --enable-important-feature" + + You can also use + the ``:append`` operator with overrides, which results in the actions + only being performed for the specified target or machine:: + + CFLAGS:append:sh4 = " --enable-important-sh4-specific-feature" + +- *Prepending (:prepend):* Use the ``:prepend`` operator to prepend + values to existing variables. This operator does not add any + additional space. Also, the operator is applied after all the ``+=``, + and ``=+`` operators have been applied and after all ``=`` + assignments have occurred. + + The following example shows the space being explicitly added to the + end to ensure the prepended value is not merged with the existing + value:: + + CFLAGS:prepend = "-I${S}/myincludes " + + You can also use the + ``:prepend`` operator with overrides, which results in the actions + only being performed for the specified target or machine:: + + CFLAGS:prepend:sh4 = "-I${S}/myincludes " + +- *Overrides:* You can use overrides to set a value conditionally, + typically based on how the recipe is being built. For example, to set + the :term:`KBRANCH` variable's + value to "standard/base" for any target + :term:`MACHINE`, except for + qemuarm where it should be set to "standard/arm-versatile-926ejs", + you would do the following:: + + KBRANCH = "standard/base" + KBRANCH:qemuarm = "standard/arm-versatile-926ejs" + + Overrides are also used to separate + alternate values of a variable in other situations. For example, when + setting variables such as + :term:`FILES` and + :term:`RDEPENDS` that are + specific to individual packages produced by a recipe, you should + always use an override that specifies the name of the package. + +- *Indentation:* Use spaces for indentation rather than tabs. For + shell functions, both currently work. However, it is a policy + decision of the Yocto Project to use tabs in shell functions. Realize + that some layers have a policy to use spaces for all indentation. + +- *Using Python for Complex Operations:* For more advanced processing, + it is possible to use Python code during variable assignments (e.g. + search and replacement on a variable). + + You indicate Python code using the ``${@python_code}`` syntax for the + variable assignment:: + + SRC_URI = "ftp://ftp.info-zip.org/pub/infozip/src/zip${@d.getVar('PV',1).replace('.', '')}.tgz + +- *Shell Function Syntax:* Write shell functions as if you were writing + a shell script when you describe a list of actions to take. You + should ensure that your script works with a generic ``sh`` and that + it does not require any ``bash`` or other shell-specific + functionality. The same considerations apply to various system + utilities (e.g. ``sed``, ``grep``, ``awk``, and so forth) that you + might wish to use. If in doubt, you should check with multiple + implementations --- including those from BusyBox. + diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst new file mode 100644 index 0000000000..e5028fffdc --- /dev/null +++ b/documentation/dev-manual/packages.rst @@ -0,0 +1,1250 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Working with Packages +********************* + +This section describes a few tasks that involve packages: + +- :ref:`dev-manual/packages:excluding packages from an image` + +- :ref:`dev-manual/packages:incrementing a package version` + +- :ref:`dev-manual/packages:handling optional module packaging` + +- :ref:`dev-manual/packages:using runtime package management` + +- :ref:`dev-manual/packages:generating and using signed packages` + +- :ref:`Setting up and running package test + (ptest) <dev-manual/packages:testing packages with ptest>` + +- :ref:`dev-manual/packages:creating node package manager (npm) packages` + +- :ref:`dev-manual/packages:adding custom metadata to packages` + +Excluding Packages from an Image +================================ + +You might find it necessary to prevent specific packages from being +installed into an image. If so, you can use several variables to direct +the build system to essentially ignore installing recommended packages +or to not install a package at all. + +The following list introduces variables you can use to prevent packages +from being installed into your image. Each of these variables only works +with IPK and RPM package types, not for Debian packages. +Also, you can use these variables from your ``local.conf`` file +or attach them to a specific image recipe by using a recipe name +override. For more detail on the variables, see the descriptions in the +Yocto Project Reference Manual's glossary chapter. + +- :term:`BAD_RECOMMENDATIONS`: + Use this variable to specify "recommended-only" packages that you do + not want installed. + +- :term:`NO_RECOMMENDATIONS`: + Use this variable to prevent all "recommended-only" packages from + being installed. + +- :term:`PACKAGE_EXCLUDE`: + Use this variable to prevent specific packages from being installed + regardless of whether they are "recommended-only" or not. You need to + realize that the build process could fail with an error when you + prevent the installation of a package whose presence is required by + an installed package. + +Incrementing a Package Version +============================== + +This section provides some background on how binary package versioning +is accomplished and presents some of the services, variables, and +terminology involved. + +In order to understand binary package versioning, you need to consider +the following: + +- Binary Package: The binary package that is eventually built and + installed into an image. + +- Binary Package Version: The binary package version is composed of two + components --- a version and a revision. + + .. note:: + + Technically, a third component, the "epoch" (i.e. :term:`PE`) is involved + but this discussion for the most part ignores :term:`PE`. + + The version and revision are taken from the + :term:`PV` and + :term:`PR` variables, respectively. + +- :term:`PV`: The recipe version. :term:`PV` represents the version of the + software being packaged. Do not confuse :term:`PV` with the binary + package version. + +- :term:`PR`: The recipe revision. + +- :term:`SRCPV`: The OpenEmbedded + build system uses this string to help define the value of :term:`PV` when + the source code revision needs to be included in it. + +- :yocto_wiki:`PR Service </PR_Service>`: A + network-based service that helps automate keeping package feeds + compatible with existing package manager applications such as RPM, + APT, and OPKG. + +Whenever the binary package content changes, the binary package version +must change. Changing the binary package version is accomplished by +changing or "bumping" the :term:`PR` and/or :term:`PV` values. Increasing these +values occurs one of two ways: + +- Automatically using a Package Revision Service (PR Service). + +- Manually incrementing the :term:`PR` and/or :term:`PV` variables. + +Given a primary challenge of any build system and its users is how to +maintain a package feed that is compatible with existing package manager +applications such as RPM, APT, and OPKG, using an automated system is +much preferred over a manual system. In either system, the main +requirement is that binary package version numbering increases in a +linear fashion and that there is a number of version components that +support that linear progression. For information on how to ensure +package revisioning remains linear, see the +":ref:`dev-manual/packages:automatically incrementing a package version number`" +section. + +The following three sections provide related information on the PR +Service, the manual method for "bumping" :term:`PR` and/or :term:`PV`, and on +how to ensure binary package revisioning remains linear. + +Working With a PR Service +------------------------- + +As mentioned, attempting to maintain revision numbers in the +:term:`Metadata` is error prone, inaccurate, +and causes problems for people submitting recipes. Conversely, the PR +Service automatically generates increasing numbers, particularly the +revision field, which removes the human element. + +.. note:: + + For additional information on using a PR Service, you can see the + :yocto_wiki:`PR Service </PR_Service>` wiki page. + +The Yocto Project uses variables in order of decreasing priority to +facilitate revision numbering (i.e. +:term:`PE`, +:term:`PV`, and +:term:`PR` for epoch, version, and +revision, respectively). The values are highly dependent on the policies +and procedures of a given distribution and package feed. + +Because the OpenEmbedded build system uses +":ref:`signatures <overview-manual/concepts:checksums (signatures)>`", which are +unique to a given build, the build system knows when to rebuild +packages. All the inputs into a given task are represented by a +signature, which can trigger a rebuild when different. Thus, the build +system itself does not rely on the :term:`PR`, :term:`PV`, and :term:`PE` numbers to +trigger a rebuild. The signatures, however, can be used to generate +these values. + +The PR Service works with both ``OEBasic`` and ``OEBasicHash`` +generators. The value of :term:`PR` bumps when the checksum changes and the +different generator mechanisms change signatures under different +circumstances. + +As implemented, the build system includes values from the PR Service +into the :term:`PR` field as an addition using the form "``.x``" so ``r0`` +becomes ``r0.1``, ``r0.2`` and so forth. This scheme allows existing +:term:`PR` values to be used for whatever reasons, which include manual +:term:`PR` bumps, should it be necessary. + +By default, the PR Service is not enabled or running. Thus, the packages +generated are just "self consistent". The build system adds and removes +packages and there are no guarantees about upgrade paths but images will +be consistent and correct with the latest changes. + +The simplest form for a PR Service is for a single host development system +that builds the package feed (building system). For this scenario, you can +enable a local PR Service by setting :term:`PRSERV_HOST` in your +``local.conf`` file in the :term:`Build Directory`:: + + PRSERV_HOST = "localhost:0" + +Once the service is started, packages will automatically +get increasing :term:`PR` values and BitBake takes care of starting and +stopping the server. + +If you have a more complex setup where multiple host development systems +work against a common, shared package feed, you have a single PR Service +running and it is connected to each building system. For this scenario, +you need to start the PR Service using the ``bitbake-prserv`` command:: + + bitbake-prserv --host ip --port port --start + +In addition to +hand-starting the service, you need to update the ``local.conf`` file of +each building system as described earlier so each system points to the +server and port. + +It is also recommended you use build history, which adds some sanity +checks to binary package versions, in conjunction with the server that +is running the PR Service. To enable build history, add the following to +each building system's ``local.conf`` file:: + + # It is recommended to activate "buildhistory" for testing the PR service + INHERIT += "buildhistory" + BUILDHISTORY_COMMIT = "1" + +For information on build +history, see the +":ref:`dev-manual/build-quality:maintaining build output quality`" section. + +.. note:: + + The OpenEmbedded build system does not maintain :term:`PR` information as + part of the shared state (sstate) packages. If you maintain an sstate + feed, it's expected that either all your building systems that + contribute to the sstate feed use a shared PR service, or you do not + run a PR service on any of your building systems. + + That's because if you had multiple machines sharing a PR service but + not their sstate feed, you could end up with "diverging" hashes for + the same output artefacts. When presented to the share PR service, + each would be considered as new and would increase the revision + number, causing many unnecessary package upgrades. + + For more information on shared state, see the + ":ref:`overview-manual/concepts:shared state cache`" + section in the Yocto Project Overview and Concepts Manual. + +Manually Bumping PR +------------------- + +The alternative to setting up a PR Service is to manually "bump" the +:term:`PR` variable. + +If a committed change results in changing the package output, then the +value of the :term:`PR` variable needs to be increased (or "bumped") as part of +that commit. For new recipes you should add the :term:`PR` variable and set +its initial value equal to "r0", which is the default. Even though the +default value is "r0", the practice of adding it to a new recipe makes +it harder to forget to bump the variable when you make changes to the +recipe in future. + +Usually, version increases occur only to binary packages. However, if +for some reason :term:`PV` changes but does not increase, you can increase +the :term:`PE` variable (Package Epoch). The :term:`PE` variable defaults to +"0". + +Binary package version numbering strives to follow the `Debian Version +Field Policy +Guidelines <https://www.debian.org/doc/debian-policy/ch-controlfields.html>`__. +These guidelines define how versions are compared and what "increasing" +a version means. + +Automatically Incrementing a Package Version Number +--------------------------------------------------- + +When fetching a repository, BitBake uses the +:term:`SRCREV` variable to determine +the specific source code revision from which to build. You set the +:term:`SRCREV` variable to +:term:`AUTOREV` to cause the +OpenEmbedded build system to automatically use the latest revision of +the software:: + + SRCREV = "${AUTOREV}" + +Furthermore, you need to reference :term:`SRCPV` in :term:`PV` in order to +automatically update the version whenever the revision of the source +code changes. Here is an example:: + + PV = "1.0+git${SRCPV}" + +The OpenEmbedded build system substitutes :term:`SRCPV` with the following: + +.. code-block:: none + + AUTOINC+source_code_revision + +The build system replaces the ``AUTOINC`` +with a number. The number used depends on the state of the PR Service: + +- If PR Service is enabled, the build system increments the number, + which is similar to the behavior of + :term:`PR`. This behavior results in + linearly increasing package versions, which is desirable. Here is an + example: + + .. code-block:: none + + hello-world-git_0.0+git0+b6558dd387-r0.0_armv7a-neon.ipk + hello-world-git_0.0+git1+dd2f5c3565-r0.0_armv7a-neon.ipk + +- If PR Service is not enabled, the build system replaces the + ``AUTOINC`` placeholder with zero (i.e. "0"). This results in + changing the package version since the source revision is included. + However, package versions are not increased linearly. Here is an + example: + + .. code-block:: none + + hello-world-git_0.0+git0+b6558dd387-r0.0_armv7a-neon.ipk + hello-world-git_0.0+git0+dd2f5c3565-r0.0_armv7a-neon.ipk + +In summary, the OpenEmbedded build system does not track the history of +binary package versions for this purpose. ``AUTOINC``, in this case, is +comparable to :term:`PR`. If PR server is not enabled, ``AUTOINC`` in the +package version is simply replaced by "0". If PR server is enabled, the +build system keeps track of the package versions and bumps the number +when the package revision changes. + +Handling Optional Module Packaging +================================== + +Many pieces of software split functionality into optional modules (or +plugins) and the plugins that are built might depend on configuration +options. To avoid having to duplicate the logic that determines what +modules are available in your recipe or to avoid having to package each +module by hand, the OpenEmbedded build system provides functionality to +handle module packaging dynamically. + +To handle optional module packaging, you need to do two things: + +- Ensure the module packaging is actually done. + +- Ensure that any dependencies on optional modules from other recipes + are satisfied by your recipe. + +Making Sure the Packaging is Done +--------------------------------- + +To ensure the module packaging actually gets done, you use the +``do_split_packages`` function within the ``populate_packages`` Python +function in your recipe. The ``do_split_packages`` function searches for +a pattern of files or directories under a specified path and creates a +package for each one it finds by appending to the +:term:`PACKAGES` variable and +setting the appropriate values for ``FILES:packagename``, +``RDEPENDS:packagename``, ``DESCRIPTION:packagename``, and so forth. +Here is an example from the ``lighttpd`` recipe:: + + python populate_packages:prepend () { + lighttpd_libdir = d.expand('${libdir}') + do_split_packages(d, lighttpd_libdir, '^mod_(.*).so$', + 'lighttpd-module-%s', 'Lighttpd module for %s', + extra_depends='') + } + +The previous example specifies a number of things in the call to +``do_split_packages``. + +- A directory within the files installed by your recipe through + :ref:`ref-tasks-install` in which to search. + +- A regular expression used to match module files in that directory. In + the example, note the parentheses () that mark the part of the + expression from which the module name should be derived. + +- A pattern to use for the package names. + +- A description for each package. + +- An empty string for ``extra_depends``, which disables the default + dependency on the main ``lighttpd`` package. Thus, if a file in + ``${libdir}`` called ``mod_alias.so`` is found, a package called + ``lighttpd-module-alias`` is created for it and the + :term:`DESCRIPTION` is set to + "Lighttpd module for alias". + +Often, packaging modules is as simple as the previous example. However, +there are more advanced options that you can use within +``do_split_packages`` to modify its behavior. And, if you need to, you +can add more logic by specifying a hook function that is called for each +package. It is also perfectly acceptable to call ``do_split_packages`` +multiple times if you have more than one set of modules to package. + +For more examples that show how to use ``do_split_packages``, see the +``connman.inc`` file in the ``meta/recipes-connectivity/connman/`` +directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can +also find examples in ``meta/classes-recipe/kernel.bbclass``. + +Here is a reference that shows ``do_split_packages`` mandatory and +optional arguments:: + + Mandatory arguments + + root + The path in which to search + file_regex + Regular expression to match searched files. + Use parentheses () to mark the part of this + expression that should be used to derive the + module name (to be substituted where %s is + used in other function arguments as noted below) + output_pattern + Pattern to use for the package names. Must + include %s. + description + Description to set for each package. Must + include %s. + + Optional arguments + + postinst + Postinstall script to use for all packages + (as a string) + recursive + True to perform a recursive search --- default + False + hook + A hook function to be called for every match. + The function will be called with the following + arguments (in the order listed): + + f + Full path to the file/directory match + pkg + The package name + file_regex + As above + output_pattern + As above + modulename + The module name derived using file_regex + extra_depends + Extra runtime dependencies (RDEPENDS) to be + set for all packages. The default value of None + causes a dependency on the main package + (${PN}) --- if you do not want this, pass empty + string '' for this parameter. + aux_files_pattern + Extra item(s) to be added to FILES for each + package. Can be a single string item or a list + of strings for multiple items. Must include %s. + postrm + postrm script to use for all packages (as a + string) + allow_dirs + True to allow directories to be matched - + default False + prepend + If True, prepend created packages to PACKAGES + instead of the default False which appends them + match_path + match file_regex on the whole relative path to + the root rather than just the filename + aux_files_pattern_verbatim + Extra item(s) to be added to FILES for each + package, using the actual derived module name + rather than converting it to something legal + for a package name. Can be a single string item + or a list of strings for multiple items. Must + include %s. + allow_links + True to allow symlinks to be matched --- default + False + summary + Summary to set for each package. Must include %s; + defaults to description if not set. + + + +Satisfying Dependencies +----------------------- + +The second part for handling optional module packaging is to ensure that +any dependencies on optional modules from other recipes are satisfied by +your recipe. You can be sure these dependencies are satisfied by using +the :term:`PACKAGES_DYNAMIC` +variable. Here is an example that continues with the ``lighttpd`` recipe +shown earlier:: + + PACKAGES_DYNAMIC = "lighttpd-module-.*" + +The name +specified in the regular expression can of course be anything. In this +example, it is ``lighttpd-module-`` and is specified as the prefix to +ensure that any :term:`RDEPENDS` and +:term:`RRECOMMENDS` on a package +name starting with the prefix are satisfied during build time. If you +are using ``do_split_packages`` as described in the previous section, +the value you put in :term:`PACKAGES_DYNAMIC` should correspond to the name +pattern specified in the call to ``do_split_packages``. + +Using Runtime Package Management +================================ + +During a build, BitBake always transforms a recipe into one or more +packages. For example, BitBake takes the ``bash`` recipe and produces a +number of packages (e.g. ``bash``, ``bash-bashbug``, +``bash-completion``, ``bash-completion-dbg``, ``bash-completion-dev``, +``bash-completion-extra``, ``bash-dbg``, and so forth). Not all +generated packages are included in an image. + +In several situations, you might need to update, add, remove, or query +the packages on a target device at runtime (i.e. without having to +generate a new image). Examples of such situations include: + +- You want to provide in-the-field updates to deployed devices (e.g. + security updates). + +- You want to have a fast turn-around development cycle for one or more + applications that run on your device. + +- You want to temporarily install the "debug" packages of various + applications on your device so that debugging can be greatly improved + by allowing access to symbols and source debugging. + +- You want to deploy a more minimal package selection of your device + but allow in-the-field updates to add a larger selection for + customization. + +In all these situations, you have something similar to a more +traditional Linux distribution in that in-field devices are able to +receive pre-compiled packages from a server for installation or update. +Being able to install these packages on a running, in-field device is +what is termed "runtime package management". + +In order to use runtime package management, you need a host or server +machine that serves up the pre-compiled packages plus the required +metadata. You also need package manipulation tools on the target. The +build machine is a likely candidate to act as the server. However, that +machine does not necessarily have to be the package server. The build +machine could push its artifacts to another machine that acts as the +server (e.g. Internet-facing). In fact, doing so is advantageous for a +production environment as getting the packages away from the development +system's :term:`Build Directory` prevents accidental overwrites. + +A simple build that targets just one device produces more than one +package database. In other words, the packages produced by a build are +separated out into a couple of different package groupings based on +criteria such as the target's CPU architecture, the target board, or the +C library used on the target. For example, a build targeting the +``qemux86`` device produces the following three package databases: +``noarch``, ``i586``, and ``qemux86``. If you wanted your ``qemux86`` +device to be aware of all the packages that were available to it, you +would need to point it to each of these databases individually. In a +similar way, a traditional Linux distribution usually is configured to +be aware of a number of software repositories from which it retrieves +packages. + +Using runtime package management is completely optional and not required +for a successful build or deployment in any way. But if you want to make +use of runtime package management, you need to do a couple things above +and beyond the basics. The remainder of this section describes what you +need to do. + +Build Considerations +-------------------- + +This section describes build considerations of which you need to be +aware in order to provide support for runtime package management. + +When BitBake generates packages, it needs to know what format or formats +to use. In your configuration, you use the +:term:`PACKAGE_CLASSES` +variable to specify the format: + +#. Open the ``local.conf`` file inside your :term:`Build Directory` (e.g. + ``poky/build/conf/local.conf``). + +#. Select the desired package format as follows:: + + PACKAGE_CLASSES ?= "package_packageformat" + + where packageformat can be "ipk", "rpm", + "deb", or "tar" which are the supported package formats. + + .. note:: + + Because the Yocto Project supports four different package formats, + you can set the variable with more than one argument. However, the + OpenEmbedded build system only uses the first argument when + creating an image or Software Development Kit (SDK). + +If you would like your image to start off with a basic package database +containing the packages in your current build as well as to have the +relevant tools available on the target for runtime package management, +you can include "package-management" in the +:term:`IMAGE_FEATURES` +variable. Including "package-management" in this configuration variable +ensures that when the image is assembled for your target, the image +includes the currently-known package databases as well as the +target-specific tools required for runtime package management to be +performed on the target. However, this is not strictly necessary. You +could start your image off without any databases but only include the +required on-target package tool(s). As an example, you could include +"opkg" in your +:term:`IMAGE_INSTALL` variable +if you are using the IPK package format. You can then initialize your +target's package database(s) later once your image is up and running. + +Whenever you perform any sort of build step that can potentially +generate a package or modify existing package, it is always a good idea +to re-generate the package index after the build by using the following +command:: + + $ bitbake package-index + +It might be tempting to build the +package and the package index at the same time with a command such as +the following:: + + $ bitbake some-package package-index + +Do not do this as +BitBake does not schedule the package index for after the completion of +the package you are building. Consequently, you cannot be sure of the +package index including information for the package you just built. +Thus, be sure to run the package update step separately after building +any packages. + +You can use the +:term:`PACKAGE_FEED_ARCHS`, +:term:`PACKAGE_FEED_BASE_PATHS`, +and +:term:`PACKAGE_FEED_URIS` +variables to pre-configure target images to use a package feed. If you +do not define these variables, then manual steps as described in the +subsequent sections are necessary to configure the target. You should +set these variables before building the image in order to produce a +correctly configured image. + +.. note:: + + Your image will need enough free storage space to run package upgrades, + especially if many of them need to be downloaded at the same time. + You should make sure images are created with enough free space + by setting the :term:`IMAGE_ROOTFS_EXTRA_SPACE` variable. + +When your build is complete, your packages reside in the +``${TMPDIR}/deploy/packageformat`` directory. For example, if +``${``\ :term:`TMPDIR`\ ``}`` is +``tmp`` and your selected package type is RPM, then your RPM packages +are available in ``tmp/deploy/rpm``. + +Host or Server Machine Setup +---------------------------- + +Although other protocols are possible, a server using HTTP typically +serves packages. If you want to use HTTP, then set up and configure a +web server such as Apache 2, lighttpd, or Python web server on the +machine serving the packages. + +To keep things simple, this section describes how to set up a +Python web server to share package feeds from the developer's +machine. Although this server might not be the best for a production +environment, the setup is simple and straight forward. Should you want +to use a different server more suited for production (e.g. Apache 2, +Lighttpd, or Nginx), take the appropriate steps to do so. + +From within the :term:`Build Directory` where you have built an image based on +your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start +the server. The following example assumes a :term:`Build Directory` of ``poky/build`` +and a :term:`PACKAGE_CLASSES` setting of ":ref:`ref-classes-package_rpm`":: + + $ cd poky/build/tmp/deploy/rpm + $ python3 -m http.server + +Target Setup +------------ + +Setting up the target differs depending on the package management +system. This section provides information for RPM, IPK, and DEB. + +Using RPM +~~~~~~~~~ + +The :wikipedia:`Dandified Packaging <DNF_(software)>` (DNF) performs +runtime package management of RPM packages. In order to use DNF for +runtime package management, you must perform an initial setup on the +target machine for cases where the ``PACKAGE_FEED_*`` variables were not +set as part of the image that is running on the target. This means if +you built your image and did not use these variables as part of the +build and your image is now running on the target, you need to perform +the steps in this section if you want to use runtime package management. + +.. note:: + + For information on the ``PACKAGE_FEED_*`` variables, see + :term:`PACKAGE_FEED_ARCHS`, :term:`PACKAGE_FEED_BASE_PATHS`, and + :term:`PACKAGE_FEED_URIS` in the Yocto Project Reference Manual variables + glossary. + +On the target, you must inform DNF that package databases are available. +You do this by creating a file named +``/etc/yum.repos.d/oe-packages.repo`` and defining the ``oe-packages``. + +As an example, assume the target is able to use the following package +databases: ``all``, ``i586``, and ``qemux86`` from a server named +``my.server``. The specifics for setting up the web server are up to +you. The critical requirement is that the URIs in the target repository +configuration point to the correct remote location for the feeds. + +.. note:: + + For development purposes, you can point the web server to the build + system's ``deploy`` directory. However, for production use, it is better to + copy the package directories to a location outside of the build area and use + that location. Doing so avoids situations where the build system + overwrites or changes the ``deploy`` directory. + +When telling DNF where to look for the package databases, you must +declare individual locations per architecture or a single location used +for all architectures. You cannot do both: + +- *Create an Explicit List of Architectures:* Define individual base + URLs to identify where each package database is located: + + .. code-block:: none + + [oe-packages] + baseurl=http://my.server/rpm/i586 http://my.server/rpm/qemux86 http://my.server/rpm/all + + This example + informs DNF about individual package databases for all three + architectures. + +- *Create a Single (Full) Package Index:* Define a single base URL that + identifies where a full package database is located:: + + [oe-packages] + baseurl=http://my.server/rpm + + This example informs DNF about a single + package database that contains all the package index information for + all supported architectures. + +Once you have informed DNF where to find the package databases, you need +to fetch them: + +.. code-block:: none + + # dnf makecache + +DNF is now able to find, install, and +upgrade packages from the specified repository or repositories. + +.. note:: + + See the `DNF documentation <https://dnf.readthedocs.io/en/latest/>`__ for + additional information. + +Using IPK +~~~~~~~~~ + +The ``opkg`` application performs runtime package management of IPK +packages. You must perform an initial setup for ``opkg`` on the target +machine if the +:term:`PACKAGE_FEED_ARCHS`, +:term:`PACKAGE_FEED_BASE_PATHS`, +and +:term:`PACKAGE_FEED_URIS` +variables have not been set or the target image was built before the +variables were set. + +The ``opkg`` application uses configuration files to find available +package databases. Thus, you need to create a configuration file inside +the ``/etc/opkg/`` directory, which informs ``opkg`` of any repository +you want to use. + +As an example, suppose you are serving packages from a ``ipk/`` +directory containing the ``i586``, ``all``, and ``qemux86`` databases +through an HTTP server named ``my.server``. On the target, create a +configuration file (e.g. ``my_repo.conf``) inside the ``/etc/opkg/`` +directory containing the following: + +.. code-block:: none + + src/gz all http://my.server/ipk/all + src/gz i586 http://my.server/ipk/i586 + src/gz qemux86 http://my.server/ipk/qemux86 + +Next, instruct ``opkg`` to fetch the +repository information: + +.. code-block:: none + + # opkg update + +The ``opkg`` application is now able to find, install, and upgrade packages +from the specified repository. + +Using DEB +~~~~~~~~~ + +The ``apt`` application performs runtime package management of DEB +packages. This application uses a source list file to find available +package databases. You must perform an initial setup for ``apt`` on the +target machine if the +:term:`PACKAGE_FEED_ARCHS`, +:term:`PACKAGE_FEED_BASE_PATHS`, +and +:term:`PACKAGE_FEED_URIS` +variables have not been set or the target image was built before the +variables were set. + +To inform ``apt`` of the repository you want to use, you might create a +list file (e.g. ``my_repo.list``) inside the +``/etc/apt/sources.list.d/`` directory. As an example, suppose you are +serving packages from a ``deb/`` directory containing the ``i586``, +``all``, and ``qemux86`` databases through an HTTP server named +``my.server``. The list file should contain: + +.. code-block:: none + + deb http://my.server/deb/all ./ + deb http://my.server/deb/i586 ./ + deb http://my.server/deb/qemux86 ./ + +Next, instruct the ``apt`` application +to fetch the repository information: + +.. code-block:: none + + $ sudo apt update + +After this step, +``apt`` is able to find, install, and upgrade packages from the +specified repository. + +Generating and Using Signed Packages +==================================== + +In order to add security to RPM packages used during a build, you can +take steps to securely sign them. Once a signature is verified, the +OpenEmbedded build system can use the package in the build. If security +fails for a signed package, the build system stops the build. + +This section describes how to sign RPM packages during a build and how +to use signed package feeds (repositories) when doing a build. + +Signing RPM Packages +-------------------- + +To enable signing RPM packages, you must set up the following +configurations in either your ``local.config`` or ``distro.config`` +file:: + + # Inherit sign_rpm.bbclass to enable signing functionality + INHERIT += " sign_rpm" + # Define the GPG key that will be used for signing. + RPM_GPG_NAME = "key_name" + # Provide passphrase for the key + RPM_GPG_PASSPHRASE = "passphrase" + +.. note:: + + Be sure to supply appropriate values for both `key_name` and + `passphrase`. + +Aside from the ``RPM_GPG_NAME`` and ``RPM_GPG_PASSPHRASE`` variables in +the previous example, two optional variables related to signing are available: + +- *GPG_BIN:* Specifies a ``gpg`` binary/wrapper that is executed + when the package is signed. + +- *GPG_PATH:* Specifies the ``gpg`` home directory used when the + package is signed. + +Processing Package Feeds +------------------------ + +In addition to being able to sign RPM packages, you can also enable +signed package feeds for IPK and RPM packages. + +The steps you need to take to enable signed package feed use are similar +to the steps used to sign RPM packages. You must define the following in +your ``local.config`` or ``distro.config`` file:: + + INHERIT += "sign_package_feed" + PACKAGE_FEED_GPG_NAME = "key_name" + PACKAGE_FEED_GPG_PASSPHRASE_FILE = "path_to_file_containing_passphrase" + +For signed package feeds, the passphrase must be specified in a separate file, +which is pointed to by the ``PACKAGE_FEED_GPG_PASSPHRASE_FILE`` +variable. Regarding security, keeping a plain text passphrase out of the +configuration is more secure. + +Aside from the ``PACKAGE_FEED_GPG_NAME`` and +``PACKAGE_FEED_GPG_PASSPHRASE_FILE`` variables, three optional variables +related to signed package feeds are available: + +- *GPG_BIN* Specifies a ``gpg`` binary/wrapper that is executed + when the package is signed. + +- *GPG_PATH:* Specifies the ``gpg`` home directory used when the + package is signed. + +- *PACKAGE_FEED_GPG_SIGNATURE_TYPE:* Specifies the type of ``gpg`` + signature. This variable applies only to RPM and IPK package feeds. + Allowable values for the ``PACKAGE_FEED_GPG_SIGNATURE_TYPE`` are + "ASC", which is the default and specifies ascii armored, and "BIN", + which specifies binary. + +Testing Packages With ptest +=========================== + +A Package Test (ptest) runs tests against packages built by the +OpenEmbedded build system on the target machine. A ptest contains at +least two items: the actual test, and a shell script (``run-ptest``) +that starts the test. The shell script that starts the test must not +contain the actual test --- the script only starts the test. On the other +hand, the test can be anything from a simple shell script that runs a +binary and checks the output to an elaborate system of test binaries and +data files. + +The test generates output in the format used by Automake:: + + result: testname + +where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and +the testname can be any identifying string. + +For a list of Yocto Project recipes that are already enabled with ptest, +see the :yocto_wiki:`Ptest </Ptest>` wiki page. + +.. note:: + + A recipe is "ptest-enabled" if it inherits the :ref:`ref-classes-ptest` + class. + +Adding ptest to Your Build +-------------------------- + +To add package testing to your build, add the :term:`DISTRO_FEATURES` and +:term:`EXTRA_IMAGE_FEATURES` variables to your ``local.conf`` file, which +is found in the :term:`Build Directory`:: + + DISTRO_FEATURES:append = " ptest" + EXTRA_IMAGE_FEATURES += "ptest-pkgs" + +Once your build is complete, the ptest files are installed into the +``/usr/lib/package/ptest`` directory within the image, where ``package`` +is the name of the package. + +Running ptest +------------- + +The ``ptest-runner`` package installs a shell script that loops through +all installed ptest test suites and runs them in sequence. Consequently, +you might want to add this package to your image. + +Getting Your Package Ready +-------------------------- + +In order to enable a recipe to run installed ptests on target hardware, +you need to prepare the recipes that build the packages you want to +test. Here is what you have to do for each recipe: + +- *Be sure the recipe inherits the* :ref:`ref-classes-ptest` *class:* + Include the following line in each recipe:: + + inherit ptest + +- *Create run-ptest:* This script starts your test. Locate the + script where you will refer to it using + :term:`SRC_URI`. Here is an + example that starts a test for ``dbus``:: + + #!/bin/sh + cd test + make -k runtest-TESTS + +- *Ensure dependencies are met:* If the test adds build or runtime + dependencies that normally do not exist for the package (such as + requiring "make" to run the test suite), use the + :term:`DEPENDS` and + :term:`RDEPENDS` variables in + your recipe in order for the package to meet the dependencies. Here + is an example where the package has a runtime dependency on "make":: + + RDEPENDS:${PN}-ptest += "make" + +- *Add a function to build the test suite:* Not many packages support + cross-compilation of their test suites. Consequently, you usually + need to add a cross-compilation function to the package. + + Many packages based on Automake compile and run the test suite by + using a single command such as ``make check``. However, the host + ``make check`` builds and runs on the same computer, while + cross-compiling requires that the package is built on the host but + executed for the target architecture (though often, as in the case + for ptest, the execution occurs on the host). The built version of + Automake that ships with the Yocto Project includes a patch that + separates building and execution. Consequently, packages that use the + unaltered, patched version of ``make check`` automatically + cross-compiles. + + Regardless, you still must add a ``do_compile_ptest`` function to + build the test suite. Add a function similar to the following to your + recipe:: + + do_compile_ptest() { + oe_runmake buildtest-TESTS + } + +- *Ensure special configurations are set:* If the package requires + special configurations prior to compiling the test code, you must + insert a ``do_configure_ptest`` function into the recipe. + +- *Install the test suite:* The :ref:`ref-classes-ptest` class + automatically copies the file ``run-ptest`` to the target and then runs make + ``install-ptest`` to run the tests. If this is not enough, you need + to create a ``do_install_ptest`` function and make sure it gets + called after the "make install-ptest" completes. + +Creating Node Package Manager (NPM) Packages +============================================ + +:wikipedia:`NPM <Npm_(software)>` is a package manager for the JavaScript +programming language. The Yocto Project supports the NPM +:ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. +You can use this fetcher in combination with +:doc:`devtool </ref-manual/devtool-reference>` to create recipes that produce +NPM packages. + +There are two workflows that allow you to create NPM packages using +``devtool``: the NPM registry modules method and the NPM project code +method. + +.. note:: + + While it is possible to create NPM recipes manually, using + ``devtool`` is far simpler. + +Additionally, some requirements and caveats exist. + +Requirements and Caveats +------------------------ + +You need to be aware of the following before using ``devtool`` to create +NPM packages: + +- Of the two methods that you can use ``devtool`` to create NPM + packages, the registry approach is slightly simpler. However, you + might consider the project approach because you do not have to + publish your module in the `NPM registry <https://docs.npmjs.com/misc/registry>`__, + which is NPM's public registry. + +- Be familiar with + :doc:`devtool </ref-manual/devtool-reference>`. + +- The NPM host tools need the native ``nodejs-npm`` package, which is + part of the OpenEmbedded environment. You need to get the package by + cloning the :oe_git:`meta-openembedded </meta-openembedded>` + repository. Be sure to add the path to your local copy + to your ``bblayers.conf`` file. + +- ``devtool`` cannot detect native libraries in module dependencies. + Consequently, you must manually add packages to your recipe. + +- While deploying NPM packages, ``devtool`` cannot determine which + dependent packages are missing on the target (e.g. the node runtime + ``nodejs``). Consequently, you need to find out what files are + missing and be sure they are on the target. + +- Although you might not need NPM to run your node package, it is + useful to have NPM on your target. The NPM package name is + ``nodejs-npm``. + +Using the Registry Modules Method +--------------------------------- + +This section presents an example that uses the ``cute-files`` module, +which is a file browser web application. + +.. note:: + + You must know the ``cute-files`` module version. + +The first thing you need to do is use ``devtool`` and the NPM fetcher to +create the recipe:: + + $ devtool add "npm://registry.npmjs.org;package=cute-files;version=1.0.2" + +The +``devtool add`` command runs ``recipetool create`` and uses the same +fetch URI to download each dependency and capture license details where +possible. The result is a generated recipe. + +After running for quite a long time, in particular building the +``nodejs-native`` package, the command should end as follows:: + + INFO: Recipe /home/.../build/workspace/recipes/cute-files/cute-files_1.0.2.bb has been automatically created; further editing may be required to make it fully functional + +The recipe file is fairly simple and contains every license that +``recipetool`` finds and includes the licenses in the recipe's +:term:`LIC_FILES_CHKSUM` +variables. You need to examine the variables and look for those with +"unknown" in the :term:`LICENSE` +field. You need to track down the license information for "unknown" +modules and manually add the information to the recipe. + +``recipetool`` creates a "shrinkwrap" file for your recipe. Shrinkwrap +files capture the version of all dependent modules. Many packages do not +provide shrinkwrap files but ``recipetool`` will create a shrinkwrap file as it +runs. + +.. note:: + + A package is created for each sub-module. This policy is the only + practical way to have the licenses for all of the dependencies + represented in the license manifest of the image. + +The ``devtool edit-recipe`` command lets you take a look at the recipe:: + + $ devtool edit-recipe cute-files + # Recipe created by recipetool + # This is the basis of a recipe and may need further editing in order to be fully functional. + # (Feel free to remove these comments when editing.) + + SUMMARY = "Turn any folder on your computer into a cute file browser, available on the local network." + # WARNING: the following LICENSE and LIC_FILES_CHKSUM values are best guesses - it is + # your responsibility to verify that the values are complete and correct. + # + # NOTE: multiple licenses have been detected; they have been separated with & + # in the LICENSE value for now since it is a reasonable assumption that all + # of the licenses apply. If instead there is a choice between the multiple + # licenses then you should change the value to separate the licenses with | + # instead of &. If there is any doubt, check the accompanying documentation + # to determine which situation is applicable. + + SUMMARY = "Turn any folder on your computer into a cute file browser, available on the local network." + LICENSE = "BSD-3-Clause & ISC & MIT" + LIC_FILES_CHKSUM = "file://LICENSE;md5=71d98c0a1db42956787b1909c74a86ca \ + file://node_modules/accepts/LICENSE;md5=bf1f9ad1e2e1d507aef4883fff7103de \ + file://node_modules/array-flatten/LICENSE;md5=44088ba57cb871a58add36ce51b8de08 \ + ... + file://node_modules/cookie-signature/Readme.md;md5=57ae8b42de3dd0c1f22d5f4cf191e15a" + + SRC_URI = " \ + npm://registry.npmjs.org/;package=cute-files;version=${PV} \ + npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \ + " + + S = "${WORKDIR}/npm" + + inherit npm + + LICENSE:${PN} = "MIT" + LICENSE:${PN}-accepts = "MIT" + LICENSE:${PN}-array-flatten = "MIT" + ... + LICENSE:${PN}-vary = "MIT" + +Three key points in the previous example are: + +- :term:`SRC_URI` uses the NPM + scheme so that the NPM fetcher is used. + +- ``recipetool`` collects all the license information. If a + sub-module's license is unavailable, the sub-module's name appears in + the comments. + +- The ``inherit npm`` statement causes the :ref:`ref-classes-npm` class to + package up all the modules. + +You can run the following command to build the ``cute-files`` package:: + + $ devtool build cute-files + +Remember that ``nodejs`` must be installed on +the target before your package. + +Assuming 192.168.7.2 for the target's IP address, use the following +command to deploy your package:: + + $ devtool deploy-target -s cute-files root@192.168.7.2 + +Once the package is installed on the target, you can +test the application to show the contents of any directory:: + + $ cd /usr/lib/node_modules/cute-files + $ cute-files + +On a browser, +go to ``http://192.168.7.2:3000`` and you see the following: + +.. image:: figures/cute-files-npm-example.png + :width: 100% + +You can find the recipe in ``workspace/recipes/cute-files``. You can use +the recipe in any layer you choose. + +Using the NPM Projects Code Method +---------------------------------- + +Although it is useful to package modules already in the NPM registry, +adding ``node.js`` projects under development is a more common developer +use case. + +This section covers the NPM projects code method, which is very similar +to the "registry" approach described in the previous section. In the NPM +projects method, you provide ``devtool`` with an URL that points to the +source files. + +Replicating the same example, (i.e. ``cute-files``) use the following +command:: + + $ devtool add https://github.com/martinaglv/cute-files.git + +The recipe this command generates is very similar to the recipe created in +the previous section. However, the :term:`SRC_URI` looks like the following:: + + SRC_URI = " \ + git://github.com/martinaglv/cute-files.git;protocol=https;branch=master \ + npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \ + " + +In this example, +the main module is taken from the Git repository and dependencies are +taken from the NPM registry. Other than those differences, the recipe is +basically the same between the two methods. You can build and deploy the +package exactly as described in the previous section that uses the +registry modules method. + +Adding custom metadata to packages +================================== + +The variable +:term:`PACKAGE_ADD_METADATA` +can be used to add additional metadata to packages. This is reflected in +the package control/spec file. To take the ipk format for example, the +CONTROL file stored inside would contain the additional metadata as +additional lines. + +The variable can be used in multiple ways, including using suffixes to +set it for a specific package type and/or package. Note that the order +of precedence is the same as this list: + +- ``PACKAGE_ADD_METADATA_<PKGTYPE>:<PN>`` + +- ``PACKAGE_ADD_METADATA_<PKGTYPE>`` + +- ``PACKAGE_ADD_METADATA:<PN>`` + +- :term:`PACKAGE_ADD_METADATA` + +`<PKGTYPE>` is a parameter and expected to be a distinct name of specific +package type: + +- IPK for .ipk packages + +- DEB for .deb packages + +- RPM for .rpm packages + +`<PN>` is a parameter and expected to be a package name. + +The variable can contain multiple [one-line] metadata fields separated +by the literal sequence '\\n'. The separator can be redefined using the +variable flag ``separator``. + +Here is an example that adds two custom fields for ipk +packages:: + + PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup:Applications/Spreadsheets" + diff --git a/documentation/dev-manual/prebuilt-libraries.rst b/documentation/dev-manual/prebuilt-libraries.rst new file mode 100644 index 0000000000..a05f39ca1e --- /dev/null +++ b/documentation/dev-manual/prebuilt-libraries.rst @@ -0,0 +1,209 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Working with Pre-Built Libraries +******************************** + +Introduction +============ + +Some library vendors do not release source code for their software but do +release pre-built binaries. When shared libraries are built, they should +be versioned (see `this article +<https://tldp.org/HOWTO/Program-Library-HOWTO/shared-libraries.html>`__ +for some background), but sometimes this is not done. + +To summarize, a versioned library must meet two conditions: + +#. The filename must have the version appended, for example: ``libfoo.so.1.2.3``. +#. The library must have the ELF tag ``SONAME`` set to the major version + of the library, for example: ``libfoo.so.1``. You can check this by + running ``readelf -d filename | grep SONAME``. + +This section shows how to deal with both versioned and unversioned +pre-built libraries. + +Versioned Libraries +=================== + +In this example we work with pre-built libraries for the FT4222H USB I/O chip. +Libraries are built for several target architecture variants and packaged in +an archive as follows:: + + ├── build-arm-hisiv300 + │ └── libft4222.so.1.4.4.44 + ├── build-arm-v5-sf + │ └── libft4222.so.1.4.4.44 + ├── build-arm-v6-hf + │ └── libft4222.so.1.4.4.44 + ├── build-arm-v7-hf + │ └── libft4222.so.1.4.4.44 + ├── build-arm-v8 + │ └── libft4222.so.1.4.4.44 + ├── build-i386 + │ └── libft4222.so.1.4.4.44 + ├── build-i486 + │ └── libft4222.so.1.4.4.44 + ├── build-mips-eglibc-hf + │ └── libft4222.so.1.4.4.44 + ├── build-pentium + │ └── libft4222.so.1.4.4.44 + ├── build-x86_64 + │ └── libft4222.so.1.4.4.44 + ├── examples + │ ├── get-version.c + │ ├── i2cm.c + │ ├── spim.c + │ └── spis.c + ├── ftd2xx.h + ├── install4222.sh + ├── libft4222.h + ├── ReadMe.txt + └── WinTypes.h + +To write a recipe to use such a library in your system: + +- The vendor will probably have a proprietary licence, so set + :term:`LICENSE_FLAGS` in your recipe. +- The vendor provides a tarball containing libraries so set :term:`SRC_URI` + appropriately. +- Set :term:`COMPATIBLE_HOST` so that the recipe cannot be used with an + unsupported architecture. In the following example, we only support the 32 + and 64 bit variants of the ``x86`` architecture. +- As the vendor provides versioned libraries, we can use ``oe_soinstall`` + from :ref:`ref-classes-utils` to install the shared library and create + symbolic links. If the vendor does not do this, we need to follow the + non-versioned library guidelines in the next section. +- As the vendor likely used :term:`LDFLAGS` different from those in your Yocto + Project build, disable the corresponding checks by adding ``ldflags`` + to :term:`INSANE_SKIP`. +- The vendor will typically ship release builds without debugging symbols. + Avoid errors by preventing the packaging task from stripping out the symbols + and adding them to a separate debug package. This is done by setting the + ``INHIBIT_`` flags shown below. + +The complete recipe would look like this:: + + SUMMARY = "FTDI FT4222H Library" + SECTION = "libs" + LICENSE_FLAGS = "ftdi" + LICENSE = "CLOSED" + + COMPATIBLE_HOST = "(i.86|x86_64).*-linux" + + # Sources available in a .tgz file in .zip archive + # at https://ftdichip.com/wp-content/uploads/2021/01/libft4222-linux-1.4.4.44.zip + # Found on https://ftdichip.com/software-examples/ft4222h-software-examples/ + # Since dealing with this particular type of archive is out of topic here, + # we use a local link. + SRC_URI = "file://libft4222-linux-${PV}.tgz" + + S = "${WORKDIR}" + + ARCH_DIR:x86-64 = "build-x86_64" + ARCH_DIR:i586 = "build-i386" + ARCH_DIR:i686 = "build-i386" + + INSANE_SKIP:${PN} = "ldflags" + INHIBIT_PACKAGE_STRIP = "1" + INHIBIT_SYSROOT_STRIP = "1" + INHIBIT_PACKAGE_DEBUG_SPLIT = "1" + + do_install () { + install -m 0755 -d ${D}${libdir} + oe_soinstall ${S}/${ARCH_DIR}/libft4222.so.${PV} ${D}${libdir} + install -d ${D}${includedir} + install -m 0755 ${S}/*.h ${D}${includedir} + } + +If the precompiled binaries are not statically linked and have dependencies on +other libraries, then by adding those libraries to :term:`DEPENDS`, the linking +can be examined and the appropriate :term:`RDEPENDS` automatically added. + +Non-Versioned Libraries +======================= + +Some Background +--------------- + +Libraries in Linux systems are generally versioned so that it is possible +to have multiple versions of the same library installed, which eases upgrades +and support for older software. For example, suppose that in a versioned +library, an actual library is called ``libfoo.so.1.2``, a symbolic link named +``libfoo.so.1`` points to ``libfoo.so.1.2``, and a symbolic link named +``libfoo.so`` points to ``libfoo.so.1.2``. Given these conditions, when you +link a binary against a library, you typically provide the unversioned file +name (i.e. ``-lfoo`` to the linker). However, the linker follows the symbolic +link and actually links against the versioned filename. The unversioned symbolic +link is only used at development time. Consequently, the library is packaged +along with the headers in the development package ``${PN}-dev`` along with the +actual library and versioned symbolic links in ``${PN}``. Because versioned +libraries are far more common than unversioned libraries, the default packaging +rules assume versioned libraries. + +Yocto Library Packaging Overview +-------------------------------- + +It follows that packaging an unversioned library requires a bit of work in the +recipe. By default, ``libfoo.so`` gets packaged into ``${PN}-dev``, which +triggers a QA warning that a non-symlink library is in a ``-dev`` package, +and binaries in the same recipe link to the library in ``${PN}-dev``, +which triggers more QA warnings. To solve this problem, you need to package the +unversioned library into ``${PN}`` where it belongs. The abridged +default :term:`FILES` variables in ``bitbake.conf`` are:: + + SOLIBS = ".so.*" + SOLIBSDEV = ".so" + FILES:${PN} = "... ${libdir}/lib*${SOLIBS} ..." + FILES_SOLIBSDEV ?= "... ${libdir}/lib*${SOLIBSDEV} ..." + FILES:${PN}-dev = "... ${FILES_SOLIBSDEV} ..." + +:term:`SOLIBS` defines a pattern that matches real shared object libraries. +:term:`SOLIBSDEV` matches the development form (unversioned symlink). These two +variables are then used in ``FILES:${PN}`` and ``FILES:${PN}-dev``, which puts +the real libraries into ``${PN}`` and the unversioned symbolic link into ``${PN}-dev``. +To package unversioned libraries, you need to modify the variables in the recipe +as follows:: + + SOLIBS = ".so" + FILES_SOLIBSDEV = "" + +The modifications cause the ``.so`` file to be the real library +and unset :term:`FILES_SOLIBSDEV` so that no libraries get packaged into +``${PN}-dev``. The changes are required because unless :term:`PACKAGES` is changed, +``${PN}-dev`` collects files before `${PN}`. ``${PN}-dev`` must not collect any of +the files you want in ``${PN}``. + +Finally, loadable modules, essentially unversioned libraries that are linked +at runtime using ``dlopen()`` instead of at build time, should generally be +installed in a private directory. However, if they are installed in ``${libdir}``, +then the modules can be treated as unversioned libraries. + +Example +------- + +The example below installs an unversioned x86-64 pre-built library named +``libfoo.so``. The :term:`COMPATIBLE_HOST` variable limits recipes to the +x86-64 architecture while the :term:`INSANE_SKIP`, :term:`INHIBIT_PACKAGE_STRIP` +and :term:`INHIBIT_SYSROOT_STRIP` variables are all set as in the above +versioned library example. The "magic" is setting the :term:`SOLIBS` and +:term:`FILES_SOLIBSDEV` variables as explained above:: + + SUMMARY = "libfoo sample recipe" + SECTION = "libs" + LICENSE = "CLOSED" + + SRC_URI = "file://libfoo.so" + + COMPATIBLE_HOST = "x86_64.*-linux" + + INSANE_SKIP:${PN} = "ldflags" + INHIBIT_PACKAGE_STRIP = "1" + INHIBIT_SYSROOT_STRIP = "1" + SOLIBS = ".so" + FILES_SOLIBSDEV = "" + + do_install () { + install -d ${D}${libdir} + install -m 0755 ${WORKDIR}/libfoo.so ${D}${libdir} + } + diff --git a/documentation/dev-manual/python-development-shell.rst b/documentation/dev-manual/python-development-shell.rst new file mode 100644 index 0000000000..81a5c43472 --- /dev/null +++ b/documentation/dev-manual/python-development-shell.rst @@ -0,0 +1,50 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using a Python Development Shell +******************************** + +Similar to working within a development shell as described in the +previous section, you can also spawn and work within an interactive +Python development shell. When debugging certain commands or even when +just editing packages, ``pydevshell`` can be a useful tool. When you +invoke the ``pydevshell`` task, all tasks up to and including +:ref:`ref-tasks-patch` are run for the +specified target. Then a new terminal is opened. Additionally, key +Python objects and code are available in the same way they are to +BitBake tasks, in particular, the data store 'd'. So, commands such as +the following are useful when exploring the data store and running +functions:: + + pydevshell> d.getVar("STAGING_DIR") + '/media/build1/poky/build/tmp/sysroots' + pydevshell> d.getVar("STAGING_DIR", False) + '${TMPDIR}/sysroots' + pydevshell> d.setVar("FOO", "bar") + pydevshell> d.getVar("FOO") + 'bar' + pydevshell> d.delVar("FOO") + pydevshell> d.getVar("FOO") + pydevshell> bb.build.exec_func("do_unpack", d) + pydevshell> + +See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:functions you can call from within python`" +section in the BitBake User Manual for details about available functions. + +The commands execute just as if the OpenEmbedded build +system were executing them. Consequently, working this way can be +helpful when debugging a build or preparing software to be used with the +OpenEmbedded build system. + +Here is an example that uses ``pydevshell`` on a target named +``matchbox-desktop``:: + + $ bitbake matchbox-desktop -c pydevshell + +This command spawns a terminal and places you in an interactive Python +interpreter within the OpenEmbedded build environment. The +:term:`OE_TERMINAL` variable +controls what type of shell is opened. + +When you are finished using ``pydevshell``, you can exit the shell +either by using Ctrl+d or closing the terminal window. + diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst index 88a63c1808..19f3e40d63 100644 --- a/documentation/dev-manual/qemu.rst +++ b/documentation/dev-manual/qemu.rst @@ -44,13 +44,13 @@ To use QEMU, you need to have QEMU installed and initialized as well as have the proper artifacts (i.e. image files and root filesystems) available. Follow these general steps to run QEMU: -1. *Install QEMU:* QEMU is made available with the Yocto Project a +#. *Install QEMU:* QEMU is made available with the Yocto Project a number of ways. One method is to install a Software Development Kit (SDK). See ":ref:`sdk-manual/intro:the qemu emulator`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual for information on how to install QEMU. -2. *Setting Up the Environment:* How you set up the QEMU environment +#. *Setting Up the Environment:* How you set up the QEMU environment depends on how you installed QEMU: - If you cloned the ``poky`` repository or you downloaded and @@ -66,7 +66,7 @@ available. Follow these general steps to run QEMU: . poky_sdk/environment-setup-core2-64-poky-linux -3. *Ensure the Artifacts are in Place:* You need to be sure you have a +#. *Ensure the Artifacts are in Place:* You need to be sure you have a pre-built kernel that will boot in QEMU. You also need the target root filesystem for your target machine's architecture: @@ -84,7 +84,7 @@ available. Follow these general steps to run QEMU: Extensible Software Development Kit (eSDK) manual for information on how to extract a root filesystem. -4. *Run QEMU:* The basic ``runqemu`` command syntax is as follows:: +#. *Run QEMU:* The basic ``runqemu`` command syntax is as follows:: $ runqemu [option ] [...] @@ -99,12 +99,13 @@ available. Follow these general steps to run QEMU: Here are some additional examples to help illustrate further QEMU: - This example starts QEMU with MACHINE set to "qemux86-64". - Assuming a standard - :term:`Build Directory`, ``runqemu`` + Assuming a standard :term:`Build Directory`, ``runqemu`` automatically finds the ``bzImage-qemux86-64.bin`` image file and the ``core-image-minimal-qemux86-64-20200218002850.rootfs.ext4`` (assuming the current build created a ``core-image-minimal`` - image). + image):: + + $ runqemu qemux86-64 .. note:: @@ -112,38 +113,31 @@ available. Follow these general steps to run QEMU: and uses the most recently built image according to the timestamp. - :: - - $ runqemu qemux86-64 - - This example produces the exact same results as the previous example. This command, however, specifically provides the image - and root filesystem type. - :: + and root filesystem type:: $ runqemu qemux86-64 core-image-minimal ext4 - - This example specifies to boot an initial RAM disk image and to - enable audio in QEMU. For this case, ``runqemu`` set the internal - variable ``FSTYPE`` to "cpio.gz". Also, for audio to be enabled, - an appropriate driver must be installed (see the previous - description for the ``audio`` option for more information). - :: + - This example specifies to boot an :term:`Initramfs` image and to + enable audio in QEMU. For this case, ``runqemu`` sets the internal + variable ``FSTYPE`` to ``cpio.gz``. Also, for audio to be enabled, + an appropriate driver must be installed (see the ``audio`` option + in :ref:`dev-manual/qemu:\`\`runqemu\`\` command-line options` + for more information):: $ runqemu qemux86-64 ramfs audio - This example does not provide enough information for QEMU to launch. While the command does provide a root filesystem type, it - must also minimally provide a `MACHINE`, `KERNEL`, or `VM` option. - :: + must also minimally provide a `MACHINE`, `KERNEL`, or `VM` option:: $ runqemu ext4 - This example specifies to boot a virtual machine image (``.wic.vmdk`` file). From the ``.wic.vmdk``, ``runqemu`` determines the QEMU architecture (`MACHINE`) to be "qemux86-64" and - the root filesystem type to be "vmdk". - :: + the root filesystem type to be "vmdk":: $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86-64.wic.vmdk @@ -190,7 +184,7 @@ the system does not need root privileges to run. It uses a user space NFS server to avoid that. Follow these steps to set up for running QEMU using an NFS server. -1. *Extract a Root Filesystem:* Once you are able to run QEMU in your +#. *Extract a Root Filesystem:* Once you are able to run QEMU in your environment, you can use the ``runqemu-extract-sdk`` script, which is located in the ``scripts`` directory along with the ``runqemu`` script. @@ -204,7 +198,7 @@ using an NFS server. runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs -2. *Start QEMU:* Once you have extracted the file system, you can run +#. *Start QEMU:* Once you have extracted the file system, you can run ``runqemu`` normally with the additional location of the file system. You can then also make changes to the files within ``./test-nfs`` and see those changes appear in the image in real time. Here is an @@ -246,11 +240,10 @@ be a problem when QEMU is running with KVM enabled. Specifically, software compiled with a certain CPU feature crashes when run on a CPU under KVM that does not support that feature. To work around this problem, you can override QEMU's runtime CPU setting by changing the -``QB_CPU_KVM`` variable in ``qemuboot.conf`` in the -:term:`Build Directory` ``deploy/image`` -directory. This setting specifies a ``-cpu`` option passed into QEMU in -the ``runqemu`` script. Running ``qemu -cpu help`` returns a list of -available supported CPU types. +``QB_CPU_KVM`` variable in ``qemuboot.conf`` in the :term:`Build Directory` +``deploy/image`` directory. This setting specifies a ``-cpu`` option passed +into QEMU in the ``runqemu`` script. Running ``qemu -cpu help`` returns a +list of available supported CPU types. QEMU Performance ================ @@ -318,7 +311,7 @@ timestamp when it needs to look for an image. Minimally, through the use of options, you must provide either a machine name, a virtual machine image (``*wic.vmdk``), or a kernel image (``*.bin``). -Following is the command-line help output for the ``runqemu`` command:: +Here is the command-line help output for the ``runqemu`` command:: $ runqemu --help @@ -330,7 +323,7 @@ Following is the command-line help output for the ``runqemu`` command:: Simplified QEMU command-line options can be passed with: nographic - disable video console serial - enable a serial console on /dev/ttyS0 - slirp - enable user networking, no root privileges is required + slirp - enable user networking, no root privileges required kvm - enable KVM when running x86/x86_64 (VT-capable CPU required) kvm-vhost - enable KVM with vhost when running x86/x86_64 (VT-capable CPU required) publicvnc - enable a VNC server open to all hosts @@ -360,7 +353,7 @@ Following is the command-line help output for the ``runqemu`` command:: ``runqemu`` Command-Line Options ================================ -Following is a description of ``runqemu`` options you can provide on the +Here is a description of ``runqemu`` options you can provide on the command line: .. note:: @@ -394,7 +387,7 @@ command line: options are basically identical. If you do not provide a MACHINE option, ``runqemu`` tries to determine it based on other options. -- ``ramfs``: Indicates you are booting an initial RAM disk (initramfs) +- ``ramfs``: Indicates you are booting an :term:`Initramfs` image, which means the ``FSTYPE`` is ``cpio.gz``. - ``iso``: Indicates you are booting an ISO image, which means the @@ -428,6 +421,29 @@ command line: networking that does not need root access but also is not as easy to use or comprehensive as the default. + Using ``slirp`` by default will forward the guest machine's + 22 and 23 TCP ports to host machine's 2222 and 2323 ports + (or the next free ports). Specific forwarding rules can be configured + by setting ``QB_SLIRP_OPT`` as environment variable or in ``qemuboot.conf`` + in the :term:`Build Directory` ``deploy/image`` directory. + Examples:: + + QB_SLIRP_OPT="-netdev user,id=net0,hostfwd=tcp::8080-:80" + + QB_SLIRP_OPT="-netdev user,id=net0,hostfwd=tcp::8080-:80,hostfwd=tcp::2222-:22" + + The first example forwards TCP port 80 from the emulated system to + port 8080 (or the next free port) on the host system, + allowing access to an http server running in QEMU from + ``http://<host ip>:8080/``. + + The second example does the same, but also forwards TCP port 22 on the + guest system to 2222 (or the next free port) on the host system, + allowing ssh access to the emulated system using + ``ssh -P 2222 <user>@<host ip>``. + + Keep in mind that proper configuration of firewall software is required. + - ``kvm``: Enables KVM when running "qemux86" or "qemux86-64" QEMU architectures. For KVM to work, all the following conditions must be met: diff --git a/documentation/dev-manual/quilt.rst b/documentation/dev-manual/quilt.rst new file mode 100644 index 0000000000..59240705ad --- /dev/null +++ b/documentation/dev-manual/quilt.rst @@ -0,0 +1,89 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using Quilt in Your Workflow +**************************** + +`Quilt <https://savannah.nongnu.org/projects/quilt>`__ is a powerful tool +that allows you to capture source code changes without having a clean +source tree. This section outlines the typical workflow you can use to +modify source code, test changes, and then preserve the changes in the +form of a patch all using Quilt. + +.. note:: + + With regard to preserving changes to source files, if you clean a + recipe or have :ref:`ref-classes-rm-work` enabled, the + :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` + as described in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual is a safer + development flow than the flow that uses Quilt. + +Follow these general steps: + +#. *Find the Source Code:* Temporary source code used by the + OpenEmbedded build system is kept in the :term:`Build Directory`. See the + ":ref:`dev-manual/temporary-source-code:finding temporary source code`" section to + learn how to locate the directory that has the temporary source code for a + particular package. + +#. *Change Your Working Directory:* You need to be in the directory that + has the temporary source code. That directory is defined by the + :term:`S` variable. + +#. *Create a New Patch:* Before modifying source code, you need to + create a new patch. To create a new patch file, use ``quilt new`` as + below:: + + $ quilt new my_changes.patch + +#. *Notify Quilt and Add Files:* After creating the patch, you need to + notify Quilt about the files you plan to edit. You notify Quilt by + adding the files to the patch you just created:: + + $ quilt add file1.c file2.c file3.c + +#. *Edit the Files:* Make your changes in the source code to the files + you added to the patch. + +#. *Test Your Changes:* Once you have modified the source code, the + easiest way to test your changes is by calling the :ref:`ref-tasks-compile` + task as shown in the following example:: + + $ bitbake -c compile -f package + + The ``-f`` or ``--force`` option forces the specified task to + execute. If you find problems with your code, you can just keep + editing and re-testing iteratively until things work as expected. + + .. note:: + + All the modifications you make to the temporary source code disappear + once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` + tasks using BitBake (i.e. ``bitbake -c clean package`` and + ``bitbake -c cleanall package``). Modifications will also disappear if + you use the :ref:`ref-classes-rm-work` feature as described in + the ":ref:`dev-manual/disk-space:conserving disk space during builds`" + section. + +#. *Generate the Patch:* Once your changes work as expected, you need to + use Quilt to generate the final patch that contains all your + modifications:: + + $ quilt refresh + + At this point, the + ``my_changes.patch`` file has all your edits made to the ``file1.c``, + ``file2.c``, and ``file3.c`` files. + + You can find the resulting patch file in the ``patches/`` + subdirectory of the source (:term:`S`) directory. + +#. *Copy the Patch File:* For simplicity, copy the patch file into a + directory named ``files``, which you can create in the same directory + that holds the recipe (``.bb``) file or the append (``.bbappend``) + file. Placing the patch here guarantees that the OpenEmbedded build + system will find the patch. Next, add the patch into the :term:`SRC_URI` + of the recipe. Here is an example:: + + SRC_URI += "file://my_changes.patch" + diff --git a/documentation/dev-manual/read-only-rootfs.rst b/documentation/dev-manual/read-only-rootfs.rst new file mode 100644 index 0000000000..251178ed54 --- /dev/null +++ b/documentation/dev-manual/read-only-rootfs.rst @@ -0,0 +1,89 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Creating a Read-Only Root Filesystem +************************************ + +Suppose, for security reasons, you need to disable your target device's +root filesystem's write permissions (i.e. you need a read-only root +filesystem). Or, perhaps you are running the device's operating system +from a read-only storage device. For either case, you can customize your +image for that behavior. + +.. note:: + + Supporting a read-only root filesystem requires that the system and + applications do not try to write to the root filesystem. You must + configure all parts of the target system to write elsewhere, or to + gracefully fail in the event of attempting to write to the root + filesystem. + +Creating the Root Filesystem +============================ + +To create the read-only root filesystem, simply add the +"read-only-rootfs" feature to your image, normally in one of two ways. +The first way is to add the "read-only-rootfs" image feature in the +image's recipe file via the :term:`IMAGE_FEATURES` variable:: + + IMAGE_FEATURES += "read-only-rootfs" + +As an alternative, you can add the same feature +from within your :term:`Build Directory`'s ``local.conf`` file with the +associated :term:`EXTRA_IMAGE_FEATURES` variable, as in:: + + EXTRA_IMAGE_FEATURES = "read-only-rootfs" + +For more information on how to use these variables, see the +":ref:`dev-manual/customizing-images:Customizing Images Using Custom \`\`IMAGE_FEATURES\`\` and \`\`EXTRA_IMAGE_FEATURES\`\``" +section. For information on the variables, see +:term:`IMAGE_FEATURES` and +:term:`EXTRA_IMAGE_FEATURES`. + +Post-Installation Scripts and Read-Only Root Filesystem +======================================================= + +It is very important that you make sure all post-Installation +(``pkg_postinst``) scripts for packages that are installed into the +image can be run at the time when the root filesystem is created during +the build on the host system. These scripts cannot attempt to run during +the first boot on the target device. With the "read-only-rootfs" feature +enabled, the build system makes sure that all post-installation scripts +succeed at file system creation time. If any of these scripts +still need to be run after the root filesystem is created, the build +immediately fails. These build-time checks ensure that the build fails +rather than the target device fails later during its initial boot +operation. + +Most of the common post-installation scripts generated by the build +system for the out-of-the-box Yocto Project are engineered so that they +can run during root filesystem creation (e.g. post-installation scripts +for caching fonts). However, if you create and add custom scripts, you +need to be sure they can be run during this file system creation. + +Here are some common problems that prevent post-installation scripts +from running during root filesystem creation: + +- *Not using $D in front of absolute paths:* The build system defines + ``$``\ :term:`D` when the root + filesystem is created. Furthermore, ``$D`` is blank when the script + is run on the target device. This implies two purposes for ``$D``: + ensuring paths are valid in both the host and target environments, + and checking to determine which environment is being used as a method + for taking appropriate actions. + +- *Attempting to run processes that are specific to or dependent on the + target architecture:* You can work around these attempts by using + native tools, which run on the host system, to accomplish the same + tasks, or by alternatively running the processes under QEMU, which + has the ``qemu_run_binary`` function. For more information, see the + :ref:`ref-classes-qemu` class. + +Areas With Write Access +======================= + +With the "read-only-rootfs" feature enabled, any attempt by the target +to write to the root filesystem at runtime fails. Consequently, you must +make sure that you configure processes and applications that attempt +these types of writes do so to directories with write access (e.g. +``/tmp`` or ``/var/run``). + diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/dev-manual/runtime-testing.rst new file mode 100644 index 0000000000..7a2b42f25a --- /dev/null +++ b/documentation/dev-manual/runtime-testing.rst @@ -0,0 +1,594 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Performing Automated Runtime Testing +************************************ + +The OpenEmbedded build system makes available a series of automated +tests for images to verify runtime functionality. You can run these +tests on either QEMU or actual target hardware. Tests are written in +Python making use of the ``unittest`` module, and the majority of them +run commands on the target system over SSH. This section describes how +you set up the environment to use these tests, run available tests, and +write and add your own tests. + +For information on the test and QA infrastructure available within the +Yocto Project, see the ":ref:`ref-manual/release-process:testing and quality assurance`" +section in the Yocto Project Reference Manual. + +Enabling Tests +============== + +Depending on whether you are planning to run tests using QEMU or on the +hardware, you have to take different steps to enable the tests. See the +following subsections for information on how to enable both types of +tests. + +Enabling Runtime Tests on QEMU +------------------------------ + +In order to run tests, you need to do the following: + +- *Set up to avoid interaction with sudo for networking:* To + accomplish this, you must do one of the following: + + - Add ``NOPASSWD`` for your user in ``/etc/sudoers`` either for all + commands or just for ``runqemu-ifup``. You must provide the full + path as that can change if you are using multiple clones of the + source repository. + + .. note:: + + On some distributions, you also need to comment out "Defaults + requiretty" in ``/etc/sudoers``. + + - Manually configure a tap interface for your system. + + - Run as root the script in ``scripts/runqemu-gen-tapdevs``, which + should generate a list of tap devices. This is the option + typically chosen for Autobuilder-type environments. + + .. note:: + + - Be sure to use an absolute path when calling this script + with sudo. + + - Ensure that your host has the package ``iptables`` installed. + + - The package recipe ``qemu-helper-native`` is required to run + this script. Build the package using the following command:: + + $ bitbake qemu-helper-native + +- *Set the DISPLAY variable:* You need to set this variable so that + you have an X server available (e.g. start ``vncserver`` for a + headless machine). + +- *Be sure your host's firewall accepts incoming connections from + 192.168.7.0/24:* Some of the tests (in particular DNF tests) start an + HTTP server on a random high number port, which is used to serve + files to the target. The DNF module serves + ``${WORKDIR}/oe-rootfs-repo`` so it can run DNF channel commands. + That means your host's firewall must accept incoming connections from + 192.168.7.0/24, which is the default IP range used for tap devices by + ``runqemu``. + +- *Be sure your host has the correct packages installed:* Depending + your host's distribution, you need to have the following packages + installed: + + - Ubuntu and Debian: ``sysstat`` and ``iproute2`` + + - openSUSE: ``sysstat`` and ``iproute2`` + + - Fedora: ``sysstat`` and ``iproute`` + + - CentOS: ``sysstat`` and ``iproute`` + +Once you start running the tests, the following happens: + +#. A copy of the root filesystem is written to ``${WORKDIR}/testimage``. + +#. The image is booted under QEMU using the standard ``runqemu`` script. + +#. A default timeout of 500 seconds occurs to allow for the boot process + to reach the login prompt. You can change the timeout period by + setting + :term:`TEST_QEMUBOOT_TIMEOUT` + in the ``local.conf`` file. + +#. Once the boot process is reached and the login prompt appears, the + tests run. The full boot log is written to + ``${WORKDIR}/testimage/qemu_boot_log``. + +#. Each test module loads in the order found in :term:`TEST_SUITES`. You can + find the full output of the commands run over SSH in + ``${WORKDIR}/testimgage/ssh_target_log``. + +#. If no failures occur, the task running the tests ends successfully. + You can find the output from the ``unittest`` in the task log at + ``${WORKDIR}/temp/log.do_testimage``. + +Enabling Runtime Tests on Hardware +---------------------------------- + +The OpenEmbedded build system can run tests on real hardware, and for +certain devices it can also deploy the image to be tested onto the +device beforehand. + +For automated deployment, a "controller image" is installed onto the +hardware once as part of setup. Then, each time tests are to be run, the +following occurs: + +#. The controller image is booted into and used to write the image to be + tested to a second partition. + +#. The device is then rebooted using an external script that you need to + provide. + +#. The device boots into the image to be tested. + +When running tests (independent of whether the image has been deployed +automatically or not), the device is expected to be connected to a +network on a pre-determined IP address. You can either use static IP +addresses written into the image, or set the image to use DHCP and have +your DHCP server on the test network assign a known IP address based on +the MAC address of the device. + +In order to run tests on hardware, you need to set :term:`TEST_TARGET` to an +appropriate value. For QEMU, you do not have to change anything, the +default value is "qemu". For running tests on hardware, the following +options are available: + +- *"simpleremote":* Choose "simpleremote" if you are going to run tests + on a target system that is already running the image to be tested and + is available on the network. You can use "simpleremote" in + conjunction with either real hardware or an image running within a + separately started QEMU or any other virtual machine manager. + +- *"SystemdbootTarget":* Choose "SystemdbootTarget" if your hardware is + an EFI-based machine with ``systemd-boot`` as bootloader and + ``core-image-testmaster`` (or something similar) is installed. Also, + your hardware under test must be in a DHCP-enabled network that gives + it the same IP address for each reboot. + + If you choose "SystemdbootTarget", there are additional requirements + and considerations. See the + ":ref:`dev-manual/runtime-testing:selecting systemdboottarget`" section, which + follows, for more information. + +- *"BeagleBoneTarget":* Choose "BeagleBoneTarget" if you are deploying + images and running tests on the BeagleBone "Black" or original + "White" hardware. For information on how to use these tests, see the + comments at the top of the BeagleBoneTarget + ``meta-yocto-bsp/lib/oeqa/controllers/beaglebonetarget.py`` file. + +- *"GrubTarget":* Choose "GrubTarget" if you are deploying images and running + tests on any generic PC that boots using GRUB. For information on how + to use these tests, see the comments at the top of the GrubTarget + ``meta-yocto-bsp/lib/oeqa/controllers/grubtarget.py`` file. + +- *"your-target":* Create your own custom target if you want to run + tests when you are deploying images and running tests on a custom + machine within your BSP layer. To do this, you need to add a Python + unit that defines the target class under ``lib/oeqa/controllers/`` + within your layer. You must also provide an empty ``__init__.py``. + For examples, see files in ``meta-yocto-bsp/lib/oeqa/controllers/``. + +Selecting SystemdbootTarget +--------------------------- + +If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do +not need any information in this section. You can skip down to the +":ref:`dev-manual/runtime-testing:running tests`" section. + +If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to +perform a one-time setup of your controller image by doing the following: + +#. *Set EFI_PROVIDER:* Be sure that :term:`EFI_PROVIDER` is as follows:: + + EFI_PROVIDER = "systemd-boot" + +#. *Build the controller image:* Build the ``core-image-testmaster`` image. + The ``core-image-testmaster`` recipe is provided as an example for a + "controller" image and you can customize the image recipe as you would + any other recipe. + + Image recipe requirements are: + + - Inherits ``core-image`` so that kernel modules are installed. + + - Installs normal linux utilities not BusyBox ones (e.g. ``bash``, + ``coreutils``, ``tar``, ``gzip``, and ``kmod``). + + - Uses a custom :term:`Initramfs` image with a custom + installer. A normal image that you can install usually creates a + single root filesystem partition. This image uses another installer that + creates a specific partition layout. Not all Board Support + Packages (BSPs) can use an installer. For such cases, you need to + manually create the following partition layout on the target: + + - First partition mounted under ``/boot``, labeled "boot". + + - The main root filesystem partition where this image gets installed, + which is mounted under ``/``. + + - Another partition labeled "testrootfs" where test images get + deployed. + +#. *Install image:* Install the image that you just built on the target + system. + +The final thing you need to do when setting :term:`TEST_TARGET` to +"SystemdbootTarget" is to set up the test image: + +#. *Set up your local.conf file:* Make sure you have the following + statements in your ``local.conf`` file:: + + IMAGE_FSTYPES += "tar.gz" + IMAGE_CLASSES += "testimage" + TEST_TARGET = "SystemdbootTarget" + TEST_TARGET_IP = "192.168.2.3" + +#. *Build your test image:* Use BitBake to build the image:: + + $ bitbake core-image-sato + +Power Control +------------- + +For most hardware targets other than "simpleremote", you can control +power: + +- You can use :term:`TEST_POWERCONTROL_CMD` together with + :term:`TEST_POWERCONTROL_EXTRA_ARGS` as a command that runs on the host + and does power cycling. The test code passes one argument to that + command: off, on or cycle (off then on). Here is an example that + could appear in your ``local.conf`` file:: + + TEST_POWERCONTROL_CMD = "powercontrol.exp test 10.11.12.1 nuc1" + + In this example, the expect + script does the following: + + .. code-block:: shell + + ssh test@10.11.12.1 "pyctl nuc1 arg" + + It then runs a Python script that controls power for a label called + ``nuc1``. + + .. note:: + + You need to customize :term:`TEST_POWERCONTROL_CMD` and + :term:`TEST_POWERCONTROL_EXTRA_ARGS` for your own setup. The one requirement + is that it accepts "on", "off", and "cycle" as the last argument. + +- When no command is defined, it connects to the device over SSH and + uses the classic reboot command to reboot the device. Classic reboot + is fine as long as the machine actually reboots (i.e. the SSH test + has not failed). It is useful for scenarios where you have a simple + setup, typically with a single board, and where some manual + interaction is okay from time to time. + +If you have no hardware to automatically perform power control but still +wish to experiment with automated hardware testing, you can use the +``dialog-power-control`` script that shows a dialog prompting you to perform +the required power action. This script requires either KDialog or Zenity +to be installed. To use this script, set the +:term:`TEST_POWERCONTROL_CMD` +variable as follows:: + + TEST_POWERCONTROL_CMD = "${COREBASE}/scripts/contrib/dialog-power-control" + +Serial Console Connection +------------------------- + +For test target classes requiring a serial console to interact with the +bootloader (e.g. BeagleBoneTarget and GrubTarget), +you need to specify a command to use to connect to the serial console of +the target machine by using the +:term:`TEST_SERIALCONTROL_CMD` +variable and optionally the +:term:`TEST_SERIALCONTROL_EXTRA_ARGS` +variable. + +These cases could be a serial terminal program if the machine is +connected to a local serial port, or a ``telnet`` or ``ssh`` command +connecting to a remote console server. Regardless of the case, the +command simply needs to connect to the serial console and forward that +connection to standard input and output as any normal terminal program +does. For example, to use the picocom terminal program on serial device +``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows:: + + TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" + +For local +devices where the serial port device disappears when the device reboots, +an additional "serdevtry" wrapper script is provided. To use this +wrapper, simply prefix the terminal command with +``${COREBASE}/scripts/contrib/serdevtry``:: + + TEST_SERIALCONTROL_CMD = "${COREBASE}/scripts/contrib/serdevtry picocom -b 115200 /dev/ttyUSB0" + +Running Tests +============= + +You can start the tests automatically or manually: + +- *Automatically running tests:* To run the tests automatically after the + OpenEmbedded build system successfully creates an image, first set the + :term:`TESTIMAGE_AUTO` variable to "1" in your ``local.conf`` file in the + :term:`Build Directory`:: + + TESTIMAGE_AUTO = "1" + + Next, build your image. If the image successfully builds, the + tests run:: + + bitbake core-image-sato + +- *Manually running tests:* To manually run the tests, first globally + inherit the :ref:`ref-classes-testimage` class by editing your + ``local.conf`` file:: + + IMAGE_CLASSES += "testimage" + + Next, use BitBake to run the tests:: + + bitbake -c testimage image + +All test files reside in ``meta/lib/oeqa/runtime/cases`` in the +:term:`Source Directory`. A test name maps +directly to a Python module. Each test module may contain a number of +individual tests. Tests are usually grouped together by the area tested +(e.g tests for systemd reside in ``meta/lib/oeqa/runtime/cases/systemd.py``). + +You can add tests to any layer provided you place them in the proper +area and you extend :term:`BBPATH` in +the ``local.conf`` file as normal. Be sure that tests reside in +``layer/lib/oeqa/runtime/cases``. + +.. note:: + + Be sure that module names do not collide with module names used in + the default set of test modules in ``meta/lib/oeqa/runtime/cases``. + +You can change the set of tests run by appending or overriding +:term:`TEST_SUITES` variable in +``local.conf``. Each name in :term:`TEST_SUITES` represents a required test +for the image. Test modules named within :term:`TEST_SUITES` cannot be +skipped even if a test is not suitable for an image (e.g. running the +RPM tests on an image without ``rpm``). Appending "auto" to +:term:`TEST_SUITES` causes the build system to try to run all tests that are +suitable for the image (i.e. each test module may elect to skip itself). + +The order you list tests in :term:`TEST_SUITES` is important and influences +test dependencies. Consequently, tests that depend on other tests should +be added after the test on which they depend. For example, since the +``ssh`` test depends on the ``ping`` test, "ssh" needs to come after +"ping" in the list. The test class provides no re-ordering or dependency +handling. + +.. note:: + + Each module can have multiple classes with multiple test methods. + And, Python ``unittest`` rules apply. + +Here are some things to keep in mind when running tests: + +- The default tests for the image are defined as:: + + DEFAULT_TEST_SUITES:pn-image = "ping ssh df connman syslog xorg scp vnc date rpm dnf dmesg" + +- Add your own test to the list of the by using the following:: + + TEST_SUITES:append = " mytest" + +- Run a specific list of tests as follows:: + + TEST_SUITES = "test1 test2 test3" + + Remember, order is important. Be sure to place a test that is + dependent on another test later in the order. + +Exporting Tests +=============== + +You can export tests so that they can run independently of the build +system. Exporting tests is required if you want to be able to hand the +test execution off to a scheduler. You can only export tests that are +defined in :term:`TEST_SUITES`. + +If your image is already built, make sure the following are set in your +``local.conf`` file:: + + INHERIT += "testexport" + TEST_TARGET_IP = "IP-address-for-the-test-target" + TEST_SERVER_IP = "IP-address-for-the-test-server" + +You can then export the tests with the +following BitBake command form:: + + $ bitbake image -c testexport + +Exporting the tests places them in the :term:`Build Directory` in +``tmp/testexport/``\ image, which is controlled by the :term:`TEST_EXPORT_DIR` +variable. + +You can now run the tests outside of the build environment:: + + $ cd tmp/testexport/image + $ ./runexported.py testdata.json + +Here is a complete example that shows IP addresses and uses the +``core-image-sato`` image:: + + INHERIT += "testexport" + TEST_TARGET_IP = "192.168.7.2" + TEST_SERVER_IP = "192.168.7.1" + +Use BitBake to export the tests:: + + $ bitbake core-image-sato -c testexport + +Run the tests outside of +the build environment using the following:: + + $ cd tmp/testexport/core-image-sato + $ ./runexported.py testdata.json + +Writing New Tests +================= + +As mentioned previously, all new test files need to be in the proper +place for the build system to find them. New tests for additional +functionality outside of the core should be added to the layer that adds +the functionality, in ``layer/lib/oeqa/runtime/cases`` (as long as +:term:`BBPATH` is extended in the +layer's ``layer.conf`` file as normal). Just remember the following: + +- Filenames need to map directly to test (module) names. + +- Do not use module names that collide with existing core tests. + +- Minimally, an empty ``__init__.py`` file must be present in the runtime + directory. + +To create a new test, start by copying an existing module (e.g. +``oe_syslog.py`` or ``gcc.py`` are good ones to use). Test modules can use +code from ``meta/lib/oeqa/utils``, which are helper classes. + +.. note:: + + Structure shell commands such that you rely on them and they return a + single code for success. Be aware that sometimes you will need to + parse the output. See the ``df.py`` and ``date.py`` modules for examples. + +You will notice that all test classes inherit ``oeRuntimeTest``, which +is found in ``meta/lib/oetest.py``. This base class offers some helper +attributes, which are described in the following sections: + +Class Methods +------------- + +Class methods are as follows: + +- *hasPackage(pkg):* Returns "True" if ``pkg`` is in the installed + package list of the image, which is based on the manifest file that + is generated during the :ref:`ref-tasks-rootfs` task. + +- *hasFeature(feature):* Returns "True" if the feature is in + :term:`IMAGE_FEATURES` or + :term:`DISTRO_FEATURES`. + +Class Attributes +---------------- + +Class attributes are as follows: + +- *pscmd:* Equals "ps -ef" if ``procps`` is installed in the image. + Otherwise, ``pscmd`` equals "ps" (busybox). + +- *tc:* The called test context, which gives access to the + following attributes: + + - *d:* The BitBake datastore, which allows you to use stuff such + as ``oeRuntimeTest.tc.d.getVar("VIRTUAL-RUNTIME_init_manager")``. + + - *testslist and testsrequired:* Used internally. The tests + do not need these. + + - *filesdir:* The absolute path to + ``meta/lib/oeqa/runtime/files``, which contains helper files for + tests meant for copying on the target such as small files written + in C for compilation. + + - *target:* The target controller object used to deploy and + start an image on a particular target (e.g. Qemu, SimpleRemote, + and SystemdbootTarget). Tests usually use the following: + + - *ip:* The target's IP address. + + - *server_ip:* The host's IP address, which is usually used + by the DNF test suite. + + - *run(cmd, timeout=None):* The single, most used method. + This command is a wrapper for: ``ssh root@host "cmd"``. The + command returns a tuple: (status, output), which are what their + names imply - the return code of "cmd" and whatever output it + produces. The optional timeout argument represents the number + of seconds the test should wait for "cmd" to return. If the + argument is "None", the test uses the default instance's + timeout period, which is 300 seconds. If the argument is "0", + the test runs until the command returns. + + - *copy_to(localpath, remotepath):* + ``scp localpath root@ip:remotepath``. + + - *copy_from(remotepath, localpath):* + ``scp root@host:remotepath localpath``. + +Instance Attributes +------------------- + +There is a single instance attribute, which is ``target``. The ``target`` +instance attribute is identical to the class attribute of the same name, +which is described in the previous section. This attribute exists as +both an instance and class attribute so tests can use +``self.target.run(cmd)`` in instance methods instead of +``oeRuntimeTest.tc.target.run(cmd)``. + +Installing Packages in the DUT Without the Package Manager +========================================================== + +When a test requires a package built by BitBake, it is possible to +install that package. Installing the package does not require a package +manager be installed in the device under test (DUT). It does, however, +require an SSH connection and the target must be using the +``sshcontrol`` class. + +.. note:: + + This method uses ``scp`` to copy files from the host to the target, which + causes permissions and special attributes to be lost. + +A JSON file is used to define the packages needed by a test. This file +must be in the same path as the file used to define the tests. +Furthermore, the filename must map directly to the test module name with +a ``.json`` extension. + +The JSON file must include an object with the test name as keys of an +object or an array. This object (or array of objects) uses the following +data: + +- "pkg" --- a mandatory string that is the name of the package to be + installed. + +- "rm" --- an optional boolean, which defaults to "false", that specifies + to remove the package after the test. + +- "extract" --- an optional boolean, which defaults to "false", that + specifies if the package must be extracted from the package format. + When set to "true", the package is not automatically installed into + the DUT. + +Here is an example JSON file that handles test "foo" installing +package "bar" and test "foobar" installing packages "foo" and "bar". +Once the test is complete, the packages are removed from the DUT:: + + { + "foo": { + "pkg": "bar" + }, + "foobar": [ + { + "pkg": "foo", + "rm": true + }, + { + "pkg": "bar", + "rm": true + } + ] + } + diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst new file mode 100644 index 0000000000..b72bad1554 --- /dev/null +++ b/documentation/dev-manual/sbom.rst @@ -0,0 +1,83 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Creating a Software Bill of Materials +************************************* + +Once you are able to build an image for your project, once the licenses for +each software component are all identified (see +":ref:`dev-manual/licenses:working with licenses`") and once vulnerability +fixes are applied (see ":ref:`dev-manual/vulnerabilities:checking +for vulnerabilities`"), the OpenEmbedded build system can generate +a description of all the components you used, their licenses, their dependencies, +their sources, the changes that were applied to them and the known +vulnerabilities that were fixed. + +This description is generated in the form of a *Software Bill of Materials* +(:term:`SBOM`), using the :term:`SPDX` standard. + +When you release software, this is the most standard way to provide information +about the Software Supply Chain of your software image and SDK. The +:term:`SBOM` tooling is often used to ensure open source license compliance by +providing the license texts used in the product which legal departments and end +users can read in standardized format. + +:term:`SBOM` information is also critical to performing vulnerability exposure +assessments, as all the components used in the Software Supply Chain are listed. + +The OpenEmbedded build system doesn't generate such information by default. +To make this happen, you must inherit the +:ref:`ref-classes-create-spdx` class from a configuration file:: + + INHERIT += "create-spdx" + +Upon building an image, you will then get: + +- :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in + ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`. + +- This toplevel file is accompanied by an ``IMAGE-MACHINE.spdx.index.json`` + containing an index of JSON :term:`SPDX` files for individual recipes. + +- The compressed archive ``IMAGE-MACHINE.spdx.tar.zst`` contains the index + and the files for the single recipes. + +The :ref:`ref-classes-create-spdx` class offers options to include +more information in the output :term:`SPDX` data: + +- Make the json files more human readable by setting (:term:`SPDX_PRETTY`). + +- Add compressed archives of the files in the generated target packages by + setting (:term:`SPDX_ARCHIVE_PACKAGED`). + +- Add a description of the source files used to generate host tools and target + packages (:term:`SPDX_INCLUDE_SOURCES`) + +- Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). + +Though the toplevel :term:`SPDX` output is available in +``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary +generated files are available in ``tmp/deploy/spdx/MACHINE`` too, such as: + +- The individual :term:`SPDX` JSON files in the ``IMAGE-MACHINE.spdx.tar.zst`` + archive. + +- Compressed archives of the files in the generated target packages, + in ``packages/packagename.tar.zst`` (when :term:`SPDX_ARCHIVE_PACKAGED` + is set). + +- Compressed archives of the source files used to build the host tools + and the target packages in ``recipes/recipe-packagename.tar.zst`` + (when :term:`SPDX_ARCHIVE_SOURCES` is set). Those are needed to fulfill + "source code access" license requirements. + +See also the :term:`SPDX_CUSTOM_ANNOTATION_VARS` variable which allows +to associate custom notes to a recipe. +See the `tools page <https://spdx.dev/resources/tools/>`__ on the :term:`SPDX` +project website for a list of tools to consume and transform the :term:`SPDX` +data generated by the OpenEmbedded build system. + +See also Joshua Watt's presentations +`Automated SBoM generation with OpenEmbedded and the Yocto Project <https://youtu.be/Q5UQUM6zxVU>`__ +at FOSDEM 2023 and +`SPDX in the Yocto Project <https://fosdem.org/2024/schedule/event/fosdem-2024-3318-spdx-in-the-yocto-project/>`__ +at FOSDEM 2024. diff --git a/documentation/dev-manual/securing-images.rst b/documentation/dev-manual/securing-images.rst new file mode 100644 index 0000000000..e5791d3d6d --- /dev/null +++ b/documentation/dev-manual/securing-images.rst @@ -0,0 +1,156 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Making Images More Secure +************************* + +Security is of increasing concern for embedded devices. Consider the +issues and problems discussed in just this sampling of work found across +the Internet: + +- *"*\ `Security Risks of Embedded + Systems <https://www.schneier.com/blog/archives/2014/01/security_risks_9.html>`__\ *"* + by Bruce Schneier + +- *"*\ `Internet Census + 2012 <http://census2012.sourceforge.net/paper.html>`__\ *"* by Carna + Botnet + +- *"*\ `Security Issues for Embedded + Devices <https://elinux.org/images/6/6f/Security-issues.pdf>`__\ *"* + by Jake Edge + +When securing your image is of concern, there are steps, tools, and +variables that you can consider to help you reach the security goals you +need for your particular device. Not all situations are identical when +it comes to making an image secure. Consequently, this section provides +some guidance and suggestions for consideration when you want to make +your image more secure. + +.. note:: + + Because the security requirements and risks are different for every + type of device, this section cannot provide a complete reference on + securing your custom OS. It is strongly recommended that you also + consult other sources of information on embedded Linux system + hardening and on security. + +General Considerations +====================== + +There are general considerations that help you create more secure images. +You should consider the following suggestions to make your device +more secure: + +- Scan additional code you are adding to the system (e.g. application + code) by using static analysis tools. Look for buffer overflows and + other potential security problems. + +- Pay particular attention to the security for any web-based + administration interface. + + Web interfaces typically need to perform administrative functions and + tend to need to run with elevated privileges. Thus, the consequences + resulting from the interface's security becoming compromised can be + serious. Look for common web vulnerabilities such as + cross-site-scripting (XSS), unvalidated inputs, and so forth. + + As with system passwords, the default credentials for accessing a + web-based interface should not be the same across all devices. This + is particularly true if the interface is enabled by default as it can + be assumed that many end-users will not change the credentials. + +- Ensure you can update the software on the device to mitigate + vulnerabilities discovered in the future. This consideration + especially applies when your device is network-enabled. + +- Regularly scan and apply fixes for CVE security issues affecting + all software components in the product, see ":ref:`dev-manual/vulnerabilities:checking for vulnerabilities`". + +- Regularly update your version of Poky and OE-Core from their upstream + developers, e.g. to apply updates and security fixes from stable + and :term:`LTS` branches. + +- Ensure you remove or disable debugging functionality before producing + the final image. For information on how to do this, see the + ":ref:`dev-manual/securing-images:considerations specific to the openembedded build system`" + section. + +- Ensure you have no network services listening that are not needed. + +- Remove any software from the image that is not needed. + +- Enable hardware support for secure boot functionality when your + device supports this functionality. + +Security Flags +============== + +The Yocto Project has security flags that you can enable that help make +your build output more secure. The security flags are in the +``meta/conf/distro/include/security_flags.inc`` file in your +:term:`Source Directory` (e.g. ``poky``). + +.. note:: + + Depending on the recipe, certain security flags are enabled and + disabled by default. + +Use the following line in your ``local.conf`` file or in your custom +distribution configuration file to enable the security compiler and +linker flags for your build:: + + require conf/distro/include/security_flags.inc + +Considerations Specific to the OpenEmbedded Build System +======================================================== + +You can take some steps that are specific to the OpenEmbedded build +system to make your images more secure: + +- Ensure "debug-tweaks" is not one of your selected + :term:`IMAGE_FEATURES`. + When creating a new project, the default is to provide you with an + initial ``local.conf`` file that enables this feature using the + :term:`EXTRA_IMAGE_FEATURES` + variable with the line:: + + EXTRA_IMAGE_FEATURES = "debug-tweaks" + + To disable that feature, simply comment out that line in your + ``local.conf`` file, or make sure :term:`IMAGE_FEATURES` does not contain + "debug-tweaks" before producing your final image. Among other things, + leaving this in place sets the root password as blank, which makes + logging in for debugging or inspection easy during development but + also means anyone can easily log in during production. + +- It is possible to set a root password for the image and also to set + passwords for any extra users you might add (e.g. administrative or + service type users). When you set up passwords for multiple images or + users, you should not duplicate passwords. + + To set up passwords, use the :ref:`ref-classes-extrausers` class, which + is the preferred method. For an example on how to set up both root and + user passwords, see the ":ref:`ref-classes-extrausers`" section. + + .. note:: + + When adding extra user accounts or setting a root password, be + cautious about setting the same password on every device. If you + do this, and the password you have set is exposed, then every + device is now potentially compromised. If you need this access but + want to ensure security, consider setting a different, random + password for each device. Typically, you do this as a separate + step after you deploy the image onto the device. + +- Consider enabling a Mandatory Access Control (MAC) framework such as + SMACK or SELinux and tuning it appropriately for your device's usage. + You can find more information in the + :yocto_git:`meta-selinux </meta-selinux/>` layer. + +Tools for Hardening Your Image +============================== + +The Yocto Project provides tools for making your image more secure. You +can find these tools in the ``meta-security`` layer of the +:yocto_git:`Yocto Project Source Repositories <>`. + diff --git a/documentation/dev-manual/security-subjects.rst b/documentation/dev-manual/security-subjects.rst new file mode 100644 index 0000000000..1b02b6a9e9 --- /dev/null +++ b/documentation/dev-manual/security-subjects.rst @@ -0,0 +1,189 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Dealing with Vulnerability Reports +********************************** + +The Yocto Project and OpenEmbedded are open-source, community-based projects +used in numerous products. They assemble multiple other open-source projects, +and need to handle security issues and practices both internal (in the code +maintained by both projects), and external (maintained by other projects and +organizations). + +This manual assembles security-related information concerning the whole +ecosystem. It includes information on reporting a potential security issue, +the operation of the YP Security team and how to contribute in the +related code. It is written to be useful for both security researchers and +YP developers. + +How to report a potential security vulnerability? +================================================= + +If you would like to report a public issue (for example, one with a released +CVE number), please report it using the +:yocto_bugs:`Security Bugzilla </enter_bug.cgi?product=Security>`. + +If you are dealing with a not-yet-released issue, or an urgent one, please send +a message to security AT yoctoproject DOT org, including as many details as +possible: the layer or software module affected, the recipe and its version, +and any example code, if available. This mailing list is monitored by the +Yocto Project Security team. + +For each layer, you might also look for specific instructions (if any) for +reporting potential security issues in the specific ``SECURITY.md`` file at the +root of the repository. Instructions on how and where submit a patch are +usually available in ``README.md``. If this is your first patch to the +Yocto Project/OpenEmbedded, you might want to have a look into the +Contributor's Manual section +":ref:`contributor-guide/submit-changes:preparing changes for submission`". + +Branches maintained with security fixes +--------------------------------------- + +See the +:ref:`Release process <ref-manual/release-process:Stable Release Process>` +documentation for details regarding the policies and maintenance of stable +branches. + +The :yocto_wiki:`Releases page </Releases>` contains a list +of all releases of the Yocto Project. Versions in gray are no longer actively +maintained with security patches, but well-tested patches may still be accepted +for them for significant issues. + +Security-related discussions at the Yocto Project +------------------------------------------------- + +We have set up two security-related mailing lists: + + - Public List: yocto [dash] security [at] yoctoproject[dot] org + + This is a public mailing list for anyone to subscribe to. This list is an + open list to discuss public security issues/patches and security-related + initiatives. For more information, including subscription information, + please see the :yocto_lists:`yocto-security mailing list info page </g/yocto-security>`. + + - Private List: security [at] yoctoproject [dot] org + + This is a private mailing list for reporting non-published potential + vulnerabilities. The list is monitored by the Yocto Project Security team. + + +What you should do if you find a security vulnerability +------------------------------------------------------- + +If you find a security flaw: a crash, an information leakage, or anything that +can have a security impact if exploited in any Open Source software built or +used by the Yocto Project, please report this to the Yocto Project Security +Team. If you prefer to contact the upstream project directly, please send a +copy to the security team at the Yocto Project as well. If you believe this is +highly sensitive information, please report the vulnerability in a secure way, +i.e. encrypt the email and send it to the private list. This ensures that +the exploit is not leaked and exploited before a response/fix has been generated. + +Security team +============= + +The Yocto Project/OpenEmbedded security team coordinates the work on security +subjects in the project. All general discussion takes place publicly. The +Security Team only uses confidential communication tools to deal with private +vulnerability reports before they are released. + +Security team appointment +------------------------- + +The Yocto Project Security Team consists of at least three members. When new +members are needed, the Yocto Project Technical Steering Committee (YP TSC) +asks for nominations by public channels including a nomination deadline. +Self-nominations are possible. When the limit time is +reached, the YP TSC posts the list of candidates for the comments of project +participants and developers. Comments may be sent publicly or privately to the +YP and OE TSCs. The candidates are approved by both YP TSC and OpenEmbedded +Technical Steering Committee (OE TSC) and the final list of the team members +is announced publicly. The aim is to have people representing technical +leadership, security knowledge and infrastructure present with enough people +to provide backup/coverage but keep the notification list small enough to +minimize information risk and maintain trust. + +YP Security Team members may resign at any time. + +Security Team Operations +------------------------ + +The work of the Security Team might require high confidentiality. Team members +are individuals selected by merit and do not represent the companies they work +for. They do not share information about confidential issues outside of the team +and do not hint about ongoing embargoes. + +Team members can bring in domain experts as needed. Those people should be +added to individual issues only and adhere to the same standards as the YP +Security Team. + +The YP security team organizes its meetings and communication as needed. + +When the YP Security team receives a report about a potential security +vulnerability, they quickly analyze and notify the reporter of the result. +They might also request more information. + +If the issue is confirmed and affects the code maintained by the YP, they +confidentially notify maintainers of that code and work with them to prepare +a fix. + +If the issue is confirmed and affects an upstream project, the YP security team +notifies the project. Usually, the upstream project analyzes the problem again. +If they deem it a real security problem in their software, they develop and +release a fix following their security policy. They may want to include the +original reporter in the loop. There is also sometimes some coordination for +handling patches, backporting patches etc, or just understanding the problem +or what caused it. + +When the fix is publicly available, the YP security team member or the +package maintainer sends patches against the YP code base, following usual +procedures, including public code review. + +What Yocto Security Team does when it receives a security vulnerability +----------------------------------------------------------------------- + +The YP Security Team team performs a quick analysis and would usually report +the flaw to the upstream project. Normally the upstream project analyzes the +problem. If they deem it a real security problem in their software, they +develop and release a fix following their own security policy. They may want +to include the original reporter in the loop. There is also sometimes some +coordination for handling patches, backporting patches etc, or just +understanding the problem or what caused it. + +The security policy of the upstream project might include a notification to +Linux distributions or other important downstream projects in advance to +discuss coordinated disclosure. These mailing lists are normally non-public. + +When the upstream project releases a version with the fix, they are responsible +for contacting `Mitre <https://www.cve.org/>`__ to get a CVE number assigned and +the CVE record published. + +If an upstream project does not respond quickly +----------------------------------------------- + +If an upstream project does not fix the problem in a reasonable time, +the Yocto's Security Team will contact other interested parties (usually +other distributions) in the community and together try to solve the +vulnerability as quickly as possible. + +The Yocto Project Security team adheres to the 90 days disclosure policy +by default. An increase of the embargo time is possible when necessary. + +Current Security Team members +----------------------------- + +For secure communications, please send your messages encrypted using the GPG +keys. Remember, message headers are not encrypted so do not include sensitive +information in the subject line. + + - Ross Burton: <ross@burtonini.com> `Public key <https://keys.openpgp.org/search?q=ross%40burtonini.com>`__ + + - Michael Halstead: <mhalstead [at] linuxfoundation [dot] org> + `Public key <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x3373170601861969>`__ + or `Public key <https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xd1f2407285e571ed12a407a73373170601861969>`__ + + - Richard Purdie: <richard.purdie@linuxfoundation.org> `Public key <https://keys.openpgp.org/search?q=richard.purdie%40linuxfoundation.org>`__ + + - Marta Rybczynska: <marta DOT rybczynska [at] syslinbit [dot] com> `Public key <https://keys.openpgp.org/search?q=marta.rybczynska@syslinbit.com>`__ + + - Steve Sakoman: <steve [at] sakoman [dot] com> `Public key <https://keys.openpgp.org/search?q=steve%40sakoman.com>`__ diff --git a/documentation/dev-manual/speeding-up-build.rst b/documentation/dev-manual/speeding-up-build.rst new file mode 100644 index 0000000000..6e0d7873ac --- /dev/null +++ b/documentation/dev-manual/speeding-up-build.rst @@ -0,0 +1,109 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Speeding Up a Build +******************* + +Build time can be an issue. By default, the build system uses simple +controls to try and maximize build efficiency. In general, the default +settings for all the following variables result in the most efficient +build times when dealing with single socket systems (i.e. a single CPU). +If you have multiple CPUs, you might try increasing the default values +to gain more speed. See the descriptions in the glossary for each +variable for more information: + +- :term:`BB_NUMBER_THREADS`: + The maximum number of threads BitBake simultaneously executes. + +- :term:`BB_NUMBER_PARSE_THREADS`: + The number of threads BitBake uses during parsing. + +- :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. + +- :term:`PARALLEL_MAKEINST`: + Extra options passed to the ``make`` command during the + :ref:`ref-tasks-install` task in + order to specify parallel installation on the local build host. + +As mentioned, these variables all scale to the number of processor cores +available on the build system. For single socket systems, this +auto-scaling ensures that the build system fundamentally takes advantage +of potential parallel operations during the build based on the build +machine's capabilities. + +Additional factors that can affect build speed are: + +- File system type: The file system type that the build is being + performed on can also influence performance. Using ``ext4`` is + recommended as compared to ``ext2`` and ``ext3`` due to ``ext4`` + improved features such as extents. + +- Disabling the updating of access time using ``noatime``: The + ``noatime`` mount option prevents the build system from updating file + and directory access times. + +- Setting a longer commit: Using the "commit=" mount option increases + the interval in seconds between disk cache writes. Changing this + interval from the five second default to something longer increases + the risk of data loss but decreases the need to write to the disk, + thus increasing the build performance. + +- Choosing the packaging backend: Of the available packaging backends, + IPK is the fastest. Additionally, selecting a singular packaging + backend also helps. + +- Using ``tmpfs`` for :term:`TMPDIR` + as a temporary file system: While this can help speed up the build, + the benefits are limited due to the compiler using ``-pipe``. The + build system goes to some lengths to avoid ``sync()`` calls into the + file system on the principle that if there was a significant failure, + the :term:`Build Directory` contents could easily be rebuilt. + +- Inheriting the :ref:`ref-classes-rm-work` class: + Inheriting this class has shown to speed up builds due to + significantly lower amounts of data stored in the data cache as well + as on disk. Inheriting this class also makes cleanup of + :term:`TMPDIR` faster, at the + expense of being easily able to dive into the source code. File + system maintainers have recommended that the fastest way to clean up + large numbers of files is to reformat partitions rather than delete + files due to the linear nature of partitions. This, of course, + assumes you structure the disk partitions and file systems in a way + that this is practical. + +Aside from the previous list, you should keep some trade offs in mind +that can help you speed up the build: + +- Remove items from + :term:`DISTRO_FEATURES` + that you might not need. + +- Exclude debug symbols and other debug information: If you do not need + these symbols and other debug information, disabling the ``*-dbg`` + package generation can speed up the build. You can disable this + generation by setting the + :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` + variable to "1". + +- Disable static library generation for recipes derived from + ``autoconf`` or ``libtool``: Here is an example showing how to + disable static libraries and still provide an override to handle + exceptions:: + + STATICLIBCONF = "--disable-static" + STATICLIBCONF:sqlite3-native = "" + EXTRA_OECONF += "${STATICLIBCONF}" + + .. note:: + + - Some recipes need static libraries in order to work correctly + (e.g. ``pseudo-native`` needs ``sqlite3-native``). Overrides, + as in the previous example, account for these kinds of + exceptions. + + - Some packages have packaging code that assumes the presence of + the static libraries. If so, you might need to exclude them as + well. + diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 9c7dde8cf2..386e5f5d29 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -29,14 +29,14 @@ however, keep in mind, the procedure here is simply a starting point. You can build off these steps and customize the procedure to fit any particular working environment and set of practices. -1. *Determine Who is Going to be Developing:* You first need to +#. *Determine Who is Going to be Developing:* You first need to understand who is going to be doing anything related to the Yocto Project and determine their roles. Making this determination is essential to completing subsequent steps, which are to get your equipment together and set up your development environment's hardware topology. - Here are possible roles: + Possible roles are: - *Application Developer:* This type of developer does application level work on top of an existing software stack. @@ -52,7 +52,7 @@ particular working environment and set of practices. automated tests that are used to ensure all application and core system development meets desired quality standards. -2. *Gather the Hardware:* Based on the size and make-up of the team, +#. *Gather the Hardware:* Based on the size and make-up of the team, get the hardware together. Ideally, any development, build, or test engineer uses a system that runs a supported Linux distribution. These systems, in general, should be high performance (e.g. dual, @@ -66,13 +66,13 @@ particular working environment and set of practices. building Yocto Project development containers to be run under Docker, which is described later. -3. *Understand the Hardware Topology of the Environment:* Once you +#. *Understand the Hardware Topology of the Environment:* Once you understand the hardware involved and the make-up of the team, you can understand the hardware topology of the development environment. You can get a visual idea of the machines and their roles across the development environment. -4. *Use Git as Your Source Control Manager (SCM):* Keeping your +#. *Use Git as Your Source Control Manager (SCM):* Keeping your :term:`Metadata` (i.e. recipes, configuration files, classes, and so forth) and any software you are developing under the control of an SCM system that is compatible @@ -88,30 +88,18 @@ particular working environment and set of practices. For information about BitBake, see the :doc:`bitbake:index`. - It is relatively easy to set up Git services and create - infrastructure like :yocto_git:`/`, which is based on - server software called ``gitolite`` with ``cgit`` being used to - generate the web interface that lets you view the repositories. The - ``gitolite`` software identifies users using SSH keys and allows + It is relatively easy to set up Git services and create infrastructure like + :yocto_git:`/`, which is based on server software called + `Gitolite <https://gitolite.com>`__ + with `cgit <https://git.zx2c4.com/cgit/about/>`__ being used to + generate the web interface that lets you view the repositories. + ``gitolite`` identifies users using SSH keys and allows branch-based access controls to repositories that you can control as little or as much as necessary. - .. note:: - - The setup of these services is beyond the scope of this manual. - However, here are sites describing how to perform setup: - - - `Gitolite <https://gitolite.com>`__: Information for - ``gitolite``. - - - `Interfaces, frontends, and - tools <https://git.wiki.kernel.org/index.php/Interfaces,_frontends,_and_tools>`__: - Documentation on how to create interfaces and frontends for - Git. - -5. *Set up the Application Development Machines:* As mentioned earlier, +#. *Set up the Application Development Machines:* As mentioned earlier, application developers are creating applications on top of existing - software stacks. Following are some best practices for setting up + software stacks. Here are some best practices for setting up machines used for application development: - Use a pre-built toolchain that contains the software stack @@ -128,9 +116,9 @@ particular working environment and set of practices. - Use multiple toolchains installed locally into different locations to allow development across versions. -6. *Set up the Core Development Machines:* As mentioned earlier, core +#. *Set up the Core Development Machines:* As mentioned earlier, core developers work on the contents of the operating system itself. - Following are some best practices for setting up machines used for + Here are some best practices for setting up machines used for developing images: - Have the :term:`OpenEmbedded Build System` available on @@ -145,7 +133,7 @@ particular working environment and set of practices. - Share layers amongst the developers of a particular project and contain the policy configuration that defines the project. -7. *Set up an Autobuilder:* Autobuilders are often the core of the +#. *Set up an Autobuilder:* Autobuilders are often the core of the development environment. It is here that changes from individual developers are brought together and centrally tested. Based on this automated build and test environment, subsequent decisions about @@ -183,12 +171,12 @@ particular working environment and set of practices. - Allows scheduling of builds so that resources can be used efficiently. -8. *Set up Test Machines:* Use a small number of shared, high +#. *Set up Test Machines:* Use a small number of shared, high performance systems for testing purposes. Developers can use these systems for wider, more extensive testing while they continue to develop locally using their primary development system. -9. *Document Policies and Change Flow:* The Yocto Project uses a +#. *Document Policies and Change Flow:* The Yocto Project uses a hierarchical structure and a pull model. There are scripts to create and send pull requests (i.e. ``create-pull-request`` and ``send-pull-request``). This model is in line with other open source @@ -213,7 +201,7 @@ particular working environment and set of practices. possible. Chances are if you have discovered the need for changes, someone else in the community needs them also. -10. *Development Environment Summary:* Aside from the previous steps, +#. *Development Environment Summary:* Aside from the previous steps, here are best practices within the Yocto Project development environment: @@ -223,7 +211,7 @@ particular working environment and set of practices. - Maintain your Metadata in layers that make sense for your situation. See the ":ref:`overview-manual/yp-intro:the yocto project layer model`" section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":ref:`dev-manual/layers:understanding and creating layers`" section for more information on layers. - Separate the project's Metadata and code by using separate Git @@ -246,14 +234,13 @@ particular working environment and set of practices. - The Yocto Project community encourages you to send patches to the project to fix bugs or add features. If you do submit patches, follow the project commit guidelines for writing good commit - messages. See the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section. + messages. See the ":doc:`../contributor-guide/submit-changes`" + section in the Yocto Project and OpenEmbedded Contributor Guide. - Send changes to the core sooner than later as others are likely to run into the same issues. For some guidance on mailing lists - to use, see the list in the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" + to use, see the lists in the + ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" section. For a description of the available mailing lists, see the ":ref:`resources-mailinglist`" section in the Yocto Project Reference Manual. @@ -267,16 +254,16 @@ development using the Yocto Project. Your build host can be a native Linux machine (recommended), it can be a machine (Linux, Mac, or Windows) that uses `CROPS <https://github.com/crops/poky-container>`__, which leverages `Docker Containers <https://www.docker.com/>`__ or it -can be a Windows machine capable of running Windows Subsystem For Linux -v2 (WSL). +can be a Windows machine capable of running version 2 of Windows Subsystem +For Linux (WSL 2). .. note:: - The Yocto Project is not compatible with - `Windows Subsystem for Linux v1 <https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux>`__. - It is compatible but not officially supported nor validated with - WSLv2. If you still decide to use WSL please upgrade to - `WSLv2 <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`__. + The Yocto Project is not compatible with version 1 of + :wikipedia:`Windows Subsystem for Linux <Windows_Subsystem_for_Linux>`. + It is compatible but neither officially supported nor validated with + WSL 2. If you still decide to use WSL please upgrade to + `WSL 2 <https://learn.microsoft.com/en-us/windows/wsl/install>`__. Once your build host is set up to use the Yocto Project, further steps are necessary depending on what you want to accomplish. See the @@ -296,22 +283,22 @@ Setting Up a Native Linux Host Follow these steps to prepare a native Linux machine as your Yocto Project Build Host: -1. *Use a Supported Linux Distribution:* You should have a reasonably +#. *Use a Supported Linux Distribution:* You should have a reasonably current Linux-based host system. You will have the best results with a recent release of Fedora, openSUSE, Debian, Ubuntu, RHEL or CentOS as these releases are frequently tested against the Yocto Project and officially supported. For a list of the distributions under validation and their status, see the ":ref:`Supported Linux - Distributions <detailed-supported-distros>`" + Distributions <system-requirements-supported-distros>`" section in the Yocto Project Reference Manual and the wiki page at :yocto_wiki:`Distribution Support </Distribution_Support>`. -2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes +#. *Have Enough Free Memory:* Your system should have at least 50 Gbytes of free disk space for building images. -3. *Meet Minimal Version Requirements:* The OpenEmbedded build system +#. *Meet Minimal Version Requirements:* The OpenEmbedded build system should be able to run on any modern distribution that has the - following versions for Git, tar, Python and gcc. + following versions for Git, tar, Python, gcc and make. - Git &MIN_GIT_VERSION; or greater @@ -321,13 +308,15 @@ Project Build Host: - gcc &MIN_GCC_VERSION; or greater. + - GNU make &MIN_MAKE_VERSION; or greater + If your build host does not meet any of these listed version requirements, you can take steps to prepare the system so that you can still use the Yocto Project. See the - ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" + ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" section in the Yocto Project Reference Manual for information. -4. *Install Development Host Packages:* Required development host +#. *Install Development Host Packages:* Required development host packages vary depending on your build host and what you want to do with the Yocto Project. Collectively, the number of required packages is large if you want to be able to cover all cases. @@ -345,7 +334,10 @@ to use the Extensible SDK, see the ":doc:`/sdk-manual/extensible`" Chapter in th Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use Toaster, see the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. +section in the Toaster User Manual. If you are a VSCode user, you can configure +the `Yocto Project BitBake +<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ +extension accordingly. Setting Up to Use CROss PlatformS (CROPS) ----------------------------------------- @@ -359,7 +351,7 @@ Yocto Project on a Windows, Mac, or Linux machine. Follow these general steps to prepare a Windows, Mac, or Linux machine as your Yocto Project build host: -1. *Determine What Your Build Host Needs:* +#. *Determine What Your Build Host Needs:* `Docker <https://www.docker.com/what-docker>`__ is a software container platform that you need to install on the build host. Depending on your build host, you might have to install different @@ -368,20 +360,20 @@ as your Yocto Project build host: Platforms <https://docs.docker.com/engine/install/#supported-platforms>`__" your build host needs to run containers. -2. *Choose What To Install:* Depending on whether or not your build host +#. *Choose What To Install:* Depending on whether or not your build host meets system requirements, you need to install "Docker CE Stable" or the "Docker Toolbox". Most situations call for Docker CE. However, if you have a build host that does not meet requirements (e.g. Pre-Windows 10 or Windows 10 "Home" version), you must install Docker Toolbox instead. -3. *Go to the Install Site for Your Platform:* Click the link for the +#. *Go to the Install Site for Your Platform:* Click the link for the Docker edition associated with your build host's native software. For example, if your build host is running Microsoft Windows Version 10 and you want the Docker CE Stable edition, click that link under "Supported Platforms". -4. *Install the Software:* Once you have understood all the +#. *Install the Software:* Once you have understood all the pre-requisites, you can download and install the appropriate software. Follow the instructions for your specific machine and the type of the software you need to install: @@ -410,15 +402,15 @@ as your Yocto Project build host: Ubuntu <https://docs.docker.com/engine/install/ubuntu/>`__ for Linux build hosts running the Ubuntu distribution. -5. *Optionally Orient Yourself With Docker:* If you are unfamiliar with +#. *Optionally Orient Yourself With Docker:* If you are unfamiliar with Docker and the container concept, you can learn more here - https://docs.docker.com/get-started/. -6. *Launch Docker or Docker Toolbox:* You should be able to launch +#. *Launch Docker or Docker Toolbox:* You should be able to launch Docker or the Docker Toolbox and have a terminal shell on your development host. -7. *Set Up the Containers to Use the Yocto Project:* Go to +#. *Set Up the Containers to Use the Yocto Project:* Go to https://github.com/crops/docker-win-mac-docs/wiki and follow the directions for your particular build host (i.e. Linux, Mac, or Windows). @@ -437,37 +429,41 @@ section. If you are going to use the Extensible SDK container, see the Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you are going to use the Toaster container, see the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. +section in the Toaster User Manual. If you are a VSCode user, you can configure +the `Yocto Project BitBake +<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ +extension accordingly. -Setting Up to Use Windows Subsystem For Linux (WSLv2) +Setting Up to Use Windows Subsystem For Linux (WSL 2) ----------------------------------------------------- -With `Windows Subsystem for Linux -(WSLv2) <https://docs.microsoft.com/en-us/windows/wsl/wsl2-about>`__, +With `Windows Subsystem for Linux (WSL 2) +<https://learn.microsoft.com/en-us/windows/wsl/>`__, you can create a Yocto Project development environment that allows you to build on Windows. You can set up a Linux distribution inside Windows in which you can develop using the Yocto Project. -Follow these general steps to prepare a Windows machine using WSLv2 as +Follow these general steps to prepare a Windows machine using WSL 2 as your Yocto Project build host: -1. *Make sure your Windows 10 machine is capable of running WSLv2:* - WSLv2 is only available for Windows 10 builds > 18917. To check which - build version you are running, you may open a command prompt on - Windows and execute the command "ver". - :: +#. *Make sure your Windows machine is capable of running WSL 2:* + + While all Windows 11 and Windows Server 2022 builds support WSL 2, + the first versions of Windows 10 and Windows Server 2019 didn't. + Check the minimum build numbers for `Windows 10 + <https://learn.microsoft.com/en-us/windows/wsl/install-manual#step-2---check-requirements-for-running-wsl-2>`__ + and for `Windows Server 2019 + <https://learn.microsoft.com/en-us/windows/wsl/install-on-server>`__. + + To check which build version you are running, you may open a command + prompt on Windows and execute the command "ver":: C:\Users\myuser> ver Microsoft Windows [Version 10.0.19041.153] - If your build is capable of running - WSLv2 you may continue, for more information on this subject or - instructions on how to upgrade to WSLv2 visit `Windows 10 - WSLv2 <https://docs.microsoft.com/en-us/windows/wsl/wsl2-install>`__ - -2. *Install the Linux distribution of your choice inside Windows 10:* - Once you know your version of Windows 10 supports WSLv2, you can +#. *Install the Linux distribution of your choice inside WSL 2:* + Once you know your version of Windows supports WSL 2, you can install the distribution of your choice from the Microsoft Store. Open the Microsoft Store and search for Linux. While there are several Linux distributions available, the assumption is that your @@ -476,35 +472,33 @@ your Yocto Project build host: making your selection, simply click "Get" to download and install the distribution. -3. *Check your Linux distribution is using WSLv2:* Open a Windows +#. *Check which Linux distribution WSL 2 is using:* Open a Windows PowerShell and run:: C:\WINDOWS\system32> wsl -l -v NAME STATE VERSION *Ubuntu Running 2 - Note the version column which says the WSL version - being used by your distribution, on compatible systems, this can be - changed back at any point in time. + Note that WSL 2 supports running as many different Linux distributions + as you want to install. -4. *Optionally Orient Yourself on WSL:* If you are unfamiliar with WSL, - you can learn more here - +#. *Optionally Get Familiar with WSL:* You can learn more on https://docs.microsoft.com/en-us/windows/wsl/wsl2-about. -5. *Launch your WSL Distibution:* From the Windows start menu simply +#. *Launch your WSL Distibution:* From the Windows start menu simply launch your WSL distribution just like any other application. -6. *Optimize your WSLv2 storage often:* Due to the way storage is - handled on WSLv2, the storage space used by the undelying Linux - distribution is not reflected immedately, and since bitbake heavily +#. *Optimize your WSL 2 storage often:* Due to the way storage is + handled on WSL 2, the storage space used by the underlying Linux + distribution is not reflected immediately, and since BitBake heavily uses storage, after several builds, you may be unaware you are - running out of space. WSLv2 uses a VHDX file for storage, this issue - can be easily avoided by manually optimizing this file often, this - can be done in the following way: + running out of space. As WSL 2 uses a VHDX file for storage, this issue + can be easily avoided by regularly optimizing this file in a manual way: + + 1. *Find the location of your VHDX file:* - 1. *Find the location of your VHDX file:* First you need to find the - distro app package directory, to achieve this open a Windows - Powershell as Administrator and run:: + First you need to find the distro app package directory, to achieve this + open a Windows Powershell as Administrator and run:: C:\WINDOWS\system32> Get-AppxPackage -Name "*Ubuntu*" | Select PackageFamilyName PackageFamilyName @@ -516,39 +510,60 @@ your Yocto Project build host: replace the PackageFamilyName and your user on the following path to find your VHDX file:: - ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ - Mode LastWriteTime Length Name - -a---- 3/14/2020 9:52 PM 57418973184 ext4.vhdx + ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ + Mode LastWriteTime Length Name + -a---- 3/14/2020 9:52 PM 57418973184 ext4.vhdx Your VHDX file path is: ``C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx`` - 2. *Optimize your VHDX file:* Open a Windows Powershell as - Administrator to optimize your VHDX file, shutting down WSL first:: + 2a. *Optimize your VHDX file using Windows Powershell:* + + To use the ``optimize-vhd`` cmdlet below, first install the Hyper-V + option on Windows. Then, open a Windows Powershell as Administrator to + optimize your VHDX file, shutting down WSL first:: C:\WINDOWS\system32> wsl --shutdown C:\WINDOWS\system32> optimize-vhd -Path C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx -Mode full - A progress bar should be shown while optimizing the - VHDX file, and storage should now be reflected correctly on the - Windows Explorer. + A progress bar should be shown while optimizing the + VHDX file, and storage should now be reflected correctly on the + Windows Explorer. + + 2b. *Optimize your VHDX file using DiskPart:* + + The ``optimize-vhd`` cmdlet noted in step 2a above is provided by + Hyper-V. Not all SKUs of Windows can install Hyper-V. As an alternative, + use the DiskPart tool. To start, open a Windows command prompt as + Administrator to optimize your VHDX file, shutting down WSL first:: + + C:\WINDOWS\system32> wsl --shutdown + C:\WINDOWS\system32> diskpart + + DISKPART> select vdisk file="<path_to_VHDX_file>" + DISKPART> attach vdisk readonly + DISKPART> compact vdisk + DISKPART> exit .. note:: - The current implementation of WSLv2 does not have out-of-the-box + The current implementation of WSL 2 does not have out-of-the-box access to external devices such as those connected through a USB port, but it automatically mounts your ``C:`` drive on ``/mnt/c/`` (and others), which you can use to share deploy artifacts to be later - flashed on hardware through Windows, but your build directory should - not reside inside this mountpoint. + flashed on hardware through Windows, but your :term:`Build Directory` + should not reside inside this mountpoint. -Once you have WSLv2 set up, everything is in place to develop just as if +Once you have WSL 2 set up, everything is in place to develop just as if you were running on a native Linux machine. If you are going to use the Extensible SDK container, see the ":doc:`/sdk-manual/extensible`" Chapter in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you are going to use the Toaster container, see the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. +section in the Toaster User Manual. If you are a VSCode user, you can configure +the `Yocto Project BitBake +<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ +extension accordingly. Locating Yocto Project Source Files =================================== @@ -578,14 +593,14 @@ repository at :yocto_git:`/poky`. Use the following procedure to locate the latest upstream copy of the ``poky`` Git repository: -1. *Access Repositories:* Open a browser and go to +#. *Access Repositories:* Open a browser and go to :yocto_git:`/` to access the GUI-based interface into the Yocto Project source repositories. -2. *Select the Repository:* Click on the repository in which you are +#. *Select the Repository:* Click on the repository in which you are interested (e.g. ``poky``). -3. *Find the URL Used to Clone the Repository:* At the bottom of the +#. *Find the URL Used to Clone the Repository:* At the bottom of the page, note the URL used to clone that repository (e.g. :yocto_git:`/poky`). @@ -594,65 +609,43 @@ Use the following procedure to locate the latest upstream copy of the For information on cloning a repository, see the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" section. -Accessing Index of Releases ---------------------------- +Accessing Source Archives +------------------------- -Yocto Project maintains an Index of Releases area that contains related -files that contribute to the Yocto Project. Rather than Git -repositories, these files are tarballs that represent snapshots in time -of a given component. +The Yocto Project also provides source archives of its releases, which +are available on :yocto_dl:`/releases/yocto/`. Then, choose the subdirectory +containing the release you wish to use, for example +:yocto_dl:`yocto-&DISTRO; </releases/yocto/yocto-&DISTRO;/>`. + +You will find there source archives of individual components (if you wish +to use them individually), and of the corresponding Poky release bundling +a selection of these components. .. note:: The recommended method for accessing Yocto Project components is to use Git to clone the upstream repository and work from within that - locally cloned repository. However, this section documents how to - use a tarball snapshot of any given component. - -Follow these steps to locate and download a particular tarball: - -1. *Access the Index of Releases:* Open a browser and go to - :yocto_dl:`Index of Releases </releases>`. The - list represents released components (e.g. ``bitbake``, ``sato``, and - so on). - - .. note:: - - The ``yocto`` directory contains the full array of released Poky - tarballs. The ``poky`` directory in the Index of Releases was - historically used for very early releases and exists now only for - retroactive completeness. - -2. *Select a Component:* Click on any released component in which you - are interested (e.g. ``yocto``). - -3. *Find the Tarball:* Drill down to find the associated tarball. For - example, click on ``yocto-&DISTRO;`` to view files associated with the - Yocto Project &DISTRO; release (e.g. - ``&YOCTO_POKY;.tar.bz2``, which is the - released Poky tarball). - -4. *Download the Tarball:* Click the tarball to download and save a - snapshot of the given component. + locally cloned repository. Using the Downloads Page ------------------------ -The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page +The :yocto_home:`Yocto Project Website <>` uses a "RELEASES" page from which you can locate and download tarballs of any Yocto Project release. Rather than Git repositories, these files represent snapshot tarballs similar to the tarballs located in the Index of Releases -described in the ":ref:`dev-manual/start:accessing index of releases`" section. +described in the ":ref:`dev-manual/start:accessing source archives`" section. -1. *Go to the Yocto Project Website:* Open The +#. *Go to the Yocto Project Website:* Open The :yocto_home:`Yocto Project Website <>` in your browser. -2. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the - pull-down "SOFTWARE" tab menu near the top of the page. +#. *Get to the Downloads Area:* Select the "RELEASES" item from the + pull-down "DEVELOPMENT" tab menu near the top of the page. -3. *Select a Yocto Project Release:* Use the menu next to "RELEASE" to - display and choose a recent or past supported Yocto Project release - (e.g. &DISTRO_NAME_NO_CAP;, &DISTRO_NAME_NO_CAP_MINUS_ONE;, and so forth). +#. *Select a Yocto Project Release:* On the top of the "RELEASE" page currently + supported releases are displayed, further down past supported Yocto Project + releases are visible. The "Download" links in the rows of the table there + will lead to the download tarballs for the release. .. note:: @@ -662,9 +655,9 @@ described in the ":ref:`dev-manual/start:accessing index of releases`" section. You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto Project releases. -4. *Download Tools or Board Support Packages (BSPs):* From the - "DOWNLOADS" page, you can download tools or BSPs as well. Just scroll - down the page and look for what you need. +#. *Download Tools or Board Support Packages (BSPs):* Next to the tarballs you + will find download tools or BSPs as well. Just select a Yocto Project + release and look for what you need. Cloning and Checking Out Branches ================================= @@ -690,10 +683,10 @@ Cloning the ``poky`` Repository Follow these steps to create a local version of the upstream :term:`Poky` Git repository. -1. *Set Your Directory:* Change your working directory to where you want +#. *Set Your Directory:* Change your working directory to where you want to create your local copy of ``poky``. -2. *Clone the Repository:* The following example command clones the +#. *Clone the Repository:* The following example command clones the ``poky`` repository and uses the default name "poky" for your local repository:: @@ -749,13 +742,13 @@ and then specifically check out that development branch. Further development on top of the branch that occurs after check it out can occur. -1. *Switch to the Poky Directory:* If you have a local poky Git +#. *Switch to the Poky Directory:* If you have a local poky Git repository, switch to that directory. If you do not have the local copy of poky, see the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" section. -2. *Determine Existing Branch Names:* +#. *Determine Existing Branch Names:* :: $ git branch -a @@ -776,7 +769,7 @@ and then specifically check out that development branch. remotes/origin/zeus-next ... and so on ... -3. *Check out the Branch:* Check out the development branch in which you +#. *Check out the Branch:* Check out the development branch in which you want to work. For example, to access the files for the Yocto Project &DISTRO; Release (&DISTRO_NAME;), use the following command:: @@ -810,19 +803,19 @@ similar to checking out by branch name except you use tag names. Checking out a branch based on a tag gives you a stable set of files not affected by development on the branch above the tag. -1. *Switch to the Poky Directory:* If you have a local poky Git +#. *Switch to the Poky Directory:* If you have a local poky Git repository, switch to that directory. If you do not have the local copy of poky, see the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" section. -2. *Fetch the Tag Names:* To checkout the branch based on a tag name, +#. *Fetch the Tag Names:* To checkout the branch based on a tag name, you need to fetch the upstream tags into your local repository:: $ git fetch --tags $ -3. *List the Tag Names:* You can list the tag names now:: +#. *List the Tag Names:* You can list the tag names now:: $ git tag 1.1_M1.final @@ -844,7 +837,7 @@ similar to checking out by branch name except you use tag names. yocto_1.5_M5.rc8 -4. *Check out the Branch:* +#. *Check out the Branch:* :: $ git checkout tags/yocto-&DISTRO; -b my_yocto_&DISTRO; diff --git a/documentation/dev-manual/temporary-source-code.rst b/documentation/dev-manual/temporary-source-code.rst new file mode 100644 index 0000000000..08bf68d982 --- /dev/null +++ b/documentation/dev-manual/temporary-source-code.rst @@ -0,0 +1,66 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Finding Temporary Source Code +***************************** + +You might find it helpful during development to modify the temporary +source code used by recipes to build packages. For example, suppose you +are developing a patch and you need to experiment a bit to figure out +your solution. After you have initially built the package, you can +iteratively tweak the source code, which is located in the +:term:`Build Directory`, and then you can force a re-compile and quickly +test your altered code. Once you settle on a solution, you can then preserve +your changes in the form of patches. + +During a build, the unpacked temporary source code used by recipes to +build packages is available in the :term:`Build Directory` as defined by the +:term:`S` variable. Below is the default value for the :term:`S` variable as +defined in the ``meta/conf/bitbake.conf`` configuration file in the +:term:`Source Directory`:: + + S = "${WORKDIR}/${BP}" + +You should be aware that many recipes override the +:term:`S` variable. For example, recipes that fetch their source from Git +usually set :term:`S` to ``${WORKDIR}/git``. + +.. note:: + + The :term:`BP` represents the base recipe name, which consists of the name + and version:: + + BP = "${BPN}-${PV}" + + +The path to the work directory for the recipe +(:term:`WORKDIR`) is defined as +follows:: + + ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} + +The actual directory depends on several things: + +- :term:`TMPDIR`: The top-level build + output directory. + +- :term:`MULTIMACH_TARGET_SYS`: + The target system identifier. + +- :term:`PN`: The recipe name. + +- :term:`EXTENDPE`: The epoch --- if + :term:`PE` is not specified, which is + usually the case for most recipes, then :term:`EXTENDPE` is blank. + +- :term:`PV`: The recipe version. + +- :term:`PR`: The recipe revision. + +As an example, assume a Source Directory top-level folder named +``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.bb``. In this case, the work directory the +build system uses to build the package would be as follows:: + + poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 + diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst new file mode 100644 index 0000000000..4fac78bdfb --- /dev/null +++ b/documentation/dev-manual/upgrading-recipes.rst @@ -0,0 +1,397 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Upgrading Recipes +***************** + +Over time, upstream developers publish new versions for software built +by layer recipes. It is recommended to keep recipes up-to-date with +upstream version releases. + +While there are several methods to upgrade a recipe, you might +consider checking on the upgrade status of a recipe first. You can do so +using the ``devtool check-upgrade-status`` command. See the +":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" +section in the Yocto Project Reference Manual for more information. + +The remainder of this section describes three ways you can upgrade a +recipe. You can use the Automated Upgrade Helper (AUH) to set up +automatic version upgrades. Alternatively, you can use +``devtool upgrade`` to set up semi-automatic version upgrades. Finally, +you can manually upgrade a recipe by editing the recipe itself. + +Using the Auto Upgrade Helper (AUH) +=================================== + +The AUH utility works in conjunction with the OpenEmbedded build system +in order to automatically generate upgrades for recipes based on new +versions being published upstream. Use AUH when you want to create a +service that performs the upgrades automatically and optionally sends +you an email with the results. + +AUH allows you to update several recipes with a single use. You can also +optionally perform build and integration tests using images with the +results saved to your hard drive and emails of results optionally sent +to recipe maintainers. Finally, AUH creates Git commits with appropriate +commit messages in the layer's tree for the changes made to recipes. + +.. note:: + + In some conditions, you should not use AUH to upgrade recipes + and should instead use either ``devtool upgrade`` or upgrade your + recipes manually: + + - When AUH cannot complete the upgrade sequence. This situation + usually results because custom patches carried by the recipe + cannot be automatically rebased to the new version. In this case, + ``devtool upgrade`` allows you to manually resolve conflicts. + + - When for any reason you want fuller control over the upgrade + process. For example, when you want special arrangements for + testing. + +The following steps describe how to set up the AUH utility: + +#. *Be Sure the Development Host is Set Up:* You need to be sure that + your development host is set up to use the Yocto Project. For + information on how to set up your host, see the + ":ref:`dev-manual/start:Preparing the Build Host`" section. + +#. *Make Sure Git is Configured:* The AUH utility requires Git to be + configured because AUH uses Git to save upgrades. Thus, you must have + Git user and email configured. The following command shows your + configurations:: + + $ git config --list + + If you do not have the user and + email configured, you can use the following commands to do so:: + + $ git config --global user.name some_name + $ git config --global user.email username@domain.com + +#. *Clone the AUH Repository:* To use AUH, you must clone the repository + onto your development host. The following command uses Git to create + a local copy of the repository on your system:: + + $ git clone git://git.yoctoproject.org/auto-upgrade-helper + Cloning into 'auto-upgrade-helper'... remote: Counting objects: 768, done. + remote: Compressing objects: 100% (300/300), done. + remote: Total 768 (delta 499), reused 703 (delta 434) + Receiving objects: 100% (768/768), 191.47 KiB | 98.00 KiB/s, done. + Resolving deltas: 100% (499/499), done. + Checking connectivity... done. + + AUH is not part of the :term:`OpenEmbedded-Core (OE-Core)` or + :term:`Poky` repositories. + +#. *Create a Dedicated Build Directory:* Run the :ref:`structure-core-script` + script to create a fresh :term:`Build Directory` that you use exclusively + for running the AUH utility:: + + $ cd poky + $ source oe-init-build-env your_AUH_build_directory + + Re-using an existing :term:`Build Directory` and its configurations is not + recommended as existing settings could cause AUH to fail or behave + undesirably. + +#. *Make Configurations in Your Local Configuration File:* Several + settings are needed in the ``local.conf`` file in the build + directory you just created for AUH. Make these following + configurations: + + - If you want to enable :ref:`Build + History <dev-manual/build-quality:maintaining build output quality>`, + which is optional, you need the following lines in the + ``conf/local.conf`` file:: + + INHERIT =+ "buildhistory" + BUILDHISTORY_COMMIT = "1" + + With this configuration and a successful + upgrade, a build history "diff" file appears in the + ``upgrade-helper/work/recipe/buildhistory-diff.txt`` file found in + your :term:`Build Directory`. + + - If you want to enable testing through the :ref:`ref-classes-testimage` + class, which is optional, you need to have the following set in + your ``conf/local.conf`` file:: + + IMAGE_CLASSES += "testimage" + + .. note:: + + If your distro does not enable by default ptest, which Poky + does, you need the following in your ``local.conf`` file:: + + DISTRO_FEATURES:append = " ptest" + + +#. *Optionally Start a vncserver:* If you are running in a server + without an X11 session, you need to start a vncserver:: + + $ vncserver :1 + $ export DISPLAY=:1 + +#. *Create and Edit an AUH Configuration File:* You need to have the + ``upgrade-helper/upgrade-helper.conf`` configuration file in your + :term:`Build Directory`. You can find a sample configuration file in the + :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`. + + Read through the sample file and make configurations as needed. For + example, if you enabled build history in your ``local.conf`` as + described earlier, you must enable it in ``upgrade-helper.conf``. + + Also, if you are using the default ``maintainers.inc`` file supplied + with Poky and located in ``meta-yocto`` and you do not set a + "maintainers_whitelist" or "global_maintainer_override" in the + ``upgrade-helper.conf`` configuration, and you specify "-e all" on + the AUH command-line, the utility automatically sends out emails to + all the default maintainers. Please avoid this. + +This next set of examples describes how to use the AUH: + +- *Upgrading a Specific Recipe:* To upgrade a specific recipe, use the + following form:: + + $ upgrade-helper.py recipe_name + + For example, this command upgrades the ``xmodmap`` recipe:: + + $ upgrade-helper.py xmodmap + +- *Upgrading a Specific Recipe to a Particular Version:* To upgrade a + specific recipe to a particular version, use the following form:: + + $ upgrade-helper.py recipe_name -t version + + For example, this command upgrades the ``xmodmap`` recipe to version 1.2.3:: + + $ upgrade-helper.py xmodmap -t 1.2.3 + +- *Upgrading all Recipes to the Latest Versions and Suppressing Email + Notifications:* To upgrade all recipes to their most recent versions + and suppress the email notifications, use the following command:: + + $ upgrade-helper.py all + +- *Upgrading all Recipes to the Latest Versions and Send Email + Notifications:* To upgrade all recipes to their most recent versions + and send email messages to maintainers for each attempted recipe as + well as a status email, use the following command:: + + $ upgrade-helper.py -e all + +Once you have run the AUH utility, you can find the results in the AUH +:term:`Build Directory`:: + + ${BUILDDIR}/upgrade-helper/timestamp + +The AUH utility +also creates recipe update commits from successful upgrade attempts in +the layer tree. + +You can easily set up to run the AUH utility on a regular basis by using +a cron job. See the +:yocto_git:`weeklyjob.sh </auto-upgrade-helper/tree/weeklyjob.sh>` +file distributed with the utility for an example. + +Using ``devtool upgrade`` +========================= + +As mentioned earlier, an alternative method for upgrading recipes to +newer versions is to use +:doc:`devtool upgrade </ref-manual/devtool-reference>`. +You can read about ``devtool upgrade`` in general 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. + +To see all the command-line options available with ``devtool upgrade``, +use the following help command:: + + $ devtool upgrade -h + +If you want to find out what version a recipe is currently at upstream +without any attempt to upgrade your local version of the recipe, you can +use the following command:: + + $ devtool latest-version recipe_name + +As mentioned in the previous section describing AUH, ``devtool upgrade`` +works in a less-automated manner than AUH. Specifically, +``devtool upgrade`` only works on a single recipe that you name on the +command line, cannot perform build and integration testing using images, +and does not automatically generate commits for changes in the source +tree. Despite all these "limitations", ``devtool upgrade`` updates the +recipe file to the new upstream version and attempts to rebase custom +patches contained by the recipe as needed. + +.. note:: + + AUH uses much of ``devtool upgrade`` behind the scenes making AUH somewhat + of a "wrapper" application for ``devtool upgrade``. + +A typical scenario involves having used Git to clone an upstream +repository that you use during build operations. Because you have built the +recipe in the past, the layer is likely added to your +configuration already. If for some reason, the layer is not added, you +could add it easily using the +":ref:`bitbake-layers <bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script>`" +script. For example, suppose you use the ``nano.bb`` recipe from the +``meta-oe`` layer in the ``meta-openembedded`` repository. For this +example, assume that the layer has been cloned into following area:: + + /home/scottrif/meta-openembedded + +The following command from your :term:`Build Directory` adds the layer to +your build configuration (i.e. ``${BUILDDIR}/conf/bblayers.conf``):: + + $ bitbake-layers add-layer /home/scottrif/meta-openembedded/meta-oe + NOTE: Starting bitbake server... + Parsing recipes: 100% |##########################################| Time: 0:00:55 + Parsing of 1431 .bb files complete (0 cached, 1431 parsed). 2040 targets, 56 skipped, 0 masked, 0 errors. + Removing 12 recipes from the x86_64 sysroot: 100% |##############| Time: 0:00:00 + Removing 1 recipes from the x86_64_i586 sysroot: 100% |##########| Time: 0:00:00 + Removing 5 recipes from the i586 sysroot: 100% |#################| Time: 0:00:00 + Removing 5 recipes from the qemux86 sysroot: 100% |##############| Time: 0:00:00 + +For this example, assume that the ``nano.bb`` recipe that +is upstream has a 2.9.3 version number. However, the version in the +local repository is 2.7.4. The following command from your build +directory automatically upgrades the recipe for you:: + + $ devtool upgrade nano -V 2.9.3 + NOTE: Starting bitbake server... + NOTE: Creating workspace layer in /home/scottrif/poky/build/workspace + Parsing recipes: 100% |##########################################| Time: 0:00:46 + Parsing of 1431 .bb files complete (0 cached, 1431 parsed). 2040 targets, 56 skipped, 0 masked, 0 errors. + NOTE: Extracting current version source... + NOTE: Resolving any missing task queue dependencies + . + . + . + NOTE: Executing SetScene Tasks + NOTE: Executing RunQueue Tasks + NOTE: Tasks Summary: Attempted 74 tasks of which 72 didn't need to be rerun and all succeeded. + Adding changed files: 100% |#####################################| Time: 0:00:00 + NOTE: Upgraded source extracted to /home/scottrif/poky/build/workspace/sources/nano + NOTE: New recipe is /home/scottrif/poky/build/workspace/recipes/nano/nano_2.9.3.bb + +.. note:: + + Using the ``-V`` option is not necessary. Omitting the version number causes + ``devtool upgrade`` to upgrade the recipe to the most recent version. + +Continuing with this example, you can use ``devtool build`` to build the +newly upgraded recipe:: + + $ devtool build nano + NOTE: Starting bitbake server... + Loading cache: 100% |################################################################################################| Time: 0:00:01 + Loaded 2040 entries from dependency cache. + Parsing recipes: 100% |##############################################################################################| Time: 0:00:00 + Parsing of 1432 .bb files complete (1431 cached, 1 parsed). 2041 targets, 56 skipped, 0 masked, 0 errors. + NOTE: Resolving any missing task queue dependencies + . + . + . + NOTE: Executing SetScene Tasks + NOTE: Executing RunQueue Tasks + NOTE: nano: compiling from external source tree /home/scottrif/poky/build/workspace/sources/nano + NOTE: Tasks Summary: Attempted 520 tasks of which 304 didn't need to be rerun and all succeeded. + +Within the ``devtool upgrade`` workflow, you can +deploy and test your rebuilt software. For this example, +however, running ``devtool finish`` cleans up the workspace once the +source in your workspace is clean. This usually means using Git to stage +and submit commits for the changes generated by the upgrade process. + +Once the tree is clean, you can clean things up in this example with the +following command from the ``${BUILDDIR}/workspace/sources/nano`` +directory:: + + $ devtool finish nano meta-oe + NOTE: Starting bitbake server... + Loading cache: 100% |################################################################################################| Time: 0:00:00 + Loaded 2040 entries from dependency cache. + Parsing recipes: 100% |##############################################################################################| Time: 0:00:01 + Parsing of 1432 .bb files complete (1431 cached, 1 parsed). 2041 targets, 56 skipped, 0 masked, 0 errors. + NOTE: Adding new patch 0001-nano.bb-Stuff-I-changed-when-upgrading-nano.bb.patch + NOTE: Updating recipe nano_2.9.3.bb + NOTE: Removing file /home/scottrif/meta-openembedded/meta-oe/recipes-support/nano/nano_2.7.4.bb + NOTE: Moving recipe file to /home/scottrif/meta-openembedded/meta-oe/recipes-support/nano + NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/nano as-is; if you no longer need it then please delete it manually + + +Using the ``devtool finish`` command cleans up the workspace and creates a patch +file based on your commits. The tool puts all patch files back into the +source directory in a sub-directory named ``nano`` in this case. + +Manually Upgrading a Recipe +=========================== + +If for some reason you choose not to upgrade recipes using +:ref:`dev-manual/upgrading-recipes:Using the Auto Upgrade Helper (AUH)` or +by :ref:`dev-manual/upgrading-recipes:Using \`\`devtool upgrade\`\``, +you can manually edit the recipe files to upgrade the versions. + +.. note:: + + Manually updating multiple recipes scales poorly and involves many + steps. The recommendation to upgrade recipe versions is through AUH + or ``devtool upgrade``, both of which automate some steps and provide + guidance for others needed for the manual process. + +To manually upgrade recipe versions, follow these general steps: + +#. *Change the Version:* Rename the recipe such that the version (i.e. + the :term:`PV` part of the recipe name) + changes appropriately. If the version is not part of the recipe name, + change the value as it is set for :term:`PV` within the recipe itself. + +#. *Update* :term:`SRCREV` *if Needed*: If the source code your recipe builds + is fetched from Git or some other version control system, update + :term:`SRCREV` to point to the + commit hash that matches the new version. + +#. *Build the Software:* Try to build the recipe using BitBake. Typical + build failures include the following: + + - License statements were updated for the new version. For this + case, you need to review any changes to the license and update the + values of :term:`LICENSE` and + :term:`LIC_FILES_CHKSUM` + as needed. + + .. note:: + + License changes are often inconsequential. For example, the + license text's copyright year might have changed. + + - Custom patches carried by the older version of the recipe might + fail to apply to the new version. For these cases, you need to + review the failures. Patches might not be necessary for the new + version of the software if the upgraded version has fixed those + issues. If a patch is necessary and failing, you need to rebase it + into the new version. + +#. *Optionally Attempt to Build for Several Architectures:* Once you + successfully build the new software for a given architecture, you + could test the build for other architectures by changing the + :term:`MACHINE` variable and + rebuilding the software. This optional step is especially important + if the recipe is to be released publicly. + +#. *Check the Upstream Change Log or Release Notes:* Checking both these + reveals if there are new features that could break + backwards-compatibility. If so, you need to take steps to mitigate or + eliminate that situation. + +#. *Optionally Create a Bootable Image and Test:* If you want, you can + test the new software by booting it onto actual hardware. + +#. *Create a Commit with the Change in the Layer Repository:* After all + builds work and any testing is successful, you can create commits for + any changes in the layer holding your upgraded recipe. + diff --git a/documentation/dev-manual/vulnerabilities.rst b/documentation/dev-manual/vulnerabilities.rst new file mode 100644 index 0000000000..1bc2a85929 --- /dev/null +++ b/documentation/dev-manual/vulnerabilities.rst @@ -0,0 +1,293 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Checking for Vulnerabilities +**************************** + +Vulnerabilities in Poky and OE-Core +=================================== + +The Yocto Project has an infrastructure to track and address unfixed +known security vulnerabilities, as tracked by the public +:wikipedia:`Common Vulnerabilities and Exposures (CVE) <Common_Vulnerabilities_and_Exposures>` +database. + +The Yocto Project maintains a `list of known vulnerabilities +<https://autobuilder.yocto.io/pub/non-release/patchmetrics/>`__ +for packages in Poky and OE-Core, tracking the evolution of the number of +unpatched CVEs and the status of patches. Such information is available for +the current development version and for each supported release. + +Security is a process, not a product, and thus at any time, a number of security +issues may be impacting Poky and OE-Core. It is up to the maintainers, users, +contributors and anyone interested in the issues to investigate and possibly fix them by +updating software components to newer versions or by applying patches to address them. +It is recommended to work with Poky and OE-Core upstream maintainers and submit +patches to fix them, see ":doc:`../contributor-guide/submit-changes`" for details. + +Vulnerability check at build time +================================= + +To enable a check for CVE security vulnerabilities using +:ref:`ref-classes-cve-check` in the specific image or target you are building, +add the following setting to your configuration:: + + INHERIT += "cve-check" + +The CVE database contains some old incomplete entries which have been +deemed not to impact Poky or OE-Core. These CVE entries can be excluded from the +check using build configuration:: + + include conf/distro/include/cve-extra-exclusions.inc + +With this CVE check enabled, BitBake build will try to map each compiled software component +recipe name and version information to the CVE database and generate recipe and +image specific reports. These reports will contain: + +- metadata about the software component like names and versions + +- metadata about the CVE issue such as description and NVD link + +- for each software component, a list of CVEs which are possibly impacting this version + +- status of each CVE: ``Patched``, ``Unpatched`` or ``Ignored`` + +The status ``Patched`` means that a patch file to address the security issue has been +applied. ``Unpatched`` status means that no patches to address the issue have been +applied and that the issue needs to be investigated. ``Ignored`` means that after +analysis, it has been deemed to ignore the issue as it for example affects +the software component on a different operating system platform. + +After a build with CVE check enabled, reports for each compiled source recipe will be +found in ``build/tmp/deploy/cve``. + +For example the CVE check report for the ``flex-native`` recipe looks like:: + + $ cat poky/build/tmp/deploy/cve/flex-native + LAYER: meta + PACKAGE NAME: flex-native + PACKAGE VERSION: 2.6.4 + CVE: CVE-2016-6354 + CVE STATUS: Patched + CVE SUMMARY: Heap-based buffer overflow in the yy_get_next_buffer function in Flex before 2.6.1 might allow context-dependent attackers to cause a denial of service or possibly execute arbitrary code via vectors involving num_to_read. + CVSS v2 BASE SCORE: 7.5 + CVSS v3 BASE SCORE: 9.8 + VECTOR: NETWORK + MORE INFORMATION: https://nvd.nist.gov/vuln/detail/CVE-2016-6354 + + LAYER: meta + PACKAGE NAME: flex-native + PACKAGE VERSION: 2.6.4 + CVE: CVE-2019-6293 + CVE STATUS: Ignored + CVE SUMMARY: An issue was discovered in the function mark_beginning_as_normal in nfa.c in flex 2.6.4. There is a stack exhaustion problem caused by the mark_beginning_as_normal function making recursive calls to itself in certain scenarios involving lots of '*' characters. Remote attackers could leverage this vulnerability to cause a denial-of-service. + CVSS v2 BASE SCORE: 4.3 + CVSS v3 BASE SCORE: 5.5 + VECTOR: NETWORK + MORE INFORMATION: https://nvd.nist.gov/vuln/detail/CVE-2019-6293 + +For images, a summary of all recipes included in the image and their CVEs is also +generated in textual and JSON formats. These ``.cve`` and ``.json`` reports can be found +in the ``tmp/deploy/images`` directory for each compiled image. + +At build time CVE check will also throw warnings about ``Unpatched`` CVEs:: + + WARNING: flex-2.6.4-r0 do_cve_check: Found unpatched CVE (CVE-2019-6293), for more information check /poky/build/tmp/work/core2-64-poky-linux/flex/2.6.4-r0/temp/cve.log + WARNING: libarchive-3.5.1-r0 do_cve_check: Found unpatched CVE (CVE-2021-36976), for more information check /poky/build/tmp/work/core2-64-poky-linux/libarchive/3.5.1-r0/temp/cve.log + +It is also possible to check the CVE status of individual packages as follows:: + + bitbake -c cve_check flex libarchive + +Fixing CVE product name and version mappings +============================================ + +By default, :ref:`ref-classes-cve-check` uses the recipe name :term:`BPN` as CVE +product name when querying the CVE database. If this mapping contains false positives, e.g. +some reported CVEs are not for the software component in question, or false negatives like +some CVEs are not found to impact the recipe when they should, then the problems can be +in the recipe name to CVE product mapping. These mapping issues can be fixed by setting +the :term:`CVE_PRODUCT` variable inside the recipe. This defines the name of the software component in the +upstream `NIST CVE database <https://nvd.nist.gov/>`__. + +The variable supports using vendor and product names like this:: + + CVE_PRODUCT = "flex_project:flex" + +In this example the vendor name used in the CVE database is ``flex_project`` and the +product is ``flex``. With this setting the ``flex`` recipe only maps to this specific +product and not products from other vendors with same name ``flex``. + +Similarly, when the recipe version :term:`PV` is not compatible with software versions used by +the upstream software component releases and the CVE database, these can be fixed using +the :term:`CVE_VERSION` variable. + +Note that if the CVE entries in the NVD database contain bugs or have missing or incomplete +information, it is recommended to fix the information there directly instead of working +around the issues possibly for a long time in Poky and OE-Core side recipes. Feedback to +NVD about CVE entries can be provided through the `NVD contact form <https://nvd.nist.gov/info/contact-form>`__. + +Fixing vulnerabilities in recipes +================================= + +Suppose a CVE security issue impacts a software component. In that case, it can +be fixed by updating to a newer version, by applying a patch, or by marking it +as patched via :term:`CVE_STATUS` variable flag. For Poky and OE-Core master +branches, updating to a more recent software component release with fixes is +the best option, but patches can be applied if releases are not yet available. + +For stable branches, we want to avoid API (Application Programming Interface) +or ABI (Application Binary Interface) breakages. When submitting an update, +a minor version update of a component is preferred if the version is +backward-compatible. Many software components have backward-compatible stable +versions, with a notable example of the Linux kernel. However, if the new +version does or likely might introduce incompatibilities, extracting and +backporting patches is preferred. + +Here is an example of fixing CVE security issues with patch files, +an example from the :oe_layerindex:`ffmpeg recipe for dunfell </layerindex/recipe/122174>`:: + + SRC_URI = "https://www.ffmpeg.org/releases/${BP}.tar.xz \ + file://mips64_cpu_detection.patch \ + file://CVE-2020-12284.patch \ + file://0001-libavutil-include-assembly-with-full-path-from-sourc.patch \ + file://CVE-2021-3566.patch \ + file://CVE-2021-38291.patch \ + file://CVE-2022-1475.patch \ + file://CVE-2022-3109.patch \ + file://CVE-2022-3341.patch \ + file://CVE-2022-48434.patch \ + " + +The recipe has both generic and security-related fixes. The CVE patch files are named +according to the CVE they fix. + +When preparing the patch file, take the original patch from the upstream repository. +Do not use patches from different distributions, except if it is the only available source. + +Modify the patch adding OE-related metadata. We will follow the example of the +``CVE-2022-3341.patch``. + +The original `commit message <https://github.com/FFmpeg/FFmpeg/commit/9cf652cef49d74afe3d454f27d49eb1a1394951e.patch/>`__ +is:: + + From 9cf652cef49d74afe3d454f27d49eb1a1394951e Mon Sep 17 00:00:00 2001 + From: Jiasheng Jiang <jiasheng@iscas.ac.cn> + Date: Wed, 23 Feb 2022 10:31:59 +0800 + Subject: [PATCH] avformat/nutdec: Add check for avformat_new_stream + + Check for failure of avformat_new_stream() and propagate + the error code. + + Signed-off-by: Michael Niedermayer <michael@niedermayer.cc> + --- + libavformat/nutdec.c | 16 ++++++++++++---- + 1 file changed, 12 insertions(+), 4 deletions(-) + + +For the correct operations of the ``cve-check``, it requires the CVE +identification in a ``CVE:`` tag of the patch file commit message using +the format:: + + CVE: CVE-2022-3341 + +It is also recommended to add the ``Upstream-Status:`` tag with a link +to the original patch and sign-off by people working on the backport. +If there are any modifications to the original patch, note them in +the ``Comments:`` tag. + +With the additional information, the header of the patch file in OE-core becomes:: + + From 9cf652cef49d74afe3d454f27d49eb1a1394951e Mon Sep 17 00:00:00 2001 + From: Jiasheng Jiang <jiasheng@iscas.ac.cn> + Date: Wed, 23 Feb 2022 10:31:59 +0800 + Subject: [PATCH] avformat/nutdec: Add check for avformat_new_stream + + Check for failure of avformat_new_stream() and propagate + the error code. + + Signed-off-by: Michael Niedermayer <michael@niedermayer.cc> + + CVE: CVE-2022-3341 + + Upstream-Status: Backport [https://github.com/FFmpeg/FFmpeg/commit/9cf652cef49d74afe3d454f27d49eb1a1394951e] + + Comments: Refreshed Hunk + Signed-off-by: Narpat Mali <narpat.mali@windriver.com> + Signed-off-by: Bhabu Bindu <bhabu.bindu@kpit.com> + --- + libavformat/nutdec.c | 16 ++++++++++++---- + 1 file changed, 12 insertions(+), 4 deletions(-) + +A good practice is to include the CVE identifier in the patch file name, the patch file +commit message and optionally in the recipe commit message. + +CVE checker will then capture this information and change the CVE status to ``Patched`` +in the generated reports. + +If analysis shows that the CVE issue does not impact the recipe due to configuration, platform, +version or other reasons, the CVE can be marked as ``Ignored`` by using +the :term:`CVE_STATUS` variable flag with appropriate reason which is mapped to ``Ignored``. +The entry should have the format like:: + + CVE_STATUS[CVE-2016-10642] = "cpe-incorrect: This is specific to the npm package that installs cmake, so isn't relevant to OpenEmbedded" + +As mentioned previously, if data in the CVE database is wrong, it is recommended +to fix those issues in the CVE database (NVD in the case of OE-core and Poky) +directly. + +Note that if there are many CVEs with the same status and reason, those can be +shared by using the :term:`CVE_STATUS_GROUPS` variable. + +Recipes can be completely skipped by CVE check by including the recipe name in +the :term:`CVE_CHECK_SKIP_RECIPE` variable. + +Implementation details +====================== + +Here's what the :ref:`ref-classes-cve-check` class does to find unpatched CVE IDs. + +First the code goes through each patch file provided by a recipe. If a valid CVE ID +is found in the name of the file, the corresponding CVE is considered as patched. +Don't forget that if multiple CVE IDs are found in the filename, only the last +one is considered. Then, the code looks for ``CVE: CVE-ID`` lines in the patch +file. The found CVE IDs are also considered as patched. +Additionally ``CVE_STATUS`` variable flags are parsed for reasons mapped to ``Patched`` +and these are also considered as patched. + +Then, the code looks up all the CVE IDs in the NIST database for all the +products defined in :term:`CVE_PRODUCT`. Then, for each found CVE: + +- If the package name (:term:`PN`) is part of + :term:`CVE_CHECK_SKIP_RECIPE`, it is considered as ``Patched``. + +- If the CVE ID has status ``CVE_STATUS[<CVE ID>] = "ignored"`` or if it's set to + any reason which is mapped to status ``Ignored`` via ``CVE_CHECK_STATUSMAP``, + it is set as ``Ignored``. + +- If the CVE ID is part of the patched CVE for the recipe, it is + already considered as ``Patched``. + +- Otherwise, the code checks whether the recipe version (:term:`PV`) + is within the range of versions impacted by the CVE. If so, the CVE + is considered as ``Unpatched``. + +The CVE database is stored in :term:`DL_DIR` and can be inspected using +``sqlite3`` command as follows:: + + sqlite3 downloads/CVE_CHECK/nvdcve_1.1.db .dump | grep CVE-2021-37462 + +When analyzing CVEs, it is recommended to: + +- study the latest information in `CVE database <https://nvd.nist.gov/vuln/search>`__. + +- check how upstream developers of the software component addressed the issue, e.g. + what patch was applied, which upstream release contains the fix. + +- check what other Linux distributions like `Debian <https://security-tracker.debian.org/tracker/>`__ + did to analyze and address the issue. + +- follow security notices from other Linux distributions. + +- follow public `open source security mailing lists <https://oss-security.openwall.org/wiki/mailing-lists>`__ for + discussions and advance notifications of CVE bugs and software releases with fixes. + diff --git a/documentation/dev-manual/wayland.rst b/documentation/dev-manual/wayland.rst new file mode 100644 index 0000000000..097be9cbde --- /dev/null +++ b/documentation/dev-manual/wayland.rst @@ -0,0 +1,90 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using Wayland and Weston +************************ + +:wikipedia:`Wayland <Wayland_(display_server_protocol)>` +is a computer display server protocol that provides a method for +compositing window managers to communicate directly with applications +and video hardware and expects them to communicate with input hardware +using other libraries. Using Wayland with supporting targets can result +in better control over graphics frame rendering than an application +might otherwise achieve. + +The Yocto Project provides the Wayland protocol libraries and the +reference :wikipedia:`Weston <Wayland_(display_server_protocol)#Weston>` +compositor as part of its release. You can find the integrated packages +in the ``meta`` layer of the :term:`Source Directory`. +Specifically, you +can find the recipes that build both Wayland and Weston at +``meta/recipes-graphics/wayland``. + +You can build both the Wayland and Weston packages for use only with targets +that accept the :wikipedia:`Mesa 3D and Direct Rendering Infrastructure +<Mesa_(computer_graphics)>`, which is also known as Mesa DRI. This implies that +you cannot build and use the packages if your target uses, for example, the +Intel Embedded Media and Graphics Driver (Intel EMGD) that overrides Mesa DRI. + +.. note:: + + Due to lack of EGL support, Weston 1.0.3 will not run directly on the + emulated QEMU hardware. However, this version of Weston will run + under X emulation without issues. + +This section describes what you need to do to implement Wayland and use +the Weston compositor when building an image for a supporting target. + +Enabling Wayland in an Image +============================ + +To enable Wayland, you need to enable it to be built and enable it to be +included (installed) in the image. + +Building Wayland +---------------- + +To cause Mesa to build the ``wayland-egl`` platform and Weston to build +Wayland with Kernel Mode Setting +(`KMS <https://wiki.archlinux.org/index.php/Kernel_Mode_Setting>`__) +support, include the "wayland" flag in the +:term:`DISTRO_FEATURES` +statement in your ``local.conf`` file:: + + DISTRO_FEATURES:append = " wayland" + +.. note:: + + If X11 has been enabled elsewhere, Weston will build Wayland with X11 + support + +Installing Wayland and Weston +----------------------------- + +To install the Wayland feature into an image, you must include the +following +:term:`CORE_IMAGE_EXTRA_INSTALL` +statement in your ``local.conf`` file:: + + CORE_IMAGE_EXTRA_INSTALL += "wayland weston" + +Running Weston +============== + +To run Weston inside X11, enabling it as described earlier and building +a Sato image is sufficient. If you are running your image under Sato, a +Weston Launcher appears in the "Utility" category. + +Alternatively, you can run Weston through the command-line interpretor +(CLI), which is better suited for development work. To run Weston under +the CLI, you need to do the following after your image is built: + +#. Run these commands to export ``XDG_RUNTIME_DIR``:: + + mkdir -p /tmp/$USER-weston + chmod 0700 /tmp/$USER-weston + export XDG_RUNTIME_DIR=/tmp/$USER-weston + +#. Launch Weston in the shell:: + + weston + diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst new file mode 100644 index 0000000000..a3880f3a1c --- /dev/null +++ b/documentation/dev-manual/wic.rst @@ -0,0 +1,731 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Creating Partitioned Images Using Wic +************************************* + +Creating an image for a particular hardware target using the +OpenEmbedded build system does not necessarily mean you can boot that +image as is on your device. Physical devices accept and boot images in +various ways depending on the specifics of the device. Usually, +information about the hardware can tell you what image format the device +requires. Should your device require multiple partitions on an SD card, +flash, or an HDD, you can use the OpenEmbedded Image Creator, Wic, to +create the properly partitioned image. + +The ``wic`` command generates partitioned images from existing +OpenEmbedded build artifacts. Image generation is driven by partitioning +commands contained in an OpenEmbedded kickstart file (``.wks``) +specified either directly on the command line or as one of a selection +of canned kickstart files as shown with the ``wic list images`` command +in the +":ref:`dev-manual/wic:generate an image using an existing kickstart file`" +section. When you apply the command to a given set of build artifacts, the +result is an image or set of images that can be directly written onto media and +used on a particular system. + +.. note:: + + For a kickstart file reference, see the + ":ref:`ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference`" + Chapter in the Yocto Project Reference Manual. + +The ``wic`` command and the infrastructure it is based on is by +definition incomplete. The purpose of the command is to allow the +generation of customized images, and as such, was designed to be +completely extensible through a plugin interface. See the +":ref:`dev-manual/wic:using the wic plugin interface`" section +for information on these plugins. + +This section provides some background information on Wic, describes what +you need to have in place to run the tool, provides instruction on how +to use the Wic utility, provides information on using the Wic plugins +interface, and provides several examples that show how to use Wic. + +Background +========== + +This section provides some background on the Wic utility. While none of +this information is required to use Wic, you might find it interesting. + +- The name "Wic" is derived from OpenEmbedded Image Creator (oeic). The + "oe" diphthong in "oeic" was promoted to the letter "w", because + "oeic" is both difficult to remember and to pronounce. + +- Wic is loosely based on the Meego Image Creator (``mic``) framework. + The Wic implementation has been heavily modified to make direct use + of OpenEmbedded build artifacts instead of package installation and + configuration, which are already incorporated within the OpenEmbedded + artifacts. + +- Wic is a completely independent standalone utility that initially + provides easier-to-use and more flexible replacements for an existing + functionality in OE-Core's :ref:`ref-classes-image-live` + class. The difference between Wic and those examples is that with Wic + the functionality of those scripts is implemented by a + general-purpose partitioning language, which is based on Redhat + kickstart syntax. + +Requirements +============ + +In order to use the Wic utility with the OpenEmbedded Build system, your +system needs to meet the following requirements: + +- The Linux distribution on your development host must support the + Yocto Project. See the ":ref:`system-requirements-supported-distros`" + section in the Yocto Project Reference Manual for the list of + distributions that support the Yocto Project. + +- The standard system utilities, such as ``cp``, must be installed on + your development host system. + +- You must have sourced the build environment setup script (i.e. + :ref:`structure-core-script`) found in the :term:`Build Directory`. + +- You need to have the build artifacts already available, which + typically means that you must have already created an image using the + OpenEmbedded build system (e.g. ``core-image-minimal``). While it + might seem redundant to generate an image in order to create an image + using Wic, the current version of Wic requires the artifacts in the + form generated by the OpenEmbedded build system. + +- You must build several native tools, which are built to run on the + build system:: + + $ bitbake wic-tools + +- Include "wic" as part of the + :term:`IMAGE_FSTYPES` + variable. + +- Include the name of the :ref:`wic kickstart file <openembedded-kickstart-wks-reference>` + as part of the :term:`WKS_FILE` variable. If multiple candidate files can + be provided by different layers, specify all the possible names through the + :term:`WKS_FILES` variable instead. + +Getting Help +============ + +You can get general help for the ``wic`` command by entering the ``wic`` +command by itself or by entering the command with a help argument as +follows:: + + $ wic -h + $ wic --help + $ wic help + +Currently, Wic supports seven commands: ``cp``, ``create``, ``help``, +``list``, ``ls``, ``rm``, and ``write``. You can get help for all these +commands except "help" by using the following form:: + + $ wic help command + +For example, the following command returns help for the ``write`` +command:: + + $ wic help write + +Wic supports help for three topics: ``overview``, ``plugins``, and +``kickstart``. You can get help for any topic using the following form:: + + $ wic help topic + +For example, the following returns overview help for Wic:: + + $ wic help overview + +There is one additional level of help for Wic. You can get help on +individual images through the ``list`` command. You can use the ``list`` +command to return the available Wic images as follows:: + + $ wic list images + genericx86 Create an EFI disk image for genericx86* + beaglebone-yocto Create SD card image for Beaglebone + qemuriscv Create qcow2 image for RISC-V QEMU machines + mkefidisk Create an EFI disk image + qemuloongarch Create qcow2 image for LoongArch QEMU machines + directdisk-multi-rootfs Create multi rootfs image using rootfs plugin + directdisk Create a 'pcbios' direct disk image + efi-bootdisk + mkhybridiso Create a hybrid ISO image + directdisk-gpt Create a 'pcbios' direct disk image + systemd-bootdisk Create an EFI disk image with systemd-boot + sdimage-bootpart Create SD card image with a boot partition + qemux86-directdisk Create a qemu machine 'pcbios' direct disk image + directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config + +Once you know the list of available +Wic images, you can use ``help`` with the command to get help on a +particular image. For example, the following command returns help on the +"beaglebone-yocto" image:: + + $ wic list beaglebone-yocto help + + Creates a partitioned SD card image for Beaglebone. + Boot files are located in the first vfat partition. + +Operational Modes +================= + +You can use Wic in two different modes, depending on how much control +you need for specifying the OpenEmbedded build artifacts that are used +for creating the image: Raw and Cooked: + +- *Raw Mode:* You explicitly specify build artifacts through Wic + command-line arguments. + +- *Cooked Mode:* The current + :term:`MACHINE` setting and image + name are used to automatically locate and provide the build + artifacts. You just supply a kickstart file and the name of the image + from which to use artifacts. + +Regardless of the mode you use, you need to have the build artifacts +ready and available. + +Raw Mode +-------- + +Running Wic in raw mode allows you to specify all the partitions through +the ``wic`` command line. The primary use for raw mode is if you have +built your kernel outside of the Yocto Project :term:`Build Directory`. +In other words, you can point to arbitrary kernel, root filesystem locations, +and so forth. Contrast this behavior with cooked mode where Wic looks in the +:term:`Build Directory` (e.g. ``tmp/deploy/images/``\ machine). + +The general form of the ``wic`` command in raw mode is:: + + $ wic create wks_file options ... + + Where: + + wks_file: + An OpenEmbedded kickstart file. You can provide + your own custom file or use a file from a set of + existing files as described by further options. + + optional arguments: + -h, --help show this help message and exit + -o OUTDIR, --outdir OUTDIR + name of directory to create image in + -e IMAGE_NAME, --image-name IMAGE_NAME + name of the image to use the artifacts from e.g. core- + image-sato + -r ROOTFS_DIR, --rootfs-dir ROOTFS_DIR + path to the /rootfs dir to use as the .wks rootfs + source + -b BOOTIMG_DIR, --bootimg-dir BOOTIMG_DIR + path to the dir containing the boot artifacts (e.g. + /EFI or /syslinux dirs) to use as the .wks bootimg + source + -k KERNEL_DIR, --kernel-dir KERNEL_DIR + path to the dir containing the kernel to use in the + .wks bootimg + -n NATIVE_SYSROOT, --native-sysroot NATIVE_SYSROOT + path to the native sysroot containing the tools to use + to build the image + -s, --skip-build-check + skip the build check + -f, --build-rootfs build rootfs + -c {gzip,bzip2,xz}, --compress-with {gzip,bzip2,xz} + compress image with specified compressor + -m, --bmap generate .bmap + --no-fstab-update Do not change fstab file. + -v VARS_DIR, --vars VARS_DIR + directory with <image>.env files that store bitbake + variables + -D, --debug output debug information + +.. note:: + + You do not need root privileges to run Wic. In fact, you should not + run as root when using the utility. + +Cooked Mode +----------- + +Running Wic in cooked mode leverages off artifacts in the +:term:`Build Directory`. In other words, you do not have to specify kernel or +root filesystem locations as part of the command. All you need to provide is +a kickstart file and the name of the image from which to use artifacts +by using the "-e" option. Wic looks in the :term:`Build Directory` (e.g. +``tmp/deploy/images/``\ machine) for artifacts. + +The general form of the ``wic`` command using Cooked Mode is as follows:: + + $ wic create wks_file -e IMAGE_NAME + + Where: + + wks_file: + An OpenEmbedded kickstart file. You can provide + your own custom file or use a file from a set of + existing files provided with the Yocto Project + release. + + required argument: + -e IMAGE_NAME, --image-name IMAGE_NAME + name of the image to use the artifacts from e.g. core- + image-sato + +Using an Existing Kickstart File +================================ + +If you do not want to create your own kickstart file, you can use an +existing file provided by the Wic installation. As shipped, kickstart +files can be found in the :ref:`overview-manual/development-environment:yocto project source repositories` in the +following two locations:: + + poky/meta-yocto-bsp/wic + poky/scripts/lib/wic/canned-wks + +Use the following command to list the available kickstart files:: + + $ wic list images + genericx86 Create an EFI disk image for genericx86* + beaglebone-yocto Create SD card image for Beaglebone + qemuriscv Create qcow2 image for RISC-V QEMU machines + mkefidisk Create an EFI disk image + qemuloongarch Create qcow2 image for LoongArch QEMU machines + directdisk-multi-rootfs Create multi rootfs image using rootfs plugin + directdisk Create a 'pcbios' direct disk image + efi-bootdisk + mkhybridiso Create a hybrid ISO image + directdisk-gpt Create a 'pcbios' direct disk image + systemd-bootdisk Create an EFI disk image with systemd-boot + sdimage-bootpart Create SD card image with a boot partition + qemux86-directdisk Create a qemu machine 'pcbios' direct disk image + directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config + +When you use an existing file, you +do not have to use the ``.wks`` extension. Here is an example in Raw +Mode that uses the ``directdisk`` file:: + + $ wic create directdisk -r rootfs_dir -b bootimg_dir \ + -k kernel_dir -n native_sysroot + +Here are the actual partition language commands used in the +``genericx86.wks`` file to generate an image:: + + # short-description: Create an EFI disk image for genericx86* + # long-description: Creates a partitioned EFI disk image for genericx86* machines + part /boot --source bootimg-efi --sourceparams="loader=grub-efi" --ondisk sda --label msdos --active --align 1024 + part / --source rootfs --ondisk sda --fstype=ext4 --label platform --align 1024 --use-uuid + part swap --ondisk sda --size 44 --label swap1 --fstype=swap + + bootloader --ptable gpt --timeout=5 --append="rootfstype=ext4 console=ttyS0,115200 console=tty0" + +Using the Wic Plugin Interface +============================== + +You can extend and specialize Wic functionality by using Wic plugins. +This section explains the Wic plugin interface. + +.. note:: + + Wic plugins consist of "source" and "imager" plugins. Imager plugins + are beyond the scope of this section. + +Source plugins provide a mechanism to customize partition content during +the Wic image generation process. You can use source plugins to map +values that you specify using ``--source`` commands in kickstart files +(i.e. ``*.wks``) to a plugin implementation used to populate a given +partition. + +.. note:: + + If you use plugins that have build-time dependencies (e.g. native + tools, bootloaders, and so forth) when building a Wic image, you need + to specify those dependencies using the :term:`WKS_FILE_DEPENDS` + variable. + +Source plugins are subclasses defined in plugin files. As shipped, the +Yocto Project provides several plugin files. You can see the source +plugin files that ship with the Yocto Project +:yocto_git:`here </poky/tree/scripts/lib/wic/plugins/source>`. +Each of these plugin files contains source plugins that are designed to +populate a specific Wic image partition. + +Source plugins are subclasses of the ``SourcePlugin`` class, which is +defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example, +the ``BootimgEFIPlugin`` source plugin found in the ``bootimg-efi.py`` +file is a subclass of the ``SourcePlugin`` class, which is found in the +``pluginbase.py`` file. + +You can also implement source plugins in a layer outside of the Source +Repositories (external layer). To do so, be sure that your plugin files +are located in a directory whose path is +``scripts/lib/wic/plugins/source/`` within your external layer. When the +plugin files are located there, the source plugins they contain are made +available to Wic. + +When the Wic implementation needs to invoke a partition-specific +implementation, it looks for the plugin with the same name as the +``--source`` parameter used in the kickstart file given to that +partition. For example, if the partition is set up using the following +command in a kickstart file:: + + part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024 + +The methods defined as class +members of the matching source plugin (i.e. ``bootimg-pcbios``) in the +``bootimg-pcbios.py`` plugin file are used. + +To be more concrete, here is the corresponding plugin definition from +the ``bootimg-pcbios.py`` file for the previous command along with an +example method called by the Wic implementation when it needs to prepare +a partition using an implementation-specific function:: + + . + . + . + class BootimgPcbiosPlugin(SourcePlugin): + """ + Create MBR boot partition and install syslinux on it. + """ + + name = 'bootimg-pcbios' + . + . + . + @classmethod + def do_prepare_partition(cls, part, source_params, creator, cr_workdir, + oe_builddir, bootimg_dir, kernel_dir, + rootfs_dir, native_sysroot): + """ + Called to do the actual content population for a partition i.e. it + 'prepares' the partition to be incorporated into the image. + In this case, prepare content for legacy bios boot partition. + """ + . + . + . + +If a +subclass (plugin) itself does not implement a particular function, Wic +locates and uses the default version in the superclass. It is for this +reason that all source plugins are derived from the ``SourcePlugin`` +class. + +The ``SourcePlugin`` class defined in the ``pluginbase.py`` file defines +a set of methods that source plugins can implement or override. Any +plugins (subclass of ``SourcePlugin``) that do not implement a +particular method inherit the implementation of the method from the +``SourcePlugin`` class. For more information, see the ``SourcePlugin`` +class in the ``pluginbase.py`` file for details: + +The following list describes the methods implemented in the +``SourcePlugin`` class: + +- ``do_prepare_partition()``: Called to populate a partition with + actual content. In other words, the method prepares the final + partition image that is incorporated into the disk image. + +- ``do_configure_partition()``: Called before + ``do_prepare_partition()`` to create custom configuration files for a + partition (e.g. syslinux or grub configuration files). + +- ``do_install_disk()``: Called after all partitions have been + prepared and assembled into a disk image. This method provides a hook + to allow finalization of a disk image (e.g. writing an MBR). + +- ``do_stage_partition()``: Special content-staging hook called + before ``do_prepare_partition()``. This method is normally empty. + + Typically, a partition just uses the passed-in parameters (e.g. the + unmodified value of ``bootimg_dir``). However, in some cases, things + might need to be more tailored. As an example, certain files might + additionally need to be taken from ``bootimg_dir + /boot``. This hook + allows those files to be staged in a customized fashion. + + .. note:: + + ``get_bitbake_var()`` allows you to access non-standard variables that + you might want to use for this behavior. + +You can extend the source plugin mechanism. To add more hooks, create +more source plugin methods within ``SourcePlugin`` and the corresponding +derived subclasses. The code that calls the plugin methods uses the +``plugin.get_source_plugin_methods()`` function to find the method or +methods needed by the call. Retrieval of those methods is accomplished +by filling up a dict with keys that contain the method names of +interest. On success, these will be filled in with the actual methods. +See the Wic implementation for examples and details. + +Wic Examples +============ + +This section provides several examples that show how to use the Wic +utility. All the examples assume the list of requirements in the +":ref:`dev-manual/wic:requirements`" section have been met. The +examples assume the previously generated image is +``core-image-minimal``. + +Generate an Image using an Existing Kickstart File +-------------------------------------------------- + +This example runs in Cooked Mode and uses the ``mkefidisk`` kickstart +file:: + + $ wic create mkefidisk -e core-image-minimal + INFO: Building wic-tools... + . + . + . + INFO: The new image(s) can be found here: + ./mkefidisk-201804191017-sda.direct + + The following build artifacts were used to create the image(s): + ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs + BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share + KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 + NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native + + INFO: The image(s) were created using OE kickstart file: + /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/mkefidisk.wks + +The previous example shows the easiest way to create an image by running +in cooked mode and supplying a kickstart file and the "-e" option to +point to the existing build artifacts. Your ``local.conf`` file needs to +have the :term:`MACHINE` variable set +to the machine you are using, which is "qemux86" in this example. + +Once the image builds, the output provides image location, artifact use, +and kickstart file information. + +.. note:: + + You should always verify the details provided in the output to make + sure that the image was indeed created exactly as expected. + +Continuing with the example, you can now write the image from the +:term:`Build Directory` onto a USB stick, or whatever media for which you +built your image, and boot from the media. You can write the image by using +``bmaptool`` or ``dd``:: + + $ oe-run-native bmaptool-native bmaptool copy mkefidisk-201804191017-sda.direct /dev/sdX + +or :: + + $ sudo dd if=mkefidisk-201804191017-sda.direct of=/dev/sdX + +.. note:: + + For more information on how to use the ``bmaptool`` + to flash a device with an image, see the + ":ref:`dev-manual/bmaptool:flashing images using \`\`bmaptool\`\``" + section. + +Using a Modified Kickstart File +------------------------------- + +Because partitioned image creation is driven by the kickstart file, it +is easy to affect image creation by changing the parameters in the file. +This next example demonstrates that through modification of the +``directdisk-gpt`` kickstart file. + +As mentioned earlier, you can use the command ``wic list images`` to +show the list of existing kickstart files. The directory in which the +``directdisk-gpt.wks`` file resides is +``scripts/lib/image/canned-wks/``, which is located in the +:term:`Source Directory` (e.g. ``poky``). +Because available files reside in this directory, you can create and add +your own custom files to the directory. Subsequent use of the +``wic list images`` command would then include your kickstart files. + +In this example, the existing ``directdisk-gpt`` file already does most +of what is needed. However, for the hardware in this example, the image +will need to boot from ``sdb`` instead of ``sda``, which is what the +``directdisk-gpt`` kickstart file uses. + +The example begins by making a copy of the ``directdisk-gpt.wks`` file +in the ``scripts/lib/image/canned-wks`` directory and then by changing +the lines that specify the target disk from which to boot:: + + $ cp /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisk-gpt.wks \ + /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks + +Next, the example modifies the ``directdisksdb-gpt.wks`` file and +changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The +example changes the following two lines and leaves the remaining lines +untouched:: + + part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024 + part / --source rootfs --ondisk sdb --fstype=ext4 --label platform --align 1024 --use-uuid + +Once the lines are changed, the +example generates the ``directdisksdb-gpt`` image. The command points +the process at the ``core-image-minimal`` artifacts for the Next Unit of +Computing (nuc) :term:`MACHINE` the +``local.conf``:: + + $ wic create directdisksdb-gpt -e core-image-minimal + INFO: Building wic-tools... + . + . + . + Initialising tasks: 100% |#######################################| Time: 0:00:01 + NOTE: Executing SetScene Tasks + NOTE: Executing RunQueue Tasks + NOTE: Tasks Summary: Attempted 1161 tasks of which 1157 didn't need to be rerun and all succeeded. + INFO: Creating image(s)... + + INFO: The new image(s) can be found here: + ./directdisksdb-gpt-201710090938-sdb.direct + + The following build artifacts were used to create the image(s): + ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs + BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share + KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 + NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native + + INFO: The image(s) were created using OE kickstart file: + /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks + +Continuing with the example, you can now directly ``dd`` the image to a +USB stick, or whatever media for which you built your image, and boot +the resulting media:: + + $ sudo dd if=directdisksdb-gpt-201710090938-sdb.direct of=/dev/sdb + 140966+0 records in + 140966+0 records out + 72174592 bytes (72 MB, 69 MiB) copied, 78.0282 s, 925 kB/s + $ sudo eject /dev/sdb + +Using a Modified Kickstart File and Running in Raw Mode +------------------------------------------------------- + +This next example manually specifies each build artifact (runs in Raw +Mode) and uses a modified kickstart file. The example also uses the +``-o`` option to cause Wic to create the output somewhere other than the +default output directory, which is the current directory:: + + $ wic create test.wks -o /home/stephano/testwic \ + --rootfs-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/rootfs \ + --bootimg-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share \ + --kernel-dir /home/stephano/yocto/build/tmp/deploy/images/qemux86 \ + --native-sysroot /home/stephano/yocto/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native + + INFO: Creating image(s)... + + INFO: The new image(s) can be found here: + /home/stephano/testwic/test-201710091445-sdb.direct + + The following build artifacts were used to create the image(s): + ROOTFS_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/rootfs + BOOTIMG_DIR: /home/stephano/yocto/build/tmp-glibc/work/qemux86-oe-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share + KERNEL_DIR: /home/stephano/yocto/build/tmp-glibc/deploy/images/qemux86 + NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native + + INFO: The image(s) were created using OE kickstart file: + test.wks + +For this example, +:term:`MACHINE` did not have to be +specified in the ``local.conf`` file since the artifact is manually +specified. + +Using Wic to Manipulate an Image +-------------------------------- + +Wic image manipulation allows you to shorten turnaround time during +image development. For example, you can use Wic to delete the kernel +partition of a Wic image and then insert a newly built kernel. This +saves you time from having to rebuild the entire image each time you +modify the kernel. + +.. note:: + + In order to use Wic to manipulate a Wic image as in this example, + your development machine must have the ``mtools`` package installed. + +The following example examines the contents of the Wic image, deletes +the existing kernel, and then inserts a new kernel: + +#. *List the Partitions:* Use the ``wic ls`` command to list all the + partitions in the Wic image:: + + $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic + Num Start End Size Fstype + 1 1048576 25041919 23993344 fat16 + 2 25165824 72157183 46991360 ext4 + + The previous output shows two partitions in the + ``core-image-minimal-qemux86.wic`` image. + +#. *Examine a Particular Partition:* Use the ``wic ls`` command again + but in a different form to examine a particular partition. + + .. note:: + + You can get command usage on any Wic command using the following + form:: + + $ wic help command + + + For example, the following command shows you the various ways to + use the + wic ls + command:: + + $ wic help ls + + + The following command shows what is in partition one:: + + $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1 + Volume in drive : is boot + Volume Serial Number is E894-1809 + Directory for ::/ + + libcom32 c32 186500 2017-10-09 16:06 + libutil c32 24148 2017-10-09 16:06 + syslinux cfg 220 2017-10-09 16:06 + vesamenu c32 27104 2017-10-09 16:06 + vmlinuz 6904608 2017-10-09 16:06 + 5 files 7 142 580 bytes + 16 582 656 bytes free + + The previous output shows five files, with the + ``vmlinuz`` being the kernel. + + .. note:: + + If you see the following error, you need to update or create a + ``~/.mtoolsrc`` file and be sure to have the line "mtools_skip_check=1" + in the file. Then, run the Wic command again:: + + ERROR: _exec_cmd: /usr/bin/mdir -i /tmp/wic-parttfokuwra ::/ returned '1' instead of 0 + output: Total number of sectors (47824) not a multiple of sectors per track (32)! + Add mtools_skip_check=1 to your .mtoolsrc file to skip this test + + +#. *Remove the Old Kernel:* Use the ``wic rm`` command to remove the + ``vmlinuz`` file (kernel):: + + $ wic rm tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz + +#. *Add In the New Kernel:* Use the ``wic cp`` command to add the + updated kernel to the Wic image. Depending on how you built your + kernel, it could be in different places. If you used ``devtool`` and + an SDK to build your kernel, it resides in the ``tmp/work`` directory + of the extensible SDK. If you used ``make`` to build the kernel, the + kernel will be in the ``workspace/sources`` area. + + The following example assumes ``devtool`` was used to build the + kernel:: + + $ wic cp poky_sdk/tmp/work/qemux86-poky-linux/linux-yocto/4.12.12+git999-r0/linux-yocto-4.12.12+git999/arch/x86/boot/bzImage \ + poky/build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz + + Once the new kernel is added back into the image, you can use the + ``dd`` command or :ref:`bmaptool + <dev-manual/bmaptool:flashing images using \`\`bmaptool\`\`>` + to flash your wic image onto an SD card or USB stick and test your + target. + + .. note:: + + Using ``bmaptool`` is generally 10 to 20 times faster than using ``dd``. + diff --git a/documentation/dev-manual/x32-psabi.rst b/documentation/dev-manual/x32-psabi.rst new file mode 100644 index 0000000000..92b1f96fa4 --- /dev/null +++ b/documentation/dev-manual/x32-psabi.rst @@ -0,0 +1,54 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Using x32 psABI +*************** + +x32 processor-specific Application Binary Interface (`x32 +psABI <https://software.intel.com/en-us/node/628948>`__) is a native +32-bit processor-specific ABI for Intel 64 (x86-64) architectures. An +ABI defines the calling conventions between functions in a processing +environment. The interface determines what registers are used and what +the sizes are for various C data types. + +Some processing environments prefer using 32-bit applications even when +running on Intel 64-bit platforms. Consider the i386 psABI, which is a +very old 32-bit ABI for Intel 64-bit platforms. The i386 psABI does not +provide efficient use and access of the Intel 64-bit processor +resources, leaving the system underutilized. Now consider the x86_64 +psABI. This ABI is newer and uses 64-bits for data sizes and program +pointers. The extra bits increase the footprint size of the programs, +libraries, and also increases the memory and file system size +requirements. Executing under the x32 psABI enables user programs to +utilize CPU and system resources more efficiently while keeping the +memory footprint of the applications low. Extra bits are used for +registers but not for addressing mechanisms. + +The Yocto Project supports the final specifications of x32 psABI as +follows: + +- You can create packages and images in x32 psABI format on x86_64 + architecture targets. + +- You can successfully build recipes with the x32 toolchain. + +- You can create and boot ``core-image-minimal`` and + ``core-image-sato`` images. + +- There is RPM Package Manager (RPM) support for x32 binaries. + +- There is support for large images. + +To use the x32 psABI, you need to edit your ``conf/local.conf`` +configuration file as follows:: + + MACHINE = "qemux86-64" + DEFAULTTUNE = "x86-64-x32" + baselib = "${@d.getVar('BASE_LIB:tune-' + (d.getVar('DEFAULTTUNE') \ + or 'INVALID')) or 'lib'}" + +Once you have set +up your configuration file, use BitBake to build an image that supports +the x32 psABI. Here is an example:: + + $ bitbake core-image-sato + diff --git a/documentation/genindex.rst b/documentation/genindex.rst index a4af06f656..149e2d36b5 100644 --- a/documentation/genindex.rst +++ b/documentation/genindex.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + ===== Index ===== diff --git a/documentation/index.rst b/documentation/index.rst index 0fca6ce720..3fef1704a4 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -26,6 +26,7 @@ Welcome to the Yocto Project Documentation :caption: Manuals Overview and Concepts Manual <overview-manual/index> + Contributor Guide <contributor-guide/index> Reference Manual <ref-manual/index> Board Support Package (BSP) Developer's guide <bsp-guide/index> Development Tasks Manual <dev-manual/index> @@ -38,10 +39,10 @@ Welcome to the Yocto Project Documentation .. toctree:: :maxdepth: 1 - :caption: Releases manual + :caption: Release Manuals :hidden: - Release Migration Guides <migration-guides/index> + Release Information <migration-guides/index> releases .. toctree:: diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst index b5290b61b3..4c463503f6 100644 --- a/documentation/kernel-dev/advanced.rst +++ b/documentation/kernel-dev/advanced.rst @@ -69,8 +69,7 @@ to indicate the branch. You can use the :term:`KBRANCH` value to define an alternate branch typically with a machine override as shown here from the ``meta-yocto-bsp`` layer:: - KBRANCH:edgerouter = "standard/edgerouter" - + KBRANCH:beaglebone-yocto = "standard/beaglebone" The linux-yocto style recipes can optionally define the following variables: @@ -183,7 +182,7 @@ the structure: order to define a base kernel policy or major kernel type to be reused across multiple BSPs, place the file in ``ktypes`` directory. -These distinctions can easily become blurred - especially as out-of-tree +These distinctions can easily become blurred --- especially as out-of-tree features slowly merge upstream over time. Also, remember that how the description files are placed is a purely logical organization and has no impact on the functionality of the kernel Metadata. There is no impact @@ -304,8 +303,8 @@ The following listings show the ``build.scc`` file and part of the . . . - char *dump_write = NULL, *files_source = NULL; - int opt; + char *dump_write = NULL, *files_source = NULL; + int opt; -- 2.10.1 @@ -352,17 +351,15 @@ in the manual. Kernel Types ------------ -A kernel type defines a high-level kernel policy by aggregating -non-hardware configuration fragments with patches you want to use when -building a Linux kernel of a specific type (e.g. a real-time kernel). -Syntactically, kernel types are no different than features as described -in the ":ref:`kernel-dev/advanced:features`" section. The -:term:`LINUX_KERNEL_TYPE` -variable in the kernel recipe selects the kernel type. For example, in -the ``linux-yocto_4.12.bb`` kernel recipe found in -``poky/meta/recipes-kernel/linux``, a -:ref:`require <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>` directive -includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, +A kernel type defines a high-level kernel policy by aggregating non-hardware +configuration fragments with patches you want to use when building a Linux +kernel of a specific type (e.g. a real-time kernel). Syntactically, kernel +types are no different than features as described in the +":ref:`kernel-dev/advanced:features`" section. The :term:`LINUX_KERNEL_TYPE` +variable in the kernel recipe selects the kernel type. For example, in the +``linux-yocto_4.12.bb`` kernel recipe found in ``poky/meta/recipes-kernel/linux``, a +:ref:`require <bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>` +directive includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, which has the following statement that defines the default kernel type:: LINUX_KERNEL_TYPE ??= "standard" @@ -566,15 +563,7 @@ Example Many real-world examples are more complex. Like any other ``.scc`` file, BSP descriptions can aggregate features. Consider the Minnow BSP definition given the ``linux-yocto-4.4`` branch of the -``yocto-kernel-cache`` (i.e. -``yocto-kernel-cache/bsp/minnow/minnow.scc``): - -.. note:: - - Although the Minnow Board BSP is unused, the Metadata remains and is - being used here just as an example. - -:: +``yocto-kernel-cache`` (i.e. ``yocto-kernel-cache/bsp/minnow/minnow.scc``):: include cfg/x86.scc include features/eg20t/eg20t.scc @@ -597,6 +586,11 @@ definition given the ``linux-yocto-4.4`` branch of the kconf hardware minnow.cfg kconf hardware minnow-dev.cfg +.. note:: + + Although the Minnow Board BSP is unused, the Metadata remains and is + being used here just as an example. + The ``minnow.scc`` description file includes a hardware configuration fragment (``minnow.cfg``) specific to the Minnow BSP as well as several more general configuration fragments and features enabling hardware @@ -735,11 +729,10 @@ reside in a separate repository. The OpenEmbedded build system adds the Metadata to the build as a "type=kmeta" repository through the :term:`SRC_URI` variable. As an example, consider the following :term:`SRC_URI` statement from the -``linux-yocto_4.12.bb`` kernel recipe:: - - SRC_URI = "git://git.yoctoproject.org/linux-yocto-4.12.git;name=machine;branch=${KBRANCH}; \ - git://git.yoctoproject.org/yocto-kernel-cache;type=kmeta;name=meta;branch=yocto-4.12;destsuffix=${KMETA}" +``linux-yocto_5.15.bb`` kernel recipe:: + SRC_URI = "git://git.yoctoproject.org/linux-yocto.git;name=machine;branch=${KBRANCH};protocol=https \ + git://git.yoctoproject.org/yocto-kernel-cache;type=kmeta;name=meta;branch=yocto-5.15;destsuffix=${KMETA};protocol=https" ``${KMETA}``, in this context, is simply used to name the directory into which the Git fetcher places the Metadata. This behavior is no different diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index a5dd02ccf2..fda41694dc 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -52,8 +52,8 @@ image and ready to make modifications as described in the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section: -1. *Initialize the BitBake Environment:* Before building an extensible - SDK, you need to initialize the BitBake build environment by sourcing +#. *Initialize the BitBake Environment:* + you need to initialize the BitBake build environment by sourcing the build environment script (i.e. :ref:`structure-core-script`):: $ cd poky @@ -66,19 +66,15 @@ section: (i.e. ``poky``) have been cloned using Git and the local repository is named "poky". -2. *Prepare Your local.conf File:* By default, the - :term:`MACHINE` variable is set to - "qemux86-64", which is fine if you are building for the QEMU emulator - in 64-bit mode. However, if you are not, you need to set the +#. *Prepare Your local.conf File:* By default, the :term:`MACHINE` variable + is set to "qemux86-64", which is fine if you are building for the QEMU + emulator in 64-bit mode. However, if you are not, you need to set the :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file - found in the - :term:`Build Directory` (i.e. - ``poky/build`` in this example). + found in the :term:`Build Directory` (i.e. ``poky/build`` in this example). Also, since you are preparing to work on the kernel image, you need - to set the - :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` - variable to include kernel modules. + to set the :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` variable to include + kernel modules. In this example we wish to build for qemux86 so we must set the :term:`MACHINE` variable to "qemux86" and also add the "kernel-modules". @@ -87,7 +83,7 @@ section: MACHINE = "qemux86" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" -3. *Create a Layer for Patches:* You need to create a layer to hold +#. *Create a Layer for Patches:* You need to create a layer to hold patches created for the kernel image. You can use the ``bitbake-layers create-layer`` command as follows:: @@ -101,16 +97,16 @@ section: For background information on working with common and BSP layers, see the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board Support (BSP) Developer's Guide, respectively. For information on how to use the ``bitbake-layers create-layer`` command to quickly set up a layer, see the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. -4. *Inform the BitBake Build Environment About Your Layer:* As directed +#. *Inform the BitBake Build Environment About Your Layer:* As directed when you created your layer, you need to add the layer to the :term:`BBLAYERS` variable in the ``bblayers.conf`` file as follows:: @@ -120,67 +116,10 @@ section: NOTE: Starting bitbake server... $ -5. *Build the Extensible SDK:* Use BitBake to build the extensible SDK - specifically for use with images to be run using QEMU:: - - $ cd poky/build - $ bitbake core-image-minimal -c populate_sdk_ext - - Once - the build finishes, you can find the SDK installer file (i.e. - ``*.sh`` file) in the following directory:: - - poky/build/tmp/deploy/sdk - - For this example, the installer file is named - ``poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh``. - -6. *Install the Extensible SDK:* Use the following command to install - the SDK. For this example, install the SDK in the default - ``poky_sdk`` directory:: - - $ cd poky/build/tmp/deploy/sdk - $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh - Poky (Yocto Project Reference Distro) Extensible SDK installer version &DISTRO; - ============================================================================ - Enter target directory for SDK (default: poky_sdk): - You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y - Extracting SDK......................................done - Setting it up... - Extracting buildtools... - Preparing build system... - Parsing recipes: 100% |#################################################################| Time: 0:00:52 - Initializing tasks: 100% |############## ###############################################| Time: 0:00:04 - Checking sstate mirror object availability: 100% |######################################| Time: 0:00:00 - Parsing recipes: 100% |#################################################################| Time: 0:00:33 - Initializing tasks: 100% |##############################################################| Time: 0:00:00 - done - SDK has been successfully set up and is ready to be used. - Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. - $ . /home/scottrif/poky_sdk/environment-setup-i586-poky-linux - - -7. *Set Up a New Terminal to Work With the Extensible SDK:* You must set - up a new terminal to work with the SDK. You cannot use the same - BitBake shell used to build the installer. - - After opening a new shell, run the SDK environment setup script as - directed by the output from installing the SDK:: - - $ source poky_sdk/environment-setup-i586-poky-linux - "SDK environment now set up; additionally you may now run devtool to perform development tasks. - Run devtool --help for further details. - - .. note:: - - If you get a warning about attempting to use the extensible SDK in - an environment set up to run BitBake, you did not use a new shell. - -8. *Build the Clean Image:* The final step in preparing to work on the - kernel is to build an initial image using ``devtool`` in the new - terminal you just set up and initialized for SDK work:: +#. *Build the Clean Image:* The final step in preparing to work on the + kernel is to build an initial image using ``bitbake``:: - $ devtool build-image + $ bitbake core-image-minimal Parsing recipes: 100% |##########################################| Time: 0:00:05 Parsing of 830 .bb files complete (0 cached, 830 parsed). 1299 targets, 47 skipped, 0 masked, 0 errors. WARNING: No packages to add, building image core-image-minimal unmodified @@ -192,7 +131,6 @@ section: NOTE: Executing SetScene Tasks NOTE: Executing RunQueue Tasks NOTE: Tasks Summary: Attempted 2866 tasks of which 2604 didn't need to be rerun and all succeeded. - NOTE: Successfully built core-image-minimal. You can find output files in /home/scottrif/poky_sdk/tmp/deploy/images/qemux86 If you were building for actual hardware and not for emulation, you could flash @@ -202,7 +140,7 @@ section: Wiki page. At this point you have set up to start making modifications to the -kernel by using the extensible SDK. For a continued example, see the +kernel. For a continued example, see the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. @@ -220,7 +158,7 @@ this procedure leaves you ready to make modifications to the kernel source as described in the ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" section: -1. *Initialize the BitBake Environment:* Before you can do anything +#. *Initialize the BitBake Environment:* Before you can do anything using BitBake, you need to initialize the BitBake build environment by sourcing the build environment script (i.e. :ref:`structure-core-script`). @@ -228,8 +166,7 @@ section: checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If you need to checkout out the &DISTRO_NAME; branch, see the ":ref:`dev-manual/start:checking out by branch in poky`" - section in the Yocto Project Development Tasks Manual. - :: + section in the Yocto Project Development Tasks Manual:: $ cd poky $ git branch @@ -244,14 +181,11 @@ section: (i.e. ``poky``) have been cloned using Git and the local repository is named "poky". -2. *Prepare Your local.conf File:* By default, the - :term:`MACHINE` variable is set to - "qemux86-64", which is fine if you are building for the QEMU emulator - in 64-bit mode. However, if you are not, you need to set the - :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file - found in the - :term:`Build Directory` (i.e. - ``poky/build`` in this example). +#. *Prepare Your local.conf File:* By default, the :term:`MACHINE` variable is + set to "qemux86-64", which is fine if you are building for the QEMU emulator + in 64-bit mode. However, if you are not, you need to set the :term:`MACHINE` + variable appropriately in your ``conf/local.conf`` file found in the + :term:`Build Directory` (i.e. ``poky/build`` in this example). Also, since you are preparing to work on the kernel image, you need to set the @@ -265,7 +199,7 @@ section: MACHINE = "qemux86" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" -3. *Create a Layer for Patches:* You need to create a layer to hold +#. *Create a Layer for Patches:* You need to create a layer to hold patches created for the kernel image. You can use the ``bitbake-layers create-layer`` command as follows:: @@ -278,16 +212,16 @@ section: For background information on working with common and BSP layers, see the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board Support (BSP) Developer's Guide, respectively. For information on how to use the ``bitbake-layers create-layer`` command to quickly set up a layer, see the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. -4. *Inform the BitBake Build Environment About Your Layer:* As directed +#. *Inform the BitBake Build Environment About Your Layer:* As directed when you created your layer, you need to add the layer to the :term:`BBLAYERS` variable in the ``bblayers.conf`` file as follows:: @@ -297,7 +231,7 @@ section: NOTE: Starting bitbake server ... $ -5. *Create a Local Copy of the Kernel Git Repository:* You can find Git +#. *Create a Local Copy of the Kernel Git Repository:* You can find Git repositories of supported Yocto Project kernels organized under "Yocto Linux Kernel" in the Yocto Project Source Repositories at :yocto_git:`/`. @@ -309,16 +243,7 @@ section: ``standard/base`` branch. The following commands show how to create a local copy of the - ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch. - - .. note:: - - The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4 - release and forward. - You cannot use the ``linux-yocto-4.12`` kernel with releases prior to - Yocto Project 2.4. - - :: + ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch:: $ cd ~ $ git clone git://git.yoctoproject.org/linux-yocto-4.12 --branch standard/base @@ -330,7 +255,14 @@ section: Resolving deltas: 100% (5152604/5152604), done. Checking connectivity... done. Checking out files: 100% (59846/59846), done. -6. *Create a Local Copy of the Kernel Cache Git Repository:* For + .. note:: + + The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4 + release and forward. + You cannot use the ``linux-yocto-4.12`` kernel with releases prior to + Yocto Project 2.4. + +#. *Create a Local Copy of the Kernel Cache Git Repository:* For simplicity, it is recommended that you create your copy of the kernel cache Git repository outside of the :term:`Source Directory`, which is @@ -364,7 +296,7 @@ layer contains its own :term:`BitBake` append files (``.bbappend``) and provides a convenient mechanism to create your own recipe files (``.bb``) as well as store and use kernel patch files. For background information on working with layers, see the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. .. note:: @@ -372,7 +304,7 @@ section in the Yocto Project Development Tasks Manual. The Yocto Project comes with many tools that simplify tasks you need to perform. One such tool is the ``bitbake-layers create-layer`` command, which simplifies creating a new layer. See the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual for information on how to use this script to quick set up a new layer. @@ -381,19 +313,15 @@ following section describes how to create a layer without the aid of tools. These steps assume creation of a layer named ``mylayer`` in your home directory: -1. *Create Structure*: Create the layer's structure:: +#. *Create Structure*: Create the layer's structure:: - $ mkdir meta-mylayer - $ mkdir meta-mylayer/conf - $ mkdir meta-mylayer/recipes-kernel - $ mkdir meta-mylayer/recipes-kernel/linux - $ mkdir meta-mylayer/recipes-kernel/linux/linux-yocto + $ mkdir -p meta-mylayer/conf meta-mylayer/recipes-kernel/linux/linux-yocto The ``conf`` directory holds your configuration files, while the ``recipes-kernel`` directory holds your append file and eventual patch files. -2. *Create the Layer Configuration File*: Move to the +#. *Create the Layer Configuration File*: Move to the ``meta-mylayer/conf`` directory and create the ``layer.conf`` file as follows:: @@ -410,7 +338,7 @@ home directory: Notice ``mylayer`` as part of the last three statements. -3. *Create the Kernel Recipe Append File*: Move to the +#. *Create the Kernel Recipe Append File*: Move to the ``meta-mylayer/recipes-kernel/linux`` directory and create the kernel's append file. This example uses the ``linux-yocto-4.12`` kernel. Thus, the name of the append file is @@ -418,14 +346,14 @@ home directory: FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:" - SRC_URI:append = " file://patch-file-one.patch" - SRC_URI:append = " file://patch-file-two.patch" - SRC_URI:append = " file://patch-file-three.patch" + SRC_URI += "file://patch-file-one.patch" + SRC_URI += "file://patch-file-two.patch" + SRC_URI += "file://patch-file-three.patch" The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements enable the OpenEmbedded build system to find patch files. For more information on using append files, see the - ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual. Modifying an Existing Recipe @@ -455,13 +383,13 @@ Creating the Append File You create this file in your custom layer. You also name it accordingly based on the linux-yocto recipe you are using. For example, if you are -modifying the ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` recipe, +modifying the ``meta/recipes-kernel/linux/linux-yocto_6.1.bb`` recipe, the append file will typically be located as follows within your custom layer: .. code-block:: none - your-layer/recipes-kernel/linux/linux-yocto_4.12.bbappend + your-layer/recipes-kernel/linux/linux-yocto_6.1.bbappend The append file should initially extend the :term:`FILESPATH` search path by @@ -489,36 +417,31 @@ As an example, consider the following append file used by the BSPs in .. code-block:: none - 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 contents of this file. Be aware that the actual commit ID strings in this example listing might be different than the actual -strings in the file from the ``meta-yocto-bsp`` layer upstream. -:: +strings in the file from the ``meta-yocto-bsp`` layer upstream:: - KBRANCH:genericx86 = "standard/base" - KBRANCH:genericx86-64 = "standard/base" + KBRANCH:genericx86 = "v6.1/standard/base" + KBRANCH:genericx86-64 = "v6.1/standard/base" + KBRANCH:beaglebone-yocto = "v6.1/standard/beaglebone" - KMACHINE:genericx86 ?= "common-pc" - KMACHINE:genericx86-64 ?= "common-pc-64" - KBRANCH:edgerouter = "standard/edgerouter" - KBRANCH:beaglebone = "standard/beaglebone" + KMACHINE:genericx86 ?= "common-pc" + KMACHINE:genericx86-64 ?= "common-pc-64" + KMACHINE:beaglebone-yocto ?= "beaglebone" - SRCREV_machine:genericx86 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19" - SRCREV_machine:genericx86-64 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19" - SRCREV_machine:edgerouter ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d" - SRCREV_machine:beaglebone ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d" + SRCREV_machine:genericx86 ?= "6ec439b4b456ce929c4c07fe457b5d6a4b468e86" + SRCREV_machine:genericx86-64 ?= "6ec439b4b456ce929c4c07fe457b5d6a4b468e86" + SRCREV_machine:beaglebone-yocto ?= "423e1996694b61fbfc8ec3bf062fc6461d64fde1" + COMPATIBLE_MACHINE:genericx86 = "genericx86" + COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64" + COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto" - COMPATIBLE_MACHINE:genericx86 = "genericx86" - COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64" - COMPATIBLE_MACHINE:edgerouter = "edgerouter" - COMPATIBLE_MACHINE:beaglebone = "beaglebone" - - LINUX_VERSION:genericx86 = "4.12.7" - LINUX_VERSION:genericx86-64 = "4.12.7" - LINUX_VERSION:edgerouter = "4.12.10" - LINUX_VERSION:beaglebone = "4.12.10" + LINUX_VERSION:genericx86 = "6.1.30" + LINUX_VERSION:genericx86-64 = "6.1.30" + LINUX_VERSION:beaglebone-yocto = "6.1.20" This append file contains statements used to support several BSPs that ship with the @@ -555,8 +478,7 @@ For example, suppose you had some configuration options in a file called ``network_configs.cfg``. You can place that file inside a directory named ``linux-yocto`` and then add a :term:`SRC_URI` statement such as the following to the append file. When the OpenEmbedded build system builds -the kernel, the configuration options are picked up and applied. -:: +the kernel, the configuration options are picked up and applied:: SRC_URI += "file://network_configs.cfg" @@ -719,12 +641,12 @@ append files, you can direct the OpenEmbedded build system to use a To specify an "in-tree" ``defconfig`` file, use the following statement form:: - KBUILD_DEFCONFIG_KMACHINE ?= "defconfig_file" + KBUILD_DEFCONFIG:<machine> ?= "defconfig_file" -Here is an example -that assigns the :term:`KBUILD_DEFCONFIG` variable based on "raspberrypi2" -and provides the path to the "in-tree" ``defconfig`` file to be used for -a Raspberry Pi 2, which is based on the Broadcom 2708/2709 chipset:: +Here is an example that assigns the :term:`KBUILD_DEFCONFIG` variable utilizing +an override for the "raspberrypi2" :term:`MACHINE` and provides the path to the +"in-tree" ``defconfig`` file to be used for a Raspberry Pi 2, which is based on +the Broadcom 2708/2709 chipset:: KBUILD_DEFCONFIG:raspberrypi2 ?= "bcm2709_defconfig" @@ -744,7 +666,7 @@ Using ``devtool`` to Patch the Kernel ===================================== The steps in this procedure show you how you can patch the kernel using -the extensible SDK and ``devtool``. +``devtool``. .. note:: @@ -765,9 +687,8 @@ modified image causes the added messages to appear on the emulator's console. The example is a continuation of the setup procedure found in the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Section. -1. *Check Out the Kernel Source Files:* First you must use ``devtool`` - to checkout the kernel source code in its workspace. Be sure you are - in the terminal set up to do work with the extensible SDK. +#. *Check Out the Kernel Source Files:* First you must use ``devtool`` + to checkout the kernel source code in its workspace. .. note:: @@ -794,10 +715,10 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se You can safely ignore these messages. The source code is correctly checked out. -2. *Edit the Source Files* Follow these steps to make some simple +#. *Edit the Source Files* Follow these steps to make some simple changes to the source files: - 1. *Change the working directory*: In the previous step, the output + #. *Change the working directory*: In the previous step, the output noted where you can find the source files (e.g. ``poky_sdk/workspace/sources/linux-yocto``). Change to where the kernel source code is before making your edits to the @@ -805,7 +726,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se $ cd poky_sdk/workspace/sources/linux-yocto - 2. *Edit the source file*: Edit the ``init/calibrate.c`` file to have + #. *Edit the source file*: Edit the ``init/calibrate.c`` file to have the following changes:: void calibrate_delay(void) @@ -825,14 +746,17 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se . . -3. *Build the Updated Kernel Source:* To build the updated kernel +#. *Build the Updated Kernel Source:* To build the updated kernel source, use ``devtool``:: $ devtool build linux-yocto -4. *Create the Image With the New Kernel:* Use the +#. *Create the Image With the New Kernel:* Use the ``devtool build-image`` command to create a new image that has the - new kernel. + new kernel:: + + $ cd ~ + $ devtool build-image core-image-minimal .. note:: @@ -842,20 +766,15 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki Page. - :: - - $ cd ~ - $ devtool build-image core-image-minimal - -5. *Test the New Image:* For this example, you can run the new image +#. *Test the New Image:* For this example, you can run the new image using QEMU to verify your changes: - 1. *Boot the image*: Boot the modified image in the QEMU emulator + #. *Boot the image*: Boot the modified image in the QEMU emulator using this command:: $ runqemu qemux86 - 2. *Verify the changes*: Log into the machine using ``root`` with no + #. *Verify the changes*: Log into the machine using ``root`` with no password and then use the following shell command to scroll through the console's boot output. @@ -867,7 +786,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se the results of your ``printk`` statements as part of the output when you scroll down the console window. -6. *Stage and commit your changes*: Within your eSDK terminal, change +#. *Stage and commit your changes*: Change your working directory to where you modified the ``calibrate.c`` file and use these Git commands to stage and commit your changes:: @@ -876,11 +795,9 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se $ git add init/calibrate.c $ git commit -m "calibrate: Add printk example" -7. *Export the Patches and Create an Append File:* To export your +#. *Export the Patches and Create an Append File:* To export your commits as patches and create a ``.bbappend`` file, use the following - command in the terminal used to work with the extensible SDK. This - example uses the previously established layer named ``meta-mylayer``. - :: + command. This example uses the previously established layer named ``meta-mylayer``:: $ devtool finish linux-yocto ~/meta-mylayer @@ -894,10 +811,9 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se finishes, the patches and the ``.bbappend`` file are located in the ``~/meta-mylayer/recipes-kernel/linux`` directory. -8. *Build the Image With Your Modified Kernel:* You can now build an +#. *Build the Image With Your Modified Kernel:* You can now build an image that includes your kernel patches. Execute the following - command from your - :term:`Build Directory` in the terminal + command from your :term:`Build Directory` in the terminal set up to run BitBake:: $ cd poky/build @@ -907,8 +823,8 @@ Using Traditional Kernel Development to Patch the Kernel ======================================================== The steps in this procedure show you how you can patch the kernel using -traditional kernel development (i.e. not using ``devtool`` and the -extensible SDK as described in the +traditional kernel development (i.e. not using ``devtool`` +as described in the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section). @@ -933,20 +849,20 @@ found in the ":ref:`kernel-dev/common:getting ready for traditional kernel development`" Section. -1. *Edit the Source Files* Prior to this step, you should have used Git +#. *Edit the Source Files* Prior to this step, you should have used Git to create a local copy of the repository for your kernel. Assuming you created the repository as directed in the ":ref:`kernel-dev/common:getting ready for traditional kernel development`" section, use the following commands to edit the ``calibrate.c`` file: - 1. *Change the working directory*: You need to locate the source + #. *Change the working directory*: You need to locate the source files in the local copy of the kernel Git repository. Change to where the kernel source code is before making your edits to the ``calibrate.c`` file:: $ cd ~/linux-yocto-4.12/init - 2. *Edit the source file*: Edit the ``calibrate.c`` file to have the + #. *Edit the source file*: Edit the ``calibrate.c`` file to have the following changes:: void calibrate_delay(void) @@ -966,7 +882,7 @@ Section. . . -2. *Stage and Commit Your Changes:* Use standard Git commands to stage +#. *Stage and Commit Your Changes:* Use standard Git commands to stage and commit the changes you just made:: $ git add calibrate.c @@ -976,7 +892,7 @@ Section. stage and commit your changes, the OpenEmbedded Build System will not pick up the changes. -3. *Update Your local.conf File to Point to Your Source Files:* In +#. *Update Your local.conf File to Point to Your Source Files:* In addition to your ``local.conf`` file specifying to use "kernel-modules" and the "qemux86" machine, it must also point to the updated kernel source files. Add @@ -1000,21 +916,21 @@ Section. be sure to specify the correct branch and machine types. For this example, the branch is ``standard/base`` and the machine is ``qemux86``. -4. *Build the Image:* With the source modified, your changes staged and +#. *Build the Image:* With the source modified, your changes staged and committed, and the ``local.conf`` file pointing to the kernel files, you can now use BitBake to build the image:: $ cd poky/build $ bitbake core-image-minimal -5. *Boot the image*: Boot the modified image in the QEMU emulator using +#. *Boot the image*: Boot the modified image in the QEMU emulator using this command. When prompted to login to the QEMU console, use "root" with no password:: $ cd poky/build $ runqemu qemux86 -6. *Look for Your Changes:* As QEMU booted, you might have seen your +#. *Look for Your Changes:* As QEMU booted, you might have seen your changes rapidly scroll by. If not, use these commands to see your changes: @@ -1026,7 +942,7 @@ Section. ``printk`` statements as part of the output when you scroll down the console window. -7. *Generate the Patch File:* Once you are sure that your patch works +#. *Generate the Patch File:* Once you are sure that your patch works correctly, you can generate a ``*.patch`` file in the kernel source repository:: @@ -1034,7 +950,7 @@ Section. $ git format-patch -1 0001-calibrate.c-Added-some-printk-statements.patch -8. *Move the Patch File to Your Layer:* In order for subsequent builds +#. *Move the Patch File to Your Layer:* In order for subsequent builds to pick up patches, you need to move the patch file you created in the previous step to your layer ``meta-mylayer``. For this example, the layer created earlier is located in your home directory as @@ -1044,9 +960,7 @@ Section. additional structure to your layer using the following commands:: $ cd ~/meta-mylayer - $ mkdir recipes-kernel - $ mkdir recipes-kernel/linux - $ mkdir recipes-kernel/linux/linux-yocto + $ mkdir -p recipes-kernel recipes-kernel/linux/linux-yocto Once you have created this hierarchy in your layer, you can move the patch file using the @@ -1054,7 +968,7 @@ Section. $ mv ~/linux-yocto-4.12/init/0001-calibrate.c-Added-some-printk-statements.patch ~/meta-mylayer/recipes-kernel/linux/linux-yocto -9. *Create the Append File:* Finally, you need to create the +#. *Create the Append File:* Finally, you need to create the ``linux-yocto_4.12.bbappend`` file and insert statements that allow the OpenEmbedded build system to find the patch. The append file needs to be in your layer's ``recipes-kernel/linux`` directory and it @@ -1062,7 +976,7 @@ Section. contents:: FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:" - SRC_URI:append = "file://0001-calibrate.c-Added-some-printk-statements.patch" + SRC_URI += "file://0001-calibrate.c-Added-some-printk-statements.patch" The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements enable the OpenEmbedded build system to find the patch file. @@ -1070,7 +984,7 @@ Section. For more information on append files and patches, see the ":ref:`kernel-dev/common:creating the append file`" and ":ref:`kernel-dev/common:applying patches`" sections. You can also see the - ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual. .. note:: @@ -1081,7 +995,7 @@ Section. the following sequence of commands:: $ cd poky/build - $ bitbake -c cleanall yocto-linux + $ bitbake -c cleanall linux-yocto $ bitbake core-image-minimal -c cleanall $ bitbake core-image-minimal $ runqemu qemux86 @@ -1111,15 +1025,14 @@ Using ``menuconfig`` The easiest way to define kernel configurations is to set them through the ``menuconfig`` tool. This tool provides an interactive method with which to set kernel configurations. For general information on -``menuconfig``, see https://en.wikipedia.org/wiki/Menuconfig. +``menuconfig``, see :wikipedia:`Menuconfig`. To use the ``menuconfig`` tool in the Yocto Project development environment, you must do the following: - Because you launch ``menuconfig`` using BitBake, you must be sure to - set up your environment by running the - :ref:`structure-core-script` script found in - the :term:`Build Directory`. + set up your environment by running the :ref:`structure-core-script` script + found in the :term:`Build Directory`. - You must be sure of the state of your build's configuration in the :term:`Source Directory`. @@ -1160,7 +1073,7 @@ Consider an example that configures the "CONFIG_SMP" setting for the .. note:: The OpenEmbedded build system recognizes this kernel as ``linux-yocto`` - through Metadata (e.g. :term:`PREFERRED_VERSION`\ ``_linux-yocto ?= "12.4%"``). + through Metadata (e.g. :term:`PREFERRED_VERSION`\ ``_linux-yocto ?= "4.12%"``). Once ``menuconfig`` launches, use the interface to navigate through the selections to find the configuration settings in which you are @@ -1171,10 +1084,10 @@ can find the option under "Processor Type and Features". To deselect Multi-Processing Support" and enter "N" to clear the asterisk. When you are finished, exit out and save the change. -Saving the selections updates the ``.config`` configuration file. This -is the file that the OpenEmbedded build system uses to configure the -kernel during the build. You can find and examine this file in the Build -Directory in ``tmp/work/``. The actual ``.config`` is located in the +Saving the selections updates the ``.config`` configuration file. This is the +file that the OpenEmbedded build system uses to configure the kernel during +the build. You can find and examine this file in the :term:`Build Directory` +in ``tmp/work/``. The actual ``.config`` is located in the area where the specific kernel is built. For example, if you were building a Linux Yocto kernel based on the ``linux-yocto-4.12`` kernel and you were building a QEMU image targeted for ``x86`` architecture, @@ -1300,7 +1213,7 @@ saved, and one freshly created using the ``menuconfig`` tool. To create a configuration fragment using this method, follow these steps: -1. *Complete a Build Through Kernel Configuration:* Complete a build at +#. *Complete a Build Through Kernel Configuration:* Complete a build at least through the kernel configuration task as follows:: $ bitbake linux-yocto -c kernel_configme -f @@ -1310,11 +1223,11 @@ steps: your build state might become unknown, it is best to run this task prior to starting ``menuconfig``. -2. *Launch menuconfig:* Run the ``menuconfig`` command:: +#. *Launch menuconfig:* Run the ``menuconfig`` command:: $ bitbake linux-yocto -c menuconfig -3. *Create the Configuration Fragment:* Run the ``diffconfig`` command +#. *Create the Configuration Fragment:* Run the ``diffconfig`` command to prepare a configuration fragment. The resulting file ``fragment.cfg`` is placed in the ``${``\ :term:`WORKDIR`\ ``}`` @@ -1376,7 +1289,7 @@ In order to run this task, you must have an existing ``.config`` file. See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for information on how to create a configuration file. -Following is sample output from the ``do_kernel_configcheck`` task: +Here is sample output from the :ref:`ref-tasks-kernel_configcheck` task: .. code-block:: none @@ -1456,12 +1369,12 @@ possible by reading the output of the kernel configuration fragment audit, noting any issues, making changes to correct the issues, and then repeating. -As part of the kernel build process, the ``do_kernel_configcheck`` task +As part of the kernel build process, the :ref:`ref-tasks-kernel_configcheck` task runs. This task validates the kernel configuration by checking the final ``.config`` file against the input files. During the check, the task produces warning messages for the following issues: -- Requested options that did not make the final ``.config`` file. +- Requested options that did not make it into the final ``.config`` file. - Configuration items that appear twice in the same configuration fragment. @@ -1485,18 +1398,18 @@ configuration. To streamline the configuration, do the following: -1. *Use a Working Configuration:* Start with a full configuration that +#. *Use a Working Configuration:* Start with a full configuration that you know works. Be sure the configuration builds and boots successfully. Use this configuration file as your baseline. -2. *Run Configure and Check Tasks:* Separately run the - ``do_kernel_configme`` and ``do_kernel_configcheck`` tasks:: +#. *Run Configure and Check Tasks:* Separately run the + :ref:`ref-tasks-kernel_configme` and :ref:`ref-tasks-kernel_configcheck` tasks:: $ bitbake linux-yocto -c kernel_configme -f $ bitbake linux-yocto -c kernel_configcheck -f -3. *Process the Results:* Take the resulting list of files from the - ``do_kernel_configcheck`` task warnings and do the following: +#. *Process the Results:* Take the resulting list of files from the + :ref:`ref-tasks-kernel_configcheck` task warnings and do the following: - Drop values that are redefined in the fragment but do not change the final ``.config`` file. @@ -1508,9 +1421,9 @@ To streamline the configuration, do the following: - Remove repeated and invalid options. -4. *Re-Run Configure and Check Tasks:* After you have worked through the +#. *Re-Run Configure and Check Tasks:* After you have worked through the output of the kernel configuration audit, you can re-run the - ``do_kernel_configme`` and ``do_kernel_configcheck`` tasks to see the + :ref:`ref-tasks-kernel_configme` and :ref:`ref-tasks-kernel_configcheck` tasks to see the results of your changes. If you have more issues, you can deal with them as described in the previous step. @@ -1539,20 +1452,20 @@ If you build a kernel image and the version string has a "+" or a "-dirty" at the end, it means there are uncommitted modifications in the kernel's source directory. Follow these steps to clean up the version string: -1. *Discover the Uncommitted Changes:* Go to the kernel's locally cloned +#. *Discover the Uncommitted Changes:* Go to the kernel's locally cloned Git repository (source directory) and use the following Git command to list the files that have been changed, added, or removed:: $ git status -2. *Commit the Changes:* You should commit those changes to the kernel +#. *Commit the Changes:* You should commit those changes to the kernel source tree regardless of whether or not you will save, export, or use the changes:: $ git add $ git commit -s -a -m "getting rid of -dirty" -3. *Rebuild the Kernel Image:* Once you commit the changes, rebuild the +#. *Rebuild the Kernel Image:* Once you commit the changes, rebuild the kernel. Depending on your particular kernel development workflow, the @@ -1560,7 +1473,7 @@ source directory. Follow these steps to clean up the version string: on building the kernel image when using ``devtool``, see the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. For - information on building the kernel image when using Bitbake, see the + information on building the kernel image when using BitBake, see the ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" section. @@ -1586,18 +1499,18 @@ You can find this recipe in the ``poky`` Git repository: Here are some basic steps you can use to work with your own sources: -1. *Create a Copy of the Kernel Recipe:* Copy the +#. *Create a Copy of the Kernel Recipe:* Copy the ``linux-yocto-custom.bb`` recipe to your layer and give it a meaningful name. The name should include the version of the Yocto Linux kernel you are using (e.g. ``linux-yocto-myproject_4.12.bb``, where "4.12" is the base version of the Linux kernel with which you would be working). -2. *Create a Directory for Your Patches:* In the same directory inside +#. *Create a Directory for Your Patches:* In the same directory inside your layer, create a matching directory to store your patches and configuration files (e.g. ``linux-yocto-myproject``). -3. *Ensure You Have Configurations:* Make sure you have either a +#. *Ensure You Have Configurations:* Make sure you have either a ``defconfig`` file or configuration fragment files in your layer. When you use the ``linux-yocto-custom.bb`` recipe, you must specify a configuration. If you do not have a ``defconfig`` file, you can run @@ -1622,7 +1535,7 @@ Here are some basic steps you can use to work with your own sources: ``arch/arm/configs`` and use the one that is the best starting point for your board). -4. *Edit the Recipe:* Edit the following variables in your recipe as +#. *Edit the Recipe:* Edit the following variables in your recipe as appropriate for your project: - :term:`SRC_URI`: The @@ -1671,7 +1584,7 @@ Here are some basic steps you can use to work with your own sources: COMPATIBLE_MACHINE = "qemux86|qemux86-64" -5. *Customize Your Recipe as Needed:* Provide further customizations to +#. *Customize Your Recipe as Needed:* Provide further customizations to your recipe as needed just as you would customize an existing linux-yocto recipe. See the ":ref:`ref-manual/devtool-reference:modifying an existing recipe`" section @@ -1755,19 +1668,17 @@ looks much like the one provided with the ``hello-mod`` template:: SRC := $(shell pwd) all: - $(MAKE) -C $(KERNEL_SRC) M=$(SRC) + $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install: - $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install + $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install ... The important point to note here is the :term:`KERNEL_SRC` variable. The -:ref:`module <ref-classes-module>` class sets this variable and the -:term:`KERNEL_PATH` variable to -``${STAGING_KERNEL_DIR}`` with the necessary Linux kernel build -information to build modules. If your module ``Makefile`` uses a -different variable, you might want to override the -:ref:`ref-tasks-compile` step, or +:ref:`ref-classes-module` class sets this variable and the :term:`KERNEL_PATH` +variable to ``${STAGING_KERNEL_DIR}`` with the necessary Linux kernel build +information to build modules. If your module ``Makefile`` uses a different +variable, you might want to override the :ref:`ref-tasks-compile` step, or create a patch to the ``Makefile`` to work with the more typical :term:`KERNEL_SRC` or :term:`KERNEL_PATH` variables. @@ -1809,7 +1720,7 @@ tree. Using Git is an efficient way to see what has changed in the tree. What Changed in a Kernel? ------------------------- -Following are a few examples that show how to use Git commands to +Here are a few examples that show how to use Git commands to examine changes. These examples are by no means the only way to see changes. @@ -1829,8 +1740,7 @@ Here is an example that looks at what has changed in the ``emenlow`` branch of the ``linux-yocto-3.19`` kernel. The lower commit range is the commit associated with the ``standard/base`` branch, while the upper commit range is the commit associated with the ``standard/emenlow`` -branch. -:: +branch:: $ git whatchanged origin/standard/base..origin/standard/emenlow @@ -1904,7 +1814,7 @@ kernel features. Consider the following example that adds the "test.scc" feature to the build. -1. *Create the Feature File:* Create a ``.scc`` file and locate it just +#. *Create the Feature File:* Create a ``.scc`` file and locate it just as you would any other patch file, ``.cfg`` file, or fetcher item you specify in the :term:`SRC_URI` statement. @@ -1932,19 +1842,19 @@ build. ``linux-yocto`` directory has both the feature ``test.scc`` file and a similarly named configuration fragment file ``test.cfg``. -2. *Add the Feature File to SRC_URI:* Add the ``.scc`` file to the +#. *Add the Feature File to SRC_URI:* Add the ``.scc`` file to the recipe's :term:`SRC_URI` statement:: - SRC_URI:append = " file://test.scc" + SRC_URI += "file://test.scc" The leading space before the path is important as the path is appended to the existing path. -3. *Specify the Feature as a Kernel Feature:* Use the +#. *Specify the Feature as a Kernel Feature:* Use the :term:`KERNEL_FEATURES` statement to specify the feature as a kernel feature:: - KERNEL_FEATURES:append = " test.scc" + KERNEL_FEATURES += "test.scc" The OpenEmbedded build system processes the kernel feature when it builds the kernel. diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst index 910318e0f9..6a2fe4bb0b 100644 --- a/documentation/kernel-dev/concepts-appx.rst +++ b/documentation/kernel-dev/concepts-appx.rst @@ -117,7 +117,7 @@ upstream Linux kernel development and are managed by the Yocto Project team's Yocto Linux kernel development strategy. It is the Yocto Project team's policy to not back-port minor features to the released Yocto Linux kernel. They only consider back-porting significant technological -jumps - and, that is done after a complete gap analysis. The reason +jumps --- and, that is done after a complete gap analysis. The reason for this policy is that back-porting any small to medium sized change from an evolving Linux kernel can easily create mismatches, incompatibilities and very subtle errors. @@ -221,7 +221,7 @@ the line-by-line code ``diff`` level is now a trivial operation. The following illustration shows the conceptual Yocto Linux kernel. .. image:: figures/kernel-architecture-overview.png - :align: center + :width: 100% In the illustration, the "Kernel.org Branch Point" marks the specific spot (or Linux kernel release) from which the Yocto Linux kernel is @@ -318,12 +318,12 @@ tree specific to your kernel from which to generate the new kernel image. The following figure shows the temporary file structure created on your -host system when you build the kernel using Bitbake. This -:term:`Build Directory` contains all the -source files used during the build. +host system when you build the kernel using BitBake. This +:term:`Build Directory` contains all the source files used during the build. .. image:: figures/kernel-overview-2-generic.png :align: center + :width: 70% Again, for additional information on the Yocto Project kernel's architecture and its branching strategy, see the diff --git a/documentation/kernel-dev/faq.rst b/documentation/kernel-dev/faq.rst index e40e3ff372..4dffa90dbd 100644 --- a/documentation/kernel-dev/faq.rst +++ b/documentation/kernel-dev/faq.rst @@ -36,9 +36,9 @@ How do I install/not-install the kernel image on the root filesystem? The kernel image (e.g. ``vmlinuz``) is provided by the ``kernel-image`` package. Image recipes depend on ``kernel-base``. To specify whether or not the kernel image is installed in the generated -root filesystem, override ``RDEPENDS:${KERNEL_PACKAGE_NAME}-base`` to include or not +root filesystem, override ``RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base`` to include or not include "kernel-image". See the -":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" +":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual for information on how to use an append file to override metadata. diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index e406f6e47f..a663733a1d 100644 --- a/documentation/kernel-dev/intro.rst +++ b/documentation/kernel-dev/intro.rst @@ -87,7 +87,7 @@ understand the following documentation: as described in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. -- The ":ref:`dev-manual/common-tasks:understanding and creating layers`" +- The ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. - The ":ref:`kernel-dev/intro:kernel modification workflow`" section. @@ -106,21 +106,21 @@ modification workflow. The illustration and accompanying list provide general information and references for further information. .. image:: figures/kernel-dev-flow.png - :align: center + :width: 100% -1. *Set up Your Host Development System to Support Development Using the +#. *Set up Your Host Development System to Support Development Using the Yocto Project*: See the ":doc:`/dev-manual/start`" section in the Yocto Project Development Tasks Manual for options on how to get a build host ready to use the Yocto Project. -2. *Set Up Your Host Development System for Kernel Development:* It is - recommended that you use ``devtool`` and an extensible SDK for kernel +#. *Set Up Your Host Development System for Kernel Development:* It is + recommended that you use ``devtool`` for kernel development. Alternatively, you can use traditional kernel development methods with the Yocto Project. Either way, there are steps you need to take to get the development environment ready. - Using ``devtool`` and the eSDK requires that you have a clean build - of the image and that you are set up with the appropriate eSDK. For + Using ``devtool`` requires that you have a clean build + of the image. For more information, see the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" section. @@ -131,10 +131,10 @@ general information and references for further information. ":ref:`kernel-dev/common:getting ready for traditional kernel development`" section. -3. *Make Changes to the Kernel Source Code if applicable:* Modifying the +#. *Make Changes to the Kernel Source Code if applicable:* Modifying the kernel does not always mean directly changing source files. However, if you have to do this, you make the changes to the files in the - eSDK's Build Directory if you are using ``devtool``. For more + Yocto's :term:`Build Directory` if you are using ``devtool``. For more information, see the ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" section. @@ -144,7 +144,7 @@ general information and references for further information. ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" section. -4. *Make Kernel Configuration Changes if Applicable:* If your situation +#. *Make Kernel Configuration Changes if Applicable:* If your situation calls for changing the kernel's configuration, you can use :ref:`menuconfig <kernel-dev/common:using \`\`menuconfig\`\`>`, which allows you to @@ -155,7 +155,7 @@ general information and references for further information. .. note:: Try to resist the temptation to directly edit an existing ``.config`` - file, which is found in the Build Directory among the source code + file, which is found in the :term:`Build Directory` among the source code used for the build. Doing so, can produce unexpected results when the OpenEmbedded build system regenerates the configuration file. @@ -169,7 +169,7 @@ general information and references for further information. Additionally, if you are working in a BSP layer and need to modify the BSP's kernel's configuration, you can use ``menuconfig``. -5. *Rebuild the Kernel Image With Your Changes:* Rebuilding the kernel +#. *Rebuild the Kernel Image With Your Changes:* Rebuilding the kernel image applies your changes. Depending on your target hardware, you can verify your changes on actual hardware or perhaps QEMU. diff --git a/documentation/kernel-dev/maint-appx.rst b/documentation/kernel-dev/maint-appx.rst index d968c856f6..53b7376089 100644 --- a/documentation/kernel-dev/maint-appx.rst +++ b/documentation/kernel-dev/maint-appx.rst @@ -92,11 +92,11 @@ top-level kernel feature or BSP. The following actions effectively provide the Metadata and create the tree that includes the new feature, patch, or BSP: -1. *Pass Feature to the OpenEmbedded Build System:* A top-level kernel +#. *Pass Feature to the OpenEmbedded Build System:* A top-level kernel feature is passed to the kernel build subsystem. Normally, this feature is a BSP for a particular kernel type. -2. *Locate Feature:* The file that describes the top-level feature is +#. *Locate Feature:* The file that describes the top-level feature is located by searching these system directories: - The in-tree kernel-cache directories, which are located in the @@ -112,31 +112,31 @@ patch, or BSP: bsp_root_name-kernel_type.scc -3. *Expand Feature:* Once located, the feature description is either +#. *Expand Feature:* Once located, the feature description is either expanded into a simple script of actions, or into an existing equivalent script that is already part of the shipped kernel. -4. *Append Extra Features:* Extra features are appended to the top-level +#. *Append Extra Features:* Extra features are appended to the top-level feature description. These features can come from the :term:`KERNEL_FEATURES` variable in recipes. -5. *Locate, Expand, and Append Each Feature:* Each extra feature is +#. *Locate, Expand, and Append Each Feature:* Each extra feature is located, expanded and appended to the script as described in step three. -6. *Execute the Script:* The script is executed to produce files +#. *Execute the Script:* The script is executed to produce files ``.scc`` and ``.cfg`` files in appropriate directories of the ``yocto-kernel-cache`` repository. These files are descriptions of all the branches, tags, patches and configurations that need to be applied to the base Git repository to completely create the source (build) branch for the new BSP or feature. -7. *Clone Base Repository:* The base repository is cloned, and the +#. *Clone Base Repository:* The base repository is cloned, and the actions listed in the ``yocto-kernel-cache`` directories are applied to the tree. -8. *Perform Cleanup:* The Git repositories are left with the desired +#. *Perform Cleanup:* The Git repositories are left with the desired branches checked out and any required branching, patching and tagging has been performed. @@ -229,6 +229,5 @@ This behavior means that all the generated files for a particular machine or BSP are now in the build tree directory. The files include the final ``.config`` file, all the ``.o`` files, the ``.a`` files, and so forth. Since each machine or BSP has its own separate -:term:`Build Directory` in its own separate -branch of the Git repository, you can easily switch between different -builds. +:term:`Build Directory` in its own separate branch of the Git repository, +you can easily switch between different builds. diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst index 6472cc2848..d8edd05b89 100644 --- a/documentation/migration-guides/index.rst +++ b/documentation/migration-guides/index.rst @@ -1,19 +1,23 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -========================== - Release Migration Guides -========================== +==================== + Release Information +==================== | -Each document in this chapter provides information about how +Each document in this chapter provides release notes and information about how to move to one release of the Yocto Project from the previous one. .. toctree:: migration-general - migration-3.5 - migration-3.4 + release-5.0 + release-4.3 + release-4.2 + release-4.1 + release-4.0 + release-3.4 migration-3.3 migration-3.2 migration-3.1 diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index 9a1539172e..95f7e3572b 100644 --- a/documentation/migration-guides/migration-1.3.rst +++ b/documentation/migration-guides/migration-1.3.rst @@ -62,7 +62,7 @@ Previously, an inconsistent mix of spaces and tabs existed, which made extending these functions using ``_append`` or ``_prepend`` complicated given that Python treats whitespace as syntactically significant. If you are defining or extending any Python functions (e.g. -``populate_packages``, ``do_unpack``, ``do_patch`` and so forth) in +``populate_packages``, :ref:`ref-tasks-unpack`, :ref:`ref-tasks-patch` and so forth) in custom recipes or classes, you need to ensure you are using consistent four-space indentation. @@ -91,11 +91,11 @@ consistency. nativesdk ~~~~~~~~~ -The suffix ``nativesdk`` is now implemented as a prefix, which -simplifies a lot of the packaging code for ``nativesdk`` recipes. All -custom ``nativesdk`` recipes, which are relocatable packages that are -native to :term:`SDK_ARCH`, and any references need to -be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. +The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a lot +of the packaging code for :ref:`ref-classes-nativesdk` recipes. All custom +:ref:`ref-classes-nativesdk` recipes, which are relocatable packages that are +native to :term:`SDK_ARCH`, and any references need to be updated to use +``nativesdk-*`` instead of ``*-nativesdk``. .. _migration-1.3-task-recipes: @@ -109,12 +109,11 @@ automatic upgrade path for most packages. However, you should update references in your own recipes and configurations as they could be removed in future releases. You should also rename any custom ``task-*`` recipes to ``packagegroup-*``, and change them to inherit -``packagegroup`` instead of ``task``, as well as taking the opportunity -to remove anything now handled by ``packagegroup.bbclass``, such as -providing ``-dev`` and ``-dbg`` packages, setting -:term:`LIC_FILES_CHKSUM`, and so forth. See the -:ref:`ref-classes-packagegroup` section for -further details. +:ref:`ref-classes-packagegroup` instead of ``task``, as well +as taking the opportunity to remove anything now handled by +:ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` +packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the +:ref:`ref-classes-packagegroup` section for further details. .. _migration-1.3-image-features: diff --git a/documentation/migration-guides/migration-1.4.rst b/documentation/migration-guides/migration-1.4.rst index baf3c08379..6db2a035b8 100644 --- a/documentation/migration-guides/migration-1.4.rst +++ b/documentation/migration-guides/migration-1.4.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 1.4 (dylan) =================== @@ -83,7 +85,7 @@ create an append file for the ``init-ifupdown`` recipe instead, which you can find in the :term:`Source Directory` at ``meta/recipes-core/init-ifupdown``. For information on how to use append files, see the -":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" +":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual. .. _migration-1.4-remote-debugging: diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 0306b99c65..c8f3cbc165 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 1.5 (dora) ================== @@ -26,8 +28,7 @@ provide packages for these, you can install and use the Buildtools tarball, which provides an SDK-like environment containing them. For more information on this requirement, see the -":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" -section. +":ref:`system-requirements-buildtools`" section. .. _migration-1.5-atom-pc-bsp: @@ -94,9 +95,8 @@ The following changes have been made to the package QA checks: this file within :ref:`ref-tasks-install` if "make install" is installing it. -- If you are using the :ref:`buildhistory <ref-classes-buildhistory>` class, - the check for the package - version going backwards is now controlled using a standard QA check. +- If you are using the :ref:`ref-classes-buildhistory` class, the check for the + package version going backwards is now controlled using a standard QA check. Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values and still wish to have this check performed, you should add "version-going-backwards" to your value for one or the other @@ -126,10 +126,14 @@ The following directory changes exist: :term:`DEPLOY_DIR_IMAGE` variable in the external environment. - When buildhistory is enabled, its output is now written under the - :term:`Build Directory` rather than - :term:`TMPDIR`. Doing so makes it easier to delete - :term:`TMPDIR` and preserve the build history. Additionally, data for - produced SDKs is now split by :term:`IMAGE_NAME`. + :term:`Build Directory` rather than :term:`TMPDIR`. Doing so makes + it easier to delete :term:`TMPDIR` and preserve the build history. + Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. + +- When :ref:`ref-classes-buildhistory` is enabled, its output + is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. + Doing so makes it easier to delete :term:`TMPDIR` and preserve the build + history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. - The ``pkgdata`` directory produced as part of the packaging process has been collapsed into a single machine-specific directory. This @@ -217,8 +221,8 @@ Task Recipes The previously deprecated ``task.bbclass`` has now been dropped. For recipes that previously inherited from this class, you should rename -them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup -instead. +them from ``task-*`` to ``packagegroup-*`` and inherit +:ref:`ref-classes-packagegroup` instead. For more information, see the ":ref:`ref-classes-packagegroup`" section. @@ -240,11 +244,11 @@ Automated Image Testing ----------------------- A new automated image testing framework has been added through the -:ref:`testimage.bbclass <ref-classes-testimage*>` class. This +:ref:`ref-classes-testimage` classes. This framework replaces the older ``imagetest-qemu`` framework. You can learn more about performing automated image tests in the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" +":ref:`dev-manual/runtime-testing:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. .. _migration-1.5-build-history: @@ -252,7 +256,7 @@ section in the Yocto Project Development Tasks Manual. Build History ------------- -Following are changes to Build History: +The changes to Build History are: - Installed package sizes: ``installed-package-sizes.txt`` for an image now records the size of the files installed by each package instead @@ -267,7 +271,7 @@ Following are changes to Build History: option for each utility for more information on the new syntax. For more information on Build History, see the -":ref:`dev-manual/common-tasks:maintaining build output quality`" +":ref:`dev-manual/build-quality:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. .. _migration-1.5-udev: @@ -275,7 +279,7 @@ section in the Yocto Project Development Tasks Manual. ``udev`` -------- -Following are changes to ``udev``: +The changes to ``udev`` are: - ``udev`` no longer brings in ``udev-extraconf`` automatically through :term:`RRECOMMENDS`, since this was originally @@ -319,7 +323,7 @@ Removed and Renamed Recipes Other Changes ------------- -Following is a list of short entries describing other changes: +Here is a list of short entries describing other changes: - ``run-postinsts``: Make this generic. @@ -341,7 +345,7 @@ Following is a list of short entries describing other changes: - ``libpam``: Deny all services for the ``OTHER`` entries. -- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict +- :ref:`ref-classes-image`: Move ``runtime_mapping_rename`` to avoid conflict with ``multilib``. See :yocto_bugs:`YOCTO #4993 </show_bug.cgi?id=4993>` in Bugzilla for more information. diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst index 358086560b..916169e836 100644 --- a/documentation/migration-guides/migration-1.6.rst +++ b/documentation/migration-guides/migration-1.6.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 1.6 (daisy) =================== @@ -9,10 +11,9 @@ Project 1.6 Release (codename "daisy") from the prior release. ``archiver`` Class ------------------ -The :ref:`archiver <ref-classes-archiver>` class has been rewritten -and its configuration has been simplified. For more details on the -source archiver, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +The :ref:`ref-classes-archiver` class has been rewritten and its configuration +has been simplified. For more details on the source archiver, see the +":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. .. _migration-1.6-packaging-changes: @@ -147,7 +148,7 @@ NFS mount, an error occurs. The ``PRINC`` variable has been deprecated and triggers a warning if detected during a build. For :term:`PR` increments on changes, use the PR service instead. You can find out more about this service in -the ":ref:`dev-manual/common-tasks:working with a pr service`" +the ":ref:`dev-manual/packages:working with a pr service`" section in the Yocto Project Development Tasks Manual. .. _migration-1.6-variable-changes-IMAGE_TYPES: @@ -220,9 +221,9 @@ Package Test (ptest) Package Tests (ptest) are built but not installed by default. For information on using Package Tests, see the -":ref:`dev-manual/common-tasks:testing packages with ptest`" -section in the Yocto Project Development Tasks Manual. For information on the -``ptest`` class, see the ":ref:`ref-classes-ptest`" section. +":ref:`dev-manual/packages:testing packages with ptest`" section in the +Yocto Project Development Tasks Manual. See also the ":ref:`ref-classes-ptest`" +section. .. _migration-1.6-build-changes: @@ -231,13 +232,13 @@ Build Changes Separate build and source directories have been enabled by default for selected recipes where it is known to work and for all -recipes that inherit the :ref:`cmake <ref-classes-cmake>` class. In -future releases the :ref:`autotools <ref-classes-autotools>` class -will enable a separate build directory by default as well. Recipes +recipes that inherit the :ref:`ref-classes-cmake` class. In +future releases the :ref:`ref-classes-autotools` class +will enable a separate :term:`Build Directory` by default as well. Recipes building Autotools-based software that fails to build with a separate -build directory should be changed to inherit from the +:term:`Build Directory` should be changed to inherit from the :ref:`autotools-brokensep <ref-classes-autotools>` class instead of -the ``autotools`` or ``autotools_stage``\ classes. +the :ref:`ref-classes-autotools` or ``autotools_stage`` classes. .. _migration-1.6-building-qemu-native: @@ -341,39 +342,39 @@ Removed and Renamed Recipes The following recipes have been removed: -- ``packagegroup-toolset-native`` - This recipe is largely unused. +- ``packagegroup-toolset-native`` --- this recipe is largely unused. -- ``linux-yocto-3.8`` - Support for the Linux yocto 3.8 kernel has been +- ``linux-yocto-3.8`` --- support for the Linux yocto 3.8 kernel has been dropped. Support for the 3.10 and 3.14 kernels have been added with the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes. -- ``ocf-linux`` - This recipe has been functionally replaced using +- ``ocf-linux`` --- this recipe has been functionally replaced using ``cryptodev-linux``. -- ``genext2fs`` - ``genext2fs`` is no longer used by the build system +- ``genext2fs`` --- ``genext2fs`` is no longer used by the build system and is unmaintained upstream. -- ``js`` - This provided an ancient version of Mozilla's javascript +- ``js`` --- this provided an ancient version of Mozilla's javascript engine that is no longer needed. -- ``zaurusd`` - The recipe has been moved to the ``meta-handheld`` +- ``zaurusd`` --- the recipe has been moved to the ``meta-handheld`` layer. -- ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe. +- ``eglibc 2.17`` --- replaced by the ``eglibc 2.19`` recipe. -- ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``. +- ``gcc 4.7.2`` --- replaced by the now stable ``gcc 4.8.2``. -- ``external-sourcery-toolchain`` - this recipe is now maintained in +- ``external-sourcery-toolchain`` --- this recipe is now maintained in the ``meta-sourcery`` layer. -- ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the +- ``linux-libc-headers-yocto 3.4+git`` --- now using version 3.10 of the ``linux-libc-headers`` by default. -- ``meta-toolchain-gmae`` - This recipe is obsolete. +- ``meta-toolchain-gmae`` --- this recipe is obsolete. -- ``packagegroup-core-sdk-gmae`` - This recipe is obsolete. +- ``packagegroup-core-sdk-gmae`` --- this recipe is obsolete. -- ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is +- ``packagegroup-core-standalone-gmae-sdk-target`` --- this recipe is obsolete. .. _migration-1.6-removed-classes: diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst index 88a6855d50..ca8222098a 100644 --- a/documentation/migration-guides/migration-1.7.rst +++ b/documentation/migration-guides/migration-1.7.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 1.7 (dizzy) =================== @@ -30,8 +32,8 @@ version required on the build host is now 1.7.8 because the ``--list`` option is now required by BitBake's Git fetcher. As always, if your host distribution does not provide a version of Git that meets this requirement, you can use the -``buildtools-tarball`` that does. See the -":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" +:term:`buildtools` tarball that does. See the +":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" section for more information. .. _migration-1.7-autotools-class-changes: @@ -39,13 +41,11 @@ section for more information. Autotools Class Changes ----------------------- -The following :ref:`autotools <ref-classes-autotools>` class changes -occurred: +The following :ref:`ref-classes-autotools` class changes occurred: -- *A separate build directory is now used by default:* The - :ref:`autotools <ref-classes-autotools>` class has been - changed to use a directory for building - (:term:`B`), which is separate from the source directory +- *A separate :term:`Build Directory` is now used by default:* The + :ref:`ref-classes-autotools` class has been changed to use a directory for + building (:term:`B`), which is separate from the source directory (:term:`S`). This is commonly referred to as ``B != S``, or an out-of-tree build. @@ -54,9 +54,8 @@ occurred: However, if the software is not capable of being built in this manner, you will need to either patch the software so that it can build separately, or you will need to change the recipe to inherit - the :ref:`autotools-brokensep <ref-classes-autotools>` class - instead of the :ref:`autotools <ref-classes-autotools>` - or ``autotools_stage`` classes. + the :ref:`autotools-brokensep <ref-classes-autotools>` class instead + of the :ref:`ref-classes-autotools` or ``autotools_stage`` classes. - The ``--foreign`` option is no longer passed to ``automake`` when running ``autoconf``: This option tells ``automake`` that a @@ -165,7 +164,7 @@ The following changes have occurred to the QA check process: more parallel execution. This change is unlikely to be an issue except for highly customized recipes that disable packaging tasks themselves by marking them as ``noexec``. For those packages, you - will need to disable the ``do_package_qa`` task as well. + will need to disable the :ref:`ref-tasks-package_qa` task as well. - Files being overwritten during the :ref:`ref-tasks-populate_sysroot` task now @@ -217,7 +216,7 @@ The following miscellaneous change occurred: should manually remove old "build-id" files from your existing build history repositories to avoid confusion. For information on the build history feature, see the - ":ref:`dev-manual/common-tasks:maintaining build output quality`" + ":ref:`dev-manual/build-quality:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst index 51a13873e2..5cc5f8a047 100644 --- a/documentation/migration-guides/migration-1.8.rst +++ b/documentation/migration-guides/migration-1.8.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 1.8 (fido) ================== @@ -68,23 +70,22 @@ the following:: Kernel Build Changes -------------------- -The kernel build process was changed to place the source in a common -shared work area and to place build artifacts separately in the source -code tree. In theory, migration paths have been provided for most common -usages in kernel recipes but this might not work in all cases. In -particular, users need to ensure that ``${S}`` (source files) and -``${B}`` (build artifacts) are used correctly in functions such as -:ref:`ref-tasks-configure` and -:ref:`ref-tasks-install`. For kernel recipes that do not -inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might -wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the -kinds of changes you need to make. For reference, here is the +The kernel build process was changed to place the source in a common shared work +area and to place build artifacts separately in the source code tree. In theory, +migration paths have been provided for most common usages in kernel recipes but +this might not work in all cases. In particular, users need to ensure that +``${S}`` (source files) and ``${B}`` (build artifacts) are used correctly in +functions such as :ref:`ref-tasks-configure` and :ref:`ref-tasks-install`. For +kernel recipes that do not inherit from :ref:`ref-classes-kernel-yocto` or +include ``linux-yocto.inc``, you might wish to refer to the ``linux.inc`` file +in the ``meta-oe`` layer for the kinds of changes you need to make. For reference, +here is the :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` where the ``linux.inc`` file in ``meta-oe`` was updated. Recipes that rely on the kernel source code and do not inherit the -module classes might need to add explicit dependencies on the -``do_shared_workdir`` kernel task, for example:: +:ref:`module <ref-classes-module>` classes might need to add explicit +dependencies on the :ref:`ref-tasks-shared_workdir` kernel task, for example:: do_configure[depends] += "virtual/kernel:do_shared_workdir" @@ -121,14 +122,13 @@ need to take corrective steps. Rebuild Improvements -------------------- -Changes have been made to the :ref:`base <ref-classes-base>`, -:ref:`autotools <ref-classes-autotools>`, and -:ref:`cmake <ref-classes-cmake>` classes to clean out generated files -when the :ref:`ref-tasks-configure` task needs to be +Changes have been made to the :ref:`ref-classes-base`, +:ref:`ref-classes-autotools`, and :ref:`ref-classes-cmake` classes to clean out +generated files when the :ref:`ref-tasks-configure` task needs to be re-executed. One of the improvements is to attempt to run "make clean" during the -``do_configure`` task if a ``Makefile`` exists. Some software packages +:ref:`ref-tasks-configure` task if a ``Makefile`` exists. Some software packages do not provide a working clean target within their make files. If you have such recipes, you need to set :term:`CLEANBROKEN` to "1" within the recipe, for example:: diff --git a/documentation/migration-guides/migration-2.0.rst b/documentation/migration-guides/migration-2.0.rst index 7217853779..13be9846df 100644 --- a/documentation/migration-guides/migration-2.0.rst +++ b/documentation/migration-guides/migration-2.0.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.0 (jethro) ==================== @@ -214,7 +216,7 @@ modifications synchronized, it is not always obvious to developers how to manipulate the Metadata as compared to the source. Metadata processing has now been removed from the -:ref:`kernel-yocto <ref-classes-kernel-yocto>` class and the external +:ref:`ref-classes-kernel-yocto` class and the external Metadata repository ``yocto-kernel-cache``, which has always been used to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto`` cache repository is now the primary location for this data. Due to this diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index eb29694bb5..18b05b52cc 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.1 (krogoth) ===================== @@ -64,7 +66,7 @@ Makefile Environment Changes :term:`EXTRA_OEMAKE` now defaults to "" instead of "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default was a historical accident that has required many classes (e.g. -``autotools``, ``module``) and recipes to override this default in order +:ref:`ref-classes-autotools`, ``module``) and recipes to override this default in order to work with sensible build systems. When upgrading to the release, you must edit any recipe that relies upon this old default by either setting :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any @@ -98,7 +100,7 @@ breaking FHS. ``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files -------------------------------------------------------- -For recipes inheriting the :ref:`autotools <ref-classes-autotools>` +For recipes inheriting the :ref:`ref-classes-autotools` class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for ``autoconf``. The reason for this change is because the ``ac_cv_sizeof_off_t`` value is not necessarily static per architecture @@ -106,14 +108,14 @@ as was previously assumed. Rather, the value changes based on whether large file support is enabled. For most software that uses ``autoconf``, this change should not be a problem. However, if you have a recipe that bypasses the standard :ref:`ref-tasks-configure` task -from the :ref:`autotools <ref-classes-autotools>` class and the software the recipe is building +from the :ref:`ref-classes-autotools` class and the software the recipe is building uses a very old version of ``autoconf``, the recipe might be incapable -of determining the correct size of ``off_t`` during ``do_configure``. +of determining the correct size of ``off_t`` during :ref:`ref-tasks-configure`. The best course of action is to patch the software as necessary to allow -the default implementation from the :ref:`autotools <ref-classes-autotools>` class to work such +the default implementation from the :ref:`ref-classes-autotools` class to work such that ``autoreconf`` succeeds and produces a working configure script, -and to remove the overridden ``do_configure`` task such that the default +and to remove the overridden :ref:`ref-tasks-configure` task such that the default implementation does get used. .. _migration-2.1-image-generation-split-out-from-filesystem-generation: @@ -128,17 +130,16 @@ separate :ref:`ref-tasks-image` tasks for clarity both in operation and in the code. For most cases, this change does not present any problems. However, if -you have made customizations that directly modify the ``do_rootfs`` task -or that mention ``do_rootfs``, you might need to update those changes. -In particular, if you had added any tasks after ``do_rootfs``, you +you have made customizations that directly modify the :ref:`ref-tasks-rootfs` task +or that mention :ref:`ref-tasks-rootfs`, you might need to update those changes. +In particular, if you had added any tasks after :ref:`ref-tasks-rootfs`, you should make edits so that those tasks are after the :ref:`ref-tasks-image-complete` task rather than -after ``do_rootfs`` so that your added tasks run at the correct +after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct time. -A minor part of this restructuring is that the post-processing -definitions and functions have been moved from the -:ref:`image <ref-classes-image>` class to the +A minor part of this restructuring is that the post-processing definitions and +functions have been moved from the :ref:`ref-classes-image` class to the :ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally, however, they remain unchanged. @@ -189,18 +190,17 @@ Class Changes The following classes have changed: - ``autotools_stage``: Removed because the - :ref:`autotools <ref-classes-autotools>` class now provides its + :ref:`ref-classes-autotools` class now provides its functionality. Recipes that inherited from ``autotools_stage`` should - now inherit from ``autotools`` instead. + now inherit from :ref:`ref-classes-autotools` instead. - ``boot-directdisk``: Merged into the ``image-vm`` class. The ``boot-directdisk`` class was rarely directly used. Consequently, this change should not cause any issues. -- ``bootimg``: Merged into the - :ref:`image-live <ref-classes-image-live>` class. The ``bootimg`` - class was rarely directly used. Consequently, this change should not - cause any issues. +- ``bootimg``: Merged into the :ref:`ref-classes-image-live` class. The + ``bootimg`` class was rarely directly used. Consequently, this change should + not cause any issues. - ``packageinfo``: Removed due to its limited use by the Hob UI, which has itself been removed. @@ -255,14 +255,14 @@ The following changes have been made for the Poky distribution: not need to change anything unless you are relying on this naming elsewhere. -- The :ref:`uninative <ref-classes-uninative>` class is now enabled +- The :ref:`ref-classes-uninative` class is now enabled by default in Poky. This class attempts to isolate the build system from the host distribution's C library and makes re-use of native shared state artifacts across different host distributions practical. With this class enabled, a tarball containing a pre-built C library is downloaded at the start of the build. - The :ref:`uninative <ref-classes-uninative>` class is enabled through the + The :ref:`ref-classes-uninative` class is enabled through the ``meta/conf/distro/include/yocto-uninative.inc`` file, which for those not using the Poky distribution, can include to easily enable the same functionality. @@ -281,7 +281,7 @@ The following changes have been made for the Poky distribution: using the Poky distribution can easily include to enable the same functionality. - Any recipe that needs to opt-out of having the "--disable-static" + Any recipe that needs to opt-out of having the ``--disable-static`` option specified on the configure command line either because it is not a supported option for the configure script or because static libraries are needed should set the following variable:: @@ -343,7 +343,7 @@ This release supports generation of GLib Introspective Repository (GIR) files through GObject introspection, which is the standard mechanism for accessing GObject-based software from runtime environments. You can enable, disable, and test the generation of this data. See the -":ref:`dev-manual/common-tasks:enabling gobject introspection support`" +":ref:`dev-manual/gobject-introspection:enabling gobject introspection support`" section in the Yocto Project Development Tasks Manual for more information. @@ -356,9 +356,9 @@ These additional changes exist: - The minimum Git version has been increased to 1.8.3.1. If your host distribution does not provide a sufficiently recent version, you can - install the buildtools, which will provide it. See the - :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` - section for more information on the buildtools tarball. + install the :term:`buildtools`, which will provide it. See the + :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` + section for more information on the :term:`buildtools` tarball. - The buggy and incomplete support for the RPM version 4 package manager has been removed. The well-tested and maintained support for @@ -384,9 +384,9 @@ These additional changes exist: - The :ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>` command now defaults to extracting the source since that is most - commonly expected. The "-x" or "--extract" options are now no-ops. If + commonly expected. The ``-x`` or ``--extract`` options are now no-ops. If you wish to provide your own existing source tree, you will now need - to specify either the "-n" or "--no-extract" options when running + to specify either the ``-n`` or ``--no-extract`` options when running ``devtool modify``. - If the formfactor for a machine is either not supplied or does not @@ -401,9 +401,9 @@ These additional changes exist: as these directories are automatically found and added. - Inaccurate disk and CPU percentage data has been dropped from - ``buildstats`` output. This data has been replaced with + :ref:`ref-classes-buildstats` output. This data has been replaced with ``getrusage()`` data and corrected IO statistics. You will probably - need to update any custom code that reads the ``buildstats`` data. + need to update any custom code that reads the :ref:`ref-classes-buildstats` data. - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. The contents of this file have been moved to individual recipes. diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index a6c1a4aa48..9d50dc6202 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.2 (morty) =================== @@ -26,8 +28,8 @@ Staging Directories in Sysroot Has Been Simplified The way directories are staged in sysroot has been simplified and introduces the new :term:`SYSROOT_DIRS`, -:term:`SYSROOT_DIRS_NATIVE`, and -:term:`SYSROOT_DIRS_BLACKLIST`. See the +:term:`SYSROOT_DIRS_NATIVE`, and ``SYSROOT_DIRS_BLACKLIST`` +(replaced by :term:`SYSROOT_DIRS_IGNORE` in version 4.0). See the :oe_lists:`v2 patch series on the OE-Core Mailing List </pipermail/openembedded-core/2016-May/121365.html>` for additional information. @@ -70,9 +72,9 @@ Metadata Must Now Use Python 3 Syntax The metadata is now required to use Python 3 syntax. For help preparing metadata, see any of the many Python 3 porting guides available. -Alternatively, you can reference the conversion commits for Bitbake and -you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are -particular areas of interest: +Alternatively, you can reference the conversion commits for BitBake and +you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. +Particular areas of interest are: - subprocess command-line pipes needing locale decoding @@ -103,7 +105,7 @@ online package-manager support through SMART still require Python 2. ``buildtools-tarball`` Includes Python 3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -``buildtools-tarball`` now includes Python 3. +The :term:`buildtools` tarball now includes Python 3. .. _migration-2.2-uclibc-replaced-by-musl: @@ -119,11 +121,10 @@ compared to uClibc. ``${B}`` No Longer Default Working Directory for Tasks ------------------------------------------------------ -``${``\ :term:`B`\ ``}`` is no longer the default working -directory for tasks. Consequently, any custom tasks you define now need -to either have the -``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag -set, or the task needs to change into the appropriate working directory +``${``\ :term:`B`\ ``}`` is no longer the default working directory for tasks. +Consequently, any custom tasks you define now need to either have the +``[``\ :ref:`dirs <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` +flag set, or the task needs to change into the appropriate working directory manually (e.g using ``cd`` for a shell task). .. note:: @@ -181,14 +182,8 @@ root filesystem, provides an image, and uses the ``nographic`` option:: $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic -Following is a list of variables that can be set in configuration files -such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``: - -.. note:: - - "QB" means "QEMU Boot". - -:: +Here is a list of variables that can be set in configuration files +such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``:: QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor") @@ -223,6 +218,10 @@ follows and run ``runqemu``: .. note:: + "QB" means "QEMU Boot". + +.. note:: + For command-line syntax, use ``runqemu help``. :: @@ -439,10 +438,10 @@ The following miscellaneous changes have occurred: - ``packagegroup-core-tools-testapps``: Removed Piglit. -- :ref:`image.bbclass <ref-classes-image>`: Renamed COMPRESS(ION) to CONVERSION. This change +- :ref:`ref-classes-image`: Renamed COMPRESS(ION) to CONVERSION. This change means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, - ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` + ``CONVERSION_DEPENDS`` and :term:`CONVERSION_CMD`. The ``COMPRESS*`` variable names will still work in the 2.2 release but metadata that does not need to be backwards-compatible should be changed to use the new names as the ``COMPRESS*`` ones will be removed in a future diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index 0b6b33d2cb..60340b9592 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.3 (pyro) ================== @@ -50,7 +52,7 @@ Consider the following: post-installation script that is installed by a function added to :term:`SYSROOT_PREPROCESS_FUNCS`. - For an example, see the :ref:`pixbufcache <ref-classes-pixbufcache>` class in ``meta/classes/`` in + For an example, see the :ref:`ref-classes-pixbufcache` class in ``meta/classes/`` in the :ref:`overview-manual/development-environment:yocto project source repositories`. .. note:: @@ -196,9 +198,9 @@ The following changes took place for BitBake: fetcher passes the new parameter through the ``SVN_SSH`` environment variable during the :ref:`ref-tasks-fetch` task. - See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`" - section in the BitBake - User Manual for additional information. + See the + ":ref:`bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`" + section in the BitBake User Manual for additional information. - ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` Removed: Because the mechanism they were part of is no longer @@ -304,8 +306,7 @@ The following package management changes took place: This change was made because too many places in DNF/RPM4 stack already make that assumption. Only the filenames and the architecture tag has changed. Nothing else has changed in OE-core system, - particularly in the :ref:`allarch.bbclass <ref-classes-allarch>` - class. + particularly in the :ref:`ref-classes-allarch` class. - Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not currently supported. This issue will be fully addressed in a future @@ -364,14 +365,14 @@ The following changes have been made to Wic: .. note:: For more information on Wic, see the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + ":ref:`dev-manual/wic:creating partitioned images using wic`" section in the Yocto Project Development Tasks Manual. - *Default Output Directory Changed:* Wic's default output directory is now the current directory by default instead of the unusual ``/var/tmp/wic``. - The "-o" and "--outdir" options remain unchanged and are used to + The ``-o`` and ``--outdir`` options remain unchanged and are used to specify your preferred output directory if you do not want to use the default directory. @@ -401,7 +402,7 @@ The following QA checks have changed: warning, you need to address missing runtime dependencies. For additional information, see the - :ref:`insane <ref-classes-insane>` class and the + :ref:`ref-classes-insane` class and the ":ref:`ref-manual/qa-checks:errors and warnings`" section. .. _migration-2.3-miscellaneous-changes: @@ -445,7 +446,7 @@ The following miscellaneous changes have occurred: RSA keys only, and with recent versions of OpenSSH, which deprecates DSA host keys. -- The :ref:`buildhistory <ref-classes-buildhistory>` class now +- The :ref:`ref-classes-buildhistory` class now correctly uses tabs as separators between all columns in ``installed-package-sizes.txt`` in order to aid import into other tools. @@ -482,29 +483,26 @@ The following miscellaneous changes have occurred: is an unnecessary burden. If you need to preserve these ``.la`` files (e.g. in a custom - distribution), you must change - :term:`INHERIT_DISTRO` such that - "remove-libtool" is not included in the value. + distribution), you must change :term:`INHERIT_DISTRO` such that + ":ref:`ref-classes-remove-libtool`" is not included + in the value. - Extensible SDKs built for GCC 5+ now refuse to install on a distribution where the host GCC version is 4.8 or 4.9. This change resulted from the fact that the installation is known to fail due to the way the ``uninative`` shared state (sstate) package is built. See - the :ref:`uninative <ref-classes-uninative>` class for additional - information. + the :ref:`ref-classes-uninative` class for additional information. -- All native and nativesdk recipes now use a separate - :term:`DISTRO_FEATURES` value instead of sharing the value used by - recipes for the target, in order to avoid unnecessary rebuilds. +- All :ref:`ref-classes-native` and :ref:`ref-classes-nativesdk` recipes now + use a separate :term:`DISTRO_FEATURES` value instead of sharing the value + used by recipes for the target, in order to avoid unnecessary rebuilds. - The :term:`DISTRO_FEATURES` for ``native`` recipes is - :term:`DISTRO_FEATURES_NATIVE` added to - an intersection of :term:`DISTRO_FEATURES` and - :term:`DISTRO_FEATURES_FILTER_NATIVE`. + The :term:`DISTRO_FEATURES` for :ref:`ref-classes-native` recipes + is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of + :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. - For nativesdk recipes, the corresponding variables are - :term:`DISTRO_FEATURES_NATIVESDK` - and + For :ref:`ref-classes-nativesdk` recipes, the corresponding + variables are :term:`DISTRO_FEATURES_NATIVESDK` and :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. - The ``FILESDIR`` variable, which was previously deprecated and rarely diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index ef5f32e6ef..5d5d601988 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.4 (rocko) =================== @@ -54,7 +56,7 @@ occurred: when "pam" is in :term:`DISTRO_FEATURES`. - The ``switch_root`` program is now packaged in a separate - "util-linux-switch-root" package for small initramfs images that + "util-linux-switch-root" package for small :term:`Initramfs` images that do not need the whole ``util-linux`` package or the busybox binary, which are both much larger than ``switch_root``. The main ``util-linux`` package has a recommended runtime dependency (i.e. @@ -89,8 +91,6 @@ occurred: Removed Recipes --------------- -The following recipes have been removed: - - ``acpitests``: This recipe is not maintained. - ``autogen-native``: No longer required by Grub, oe-core, or @@ -195,12 +195,10 @@ Kernel Device Tree Move ----------------------- Kernel Device Tree support is now easier to enable in a kernel recipe. -The Device Tree code has moved to a -:ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class. +The Device Tree code has moved to a :ref:`ref-classes-kernel-devicetree` class. Functionality is automatically enabled for any recipe that inherits the -:ref:`kernel <ref-classes-kernel>` class and sets the -:term:`KERNEL_DEVICETREE` variable. The -previous mechanism for doing this, +:ref:`kernel <ref-classes-kernel>` class and sets the :term:`KERNEL_DEVICETREE` +variable. The previous mechanism for doing this, ``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid breakage, but triggers a deprecation warning. Future releases of the Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``. @@ -213,8 +211,6 @@ recipes you might have. This will avoid breakage in post 2.4 releases. Package QA Changes ------------------ -The following package QA changes took place: - - The "unsafe-references-in-scripts" QA check has been removed. - If you refer to ``${COREBASE}/LICENSE`` within @@ -229,8 +225,6 @@ The following package QA changes took place: ``README`` File Changes ----------------------- -The following are changes to ``README`` files: - - The main Poky ``README`` file has been moved to the ``meta-poky`` layer and has been renamed ``README.poky``. A symlink has been created so that references to the old location work. @@ -246,8 +240,6 @@ The following are changes to ``README`` files: Miscellaneous Changes --------------------- -The following are additional changes: - - The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it have been removed. You should remove this variable from any custom recipes. @@ -269,11 +261,11 @@ The following are additional changes: from ``meta-poky`` to OE-Core (i.e. from ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``). -- The :ref:`buildhistory <ref-classes-buildhistory>` class now makes +- The :ref:`ref-classes-buildhistory` class now makes a single commit per build rather than one commit per subdirectory in the repository. This behavior assumes the commits are enabled with :term:`BUILDHISTORY_COMMIT` = "1", which - is typical. Previously, the :ref:`buildhistory <ref-classes-buildhistory>` class made one commit + is typical. Previously, the :ref:`ref-classes-buildhistory` class made one commit per subdirectory in the repository in order to make it easier to see the changes for a particular subdirectory. To view a particular change, specify that subdirectory as the last parameter on the @@ -286,7 +278,7 @@ The following are additional changes: - BitBake fires multiple "BuildStarted" events when multiconfig is enabled (one per configuration). For more information, see the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events`" + ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:events`" section in the BitBake User Manual. - By default, the ``security_flags.inc`` file sets a @@ -301,7 +293,7 @@ The following are additional changes: likely be removed in the next Yocto Project release. - The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in - conjunction with the "wic" image type through ``CONVERSION_CMD``. + conjunction with the "wic" image type through :term:`CONVERSION_CMD`. Consequently, the equivalent image types are now ``wic.vmdk``, ``wic.vdi``, and ``wic.qcow2``, respectively. diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index abd26809df..facf5110b7 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.5 (sumo) ================== @@ -85,8 +87,6 @@ The following recipes have been removed: Scripts and Tools Changes ------------------------- -The following are changes to scripts and tools: - - ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts previously shipped with poky but not in OpenEmbedded-Core have been @@ -117,8 +117,6 @@ The following are changes to scripts and tools: BitBake Changes --------------- -The following are BitBake changes: - - The ``--runall`` option has changed. There are two different behaviors people might want: @@ -137,7 +135,7 @@ The following are BitBake changes: - Several explicit "run this task for all recipes in the dependency tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, and the ``*all`` tasks provided by the ``distrodata`` and - :ref:`archiver <ref-classes-archiver>` classes). There is a BitBake option to complete this for + :ref:`ref-classes-archiver` classes). There is a BitBake option to complete this for any arbitrary task. For example:: bitbake <target> -c fetchall @@ -151,7 +149,7 @@ The following are BitBake changes: Python and Python 3 Changes --------------------------- -The following are auto-packaging changes to Python and Python 3: +Here are auto-packaging changes to Python and Python 3: The script-managed ``python-*-manifest.inc`` files that were previously used to generate Python and Python 3 packages have been replaced with a @@ -185,9 +183,7 @@ change please see :yocto_git:`this commit Miscellaneous Changes --------------------- -The following are additional changes: - -- The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. +- The :ref:`ref-classes-kernel` class supports building packages for multiple kernels. If your kernel recipe or ``.bbappend`` file mentions packaging at all, you should replace references to the kernel in package names with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable @@ -195,7 +191,7 @@ The following are additional changes: ``RDEPENDS_kernel-base = ""`` you can avoid warnings using ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. -- The :ref:`buildhistory <ref-classes-buildhistory>` class commits changes to the repository by +- The :ref:`ref-classes-buildhistory` class commits changes to the repository by default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. If you want to disable commits you need to set ``BUILDHISTORY_COMMIT = "0"`` in your configuration. @@ -207,12 +203,12 @@ The following are additional changes: maintains a full-featured BSP in the ``meta-ti`` layer. This rename avoids the previous name clash that existed between the two BSPs. -- The :ref:`update-alternatives <ref-classes-update-alternatives>` class no longer works with SysV ``init`` +- The :ref:`ref-classes-update-alternatives` class no longer works with SysV ``init`` scripts because this usage has been problematic. Also, the ``sysklogd`` recipe no longer uses ``update-alternatives`` because it is incompatible with other implementations. -- By default, the :ref:`cmake <ref-classes-cmake>` class uses +- By default, the :ref:`ref-classes-cmake` class uses ``ninja`` instead of ``make`` for building. This improves build performance. If a recipe is broken with ``ninja``, then the recipe can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to @@ -261,10 +257,10 @@ The following are additional changes: ``pkg_postinst_ontarget()`` or call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. Any failure of a ``pkg_postinst()`` script (including ``exit 1``) - will trigger a warning during ``do_rootfs``. + will trigger a warning during :ref:`ref-tasks-rootfs`. For more information, 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. - The ``elf`` image type has been removed. This image type was removed diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst index c68414e1ca..ecb559dd4c 100644 --- a/documentation/migration-guides/migration-2.6.rst +++ b/documentation/migration-guides/migration-2.6.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.6 (thud) ================== @@ -118,8 +120,7 @@ For names of recipes removed because of this repository change, see the --------------------------------------------------------------------------------------------------- Previously, it was possible for Python recipes that inherited the -``distutils`` and -:ref:`distutils3 <ref-classes-distutils3>` classes to fetch code +``distutils`` and ``distutils3`` classes to fetch code during the :ref:`ref-tasks-configure` task to satisfy dependencies mentioned in ``setup.py`` if those dependencies were not provided in the sysroot (i.e. recipes providing the dependencies were @@ -127,16 +128,16 @@ missing from :term:`DEPENDS`). .. note:: - This change affects classes beyond just the two mentioned (i.e. - ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` - classes are affected. For example, the ``setuptools`` and ``setuptools3`` + This change affects classes beyond just the two mentioned (i.e. ``distutils`` + and ``distutils3``). Any recipe that inherits ``distutils*`` classes are + affected. For example, the ``setuptools`` and :ref:`ref-classes-setuptools3` recipes are affected since they inherit the ``distutils*`` classes. Fetching these types of dependencies that are not provided in the sysroot negatively affects the ability to reproduce builds. This type of fetching is now explicitly disabled. Consequently, any missing dependencies in Python recipes that use these classes now result in an -error during the ``do_configure`` task. +error during the :ref:`ref-tasks-configure` task. .. _migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported: @@ -209,22 +210,19 @@ The following changes have been made: ``SERIAL_CONSOLE`` Deprecated ----------------------------- -The :term:`SERIAL_CONSOLE` variable has been -functionally replaced by the -:term:`SERIAL_CONSOLES` variable for some time. -With the Yocto Project 2.6 release, :term:`SERIAL_CONSOLE` has been -officially deprecated. +The ``SERIAL_CONSOLE`` variable has been functionally replaced by the +:term:`SERIAL_CONSOLES` variable for some time. With the Yocto Project 2.6 +release, ``SERIAL_CONSOLE`` has been officially deprecated. -:term:`SERIAL_CONSOLE` will continue to work as before for the 2.6 release. +``SERIAL_CONSOLE`` will continue to work as before for the 2.6 release. However, for the sake of future compatibility, it is recommended that -you replace all instances of :term:`SERIAL_CONSOLE` with -:term:`SERIAL_CONSOLES`. +you replace all instances of ``SERIAL_CONSOLE`` with :term:`SERIAL_CONSOLES`. .. note:: The only difference in usage is that :term:`SERIAL_CONSOLES` expects entries to be separated using semicolons as compared to - :term:`SERIAL_CONSOLE`, which expects spaces. + ``SERIAL_CONSOLE``, which expects spaces. .. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error: @@ -276,16 +274,16 @@ The following changes have occurred: specifying list items to remove, be aware that leading and trailing whitespace resulting from the removal is retained. - See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`" + See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`" section in the BitBake User Manual for a detailed example. -.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: +.. _migration-2.6-systemd-configuration-now-split-out-to-systemd-conf: ``systemd`` Configuration is Now Split Into ``systemd-conf`` ------------------------------------------------------------ The configuration for the ``systemd`` recipe has been moved into a -``system-conf`` recipe. Moving this configuration to a separate recipe +``systemd-conf`` recipe. Moving this configuration to a separate recipe avoids the ``systemd`` recipe from becoming machine-specific for cases where machine-specific configurations need to be applied (e.g. for ``qemu*`` machines). @@ -316,13 +314,11 @@ This section provides information about automatic testing changes: exists and has been replaced by the :term:`TESTIMAGE_AUTO` variable. -- Inheriting the ``testimage`` and ``testsdk`` Classes: Best - practices now dictate that you use the - :term:`IMAGE_CLASSES` variable rather than the - :term:`INHERIT` variable when you inherit the - :ref:`testimage <ref-classes-testimage*>` and - :ref:`testsdk <ref-classes-testsdk>` classes used for automatic - testing. +- Inheriting the :ref:`ref-classes-testimage` and :ref:`ref-classes-testsdk` + classes: best practices now dictate that you use the :term:`IMAGE_CLASSES` + variable rather than the :term:`INHERIT` variable when you inherit the + :ref:`ref-classes-testimage` and :ref:`ref-classes-testsdk` classes used + for automatic testing. .. _migration-2.6-openssl-changes: @@ -344,8 +340,7 @@ BitBake Changes --------------- The server logfile ``bitbake-cookerdaemon.log`` is now always placed in -the :term:`Build Directory` instead of the current -directory. +the :term:`Build Directory` instead of the current directory. .. _migration-2.6-security-changes: @@ -369,7 +364,7 @@ Any failure of a ``pkg_postinst()`` script (including exit 1) triggers an error during the :ref:`ref-tasks-rootfs` task. For more information on post-installation behavior, see the -":ref:`dev-manual/common-tasks:post-installation scripts`" +":ref:`dev-manual/new-recipe:post-installation scripts`" section in the Yocto Project Development Tasks Manual. .. _migration-2.6-python-3-profile-guided-optimizations: diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst index ae70353bf7..c49d2f05d2 100644 --- a/documentation/migration-guides/migration-2.7.rst +++ b/documentation/migration-guides/migration-2.7.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.7 (warrior) ===================== @@ -15,7 +17,7 @@ The following changes have been made to BitBake: functions (e.g. ``def funcname:``) in the metadata for tab indentation. If found, BitBake produces a warning. -- Bitbake now checks +- BitBake now checks :term:`BBFILE_COLLECTIONS` for duplicate entries and triggers an error if any are found. @@ -172,8 +174,7 @@ The following miscellaneous changes occurred: - ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been removed. -- :ref:`native <ref-classes-native>` class: - :term:`RDEPENDS` handling has been enabled. +- :ref:`ref-classes-native` class: :term:`RDEPENDS` handling has been enabled. - ``inetutils``: This recipe has rsh disabled. diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 610298bda6..67fcac41f7 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 3.0 (zeus) ================== @@ -47,7 +49,7 @@ The following recipes have been removed. - ``core-image-lsb-sdk``: Part of removed LSB support. - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` - recipe and :ref:`cve-check <ref-classes-cve-check>` class. + recipe and :ref:`ref-classes-cve-check` class. - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is an adequate and maintained alternative. @@ -108,7 +110,7 @@ Packaging Changes The following packaging changes have occurred. -- The `Epiphany <https://en.wikipedia.org/wiki/GNOME_Web>`__ browser +- The :wikipedia:`Epiphany <GNOME_Web>` browser has been dropped from ``packagegroup-self-hosted`` as it has not been needed inside ``build-appliance-image`` for quite some time and was causing resource problems. @@ -142,17 +144,17 @@ CVE Checking ------------ ``cve-check-tool`` has been functionally replaced by a new -``cve-update-db`` recipe and functionality built into the :ref:`cve-check <ref-classes-cve-check>` +``cve-update-db`` recipe and functionality built into the :ref:`ref-classes-cve-check` class. The result uses NVD JSON data feeds rather than the deprecated XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, and makes other improvements. Additionally, the ``CVE_CHECK_CVE_WHITELIST`` variable has been replaced -by ``CVE_CHECK_WHITELIST``. +by ``CVE_CHECK_WHITELIST`` (replaced by :term:`CVE_CHECK_IGNORE` in version 4.0). .. _migration-3.0-bitbake-changes: -Bitbake Changes +BitBake Changes --------------- The following BitBake changes have occurred. @@ -216,13 +218,13 @@ The following sanity check changes occurred. - :term:`SRC_URI` is now checked for usage of two problematic items: - - "${PN}" prefix/suffix use - Warnings always appear if ${PN} is + - "${PN}" prefix/suffix use --- warnings always appear if ${PN} is used. You must fix the issue regardless of whether multiconfig or anything else that would cause prefixing/suffixing to happen. - - Github archive tarballs - these are not guaranteed to be stable. + - Github archive tarballs --- these are not guaranteed to be stable. Consequently, it is likely that the tarballs will be refreshed and - thus the SRC_URI checksums will fail to apply. It is recommended + thus the :term:`SRC_URI` checksums will fail to apply. It is recommended that you fetch either an official release tarball or a specific revision from the actual Git repository instead. @@ -259,7 +261,9 @@ The following miscellaneous changes have occurred. - The ``gnome`` class has been removed because it now does very little. You should update recipes that previously inherited this class to do - the following: inherit gnomebase gtk-icon-cache gconf mime + the following:: + + inherit gnomebase gtk-icon-cache gconf mime - The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been removed. This file was previously deprecated in favor of setting @@ -282,8 +286,8 @@ The following miscellaneous changes have occurred. - You must change the host distro identifier used in :term:`NATIVELSBSTRING` to use all lowercase characters even if it does not contain a version number. This change - is necessary only if you are not using ``uninative`` and - :term:`SANITY_TESTED_DISTROS`. + is necessary only if you are not using + :ref:`ref-classes-uninative` and :term:`SANITY_TESTED_DISTROS`. - In the ``base-files`` recipe, writing the hostname into ``/etc/hosts`` and ``/etc/hostname`` is now done within the main diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index cb0296717e..fdb959c4af 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 3.1 (dunfell) ===================== @@ -125,7 +127,7 @@ renamed to ``features_check``; the ``distro_features_check`` class still exists but generates a warning and redirects to the new class. In preparation for a future removal of the old class it is recommended that you update recipes currently inheriting ``distro_features_check`` to -inherit :ref:`features_check <ref-classes-features_check>` instead. +inherit :ref:`ref-classes-features_check` instead. .. _migration-3.1-removed-classes: @@ -200,7 +202,7 @@ Packaging changes ----------------- - ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is - rarely needed to build modern software - gettext can do most of the + rarely needed to build modern software --- gettext can do most of the things it used to be needed for. ``intltool`` has also been removed from ``packagegroup-core-self-hosted`` as it is not needed to for standard builds. @@ -234,14 +236,14 @@ Packaging changes Additional warnings ------------------- -Warnings will now be shown at ``do_package_qa`` time in the following +Warnings will now be shown at :ref:`ref-tasks-package_qa` time in the following circumstances: - A recipe installs ``.desktop`` files containing ``MimeType`` keys but - does not inherit the new ``mime-xdg`` class + does not inherit the new :ref:`ref-classes-mime-xdg` class - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` - but does not inherit the :ref:`mime <ref-classes-mime>` class + but does not inherit the :ref:`ref-classes-mime` class .. _migration-3.1-x86-live-wic: @@ -260,7 +262,7 @@ Miscellaneous changes --------------------- - The undocumented ``SRC_DISTRIBUTE_LICENSES`` variable has now been - removed in favour of a new :term:`AVAILABLE_LICENSES` variable which is + removed in favour of a new ``AVAILABLE_LICENSES`` variable which is dynamically set based upon license files found in ``${COMMON_LICENSE_DIR}`` and ``${LICENSE_PATH}``. diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index d593effe97..c538df04d2 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 3.2 (gatesgarth) ======================== @@ -11,7 +13,7 @@ Minimum system requirements ``gcc`` version 6.0 is now required at minimum on the build host. For older host distributions where this is not available, you can use the -``buildtools-extended-tarball`` (easily installable using +:term:`buildtools-extended` tarball (easily installable using ``scripts/install-buildtools``). @@ -23,7 +25,7 @@ Removed recipes The following recipes have been removed: - ``bjam-native``: replaced by ``boost-build-native`` -- ``avahi-ui``: folded into the main ``avahi`` recipe - the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. +- ``avahi-ui``: folded into the main ``avahi`` recipe --- the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. - ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class - ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea`` - ``libmodulemd-v1``: replaced by ``libmodulemd`` @@ -37,7 +39,7 @@ Removed classes The following classes (.bbclass files) have been removed: -- ``spdx``: obsolete - the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. +- ``spdx``: obsolete --- the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. - ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds. @@ -46,7 +48,7 @@ pseudo path filtering and mismatch behaviour -------------------------------------------- pseudo now operates on a filtered subset of files. This is a significant change -to the way pseudo operates within OpenEmbedded - by default, pseudo monitors and +to the way pseudo operates within OpenEmbedded --- by default, pseudo monitors and logs (adds to its database) any file created or modified whilst in a ``fakeroot`` environment. However, there are large numbers of files that we simply don't care about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`}, @@ -60,7 +62,7 @@ pseudo as the interprocess round trip to the server is avoided. There is a possible complication where some existing recipe may break, for example, a recipe was found to be writing to ``${B}/install`` for -``make install`` in ``do_install`` and since ``${B}`` is listed as not to be tracked, +``make install`` in :ref:`ref-tasks-install` and since ``${B}`` is listed as not to be tracked, there were errors trying to ``chown root`` for files in this location. Another example was the ``tcl`` recipe where the source directory :term:`S` is set to a subdirectory of the source tree but files were written out to the directory @@ -68,7 +70,7 @@ structure above that subdirectory. For these types of cases in your own recipes, extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not be monitoring. -In addition, pseudo's behaviour on mismatches has now been changed - rather +In addition, pseudo's behaviour on mismatches has now been changed --- rather than doing what turns out to be a rather dangerous "fixup" if it sees a file with a different path but the same inode as another file it has previously seen, pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` @@ -86,7 +88,7 @@ value to be explicitly prepended to package names being added as dependencies (e.g. in :term:`RDEPENDS` and :term:`RRECOMMENDS` values) where the dependency is conditionally added. -If you have anonymous python or in-line python conditionally adding +If you have anonymous Python or in-line Python conditionally adding dependencies in your custom recipes, and you intend for those recipes to work with multilib, then you will need to ensure that ``${MLPREFIX}`` is prefixed on the package names in the dependencies, for example @@ -137,10 +139,10 @@ DHCP server/client replaced The ``dhcp`` software package has become unmaintained and thus has been functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will -need to replace references to the recipe/package names as appropriate - most +need to replace references to the recipe/package names as appropriate --- most commonly, at the package level ``dhcp-client`` should be replaced by ``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any -custom configuration files for these they will need to be adapted - refer to +custom configuration files for these they will need to be adapted --- refer to the upstream documentation for ``dhcpcd`` and ``kea`` for further details. @@ -149,7 +151,7 @@ the upstream documentation for ``dhcpcd`` and ``kea`` for further details. Packaging changes ----------------- -- ``python3``: the ``urllib`` python package has now moved into the core package, as it is used more commonly than just netclient (e.g. email, xml, mimetypes, pydoc). In addition, the ``pathlib`` module is now also part of the core package. +- ``python3``: the ``urllib`` Python package has now moved into the core package, as it is used more commonly than just netclient (e.g. email, xml, mimetypes, pydoc). In addition, the ``pathlib`` module is now also part of the core package. - ``iptables``: ``iptables-apply`` and ``ip6tables-apply`` have been split out to their own package to avoid a bash dependency in the main ``iptables`` package @@ -175,13 +177,23 @@ errors: In addition, the following new checks were added and default to triggering an error: -- :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines longer than 128 characters, which can give an error at runtime depending on the operating system. +- :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines + longer than 128 characters, which can give an error at runtime depending on + the operating system. -- :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check if any of the variables supported by the :ref:`features_check <ref-classes-features_check>` class is set while not inheriting the class itself. +- :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check + if any of the variables supported by the :ref:`ref-classes-features_check` + class is set while not inheriting the class itself. -- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. +- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: + Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its + packages, and does not inherit the :ref:`ref-classes-update-alternatives` + class. -- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable - remove any instances of these in your recipes if the warning is displayed. +- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` + will now trigger a warning so that they can be removed and path comparisons + can be more reliable --- remove any instances of these in your recipes if the + warning is displayed. .. _migration-3.2-src-uri-file-globbing: @@ -191,7 +203,7 @@ Globbing no longer supported in ``file://`` entries in ``SRC_URI`` Globbing (``*`` and ``?`` wildcards) in ``file://`` URLs within :term:`SRC_URI` did not properly support file checksums, thus changes to the source files -would not always change the do_fetch task checksum, and consequently would +would not always change the :ref:`ref-tasks-fetch` task checksum, and consequently would not ensure that the changed files would be incorporated in subsequent builds. Unfortunately it is not practical to make globbing work generically here, so @@ -207,9 +219,18 @@ files into a subdirectory and reference that instead. deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` ---------------------------------------------------------- -``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. +:ref:`ref-tasks-deploy` as implemented in the :ref:`ref-classes-deploy` class +now cleans up ${:term:`DEPLOYDIR`} before running, just as +:ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces +the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from +previous runs, possibly even with different config, in case of incremental +builds. -Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. +Most recipes and classes that inherit the :ref:`ref-classes-deploy` class or +interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this +unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files +into ``${DEPLOYDIR}`` --- these should be refactored to use +``do_deploy_prepend`` instead. .. _migration-3.2-nativesdk-sdk-provides-dummy: @@ -217,7 +238,13 @@ Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` cla Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` ------------------------------------------------------------------------------- -All ``nativesdk`` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g. ``buildtools-tarball``), you will need to ensure ``nativesdk-sdk-provides-dummy`` or an equivalent is included in :term:`TOOLCHAIN_HOST_TASK`. +All :ref:`ref-classes-nativesdk` packages require ``/bin/sh`` due +to their postinstall scriptlets, thus this package has to be dummy-provided +within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have +a custom SDK recipe (or your own SDK-style recipe similar to e.g. +``buildtools-tarball``), you will need to ensure +``nativesdk-sdk-provides-dummy`` or an equivalent is included in +:term:`TOOLCHAIN_HOST_TASK`. ``ld.so.conf`` now moved back to main ``glibc`` package @@ -265,10 +292,10 @@ using the GL options. .. _migration-3.2-initramfs-suffix: -initramfs images now use a blank suffix +Initramfs images now use a blank suffix --------------------------------------- -The reference initramfs images (``core-image-minimal-initramfs``, +The reference :term:`Initramfs` images (``core-image-minimal-initramfs``, ``core-image-tiny-initramfs`` and ``core-image-testmaster-initramfs``) now set an empty string for :term:`IMAGE_NAME_SUFFIX`, which otherwise defaults to ``".rootfs"``. These images aren't root filesystems and thus the rootfs @@ -283,7 +310,7 @@ Image artifact name variables now centralised in image-artifact-names class --------------------------------------------------------------------------- The defaults for the following image artifact name variables have been moved -from bitbake.conf to a new ``image-artifact-names`` class: +from ``bitbake.conf`` to a new ``image-artifact-names`` class: - :term:`IMAGE_BASENAME` - :term:`IMAGE_LINK_NAME` @@ -303,7 +330,7 @@ now need to be changed to ``inherit image-artifact-names``. Miscellaneous changes --------------------- -- Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed - replace any remaining instances with :term:`FEATURE_PACKAGES`. +- Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed --- replace any remaining instances with :term:`FEATURE_PACKAGES`. - The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`. - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index f982b1c80a..d1e589d7b4 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 3.3 (hardknott) ======================= @@ -12,12 +14,11 @@ Minimum system requirements You will now need at least Python 3.6 installed on your build host. Most recent distributions provide this, but should you be building on a distribution that -does not have it, you can use the ``buildtools-tarball`` (easily installable -using ``scripts/install-buildtools``) - see -:ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` +does not have it, you can use the :term:`buildtools` tarball (easily installable +using ``scripts/install-buildtools``) --- see +:ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` for details. - .. _migration-3.3-removed-recipes: Removed recipes @@ -62,13 +63,15 @@ need to update those. New ``python3targetconfig`` class --------------------------------- -A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been -created for situations where you would previously have inherited the -:ref:`python3native <ref-classes-python3native>` class but need access to target configuration data (such as -correct installation directories). Recipes where this situation applies should -be changed to inherit ``python3targetconfig`` instead of ``python3native``. This -also adds a dependency on target ``python3``, so it should only be used where -appropriate in order to avoid unnecessarily lengthening builds. +A new :ref:`ref-classes-python3targetconfig` class has +been created for situations where you would previously have inherited the +:ref:`ref-classes-python3native` class but need access to +target configuration data (such as correct installation directories). Recipes +where this situation applies should be changed to inherit +:ref:`ref-classes-python3targetconfig` instead of +:ref:`ref-classes-python3native`. This also adds a dependency +on target ``python3``, so it should only be used where appropriate in order to +avoid unnecessarily lengthening builds. Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, ``python3-pycairo``. @@ -76,7 +79,7 @@ Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, .. _migration-3.3-distutils-path: -``setup.py`` path for python modules +``setup.py`` path for Python modules ------------------------------------ In a Python module, sometimes ``setup.py`` can be buried deep in the @@ -90,17 +93,16 @@ example:: then in ``setup.py`` it works with source code in a relative fashion, such as ``../../src``. This causes pseudo to fail as it isn't able to track -the paths properly. This release introduces a new :term:`DISTUTILS_SETUP_PATH` +the paths properly. This release introduces a new ``DISTUTILS_SETUP_PATH`` variable so that recipes can specify it explicitly, for example:: S = "${WORKDIR}/git" DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" -Recipes that inherit from :ref:`distutils3 <ref-classes-distutils3>` (or -:ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits -:ref:`distutils3 <ref-classes-distutils3>`) that also set :term:`S` to -point to a Python module within a subdirectory in the aforementioned -manner should be changed to set :term:`DISTUTILS_SETUP_PATH` instead. +Recipes that inherit from ``distutils3`` (or :ref:`ref-classes-setuptools3` +which itself inherits ``distutils3``) that also set :term:`S` to point to a +Python module within a subdirectory in the aforementioned manner should be +changed to set ``DISTUTILS_SETUP_PATH`` instead. .. _migration-3.3-bitbake: @@ -133,7 +135,7 @@ unless you want to take advantage of the improved granularity: - ``procps``: split ``ps`` and ``sysctl`` into their own packages - ``rpm``: split build and extra functionality into separate packages - ``sudo``: split ``sudo`` binary into ``sudo-sudo`` and libs into ``sudo-lib`` -- ``systemtap``: examples, python scripts and runtime material split out +- ``systemtap``: examples, Python scripts and runtime material split out - ``util-linux``: ``libuuid`` has been split out to its own ``util-linux-libuuid`` recipe (and corresponding packages) to avoid circular dependencies if ``libgcrypt`` support is enabled in ``util-linux``. diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index e785277356..a9b1057206 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst @@ -1,11 +1,13 @@ -Release 3.4 (honister) -====================== +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Migration notes for 3.4 (honister) +---------------------------------- This section provides migration information for moving to the Yocto Project 3.4 Release (codename "honister") from the prior release. Override syntax changes ------------------------ +~~~~~~~~~~~~~~~~~~~~~~~ In this release, the ``:`` character replaces the use of ``_`` to refer to an override, most commonly when making a conditional assignment @@ -22,7 +24,7 @@ syntax, so the following:: SRC_URI_append = " file://somefile" SRC_URI_append_qemux86 = " file://somefile2" - SRC_URI_remove_qemux86-64 = " file://somefile3" + SRC_URI_remove_qemux86-64 = "file://somefile3" SRC_URI_prepend_qemuarm = "file://somefile4 " FILES_${PN}-ptest = "${bindir}/xyz" IMAGE_CMD_tar = "tar" @@ -34,7 +36,7 @@ would now become:: SRC_URI:append = " file://somefile" SRC_URI:append:qemux86 = " file://somefile2" - SRC_URI:remove:qemux86-64 = " file://somefile3" + SRC_URI:remove:qemux86-64 = "file://somefile3" SRC_URI:prepend:qemuarm = "file://somefile4 " FILES:${PN}-ptest = "${bindir}/xyz" IMAGE_CMD:tar = "tar" @@ -43,7 +45,7 @@ would now become:: BB_TASK_NICE_LEVEL:task-testimage = '0' This also applies to -:ref:`variable queries to the datastore <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:functions for accessing datastore variables>`, +:ref:`variable queries to the datastore <bitbake-user-manual/bitbake-user-manual-metadata:functions for accessing datastore variables>`, for example using ``getVar`` and similar so ``d.getVar("RDEPENDS_${PN}")`` becomes ``d.getVar("RDEPENDS:${PN}")``. @@ -86,21 +88,19 @@ BitBake no longer has to guess and maintain large lookup lists just in case e.g. ``functionname`` in ``my_functionname`` is an override, and thus should improve efficiency. - New host dependencies ---------------------- +~~~~~~~~~~~~~~~~~~~~~ The ``lz4c``, ``pzstd`` and ``zstd`` commands are now required to be installed on the build host to support LZ4 and Zstandard compression functionality. These are typically provided by ``lz4`` and ``zstd`` packages in most Linux distributions. Alternatively they are available -as part of ``buildtools-tarball`` if your distribution does not provide +as part of :term:`buildtools` tarball if your distribution does not provide them. For more information see :ref:`ref-manual/system-requirements:required packages for the build host`. - Removed recipes ---------------- +~~~~~~~~~~~~~~~ The following recipes have been removed in this release: @@ -119,19 +119,17 @@ The following recipes have been removed in this release: any known layer - ``packagegroup-core-clutter``: removed along with clutter - Removed classes ---------------- +~~~~~~~~~~~~~~~ - ``clutter``: moved to meta-gnome along with clutter itself - ``image-mklibs``: not actively tested and upstream mklibs still requires Python 2 - ``meta``: no longer useful. Recipes that need to skip installing - packages should inherit ``nopackages`` instead. - + packages should inherit :ref:`ref-classes-nopackages` instead. Prelinking disabled by default ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Recent tests have shown that prelinking works only when PIE is not enabled (see `here <https://rlbl.me/prelink-1>`__ and `here <https://rlbl.me/prelink-2>`__), @@ -140,24 +138,22 @@ configuration provided and tested by the Yocto Project, there is simply no sense in continuing to enable prelink. There's also a concern that no one is maintaining the code, and there -are open bugs (including `this serious one <https://bugzilla.yoctoproject.org/show_bug.cgi?id=14429>`__). +are open bugs (including :yocto_bugs:`this serious one </show_bug.cgi?id=14429>`). Given that prelink does intricate address arithmetic and rewriting of binaries the best option is to disable the feature. It is recommended that you consider disabling this feature in your own configuration if it is currently enabled. - Virtual runtime provides ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ Recipes shouldn't use the ``virtual/`` string in :term:`RPROVIDES` and -:term:`RDEPENDS` - it is confusing because ``virtual/`` has no special +:term:`RDEPENDS` --- it is confusing because ``virtual/`` has no special meaning in :term:`RPROVIDES` and :term:`RDEPENDS` (unlike in the corresponding build-time :term:`PROVIDES` and :term:`DEPENDS`). - Tune files moved to architecture-specific directories ------------------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The tune files found in ``conf/machine/include`` have now been moved into their respective architecture name directories under that same @@ -165,20 +161,19 @@ location; e.g. x86 tune files have moved into an ``x86`` subdirectory, MIPS tune files have moved into a ``mips`` subdirectory, etc. The ARM tunes have an extra level (``armv8a``, ``armv8m``, etc.) and some have been renamed to make them uniform with the rest of the tunes. -See `this commit <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=1d381f21f5f13aa0c4e1a45683ed656ebeedd37d>`__ +See :yocto_git:`this commit </poky/commit/?id=1d381f21f5f13aa0c4e1a45683ed656ebeedd37d>` for reference. If you have any references to tune files (e.g. in custom machine configuration files) they will need to be updated. - Extensible SDK host extension ------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For a normal SDK, some layers append to :term:`TOOLCHAIN_HOST_TASK` unconditionally which is fine, until the eSDK tries to override the variable to its own values. Instead of installing packages specified -in this variable it uses native recipes instead - a very different +in this variable it uses native recipes instead --- a very different approach. This has led to confusing errors when binaries are added to the SDK but not relocated. @@ -186,9 +181,8 @@ To avoid these issues, a new :term:`TOOLCHAIN_HOST_TASK_ESDK` variable has been created. If you wish to extend what is installed in the host portion of the eSDK then you will now need to set this variable. - Package/recipe splitting ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ - ``perl-cross`` has been split out from the main ``perl`` recipe to its own ``perlcross`` recipe for maintenance reasons. If you have @@ -203,7 +197,7 @@ Package/recipe splitting then you may now need to add it explicitly. - The ``rpm`` package no longer has ``rpm-build`` in its :term:`RRECOMMENDS`; - if by chance you still need rpm package building functionality in + if by chance you still need rpm package building functionality in your image and you have not already done so then you should add ``rpm-build`` to your image explicitly. @@ -211,11 +205,10 @@ Package/recipe splitting ``python3-statistics`` package instead of ``python3-misc`` as previously. - Image / SDK generation changes ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Recursive dependencies on the ``do_build`` task are now disabled when +- Recursive dependencies on the :ref:`ref-tasks-build` task are now disabled when building SDKs. These are generally not needed; in the unlikely event that you do encounter problems then it will probably be as a result of missing explicit dependencies that need to be added. @@ -239,11 +232,10 @@ Image / SDK generation changes you should instead add the new ``lic-pkgs`` feature to :term:`IMAGE_FEATURES`. - Miscellaneous -------------- +~~~~~~~~~~~~~ -- Certificates are now properly checked when bitbake fetches sources +- Certificates are now properly checked when BitBake fetches sources over HTTPS. If you receive errors as a result for your custom recipes, you will need to use a mirror or address the issue with the operators of the server in question. @@ -262,11 +254,22 @@ Miscellaneous - The previously deprecated ``COMPRESS_CMD`` and ``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use - ``CONVERSION_CMD`` and :term:`CVE_CHECK_WHITELIST` respectively + :term:`CONVERSION_CMD` and ``CVE_CHECK_WHITELIST`` (replaced by + :term:`CVE_CHECK_IGNORE` in version 4.0) respectively instead. - The obsolete ``oe_machinstall`` function previously provided in the - :ref:`utils <ref-classes-utils>` class has been removed. For + :ref:`ref-classes-utils` class has been removed. For machine-specific installation it is recommended that you use the built-in override support in the fetcher or overrides in general instead. + +- The ``-P`` (``--clear-password``) option can no longer be used with + ``useradd`` and ``usermod`` entries in :term:`EXTRA_USERS_PARAMS`. + It was being implemented using a custom patch to the ``shadow`` recipe + which clashed with a ``-P`` option that was added upstream in + ``shadow`` version 4.9, and in any case is fundamentally insecure. + Hardcoded passwords are still supported but they need to be hashed, see + examples in :term:`EXTRA_USERS_PARAMS`. + + diff --git a/documentation/migration-guides/migration-3.5.rst b/documentation/migration-guides/migration-3.5.rst deleted file mode 100644 index bd807eb8c7..0000000000 --- a/documentation/migration-guides/migration-3.5.rst +++ /dev/null @@ -1,44 +0,0 @@ -Release 3.5 (kirkstone) -======================= - -This section provides migration information for moving to the Yocto -Project 3.5 Release (codename "kirkstone") from the prior release. - -Recipe changes --------------- - -- Because of the uncertainty in future default branch names in git repositories, - it is now required to add a branch name to all URLs described - by ``git://`` and ``gitsm://`` :term:`SRC_URI` entries. For example:: - - SRC_URI = "git://git.denx.de/u-boot.git;branch=master" - - A :oe_git:`convert-srcuri </openembedded-core/tree/scripts/contrib/convert-srcuri.py>` - script to convert your recipes is available in :term:`OpenEmbedded-Core (OE-Core)` - and in :term:`Poky`. - -- Because of `GitHub dropping support for the git: - protocol <https://github.blog/2021-09-01-improving-git-protocol-security-github/>`__, - recipes now need to use ``;protocol=https`` at the end of GitHub - URLs. The same script as above can be used to convert the recipes. - -- The :term:`TOPDIR` variable and the current working directory are no longer modified - when parsing recipes. Any code depending on that behaviour will no longer work. - -- The ``append``, ``prepend`` and ``remove`` operators can now only be combined with - ``=`` and ``:=`` operators. To the exception of the ``append`` plus ``+=`` and - ``prepend`` plus ``=+`` combinations, all combinations could be factored up to the - ``append``, ``prepend`` or ``remove`` in the combination. This brought a lot of - confusion on how the override style syntax operators work and should be used. - Therefore, those combinations can simply be replaced by a single ``append``, - ``prepend`` or ``remove`` operator without any additional change. - For the ``append`` plus ``+=`` (and ``prepend`` plus ``=+``) combinations, - the content should be prefixed (respectively suffixed) by a space to maintain - the same behavior. You can learn more about override style syntax operators - (``append``, ``prepend`` and ``remove``) in the BitBake documentation: - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)` - and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. - -- :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages - which use :term:`PKG` renaming such as :ref:`debian.bbclass <ref-classes-debian>`. - diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst new file mode 100644 index 0000000000..0e9e741458 --- /dev/null +++ b/documentation/migration-guides/migration-4.0.rst @@ -0,0 +1,271 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.0 (kirkstone) +======================= + +Migration notes for 4.0 (kirkstone) +----------------------------------- + +This section provides migration information for moving to the Yocto +Project 4.0 Release (codename "kirkstone") from the prior release. + +.. _migration-4.0-inclusive-language: + +Inclusive language improvements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To use more `inclusive language <https://inclusivenaming.org/>`__ +in the code and documentation, some variables have been renamed, and +some have been deleted where they are no longer needed. In many cases the +new names are also easier to understand. BitBake will stop with an error when +renamed or removed variables still exist in your recipes or configuration. + +Please note that the change applies also to environmental variables, so +make sure you use a fresh environment for your build. + +The following variables have changed their names: + +- ``BB_ENV_WHITELIST`` became :term:`BB_ENV_PASSTHROUGH` +- ``BB_ENV_EXTRAWHITE`` became :term:`BB_ENV_PASSTHROUGH_ADDITIONS` +- ``BB_HASHBASE_WHITELIST`` became :term:`BB_BASEHASH_IGNORE_VARS` +- ``BB_HASHCONFIG_WHITELIST`` became :term:`BB_HASHCONFIG_IGNORE_VARS` +- ``BB_HASHTASK_WHITELIST`` became ``BB_TASKHASH_IGNORE_TASKS`` +- ``BB_SETSCENE_ENFORCE_WHITELIST`` became ``BB_SETSCENE_ENFORCE_IGNORE_TASKS`` +- ``CVE_CHECK_PN_WHITELIST`` became :term:`CVE_CHECK_SKIP_RECIPE` +- ``CVE_CHECK_WHITELIST`` became :term:`CVE_CHECK_IGNORE` +- ``ICECC_USER_CLASS_BL`` became :term:`ICECC_CLASS_DISABLE` +- ``ICECC_SYSTEM_CLASS_BL`` became :term:`ICECC_CLASS_DISABLE` +- ``ICECC_USER_PACKAGE_WL`` became :term:`ICECC_RECIPE_ENABLE` +- ``ICECC_USER_PACKAGE_BL`` became :term:`ICECC_RECIPE_DISABLE` +- ``ICECC_SYSTEM_PACKAGE_BL`` became :term:`ICECC_RECIPE_DISABLE` +- ``LICENSE_FLAGS_WHITELIST`` became :term:`LICENSE_FLAGS_ACCEPTED` +- ``MULTI_PROVIDER_WHITELIST`` became :term:`BB_MULTI_PROVIDER_ALLOWED` +- ``PNBLACKLIST`` became :term:`SKIP_RECIPE` +- ``SDK_LOCAL_CONF_BLACKLIST`` became :term:`ESDK_LOCALCONF_REMOVE` +- ``SDK_LOCAL_CONF_WHITELIST`` became :term:`ESDK_LOCALCONF_ALLOW` +- ``SDK_INHERIT_BLACKLIST`` became :term:`ESDK_CLASS_INHERIT_DISABLE` +- ``SSTATE_DUPWHITELIST`` became ``SSTATE_ALLOW_OVERLAP_FILES`` +- ``SYSROOT_DIRS_BLACKLIST`` became :term:`SYSROOT_DIRS_IGNORE` +- ``UNKNOWN_CONFIGURE_WHITELIST`` became :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` +- ``WHITELIST_<license>`` became :term:`INCOMPATIBLE_LICENSE_EXCEPTIONS` + +In addition, ``BB_STAMP_WHITELIST``, ``BB_STAMP_POLICY``, ``INHERIT_BLACKLIST``, +``TUNEABI``, ``TUNEABI_WHITELIST``, and ``TUNEABI_OVERRIDE`` have been removed. + +Many internal variable names have been also renamed accordingly. + +In addition, in the ``cve-check`` output, the CVE issue status ``Whitelisted`` +has been renamed to ``Ignored``. + +The :term:`BB_DISKMON_DIRS` variable value now uses the term ``HALT`` +instead of ``ABORT``. + +A :oe_git:`convert-variable-renames.py +</openembedded-core/tree/scripts/contrib/convert-variable-renames.py>` +script is provided to convert your recipes and configuration, +and also warns you about the use of problematic words. The script performs +changes and you need to review them before committing. An example warning +looks like:: + + poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort + +Fetching changes +~~~~~~~~~~~~~~~~ + +- Because of the uncertainty in future default branch names in git repositories, + it is now required to add a branch name to all URLs described + by ``git://`` and ``gitsm://`` :term:`SRC_URI` entries. For example:: + + SRC_URI = "git://git.denx.de/u-boot.git;branch=master" + + A :oe_git:`convert-srcuri </openembedded-core/tree/scripts/contrib/convert-srcuri.py>` + script to convert your recipes is available in :term:`OpenEmbedded-Core (OE-Core)` + and in :term:`Poky`. + +- Because of `GitHub dropping support for the git: + protocol <https://github.blog/2021-09-01-improving-git-protocol-security-github/>`__, + recipes now need to use ``;protocol=https`` at the end of GitHub + URLs. The same ``convert-srcuri`` script mentioned above can be used to convert + your recipes. + +- Network access from tasks is now disabled by default on kernels which support + this feature (on most recent distros such as CentOS 8 and Debian 11 onwards). + This means that tasks accessing the network need to be marked as such with the ``network`` + flag. For example:: + + do_mytask[network] = "1" + + This is allowed by default from :ref:`ref-tasks-fetch` but not from any of our other standard + tasks. Recipes shouldn't be accessing the network outside of :ref:`ref-tasks-fetch` as it + usually undermines fetcher source mirroring, image and licence manifests, software + auditing and supply chain security. + +License changes +~~~~~~~~~~~~~~~ + +- The ambiguous "BSD" license has been removed from the ``common-licenses`` directory. + Each recipe that fetches or builds BSD-licensed code should specify the proper + version of the BSD license in its :term:`LICENSE` value. + +- :term:`LICENSE` variable values should now use `SPDX identifiers <https://spdx.org/licenses/>`__. + If they do not, by default a warning will be shown. A + :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` + script can be used to update your recipes. + +- :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__. + Additionally, wildcarding is now limited to specifically supported values - + see the :term:`INCOMPATIBLE_LICENSE` documentation for further information. + +- The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance + liability and is highly dependent on which layers are added to the configuration, + which can cause signature issues for users. In addition the ``available_licenses()`` + function has been removed from the :ref:`ref-classes-license` class as + it is no longer needed. + +Removed recipes +~~~~~~~~~~~~~~~ + +The following recipes have been removed in this release: + +- ``dbus-test``: merged into main dbus recipe +- ``libid3tag``: moved to meta-oe - no longer needed by anything in OE-Core +- ``libportal``: moved to meta-gnome - no longer needed by anything in OE-Core +- ``linux-yocto``: removed version 5.14 recipes (5.15 and 5.10 still provided) +- ``python3-nose``: has not changed since 2016 upstream, and no longer needed by anything in OE-Core +- ``rustfmt``: not especially useful as a standalone recipe + +Python changes +~~~~~~~~~~~~~~ + +- ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*`` + classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*`` + classes should be updated to inherit ``setuptools*`` equivalents instead. + +- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. + The new Python packaging classes that should be used are + :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` + and :ref:`ref-classes-python_poetry_core`. + +- 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 instead. + +Prelink removed +~~~~~~~~~~~~~~~ + +Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with +binary corruption, has a number of open bugs and is of questionable benefit +without disabling load address randomization and PIE executables. + +We disabled prelinking by default in the honister (3.4) release, but left it able +to be enabled if desired. However, without glibc support it cannot be maintained +any further, so all of the prelinking functionality has been removed in this release. +If you were enabling the ``image-prelink`` class in :term:`INHERIT`, :term:`IMAGE_CLASSES`, +:term:`USER_CLASSES` etc in your configuration, then you will need to remove the +reference(s). + +Reproducible as standard +~~~~~~~~~~~~~~~~~~~~~~~~ + +Reproducibility is now considered as standard functionality, thus the +``reproducible`` class has been removed and its previous contents merged into the +:ref:`ref-classes-base` class. If you have references in your configuration to +``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be +removed. + +Additionally, the ``BUILD_REPRODUCIBLE_BINARIES`` variable is no longer used. +Specifically for the kernel, if you wish to enable build timestamping functionality +that is normally disabled for reproducibility reasons, you can do so by setting +a new :term:`KERNEL_DEBUG_TIMESTAMPS` variable to "1". + +Supported host distribution changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Support for :wikipedia:`AlmaLinux <AlmaLinux>` + hosts replacing :wikipedia:`CentOS <CentOS>`. + The following distribution versions were dropped: CentOS 8, Ubuntu 16.04 and Fedora 30, 31 and 32. + +- ``gcc`` version 7.5 is now required at minimum on the build host. For older + host distributions where this is not available, you can use the + :term:`buildtools-extended` tarball (easily installable using + ``scripts/install-buildtools``). + +:append/:prepend in combination with other operators +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``append``, ``prepend`` and ``remove`` operators can now only be combined with +``=`` and ``:=`` operators. To the exception of the ``append`` plus ``+=`` and +``prepend`` plus ``=+`` combinations, all combinations could be factored up to the +``append``, ``prepend`` or ``remove`` in the combination. This brought a lot of +confusion on how the override style syntax operators work and should be used. +Therefore, those combinations should be replaced by a single ``append``, +``prepend`` or ``remove`` operator without any additional change. +For the ``append`` plus ``+=`` (and ``prepend`` plus ``=+``) combinations, +the content should be prefixed (respectively suffixed) by a space to maintain +the same behavior. You can learn more about override style syntax operators +(``append``, ``prepend`` and ``remove``) in the BitBake documentation: +:ref:`bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)` +and :ref:`bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. + +Miscellaneous changes +~~~~~~~~~~~~~~~~~~~~~ + +- ``blacklist.bbclass`` is removed and the functionality moved to the + :ref:`ref-classes-base` class with a more descriptive + ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` + function. The usage remains the same, for example:: + + SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" + +- :ref:`ref-classes-allarch` packagegroups can no longer depend on packages + which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups + recipes should be changed to avoid inheriting :ref:`ref-classes-allarch`. + +- The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, + since at the time of creation `--relative` was only available in coreutils 8.16 + onwards which was too new for the older supported distros. Current supported host + distros have a new enough version of coreutils, so it is no longer needed. If you have + any calls to ``lnr`` in your recipes or classes, they should be replaced with + `ln --relative --symbolic` or `ln -rs` if you prefer the short version. + +- The ``package_qa_handle_error()`` function formerly in the :ref:`ref-classes-insane` + class has been moved and renamed - if you have any references in your own custom + classes they should be changed to ``oe.qa.handle_error()``. + +- When building ``perl``, Berkeley db support is no longer enabled by default, since + Berkeley db is largely obsolete. If you wish to reenable it, you can append ``bdb`` + to :term:`PACKAGECONFIG` in a ``perl`` bbappend or ``PACKAGECONFIG:pn-perl`` at + the configuration level. + +- For the ``xserver-xorg`` recipe, the ``xshmfence``, ``xmlto`` and ``systemd`` options + previously supported in :term:`PACKAGECONFIG` have been removed, as they are no + longer supported since the move from building it with autotools to meson in this release. + +- For the ``libsdl2`` recipe, various X11 features are now disabled by default (primarily + for reproducibility purposes in the native case) with options in :term:`EXTRA_OECMAKE` + within the recipe. These can be changed within a bbappend if desired. See the + ``libsdl2`` recipe for more details. + +- The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since + the crc extension is now enabled by default for cortexa72. Replace any references to + these with ``cortexa72`` and ``cortexa72-crypto`` respectively. + +- The Python development shell (previously known as ``devpyshell``) feature has been + renamed to ``pydevshell``. To start it you should now run:: + + bitbake <target> -c pydevshell + +- The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as + libraries should normally be brought in via dependencies. If you have any references + to this then remove them. + +- The :term:`TOPDIR` variable and the current working directory are no longer modified + when parsing recipes. Any code depending on the previous behaviour will no longer + work - change any such code to explicitly use appropriate path variables instead. + +- In order to exclude the kernel image from the image rootfs, + :term:`RRECOMMENDS`\ ``:${KERNEL_PACKAGE_NAME}-base`` should be set instead of + :term:`RDEPENDS`\ ``:${KERNEL_PACKAGE_NAME}-base``. diff --git a/documentation/migration-guides/migration-4.1.rst b/documentation/migration-guides/migration-4.1.rst new file mode 100644 index 0000000000..86721b9873 --- /dev/null +++ b/documentation/migration-guides/migration-4.1.rst @@ -0,0 +1,216 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.1 (langdale) +====================== + +Migration notes for 4.1 (langdale) +----------------------------------- + +This section provides migration information for moving to the Yocto +Project 4.1 Release (codename "langdale") from the prior release. + + +.. _migration-4.1-make-4.0: + +make 4.0 is now the minimum required make version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +glibc now requires ``make`` 4.0 to build, thus it is now the version required to +be installed on the build host. A new :term:`buildtools-make` tarball has been +introduced to provide just make 4.0 for host distros without a current/working +make 4.x version; if you also need other tools you can use the updated +:term:`buildtools` tarball. For more information see +:ref:`ref-manual/system-requirements:required packages for the build host`. + + +.. _migration-4.1-complementary-deps: + +Complementary package installation ignores recommends +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When installing complementary packages (e.g. ``-dev`` and ``-dbg`` packages when +building an SDK, or if you have added ``dev-deps`` to :term:`IMAGE_FEATURES`), +recommends (as defined by :term:`RRECOMMENDS`) are no longer installed. + +If you wish to double-check the contents of your images after this change, see +:ref:`Checking Image / SDK Changes <migration-general-buildhistory>`. If needed +you can explicitly install items by adding them to :term:`IMAGE_INSTALL` in +image recipes or :term:`TOOLCHAIN_TARGET_TASK` for the SDK. + + +.. _migration-4.1-dev-recommends: + +dev dependencies are now recommends +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The default for ``${PN}-dev`` package is now to use :term:`RRECOMMENDS` instead +of :term:`RDEPENDS` to pull in the main package. This takes advantage of a +change to complimentary package installation to not follow :term:`RRECOMMENDS` +(as mentioned above) and for example means an SDK for an image with both openssh +and dropbear components will now build successfully. + + +.. _migration-4.1-dropbear-sftp: + +dropbear now recommends openssh-sftp-server +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +openssh has switched the scp client to use the sftp protocol instead of scp to +move files. This means scp from Fedora 36 and other current distributions will +no longer be able to move files to/from a system running dropbear with no sftp +server installed. + +The sftp server from openssh is small (200kb uncompressed) and standalone, so +adding it to the packagegroup seems to be the best way to preserve the +functionality for user sanity. However, if you wish to avoid this dependency, +you can either: + + A. Use ``dropbear`` in :term:`IMAGE_INSTALL` instead of + ``packagegroup-core-ssh-dropbear`` (or ``ssh-server-dropbear`` in + :term:`IMAGE_FEATURES`), or + B. Add ``openssh-sftp-server`` to :term:`BAD_RECOMMENDATIONS`. + + +.. _migration-4.1-classes-split: + +Classes now split by usage context +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A split directory structure has now been set up for ``.bbclass`` files - classes +that are intended to be inherited only by recipes (e.g. ``inherit`` in a recipe +file, :term:`IMAGE_CLASSES` or :term:`KERNEL_CLASSES`) should be in a +``classes-recipe`` subdirectory and classes that are intended to be inherited +globally (e.g. via ``INHERIT +=``, :term:`PACKAGE_CLASSES`, :term:`USER_CLASSES` +or :term:`INHERIT_DISTRO`) should be in ``classes-global``. Classes in the +existing ``classes`` subdirectory will continue to work in any context as before. + +Other than knowing where to look when manually browsing the class files, this is +not likely to require any changes to your configuration. However, if in your +configuration you were using some classes in the incorrect context, you will now +receive an error during parsing. For example, the following in ``local.conf`` will +now cause an error:: + + INHERIT += "testimage" + +Since :ref:`ref-classes-testimage` is a class intended solely to +affect image recipes, this would be correctly specified as:: + + IMAGE_CLASSES += "testimage" + + +.. _migration-4.1-local-file-error: + +Missing local files in SRC_URI now triggers an error +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If a file referenced in :term:`SRC_URI` does not exist, in 4.1 this will trigger +an error at parse time where previously this only triggered a warning. In the past +you could ignore these warnings for example if you have multiple build +configurations (e.g. for several different target machines) and there were recipes +that you were not building in one of the configurations. If you have this scenario +you will now need to conditionally add entries to :term:`SRC_URI` where they are +valid, or use :term:`COMPATIBLE_MACHINE` / :term:`COMPATIBLE_HOST` to prevent the +recipe from being available (and therefore avoid it being parsed) in configurations +where the files aren't available. + + +.. _migration-4.1-qa-checks: + +QA check changes +~~~~~~~~~~~~~~~~ + +- The :ref:`buildpaths <qa-check-buildpaths>` QA check is now enabled by default + in :term:`WARN_QA`, and thus any build system paths found in output files will + trigger a warning. If you see these warnings for your own recipes, for full + binary reproducibility you should make the necessary changes to the recipe build + to remove these paths. If you wish to disable the warning for a particular + recipe you can use :term:`INSANE_SKIP`, or for the entire build you can adjust + :term:`WARN_QA`. For more information, see the :ref:`buildpaths QA check + <qa-check-buildpaths>` section. + +- ``do_qa_staging`` now checks shebang length in all directories specified by + :term:`SYSROOT_DIRS`, since there is a maximum length defined in the kernel. For + native recipes which write scripts to the sysroot, if the shebang line in one of + these scripts is too long you will get an error. This can be skipped using + :term:`INSANE_SKIP` if necessary, but the best course of action is of course to + fix the script. There is now also a ``create_cmdline_shebang_wrapper`` function + that you can call e.g. from ``do_install`` (or ``do_install:append``) within a + recipe to create a wrapper to fix such scripts - see the ``libcheck`` recipe + for an example usage. + + + +Miscellaneous changes +~~~~~~~~~~~~~~~~~~~~~ + +- ``mount.blacklist`` has been renamed to ``mount.ignorelist`` in + ``udev-extraconf``. If you are customising this file via ``udev-extraconf`` then + you will need to update your ``udev-extraconf`` ``.bbappend`` as appropriate. +- ``help2man-native`` has been removed from implicit sysroot dependencies. If a + recipe needs ``help2man-native`` it should now be explicitly added to + :term:`DEPENDS` within the recipe. +- For images using systemd, the reboot watchdog timeout has been set to 60 + seconds (from the upstream default of 10 minutes). If you wish to override this + you can set :term:`WATCHDOG_TIMEOUT` to the desired timeout in seconds. Note + that the same :term:`WATCHDOG_TIMEOUT` variable also specifies the timeout used + for the ``watchdog`` tool (if that is being built). +- The :ref:`ref-classes-image-buildinfo` class now writes to + ``${sysconfdir}/buildinfo`` instead of ``${sysconfdir}/build`` by default (i.e. + the default value of :term:`IMAGE_BUILDINFO_FILE` has been changed). If you have + code that reads this from images at build or runtime you will need to update it + or specify your own value for :term:`IMAGE_BUILDINFO_FILE`. +- In the :ref:`ref-classes-archiver` class, the default + ``ARCHIVER_OUTDIR`` value no longer includes the :term:`MACHINE` value in order + to avoid the archive task running multiple times in a multiconfig setup. If you + have custom code that does something with the files archived by the + :ref:`ref-classes-archiver` class then you may need to adjust it to + the new structure. +- If you are not using `systemd` then udev is now configured to use labels + (``LABEL`` or ``PARTLABEL``) to set the mount point for the device. For example:: + + /run/media/rootfs-sda2 + + instead of:: + + /run/media/sda2 + +- ``icu`` no longer provides the ``icu-config`` configuration tool - upstream + have indicated ``icu-config`` is deprecated and should no longer be used. Code + with references to it will need to be updated, for example to use ``pkg-config`` + instead. +- The ``rng-tools`` systemd service name has changed from ``rngd`` to ``rng-tools`` +- The ``largefile`` :term:`DISTRO_FEATURES` item has been removed, large file + support is now always enabled where it was previously optional. +- The Python ``zoneinfo`` module is now split out to its own ``python3-zoneinfo`` + package. +- The :term:`PACKAGECONFIG` option to enable wpa_supplicant in the ``connman`` + recipe has been renamed to "wpa-supplicant". If you have set :term:`PACKAGECONFIG` for + the ``connman`` recipe to include this option you will need to update + your configuration. Related to this, the :term:`WIRELESS_DAEMON` variable + now expects the new ``wpa-supplicant`` naming and affects ``packagegroup-base`` + as well as ``connman``. +- The ``wpa-supplicant`` recipe no longer uses a static (and stale) ``defconfig`` + file, instead it uses the upstream version with appropriate edits for the + :term:`PACKAGECONFIG`. If you are customising this file you will need to + update your customisations. +- With the introduction of picobuild in + :ref:`ref-classes-python_pep517`, The ``PEP517_BUILD_API`` + variable is no longer supported. If you have any references to this variable + you should remove them. + + +.. _migration-4.1-removed-recipes: + +Removed recipes +~~~~~~~~~~~~~~~ + +The following recipes have been removed in this release: + +- ``alsa-utils-scripts``: merged into alsa-utils +- ``cargo-cross-canadian``: optimised out +- ``lzop``: obsolete, unmaintained upstream +- ``linux-yocto (5.10)``: 5.15 and 5.19 are currently provided +- ``rust-cross``: optimised out +- ``rust-crosssdk``: optimised out +- ``rust-tools-cross-canadian``: optimised out +- ``xf86-input-keyboard``: obsolete (replaced by libinput/evdev) diff --git a/documentation/migration-guides/migration-4.2.rst b/documentation/migration-guides/migration-4.2.rst new file mode 100644 index 0000000000..f5f12c8871 --- /dev/null +++ b/documentation/migration-guides/migration-4.2.rst @@ -0,0 +1,276 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.2 (mickledore) +======================== + +Migration notes for 4.2 (mickledore) +------------------------------------ + +This section provides migration information for moving to the Yocto +Project 4.2 Release (codename "mickledore") from the prior release. + +.. _migration-4.2-supported-distributions: + +Supported distributions +~~~~~~~~~~~~~~~~~~~~~~~ + +This release supports running BitBake on new GNU/Linux distributions: + +- Fedora 36 and 37 +- AlmaLinux 8.7 and 9.1 +- OpenSuse 15.4 + +On the other hand, some earlier distributions are no longer supported: + +- Debian 10.x +- Fedora 34 and 35 +- AlmaLinux 8.5 + +See :ref:`all supported distributions <system-requirements-supported-distros>`. + +.. _migration-4.2-python-3.8: + +Python 3.8 is now the minimum required Python version version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +BitBake and OpenEmbedded-Core now require Python 3.8 or newer, +making it a requirement to use a distribution providing at least this +version, or to install a :term:`buildtools` tarball. + +.. _migration-4.2-gcc-8.0: + +gcc 8.0 is now the minimum required GNU C compiler version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This version, released in 2018, is a minimum requirement +to build the ``mesa-native`` recipe and as the latter is in the +default dependency chain when building QEMU this has now been +made a requirement for all builds. + +In the event that your host distribution does not provide this +or a newer version of gcc, you can install a +:term:`buildtools-extended` tarball. + +.. _migration-4.2-new-nvd-api: + +Fetching the NVD vulnerability database through the 2.0 API +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This new version adds a new fetcher for the NVD database using the 2.0 API, +as the 1.0 API will be retired in 2023. + +The implementation changes as little as possible, keeping the current +database format (but using a different database file for the transition +period), with a notable exception of not using the META table. + +Here are minor changes that you may notice: + +- The database starts in 1999 instead of 2002 +- The complete fetch is longer (30 minutes typically) + +.. _migration-4.2-rust-crate-checksums: + +Rust: mandatory checksums for crates +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This release now supports checksums for Rust crates and makes +them mandatory for each crate in a recipe. See :yocto_git:`python3_bcrypt recipe changes +</poky/commit/?h=mickledore&id=0dcb5ab3462fdaaf1646b05a00c7150eea711a9a>` +for example. + +The ``cargo-update-recipe-crates`` utility +:yocto_git:`has been extended </poky/commit/?h=mickledore&id=eef7fbea2c5bf59369390be4d5efa915591b7b22>` +to include such checksums. So, in case you need to add the list of checksums +to a recipe just inheriting the :ref:`ref-classes-cargo` class so far, you can +follow these steps: + +#. Make the recipe inherit :ref:`ref-classes-cargo-update-recipe-crates` +#. Remove all ``crate://`` lines from the recipe +#. Create an empty ``${BPN}-crates.inc`` file and make your recipe require it +#. Execute ``bitbake -c update_crates your_recipe`` +#. Copy and paste the output of BitBake about the missing checksums into the + ``${BPN}-crates.inc`` file. + + +.. _migration-4.2-addpylib: + +Python library code extensions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +BitBake in this release now supports a new ``addpylib`` directive to enable +Python libraries within layers. + +This directive should be added to your layer configuration +as in the below example from ``meta/conf/layer.conf``:: + + addpylib ${LAYERDIR}/lib oe + +Layers currently adding a lib directory to extend Python library code should now +use this directive as :term:`BBPATH` is not going to be added automatically by +OE-Core in future. Note that the directives are immediate operations, so it does +make modules available for use sooner than the current BBPATH-based approach. + +For more information, see :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`. + + +.. _migration-4.2-removed-variables: + +Removed variables +~~~~~~~~~~~~~~~~~ + +The following variables have been removed: + +- ``SERIAL_CONSOLE``, deprecated since version 2.6, replaced by :term:`SERIAL_CONSOLES`. +- ``PACKAGEBUILDPKGD``, a mostly internal variable in the :ref:`ref-classes-package` + class was rarely used to customise packaging. If you were using this in your custom + recipes or bbappends, you will need to switch to using :term:`PACKAGE_PREPROCESS_FUNCS` + or :term:`PACKAGESPLITFUNCS` instead. + +.. _migration-4.2-removed-recipes: + +Removed recipes +~~~~~~~~~~~~~~~ + +The following recipes have been removed in this release: + +- ``python3-picobuild``: after switching to ``python3-build`` +- ``python3-strict-rfc3339``: unmaintained and not needed by anything in + :oe_git:`openembedded-core </openembedded-core>` + or :oe_git:`meta-openembedded </meta-openembedded>`. +- ``linux-yocto``: removed version 5.19 recipes (6.1 and 5.15 still provided) + + +.. _migration-4.2-removed-classes: + +Removed classes +~~~~~~~~~~~~~~~ + +The following classes have been removed in this release: + +- ``rust-bin``: no longer used +- ``package_tar``: could not be used for actual packaging, and thus not particularly useful. + + +LAYERSERIES_COMPAT for custom layers and devtool workspace +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some layer maintainers have been setting :term:`LAYERSERIES_COMPAT` in their +layer's ``conf/layer.conf`` to the value of ``LAYERSERIES_CORENAMES`` to +effectively bypass the compatibility check - this is no longer permitted. +Layer maintainers should set :term:`LAYERSERIES_COMPAT` appropriately to +help users understand the compatibility status of the layer. + +Additionally, the :term:`LAYERSERIES_COMPAT` value for the devtool workspace +layer is now set at the time of creation, thus if you upgrade with the +workspace layer enabled and you wish to retain it, you will need to manually +update the :term:`LAYERSERIES_COMPAT` value in ``workspace/conf/layer.conf`` +(or remove the path from :term:`BBLAYERS` in ``conf/bblayers.conf`` and +delete/move the ``workspace`` directory out of the way if you no longer +need it). + + +.. _migration-4.2-runqemu-slirp: + +runqemu now limits slirp host port forwarding to localhost +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +With default slirp port forwarding configuration in runqemu, qemu +previously listened on TCP ports 2222 and 2323 on all IP addresses +available on the build host. Most use cases with runqemu only need +it for localhost and it is not safe to run qemu images with root +login without password enabled and listening on all available, +possibly Internet reachable network interfaces. Thus, in this +release we limit qemu port forwarding to localhost (127.0.0.1). + +However, if you need the qemu machine to be reachable from the +network, then it can be enabled via ``conf/local.conf`` or machine +config variable ``QB_SLIRP_OPT``:: + + QB_SLIRP_OPT = "-netdev user,id=net0,hostfwd=tcp::2222-:22" + + +.. _migration-4.2-patch-qa: + +Patch QA checks +~~~~~~~~~~~~~~~ + +The QA checks for patch fuzz and Upstream-Status have been reworked +slightly in this release. The Upstream-Status checking is now configurable +from :term:`WARN_QA` / :term:`ERROR_QA` (``patch-status-core`` for the +core layer, and ``patch-status-noncore`` for other layers). + +The ``patch-fuzz`` and ``patch-status-core`` checks are now in the default +value of :term:`ERROR_QA` so that they will cause the build to fail +if triggered. If you prefer to avoid this you will need to adjust the value +of :term:`ERROR_QA` in your configuration as desired. + + +.. _migration-4.2-mesa: + +Native/nativesdk mesa usage and graphics drivers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This release includes mesa 23.0, and with that mesa release it is not longer +possible to use drivers from the host system, as mesa upstream has added strict +checks for matching builds between drivers and libraries that load them. + +This is particularly relevant when running QEMU built within the build +system. A check has been added to runqemu so that there is a helpful error +when there is no native/nativesdk opengl/virgl support available. + +To support this, a number of drivers have been enabled when building ``mesa-native``. +The one major dependency pulled in by this change is ``llvm-native`` which will +add a few minutes to the build on a modern machine. If this is undesirable, you +can set the value of :term:`DISTRO_FEATURES_NATIVE` in your configuration such +that ``opengl`` is excluded. + + +.. _migration-4.2-misc-changes: + +Miscellaneous changes +~~~~~~~~~~~~~~~~~~~~~ + +- The :term:`IMAGE_NAME` variable is now set based on :term:`IMAGE_LINK_NAME`. This + means that if you are setting :term:`IMAGE_LINK_NAME` to "" to disable unversioned + image symlink creation, you also now 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}" + +- In ``/etc/os-release``, the ``VERSION_CODENAME`` field is now used instead of + ``DISTRO_CODENAME`` (though its value is still set from the :term:`DISTRO_CODENAME` + variable) for better conformance to standard os-release usage. If you have runtime + code reading this from ``/etc/os-release`` it may need to be updated. + +- The kmod recipe now enables OpenSSL support by default in order to support module + signing. If you do not need this and wish to reclaim some space/avoid the dependency + you should set :term:`PACKAGECONFIG` in a kmod bbappend (or ``PACKAGECONFIG:pn-kmod`` + at the configuration level) to exclude ``openssl``. + +- The ``OEBasic`` signature handler (see :term:`BB_SIGNATURE_HANDLER`) has been + removed. It is unlikely that you would have selected to use this, but if you have + you will need to remove this setting. + +- The :ref:`ref-classes-package` class now checks if package names conflict via + ``PKG:${PN}`` override during ``do_package``. If you receive the associated error + you will need to address the :term:`PKG` usage so that the conflict is resolved. + +- openssh no longer uses :term:`RRECOMMENDS` to pull in ``rng-tools``, since rngd + is no longer needed as of Linux kernel 5.6. If you still need ``rng-tools`` + installed for other reasons, you should add ``rng-tools`` explicitly to your + image. If you additionally need rngd to be started as a service you will also + need to add the ``rng-tools-service`` package as that has been split out. + +- The cups recipe no longer builds with the web interface enabled, saving ~1.8M of + space in the final image. If you wish to enable it, you should set + :term:`PACKAGECONFIG` in a cups bbappend (or ``PACKAGECONFIG:pn-cups`` at the + configuration level) to include ``webif``. + +- The :ref:`ref-classes-scons` class now passes a ``MAXLINELENGTH`` argument to + scons in order to fix an issue with scons and command line lengths when ccache is + enabled. However, some recipes may be using older scons versions which don't support + this argument. If that is the case you can set the following in the recipe in order + to disable this:: + + SCONS_MAXLINELENGTH = "" diff --git a/documentation/migration-guides/migration-4.3.rst b/documentation/migration-guides/migration-4.3.rst new file mode 100644 index 0000000000..fc25397d70 --- /dev/null +++ b/documentation/migration-guides/migration-4.3.rst @@ -0,0 +1,252 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.3 (nanbield) +======================== + +Migration notes for 4.3 (nanbield) +------------------------------------ + +This section provides migration information for moving to the Yocto +Project 4.3 Release (codename "nanbield") from the prior release. + +.. _migration-4.3-supported-kernel-versions: + +Supported kernel versions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :term:`OLDEST_KERNEL` setting has been changed to "5.15" in this release, meaning that +out the box, older kernels are not supported. There were two reasons for this. +Firstly it allows glibc optimisations that improve the performance of the system +by removing compatibility code and using modern kernel APIs exclusively. The second +issue was this allows 64 bit time support even on 32 bit platforms and resolves Y2038 +issues. + +It is still possible to override this value and build for older kernels, this is just +no longer the default supported configuration. This setting does not affect which +kernel versions SDKs will run against and does not affect which versions of the kernel +can be used to run builds. + +.. _migration-4.3-layername-override: + +Layername override implications +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Code can now know which layer a recipe is coming from through the newly added +:term:`FILE_LAYERNAME` variable and the ``layer-<layername> override``. This is being used +for enabling QA checks on a per layer basis. For existing code this has the +side effect that the QA checks will apply to recipes being bbappended +from other layers - for example, patches added through such bbappends will now +need to have the "Upstream-Status" specified in the patch header. + +.. _migration-4.3-compiling-changes: + +Compiling changes +~~~~~~~~~~~~~~~~~ + +- Code on 32 bit platforms is now compiled with largefile support and 64 + bit ``time_t``, to avoid the Y2038 time overflow issue. This breaks the ABI + and could break existing programs in untested layers. + +.. _migration-4.3-supported-distributions: + +Supported distributions +~~~~~~~~~~~~~~~~~~~~~~~ + +This release supports running BitBake on new GNU/Linux distributions: + +- Ubuntu 22.10 +- Fedora 38 +- Debian 12 +- CentOS Stream 8 +- AlmaLinux 8.8 +- AlmaLinux 9.2 + +On the other hand, some earlier distributions are no longer supported: + +- Fedora 36 +- AlmaLinux 8.7 +- AlmaLinux 9.1 + +See :ref:`all supported distributions <system-requirements-supported-distros>`. + +.. _migration-4.3-removed-machines: + +edgerouter machine removed +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``edgerouter`` reference BSP for the MIPS architecture in ``meta-yocto-bsp`` +has been removed as the hardware has been unavailable for some time. There is no +suitable reference MIPS hardware to replace it with, but the MIPS architecture +will continue to get coverage via QEMU build/boot testing. + +.. _migration-4.3-go-changes: + +Go language changes +~~~~~~~~~~~~~~~~~~~ + +- Support for the Glide package manager has been removed, as ``go mod`` + has become the standard. + +.. _migration-4.3-systemd-changes: + +systemd changes +~~~~~~~~~~~~~~~ + +Upstream systemd is now more strict on filesystem layout and the ``usrmerge`` +feature is therefore required alongside systemd. The Poky test configurations +have been updated accordingly for systemd. + +.. _migration-4.3-recipe-changes: + +Recipe changes +~~~~~~~~~~~~~~ + +- Runtime testing of ptest now fails if no test results are returned by + any given ptest. + +.. _migration-4.3-deprecated-variables: + +Deprecated variables +~~~~~~~~~~~~~~~~~~~~ + +The following variables have been deprecated: + +- :term:`CVE_CHECK_IGNORE`: use :term:`CVE_STATUS` instead. + +.. _migration-4.3-removed-variables: + +Removed variables +~~~~~~~~~~~~~~~~~ + +The following variables have been removed: + +- ``AUTHOR`` +- ``PERLARCH`` +- ``PERLVERSION`` +- ``QEMU_USE_SLIRP`` - add ``slirp`` to ``TEST_RUNQEMUPARAMS`` instead. +- ``SERIAL_CONSOLES_CHECK`` - no longer necessary because all + consoles listed in :term:`SERIAL_CONSOLES` are checked for their existence + before a ``getty`` is started. + +.. _migration-4.3-removed-recipes: + +Removed recipes +~~~~~~~~~~~~~~~ + +The following recipes have been removed in this release: + +- ``apmd``: obsolete (``apm`` in :term:`MACHINE_FEATURES` also removed). +- ``cve-update-db-native``: functionally replaced by ``cve-update-nvd2-native`` +- ``gcr3``: no longer needed by core recipes, moved to meta-gnome (gcr, i.e. version 4.x, is still provided). +- ``glide``: as explained in :ref:`migration-4.3-go-changes`. +- ``libdmx``: obsolete +- ``linux-yocto`` version 5.15 (versions 6.1 and 6.5 provided instead). +- ``python3-async``: obsolete - no longer needed by ``python3-gitdb`` or any other core recipe +- ``rust-hello-world``: there are sufficient other Rust recipes and test cases such that this is no longer needed. + + +.. _migration-4.3-removed-classes: + +Removed classes +~~~~~~~~~~~~~~~ + +The following classes have been removed in this release: + +- ``glide``: as explained in :ref:`migration-4.3-go-changes`. + + +Output file naming changes +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In 4.3 there are some minor differences in image and SDK output file names. +If you rely on the existing naming (e.g. in external scripts) you may need to +either modify configuration or adapt to the new naming. Further details: + +- :term:`IMAGE_NAME` and :term:`IMAGE_LINK_NAME` now include the + :term:`IMAGE_NAME_SUFFIX` value directly. In practical terms, this means + that ``.rootfs`` will now appear in image output file names. If you do not + wish to have the ``.rootfs`` suffix used, you can just set + :term:`IMAGE_NAME_SUFFIX` to "" and this will now be consistently respected + in both the image file and image file symlink names. As part of this change, + support for the ``imgsuffix`` task varflag has been dropped (mostly + an internal implementation detail, but if you were implementing a custom + image construction with a task in a similar manner to ``do_bootimg`` + you may have been using this). + +- :term:`SDK_NAME` now includes the values of :term:`IMAGE_BASENAME` and + :term:`MACHINE` so that they are unique when building SDKs for different + images and machines. + + + +.. _migration-4.3-pr-pe: + +Versioning changes +~~~~~~~~~~~~~~~~~~ + +- :term:`PR` values have been removed from all core recipes - distro maintainers + who make use of :term:`PR` values would need to curate these already so the + sparsely set base values would not be that useful anymore. If you have been + relying on these (i.e. you are maintaining a binary package feed where package + versions should only ever increase), double-check the output (perhaps with the + help of the :ref:`ref-classes-buildhistory` class) to ensure that package + versions are consistent. + +- The :term:`PR` value can no longer be set from the recipe file name - this + was rarely used, but in any case is no longer supported. + +- :term:`PE` and :term:`PR` are no longer included in the work directory path + (:term:`WORKDIR`). This may break some tool assumptions about directory paths, + but those should really be querying paths from the build system (or not poking + into :term:`WORKDIR` externally). + +- Source revision information has been moved from :term:`PV` to :term:`PKGV`. + The user visible effect of this change is that :term:`PV` will no longer have + revision information in it and this will now be appended to the :term:`PV` + value through :term:`PKGV` when the packages are written out (as long as "+" + is present in the :term:`PKGV` value). Since :term:`PV` is used in + :term:`STAMP` and :term:`WORKDIR`, you may notice small directory naming and + stamp naming changes. + +- The :term:`SRCPV` variable is no longer needed in :term:`PV`, but since + the default :term:`SRCPV` value is now "", using it is effectively now just a + null operation - you can remove it (leaving behind the "+") , but it is not + yet required to do so. + + +.. _migration-4.3-qemu-changes: + +QEMU changes +~~~~~~~~~~~~ + +- The ``runqemu`` script no longer systematically adds two serial ports + (``--serial null`` and ``-serial mon:stdio``) to the QEMU emulated machine + if the user already adds such ports through the ``QB_OPT_APPEND`` setting. + + If the user adds one port, only ``--serial null`` is added, and + ``-serial mon:stdio`` is no longer passed. If the user adds more than one + port, ``--serial null`` is no longer added either. This can break some + existing QEMU based configurations expecting such serial ports to be added + when ``runqemu`` is executed. + + This change was made to avoid exceeding two serial ports, which interferes + with automated testing. + +- ``runqemu`` now uses the ``ip tuntap`` command instead of ``tunctl``, and + thus ``tunctl`` is no longer built by the ``qemu-helper-native`` recipe; if + for some reason you were calling ``tunctl`` directly from your own scripts + you should switch to calling ``ip tuntap`` instead. + +.. _migration-4.3-misc-changes: + +Miscellaneous changes +~~~~~~~~~~~~~~~~~~~~~ + +- The ``-crosssdk`` suffix and any :term:`MLPREFIX` were removed from + ``virtual/XXX`` provider/dependencies where a ``PREFIX`` was used as well, + as we don't need both and it made automated dependency rewriting + unnecessarily complex. In general this only affects internal toolchain + dependencies so isn't end user visible, but if for some reason you have + custom classes or recipes that rely upon the old providers then you will + need to update those. + diff --git a/documentation/migration-guides/migration-5.0.rst b/documentation/migration-guides/migration-5.0.rst new file mode 100644 index 0000000000..cf413300c2 --- /dev/null +++ b/documentation/migration-guides/migration-5.0.rst @@ -0,0 +1,202 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 5.0 LTS (scarthgap) +=========================== + +Migration notes for 5.0 (scarthgap) +------------------------------------ + +This section provides migration information for moving to the Yocto +Project 5.0 Release (codename "scarthgap") from the prior release. + +To migrate from an earlier LTS release, you **also** need to check all +the previous migration notes from your release to this new one: + +- :doc:`/migration-guides/migration-4.3` +- :doc:`/migration-guides/migration-4.2` +- :doc:`/migration-guides/migration-4.1` +- :doc:`/migration-guides/migration-4.0` +- :doc:`/migration-guides/migration-3.4` +- :doc:`/migration-guides/migration-3.3` +- :doc:`/migration-guides/migration-3.2` + +.. _migration-5.0-supported-kernel-versions: + +Supported kernel versions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :term:`OLDEST_KERNEL` setting is still "5.15" in this release, meaning that +out the box, older kernels are not supported. See :ref:`4.3 migration notes +<migration-4.3-supported-kernel-versions>` for details. + +.. _migration-5.0-supported-distributions: + +Supported distributions +~~~~~~~~~~~~~~~~~~~~~~~ + +Compared to the previous releases, running BitBake is supported on new +GNU/Linux distributions: + +- Rocky 9 + +On the other hand, some earlier distributions are no longer supported: + +- Fedora 37 +- Ubuntu 22.10 +- OpenSUSE Leap 15.3 + +See :ref:`all supported distributions <system-requirements-supported-distros>`. + +.. _migration-5.0-go-changes: + +Go language changes +~~~~~~~~~~~~~~~~~~~ + +The ``linkmode`` flag was dropped from ``GO_LDFLAGS`` for ``nativesdk`` and +``cross-canadian``. Also, dynamic linking was disabled for the whole set of +(previously) supported architectures in the ``goarch`` class. + +.. _migration-5.0-systemd-changes: + +systemd changes +~~~~~~~~~~~~~~~ + +Systemd's nss-resolve plugin is now supported and can be added via the +``nss-resolve`` :term:`PACKAGECONFIG` option , which is from now on required +(along with ``resolved``) by the ``systemd-resolved`` feature. Related to that +(i.e., Systemd's network name resolution), an option to use ``stub-resolv.conf`` +was added as well. + +.. _migration-5.0-recipe-changes: + +Recipe changes +~~~~~~~~~~~~~~ + +- Runtime testing of ptest now fails if no test results are returned by + any given ptest. + +.. _migration-5.0-deprecated-variables: + +Deprecated variables +~~~~~~~~~~~~~~~~~~~~ + +- ``CVE_CHECK_IGNORE`` should be replaced with :term:`CVE_STATUS` + + +.. _migration-5.0-removed-variables: + +Removed variables +~~~~~~~~~~~~~~~~~ + +The following variables have been removed: + +- ``DEPLOY_DIR_TAR``: no longer needed since the package_tar class was removed in 4.2. +- ``PYTHON_PN``: Python 2 has previously been removed, leaving Python 3 as the sole + major version. Therefore, this abstraction to differentiate both versions is + no longer needed. +- ``oldincludedir`` +- ``USE_L10N``: previously deprecated, and now removed. +- ``CVE_SOCKET_TIMEOUT`` +- ``SERIAL_CONSOLES_CHECK`` - use :term:`SERIAL_CONSOLES` instead as all consoles specified in the latter are checked for their existence before a ``getty`` is started. + +.. _migration-5.0-removed-recipes: + +Removed recipes +~~~~~~~~~~~~~~~ + +The following recipes have been removed in this release: + +- ``libcroco``: deprecated and archived by the Gnome Project. +- ``liberror-perl``: unmaintained and no longer needed - moved to meta-perl. +- ``linux-yocto``: version 6.1 (version 6.6 provided instead). +- ``systemtap-uprobes``: obsolete. +- ``zvariant``: fails to build with newer Rust. + +.. _migration-5.0-removed-classes: + +Removed classes +~~~~~~~~~~~~~~~ + +No classes have been removed in this release. + +.. _migration-5.0-qemu-changes: + +QEMU changes +~~~~~~~~~~~~ + +In ``tune-core2``, the cpu models ``n270`` and ``core2duo`` are no longer +passed to QEMU, since its documentation recommends not using them with ``-cpu`` +option. Therefore, from now on, ``Nehalem`` model is used instead. + + +ipk packaging changes +~~~~~~~~~~~~~~~~~~~~~ + +ipk packaging (using ``opkg``) now uses ``zstd`` compression instead of ``xz`` +for better compression and performance. This does mean that ``.ipk`` packages +built using the 5.0 release requires Opkg built with zstd enabled --- naturally +this is the case in 5.0, but at least by default these packages will not be +usable on older systems where Opkg does not have zstd enabled at build time. + +Additionally, the internal dependency solver in Opkg is now deprecated --- it +is still available in this release but will trigger a warning if selected. +The default has been the external ``libsolv`` solver for some time, but if you +have explicitly removed that from :term:`PACKAGECONFIG` for Opkg to +select the internal solver, you should plan to switch to ``libsolv`` in the +near future (by including ``libsolv`` your custom :term:`PACKAGECONFIG` value +for Opkg, or reverting to the default value). + + +motd message when using ``DISTRO = "poky"`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The default ``poky`` :term:`DISTRO` is explicitly a *reference* distribution +for testing and development purposes. It enables most hardware and software +features so that they can be tested, but this also means that +from a security point of view the attack surface is very large. + +We encourage anyone using the Yocto Project for production use to create +their own distribution and not use Poky. To encourage this behaviour +further, in 5.0 a warning has been added to ``/etc/motd`` when Poky is used +so that the developer will see it when they log in. If you are creating your +own distribution this message will not show up. + +For information on how to create your own distribution, see +":ref:`dev-manual/custom-distribution:creating your own distribution`". + +.. _migration-5.0-misc-changes: + +Miscellaneous changes +~~~~~~~~~~~~~~~~~~~~~ + +- ``bitbake-whatchanged`` script was removed as it was broken and unmaintained. + +- ``scripts/sstate-cache-management.sh`` has been replaced by + ``scripts/sstate-cache-management.py``, a more performant Python-based version. + +- The ``bmap-tools`` recipe has been renamed to ``bmaptool``. + +- ``gpgme`` has had Python binding support disabled since upstream does not + support Python 3.12 yet. This will be fixed in future once it is fixed upstream.) + +- A warning will now be shown if the ``virtual/`` prefix is used in runtime + contexts (:term:`RDEPENDS` / :term:`RPROVIDES`) --- + See :ref:`virtual-slash <qa-check-virtual-slash>` for details. + +- ``recipetool`` now prefixes the names of recipes created for Python modules + with ``python3-``. + +- The :ref:`ref-classes-cve-check` class no longer produces a warning for + remote patches --- it only logs a note and does not try to fetch the patch + in order to scan it for issues or CVE numbers. However, CVE number + references in remote patch file names will now be picked up. + +- The values of :term:`PE` and :term:`PR` have been dropped from + ``-f{file,macro,debug}-prefix-map``, in order to avoid unnecessary churn + in debugging symbol paths when the version is bumped. This is unlikely to + cause issues, but if you are paying attention to the debugging source path + (e.g. in recipes that need to manipulate these files during packaging) then + you will notice the difference. A new :term:`TARGET_DBGSRC_DIR` variable is + provided to make this easier. + +- ``ccache`` no longer supports FORTRAN. diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index 9eecf69af8..1820f5cfd8 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Introduction ============ @@ -70,3 +72,37 @@ any new Yocto Project release. bitbake-layers show-appends +.. _migration-general-buildhistory: + +- *Checking Image / SDK Changes*: + + The :ref:`ref-classes-buildhistory` class can be used + if you wish to check the impact of changes to images / SDKs across + the migration (e.g. added/removed packages, added/removed files, size + changes etc.). To do this, follow these steps: + + #. Enable :ref:`ref-classes-buildhistory` before the migration + + #. Run a pre-migration build + + #. Capture the :ref:`ref-classes-buildhistory` output (as + specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for + subsequent builds. How you would do this depends on how you are running + your builds - if you are doing this all on one workstation in the same + :term:`Build Directory` you may not need to do anything other than not + deleting the :ref:`ref-classes-buildhistory` output + directory. For builds in a pipeline it may be more complicated. + + #. Set a tag in the :ref:`ref-classes-buildhistory` output (which is a git repository) before + migration, to make the commit from the pre-migration build easy to find + as you may end up running multiple builds during the migration. + + #. Perform the migration + + #. Run a build + + #. Check the output changes between the previously set tag and HEAD in the + :ref:`ref-classes-buildhistory` output using ``git diff`` or ``buildhistory-diff``. + + For more information on using :ref:`ref-classes-buildhistory`, see + :ref:`dev-manual/build-quality:maintaining build output quality`. diff --git a/documentation/migration-guides/release-3.4.rst b/documentation/migration-guides/release-3.4.rst new file mode 100644 index 0000000000..043fdd1c9f --- /dev/null +++ b/documentation/migration-guides/release-3.4.rst @@ -0,0 +1,14 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 3.4 (honister) +====================== + +.. toctree:: + + migration-3.4 + release-notes-3.4 + release-notes-3.4.1 + release-notes-3.4.2 + release-notes-3.4.3 + release-notes-3.4.4 + diff --git a/documentation/migration-guides/release-4.0.rst b/documentation/migration-guides/release-4.0.rst new file mode 100644 index 0000000000..685799e268 --- /dev/null +++ b/documentation/migration-guides/release-4.0.rst @@ -0,0 +1,26 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.0 (kirkstone) +======================= + +.. toctree:: + + migration-4.0 + release-notes-4.0 + release-notes-4.0.1 + release-notes-4.0.2 + release-notes-4.0.3 + release-notes-4.0.4 + release-notes-4.0.5 + release-notes-4.0.6 + release-notes-4.0.7 + release-notes-4.0.8 + release-notes-4.0.9 + release-notes-4.0.10 + release-notes-4.0.11 + release-notes-4.0.12 + release-notes-4.0.13 + release-notes-4.0.14 + release-notes-4.0.15 + release-notes-4.0.16 + release-notes-4.0.17 diff --git a/documentation/migration-guides/release-4.1.rst b/documentation/migration-guides/release-4.1.rst new file mode 100644 index 0000000000..7d1ce95e25 --- /dev/null +++ b/documentation/migration-guides/release-4.1.rst @@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.1 (langdale) +====================== + +.. toctree:: + + migration-4.1 + release-notes-4.1 + release-notes-4.1.1 + release-notes-4.1.2 + release-notes-4.1.3 + release-notes-4.1.4 diff --git a/documentation/migration-guides/release-4.2.rst b/documentation/migration-guides/release-4.2.rst new file mode 100644 index 0000000000..5ef2cc6657 --- /dev/null +++ b/documentation/migration-guides/release-4.2.rst @@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.2 (mickledore) +======================== + +.. toctree:: + + migration-4.2 + release-notes-4.2 + release-notes-4.2.1 + release-notes-4.2.2 + release-notes-4.2.3 + release-notes-4.2.4 diff --git a/documentation/migration-guides/release-4.3.rst b/documentation/migration-guides/release-4.3.rst new file mode 100644 index 0000000000..1f07d229a7 --- /dev/null +++ b/documentation/migration-guides/release-4.3.rst @@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 4.3 (nanbield) +======================== + +.. toctree:: + + migration-4.3 + release-notes-4.3 + release-notes-4.3.1 + release-notes-4.3.2 + release-notes-4.3.3 + release-notes-4.3.4 diff --git a/documentation/migration-guides/release-5.0.rst b/documentation/migration-guides/release-5.0.rst new file mode 100644 index 0000000000..bd19b707f6 --- /dev/null +++ b/documentation/migration-guides/release-5.0.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 5.0 (scarthgap) +======================= + +.. toctree:: + + migration-5.0 + release-notes-5.0 diff --git a/documentation/migration-guides/release-notes-3.4.1.rst b/documentation/migration-guides/release-notes-3.4.1.rst new file mode 100644 index 0000000000..097c249a90 --- /dev/null +++ b/documentation/migration-guides/release-notes-3.4.1.rst @@ -0,0 +1,254 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 3.4.1 (honister) +---------------------------------- + +Known Issues in 3.4.1 +~~~~~~~~~~~~~~~~~~~~~ + +- :yocto_bugs:`bsps-hw.bsps-hw.Test_Seek_bar_and_volume_control manual test case failure </show_bug.cgi?id=14622>` + +Security Fixes in 3.4.1 +~~~~~~~~~~~~~~~~~~~~~~~ + +- glibc: Backport fix for :cve:`2021-43396` +- vim: add patch number to :cve:`2021-3778` patch +- vim: fix :cve:`2021-3796`, :cve:`2021-3872`, and :cve:`2021-3875` +- squashfs-tools: follow-up fix for :cve:`2021-41072` +- avahi: update CVE id fixed by local-ping.patch +- squashfs-tools: fix :cve:`2021-41072` +- ffmpeg: fix :cve:`2021-38114` +- curl: fix :cve:`2021-22945`, :cve:`2021-22946` and :cve:`2021-22947` + +Fixes in 3.4.1 +~~~~~~~~~~~~~~ + +- bitbake.conf: Fix corruption of GNOME mirror url +- bitbake.conf: Use wayland distro feature for native builds +- bitbake: Revert "parse/ast: Show errors for append/prepend/remove operators combined with +=/.=" +- bitbake: bitbake-worker: Add debug when unpickle fails +- bitbake: cooker: Fix task-depends.dot for multiconfig targets +- bitbake: cooker: Handle parse threads disappearing to avoid hangs +- bitbake: cooker: Handle parsing results queue race +- bitbake: cooker: Remove debug code, oops :( +- bitbake: cooker: check if upstream hash equivalence server is available +- bitbake: fetch/git: Handle github dropping git:// support +- bitbake: fetch/wget: Add timeout for checkstatus calls (30s) +- bitbake: fetch2/perforce: Fix typo +- bitbake: fetch2: Fix url remap issue and add testcase +- bitbake: fetch2: fix downloadfilename issue with premirror +- bitbake: fetch: Handle mirror user/password replacements correctly +- bitbake: parse/ast: Show errors for append/prepend/remove operators combined with +=/.= +- bitbake: runqueue: Fix runall option handling +- bitbake: runqueue: Fix runall option task deletion ordering issue +- bitbake: test/fetch: Update urls to match upstream branch name changes +- bitbake: tests/fetch.py: add test case to ensure downloadfilename is used for premirror +- bitbake: tests/fetch.py: fix premirror test cases +- bitbake: tests/fetch: Update github urls +- bitbake: tests/fetch: Update pcre.org address after github changes +- bitbake: tests/runqueue: Ensure hashserv exits before deleting files +- bitbake: utils: Handle lockfile filenames that are too long for filesystems +- bootchart2: Don't compile Python modules +- build-appliance-image: Update to honister head revision +- buildhistory: Fix package output files for SDKs +- busybox: 1.34.0 -> 1.34.1 +- ca-certificates: update 20210119 -> 20211016 +- classes/populate_sdk_base: Add setscene tasks +- conf: update for release 3.4 +- convert-srcuri.py: use regex to check space in :term:`SRC_URI` +- create-spdx: Fix key errors in do_create_runtime_spdx +- create-spdx: Protect against None from :term:`LICENSE_PATH` +- create-spdx: Set the Organization field via a variable +- create-spdx: add create_annotation function +- create-spdx: cross recipes are native also +- create_spdx: ensure is_work_shared() is unique +- cups: Fix missing installation of cups sysv init scripts +- docs: poky.yaml: updates for 3.4 +- dpkg: Install dkpg-perl scripts to versioned perl directory +- glibc-version.inc: remove branch= from GLIBC_GIT_URI +- go-helloworld/glide: Fix urls +- go.bbclass: Allow adding parameters to go ldflags +- go: upgrade 1.16.7 -> 1.16.8 +- gst-devtools: 1.18.4 -> 1.18.5 +- gst-examples: 1.18.4 -> 1.18.5 +- gstreamer1.0-libav: 1.18.4 -> 1.18.5 +- gstreamer1.0-omx: 1.18.4 -> 1.18.5 +- gstreamer1.0-plugins-bad: 1.18.4 -> 1.18.5 +- gstreamer1.0-plugins-base: 1.18.4 -> 1.18.5 +- gstreamer1.0-plugins-good: 1.18.4 -> 1.18.5 +- gstreamer1.0-plugins-ugly: 1.18.4 -> 1.18.5 +- gstreamer1.0-python: 1.18.4 -> 1.18.5 +- gstreamer1.0-rtsp-server: 1.18.4 -> 1.18.5 +- gstreamer1.0-vaapi: 1.18.4 -> 1.18.5 +- gstreamer1.0: 1.18.4 -> 1.18.5 +- insane.bbclass: Add a check for directories that are expected to be empty +- kernel-devsrc: Add vdso.lds and other build files for riscv64 as well +- libnewt: Use python3targetconfig to fix reproducibility issue +- libpcre/libpcre2: correct :term:`SRC_URI` +- libx11-compose-data: Update :term:`LICENSE` to better reflect reality +- libx11: Update :term:`LICENSE` to better reflect reality +- libxml2: Use python3targetconfig to fix reproducibility issue +- linunistring: Add missing gperf-native dependency +- linux-firmware: upgrade to 20211027 +- linux-yocto-dev: Ensure :term:`DEPENDS` matches recent 5.14 kernel changes +- linux-yocto-rt/5.10: update to -rt54 +- linux-yocto/5.10: update to v5.10.78 +- linux-yocto/5.14: common-pc: enable CONFIG_ATA_PIIX as built-in +- linux-yocto/5.14: update to v5.14.17 +- linux-yocto: add libmpc-native to :term:`DEPENDS` +- lttng-tools: replace ad hoc ptest fixup with upstream fixes +- manuals: releases.rst: move gatesgarth to outdated releases section +- mesa: Enable svga for x86 only +- mesa: upgrade 21.2.1 -> 21.2.4 +- meson.bblcass: Remove empty egg-info directories before running meson +- meson: install native file in sdk +- meson: move lang args to the right section +- meson: set objcopy in the cross and native toolchain files +- meta/scripts: Manual git url branch additions +- meta: Add explict branch to git SRC_URIs +- migration-3.4: add additional migration info +- migration-3.4: add some extra packaging notes +- migration-3.4: tweak overrides change section +- migration: tweak introduction section +- mirrors: Add kernel.org sources mirror for downloads.yoctoproject.org +- mirrors: Add uninative mirror on kernel.org +- nativesdk-packagegroup-sdk-host.bb: Update host tools for wayland +- oeqa/runtime/parselogs: modified drm error in common errors list +- oeqa/selftest/sstatetests: fix typo ware -> were +- oeqa: Update cleanup code to wait for hashserv exit +- opkg: Fix poor operator combination choice +- ovmf: update 202105 -> 202108 +- patch.bbclass: when the patch fails show more info on the fatal error +- poky.conf: bump version for 3.4.1 honister release +- poky.yaml: add lz4 and zstd to essential host packages +- poky.yaml: fix lz4 package name for older Ubuntu versions +- pseudo: Add fcntl64 wrapper +- python3-setuptools: _distutils/sysconfig fix +- python3: update to 3.9.7 +- qemu.inc: Remove empty egg-info directories before running meson +- recipes: Update github.com urls to use https +- ref-manual: Update how to set a useradd password +- ref-manual: document "reproducible_build" class and :term:`SOURCE_DATE_EPOCH` +- ref-manual: document BUILD_REPRODUCIBLE_BINARIES +- ref-manual: document :term:`TOOLCHAIN_HOST_TASK_ESDK` +- ref-manual: remove meta class +- ref-manual: update system requirements +- releases.rst: fix release number for 3.3.3 +- scripts/convert-srcuri: Update :term:`SRC_URI` conversion script to handle github url changes +- scripts/lib/wic/help.py: Update Fedora Kickstart URLs +- scripts/oe-package-browser: Fix after overrides change +- scripts/oe-package-browser: Handle no packages being built +- spdx.py: Add annotation to relationship +- sstate: Account for reserved characters when shortening sstate filenames +- sstate: another fix for touching files inside pseudo +- sstate: fix touching files inside pseudo +- staging: Fix autoconf-native rebuild failure +- strace: fix build against 5.15 kernel/kernel-headers +- strace: show test suite log on failure +- stress-ng: convert to git, website is down +- systemd: add missing include for musl +- tar: filter CVEs using vendor name +- test-manual: how to enable reproducible builds +- testimage: fix unclosed testdata file +- tzdata: update 2021d to 2021d +- uninative: Add version to uninative tarball name +- waffle: convert to git, website is down +- wayland: Fix wayland-tools packaging +- wireless-regdb: upgrade 2021.07.14 -> 2021.08.28 +- wpa-supplicant: Match package override to :term:`PACKAGES` for pkg_postinst + +Contributors to 3.4.1 +~~~~~~~~~~~~~~~~~~~~~ + +- Ahmed Hossam +- Alexander Kanavin +- Alexandre Belloni +- Andrej Valek +- Andres Beltran +- Anuj Mittal +- Bruce Ashfield +- Chen Qi +- Claus Stovgaard +- Daiane Angolini +- Hsia-Jun(Randy) Li +- Jon Mason +- Jose Quaresma +- Joshua Watt +- Kai Kang +- Khem Raj +- Kiran Surendran +- Manuel Leonhardt +- Michael Opdenacker +- Oleksandr Kravchuk +- Pablo Saavedra +- Paul Eggleton +- Peter Kjellerstedt +- Quentin Schulz +- Ralph Siemsen +- Randy Li +- Richard Purdie +- Ross Burton +- Sakib Sajal +- Saul Wold +- Teoh Jay Shen +- Tim Orling +- Tom Hochstein +- Yureka + +Repositories / Downloads for 3.4.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`honister </poky/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.1 </poky/tag/?h=yocto-3.4.1>` +- Git Revision: :yocto_git:`b53230c08d9f02ecaf35b4f0b70512abbf10ae11 </poky/commit/?id=b53230c08d9f02ecaf35b4f0b70512abbf10ae11>` +- Release Artefact: poky-b53230c08d9f02ecaf35b4f0b70512abbf10ae11 +- sha: 57d49e2afafb555baf65643acf752464f0eb7842b964713a5de7530c392de159 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.1/poky-b53230c08d9f02ecaf35b4f0b70512abbf10ae11.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.1/poky-b53230c08d9f02ecaf35b4f0b70512abbf10ae11.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`honister </meta-mingw/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.1 </meta-mingw/tag/?h=yocto-3.4.1>` +- Git Revision: :yocto_git:`f5d761cbd5c957e4405c5d40b0c236d263c916a8 </meta-mingw/commit/?id=f5d761cbd5c957e4405c5d40b0c236d263c916a8>` +- Release Artefact: meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8 +- sha: d4305d638ef80948584526c8ca386a8cf77933dffb8a3b8da98d26a5c40fcc11 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.1/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.1/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`honister </meta-gplv2/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.1 </meta-gplv2/tag/?h=yocto-3.4.1>` +- Git Revision: :yocto_git:`f04e4369bf9dd3385165281b9fa2ed1043b0e400 </meta-gplv2/commit/?id=f04e4369bf9dd3385165281b9fa2ed1043b0e400>` +- Release Artefact: meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400 +- sha: ef8e2b1ec1fb43dbee4ff6990ac736315c7bc2d8c8e79249e1d337558657d3fe +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`1.52 </bitbake/log/?h=1.52>` +- Tag: :oe_git:`yocto-3.4.1 </bitbake/tag/?h=yocto-3.4.1>` +- Git Revision: :oe_git:`44a83b373e1fc34c93cd4a6c6cf8b73b230c1520 </bitbake/commit/?id=44a83b373e1fc34c93cd4a6c6cf8b73b230c1520>` +- Release Artefact: bitbake-44a83b373e1fc34c93cd4a6c6cf8b73b230c1520 +- sha: 03d50c1318d88d62eb01d359412ea5a8014ef506266629a2bd43ab3a2ef19430 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.1/bitbake-44a83b373e1fc34c93cd4a6c6cf8b73b230c1520.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.1/bitbake-44a83b373e1fc34c93cd4a6c6cf8b73b230c1520.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`honister </yocto-docs/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.1 </yocto-docs/tag/?h=yocto-3.4.1>` +- Git Revision: :yocto_git:`b250eda5a0beba8acc9641c55a5b0e30594b5178 </yocto-docs/commit/?b250eda5a0beba8acc9641c55a5b0e30594b5178>` diff --git a/documentation/migration-guides/release-notes-3.4.2.rst b/documentation/migration-guides/release-notes-3.4.2.rst new file mode 100644 index 0000000000..5ff42d3900 --- /dev/null +++ b/documentation/migration-guides/release-notes-3.4.2.rst @@ -0,0 +1,242 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 3.4.2 (honister) +---------------------------------- + +Security Fixes in 3.4.2 +~~~~~~~~~~~~~~~~~~~~~~~ + +- tiff: backport fix for :cve:`2022-22844` +- glibc : Fix :cve:`2021-3999` +- glibc : Fix :cve:`2021-3998` +- glibc : Fix :cve:`2022-23219` +- glibc : Fix :cve:`2022-23218` +- lighttpd: backport a fix for :cve:`2022-22707` +- speex: fix :cve:`2020-23903` +- linux-yocto/5.10: amdgpu: updates for :cve:`2021-42327` +- libsndfile1: fix :cve:`2021-4156` +- xserver-xorg: whitelist two CVEs +- grub2: fix :cve:`2021-3981` +- xserver-xorg: update :term:`CVE_PRODUCT` +- binutils: :cve:`2021-42574` +- gcc: Fix :cve:`2021-42574` +- gcc: Fix :cve:`2021-35465` +- cve-extra-exclusions: add db CVEs to exclusion list +- gcc: Add :cve:`2021-37322` to the list of CVEs to ignore +- bind: fix :cve:`2021-25219` +- openssh: fix :cve:`2021-41617` +- ncurses: fix :cve:`2021-39537` +- vim: fix :cve:`2021-3968` and :cve:`2021-3973` +- vim: fix :cve:`2021-3927` and :cve:`2021-3928` +- gmp: fix :cve:`2021-43618` + +Fixes in 3.4.2 +~~~~~~~~~~~~~~ + +- build-appliance-image: Update to honister head revision +- poky.conf: bump version for 3.4.2 release +- libxml2: Backport python3-lxml workaround patch +- core-image-sato-sdk: allocate more memory when in qemu +- vim: upgrade to patch 4269 +- vim: update to include latest CVE fixes +- expat: upgrade to 2.4.4 +- libusb1: correct :term:`SRC_URI` +- yocto-check-layer: add debug output for the layers that were found +- linux-firmware: Add CLM blob to linux-firmware-bcm4373 package +- linux-yocto/5.10: update to v5.10.93 +- icu: fix make_icudata dependencies +- sstate: Improve failure to obtain archive message/handling +- insane.bbclass: Correct package_qa_check_empty_dirs() +- sstate: A third fix for for touching files inside pseudo +- kernel: introduce python3-dtschema-wrapper +- vim: upgrade to 8.2 patch 3752 +- bootchart2: Add missing python3-math dependency +- socat: update :term:`SRC_URI` +- pigz: fix one failure of command "unpigz -l" +- linux-yocto/5.14: update genericx86* machines to v5.14.21 +- linux-yocto/5.10: update genericx86* machines to v5.10.87 +- go: upgrade 1.16.10 -> 1.16.13 +- linux-yocto/5.10/cfg: add kcov feature fragment +- linux-yocto/5.14: fix arm 32bit -rt warnings +- oeqa/sstate: Fix allarch samesigs test +- rootfs-postcommands.bbclass: Make two comments use the new variable syntax +- cve-check: add lockfile to task +- lib/oe/reproducible: correctly set .git location when recursively looking for git repos +- epiphany: Update 40.3 -> 40.6 +- scripts/buildhistory-diff: drop use of distutils +- scripts: Update to use exec_module() instead of load_module() +- vulkan-loader: inherit pkgconfig +- webkitgtk: Add reproducibility fix +- openssl: Add reproducibility fix +- rpm: remove tmp folder created during install +- package_manager: ipk: Fix host manifest generation +- bitbake: utils: Update to use exec_module() instead of load_module() +- linux-yocto: add libmpc-native to :term:`DEPENDS` +- ref-manual: fix patch documentation +- bitbake: tests/fetch: Drop gnu urls from wget connectivity test +- bitbake: fetch: npm: Use temporary file for empty user config +- bitbake: fetch: npm: Quote destdir in run chmod command +- bitbake: process: Do not mix stderr with stdout +- xserver-xorg: upgrade 1.20.13 -> 1.20.14 +- python3-pyelftools: Depend on debugger, pprint +- linux-firmware: upgrade 20211027 -> 20211216 +- oeqa/selftest/bbtests: Use YP sources mirror instead of GNU +- systemd: Fix systemd-journal-gateway user/groups +- license.bbclass: implement ast.NodeVisitor.visit_Constant +- oe/license: implement ast.NodeVisitor.visit_Constant +- packagedata.py: silence a DeprecationWarning +- uboot-sign: fix the concatenation when multiple U-BOOT configurations are specified +- runqemu: check the qemu PID has been set before kill()ing it +- selftest/devtool: Check branch in git fetch +- recipetool: Set master branch only as fallback +- kern-tools: bug fixes and kgit-gconfig +- linux-yocto-rt/5.10: update to -rt56 +- linux-yocto/5.14: update to v5.14.21 +- python3: upgrade 3.9.7 -> 3.9.9 +- bitbake: lib/pyinotify.py: Remove deprecated module asyncore +- updates for recent releases +- libdrm: upgrade 2.4.108 -> 2.4.109 +- patch.py: Initialize git repo before patching +- boost: Fix build on arches with no atomics +- boost: allow searching for python310 +- recipetool: extend curl detection when creating recipes +- recipetool: handle GitLab URLs like we do GitHub +- README.OE-Core.md: update URLs +- libtool: change the default AR_FLAGS from "cru" to "cr" +- libtool: Update patchset to match those submitted upstream +- scripts/checklayer/common.py: Fixed a minor grammatical error +- oeqa/parselogs: Fix quoting +- oeqa/utils/dump: Fix typo +- systemd: update 249.6 -> 249.7 +- glibc: Fix i586/c3 support +- wic: support rootdev identified by partition label +- buildhistory: Fix srcrevs output +- classes/crate-fetch: Ensure crate fetcher is available +- rootfs-postcommands: update systemd_create_users +- classes/meson: Add optional rust definitions +- rust-cross: Replace :term:`TARGET_ARCH` with :term:`TUNE_PKGARCH` +- maintainers.inc: fix up rust-cross entry +- rust-cross: Fix directory not deleted for race glibc vs. musl +- wic: use shutil.which +- bitbake: data_smart.py: Skip old override syntax checking for anonymous functions +- documentation: conf.py: fix version of bitbake objects.inv +- updates for release 3.3.4 + +Contributors to 3.4.2 +~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Alexandre Belloni +- Anton Mikanovich +- Anuj Mittal +- Bruce Ashfield +- Carlos Rafael Giani +- Chaitanya Vadrevu +- Changqing Li +- Dhruva Gole +- Florian Amstutz +- Joshua Watt +- Kai Kang +- Khairul Rohaizzat Jamaluddin +- Khem Raj +- Konrad Weihmann +- Kory Maincent +- Li Wang +- Marek Vasut +- Markus Volk +- Martin Jansa +- Max Krummenacher +- Michael Opdenacker +- Mingli Yu +- Oleksiy Obitotskyy +- Pavel Zhukov +- Peter Kjellerstedt +- Pgowda +- Quentin Schulz +- Richard Purdie +- Robert Yang +- Ross Burton +- Rudolf J Streif +- Sakib Sajal +- Samuli Piippo +- Schmidt, Adriaan +- Stefan Herbrechtsmeier +- Steve Sakoman +- Sundeep KOKKONDA +- Teoh Jay Shen +- Thomas Perrot +- Tim Orling +- Vyacheslav Yurkov +- Yongxin Liu +- pgowda +- Wang Mingyu + +Repositories / Downloads for 3.4.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`honister </poky/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.2 </poky/tag/?h=yocto-3.4.2>` +- Git Revision: :yocto_git:`e0ab08bb6a32916b457d221021e7f402ffa36b1a </poky/commit/?id=e0ab08bb6a32916b457d221021e7f402ffa36b1a>` +- Release Artefact: poky-e0ab08bb6a32916b457d221021e7f402ffa36b1a +- sha: 8580dc5067ee426fe347a0d0f7a74c29ba539120bbe8438332339a9c8bce00fd +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.2/poky-e0ab08bb6a32916b457d221021e7f402ffa36b1a.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.2/poky-e0ab08bb6a32916b457d221021e7f402ffa36b1a.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`honister </openembedded-core/log/?h=honister>` +- Tag: :oe_git:`yocto-3.4.2 </openembedded-core/tag/?h=yocto-3.4.2>` +- Git Revision: :oe_git:`418a9c4c31615a9e3e011fc2b21fb7154bc6c93a </openembedded-core/commit/?id=418a9c4c31615a9e3e011fc2b21fb7154bc6c93a>` +- Release Artefact: oecore-418a9c4c31615a9e3e011fc2b21fb7154bc6c93a +- sha: f2ca94a5a7ec669d4c208d1729930dfc1b917846dbb2393d01d6d5856fcbc6de +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.2/oecore-418a9c4c31615a9e3e011fc2b21fb7154bc6c93a.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.2/oecore-418a9c4c31615a9e3e011fc2b21fb7154bc6c93a.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`meta-mingw` +- Branch: :yocto_git:`honister </meta-mingw/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.2 </meta-mingw/tag/?h=yocto-3.4.2>` +- Git Revision: :yocto_git:`f5d761cbd5c957e4405c5d40b0c236d263c916a8 </meta-mingw/commit/?id=f5d761cbd5c957e4405c5d40b0c236d263c916a8>` +- Release Artefact: meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8 +- sha: d4305d638ef80948584526c8ca386a8cf77933dffb8a3b8da98d26a5c40fcc11 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.2/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.2/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`honister </meta-gplv2/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.2 </meta-gplv2/tag/?h=yocto-3.4.2>` +- Git Revision: :yocto_git:`f04e4369bf9dd3385165281b9fa2ed1043b0e400 </meta-gplv2/commit/?id=f04e4369bf9dd3385165281b9fa2ed1043b0e400>` +- Release Artefact: meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400 +- sha: ef8e2b1ec1fb43dbee4ff6990ac736315c7bc2d8c8e79249e1d337558657d3fe +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.2/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.2/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`1.52 </bitbake/log/?h=1.52>` +- Tag: :oe_git:`yocto-3.4.2 </bitbake/tag/?h=yocto-3.4.2>` +- Git Revision: :oe_git:`c039182c79e2ccc54fff5d7f4f266340014ca6e0 </bitbake/commit/?id=c039182c79e2ccc54fff5d7f4f266340014ca6e0>` +- Release Artefact: bitbake-c039182c79e2ccc54fff5d7f4f266340014ca6e0 +- sha: bd80297f8d8aa40cbcc8a3d4e23a5223454b305350adf34cd29b5fb65c1b4c52 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.2/bitbake-c039182c79e2ccc54fff5d7f4f266340014ca6e0.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.2/bitbake-c039182c79e2ccc54fff5d7f4f266340014ca6e0.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`honister </yocto-docs/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.2 </yocto-docs/tag/?h=yocto-3.4.2>` +- Git Revision: :yocto_git:`3061d3d62054a5c3b9e16bfce4bcd186fa7a23d2` </yocto-docs/commit/?3061d3d62054a5c3b9e16bfce4bcd186fa7a23d2>` diff --git a/documentation/migration-guides/release-notes-3.4.3.rst b/documentation/migration-guides/release-notes-3.4.3.rst new file mode 100644 index 0000000000..2af802307d --- /dev/null +++ b/documentation/migration-guides/release-notes-3.4.3.rst @@ -0,0 +1,199 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 3.4.3 (honister) +---------------------------------- + +Security Fixes in 3.4.3 +~~~~~~~~~~~~~~~~~~~~~~~ + +- ghostscript: fix :cve:`2021-3781` +- ghostscript: fix :cve:`2021-45949` +- tiff: Add backports for two CVEs from upstream (:cve:`2022-0561` & :cve:`2022-0562`) +- gcc : Fix :cve:`2021-46195` +- virglrenderer: fix `CVE-2022-0135 <https://security-tracker.debian.org/tracker/CVE-2022-0135>`__ and `CVE-2022-0175 <https://security-tracker.debian.org/tracker/CVE-2022-0175>`__ +- binutils: Add fix for :cve:`2021-45078` + + +Fixes in 3.4.3 +~~~~~~~~~~~~~~ + +- Revert "cve-check: add lockfile to task" +- asciidoc: update git repository +- bitbake: build: Tweak exception handling for setscene tasks +- bitbake: contrib: Fix hash server Dockerfile dependencies +- bitbake: cooker: Improve parsing failure from handled exception usability +- bitbake: data_smart: Fix overrides file/line message additions +- bitbake: fetch2: ssh: username and password are optional +- bitbake: tests/fetch: Handle upstream master -> main branch change +- bitbake: utils: Ensure shell function failure in python logging is correct +- build-appliance-image: Update to honister head revision +- build-appliance-image: Update to honister head revision +- coreutils: remove obsolete ignored CVE list +- crate-fetch: fix setscene failures +- cups: Add --with-dbusdir to :term:`EXTRA_OECONF` for deterministic build +- cve-check: create directory of CVE_CHECK_MANIFEST before copy +- cve-check: get_cve_info should open the database read-only +- default-distrovars.inc: Switch connectivity check to a yoctoproject.org page +- depmodwrapper-cross: add config directory option +- devtool: deploy-target: Remove stripped binaries in pseudo context +- devtool: explicitly set main or master branches in upgrades when available +- docs: fix hardcoded link warning messages +- documentation: conf.py: update for 3.4.2 +- documentation: prepare for 3.4.3 release +- expat: Upgrade to 2.4.7 +- gcc-target: fix glob to remove gcc-<version> binary +- gcsections: add nativesdk-cairo to exclude list +- go: update to 1.16.15 +- gst-devtools: 1.18.5 -> 1.18.6 +- gst-examples: 1.18.5 -> 1.18.6 +- gstreamer1.0-libav: 1.18.5 -> 1.18.6 +- gstreamer1.0-omx: 1.18.5 -> 1.18.6 +- gstreamer1.0-plugins-bad: 1.18.5 -> 1.18.6 +- gstreamer1.0-plugins-base: 1.18.5 -> 1.18.6 +- gstreamer1.0-plugins-good: 1.18.5 -> 1.18.6 +- gstreamer1.0-plugins-ugly: 1.18.5 -> 1.18.6 +- gstreamer1.0-python: 1.18.5 -> 1.18.6 +- gstreamer1.0-rtsp-server: 1.18.5 -> 1.18.6 +- gstreamer1.0-vaapi: 1.18.5 -> 1.18.6 +- gstreamer1.0: 1.18.5 -> 1.18.6 +- harfbuzz: upgrade 2.9.0 -> 2.9.1 +- initramfs-framework: unmount automounts before switch_root +- kernel-devsrc: do not copy Module.symvers file during install +- libarchive : update to 3.5.3 +- libpcap: Disable DPDK explicitly +- libxml-parser-perl: Add missing :term:`RDEPENDS` +- linux-firmware: upgrade 20211216 -> 20220209 +- linux-yocto/5.10: Fix ramoops/ftrace +- linux-yocto/5.10: features/zram: remove CONFIG_ZRAM_DEF_COMP +- linux-yocto/5.10: fix dssall build error with binutils 2.3.8 +- linux-yocto/5.10: ppc/riscv: fix build with binutils 2.3.8 +- linux-yocto/5.10: update genericx86* machines to v5.10.99 +- linux-yocto/5.10: update to v5.10.103 +- mc: fix build if ncurses have been configured without wide characters +- oeqa/buildtools: Switch to our webserver instead of example.com +- patch.py: Prevent git repo reinitialization +- perl: Improve and update module RPDEPENDS +- poky.conf: bump version for 3.4.3 honister release +- qemuboot: Fix build error if UNINATIVE_LOADER is unset +- quilt: Disable external sendmail for deterministic build +- recipetool: Fix circular reference in :term:`SRC_URI` +- releases: update to include 3.3.5 +- releases: update to include 3.4.2 +- rootfs-postcommands: amend systemd_create_users add user to group check +- ruby: update 3.0.2 -> 3.0.3 +- scripts/runqemu-ifdown: Don't treat the last iptables command as special +- sdk: fix search for dynamic loader +- selftest: recipetool: Correct the URI for socat +- sstate: inside the threadedpool don't write to the shared localdata +- uninative: Upgrade to 3.5 +- util-linux: upgrade to 2.37.4 +- vim: Update to 8.2.4524 for further CVE fixes +- wic: Use custom kernel path if provided +- wireless-regdb: upgrade 2021.08.28 -> 2022.02.18 +- zip: modify when match.S is built + +Contributors to 3.4.3 +~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Anuj Mittal +- Bill Pittman +- Bruce Ashfield +- Chee Yang Lee +- Christian Eggers +- Daniel Gomez +- Daniel Müller +- Daniel Wagenknecht +- Florian Amstutz +- Joe Slater +- Jose Quaresma +- Justin Bronder +- Lee Chee Yang +- Michael Halstead +- Michael Opdenacker +- Oleksandr Ocheretnyi +- Oleksandr Suvorov +- Pavel Zhukov +- Peter Kjellerstedt +- Richard Purdie +- Robert Yang +- Ross Burton +- Sakib Sajal +- Saul Wold +- Sean Anderson +- Stefan Herbrechtsmeier +- Tamizharasan Kumar +- Tean Cunningham +- Zoltán Böszörményi +- pgowda +- Wang Mingyu + +Repositories / Downloads for 3.4.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`honister </poky/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.3 </poky/tag/?h=yocto-3.4.3>` +- Git Revision: :yocto_git:`ee68ae307fd951b9de6b31dc6713ea29186b7749 </poky/commit/?id=ee68ae307fd951b9de6b31dc6713ea29186b7749>` +- Release Artefact: poky-ee68ae307fd951b9de6b31dc6713ea29186b7749 +- sha: 92c3d73c3e74f0e1d5c2ab2836ce3a3accbe47772cea70df3755845e0db1379b +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.3/poky-ee68ae307fd951b9de6b31dc6713ea29186b7749.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.3/poky-ee68ae307fd951b9de6b31dc6713ea29186b7749.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`honister </openembedded-core/log/?h=honister>` +- Tag: :oe_git:`yocto-3.4.3 </openembedded-core/tag/?h=yocto-3.4.3>` +- Git Revision: :oe_git:`ebca8f3ac9372b7ebb3d39e8f7f930b63b481448 </openembedded-core/commit/?id=ebca8f3ac9372b7ebb3d39e8f7f930b63b481448>` +- Release Artefact: oecore-ebca8f3ac9372b7ebb3d39e8f7f930b63b481448 +- sha: f28e503f6f6c0bcd9192dbd528f8e3c7bcea504c089117e0094d9a4f315f4b9f +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.3/oecore-ebca8f3ac9372b7ebb3d39e8f7f930b63b481448.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.3/oecore-ebca8f3ac9372b7ebb3d39e8f7f930b63b481448.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`honister </meta-mingw/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.3 </meta-mingw/tag/?h=yocto-3.4.3>` +- Git Revision: :yocto_git:`f5d761cbd5c957e4405c5d40b0c236d263c916a8 </meta-mingw/commit/?id=f5d761cbd5c957e4405c5d40b0c236d263c916a8>` +- Release Artefact: meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8 +- sha: d4305d638ef80948584526c8ca386a8cf77933dffb8a3b8da98d26a5c40fcc11 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.3/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.3/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`honister </meta-gplv2/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.3 </meta-gplv2/tag/?h=yocto-3.4.3>` +- Git Revision: :yocto_git:`f04e4369bf9dd3385165281b9fa2ed1043b0e400 </meta-gplv2/commit/?id=f04e4369bf9dd3385165281b9fa2ed1043b0e400>` +- Release Artefact: meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400 +- sha: ef8e2b1ec1fb43dbee4ff6990ac736315c7bc2d8c8e79249e1d337558657d3fe +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.3/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.3/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`1.52 </bitbake/log/?h=1.52>` +- Tag: :oe_git:`yocto-3.4.3 </bitbake/tag/?h=yocto-3.4.3>` +- Git Revision: :oe_git:`43dcb2b2a2b95a5c959be57bca94fb7190ea6257 </bitbake/commit/?id=43dcb2b2a2b95a5c959be57bca94fb7190ea6257>` +- Release Artefact: bitbake-43dcb2b2a2b95a5c959be57bca94fb7190ea6257 +- sha: 92497ff97fed81dcc6d3e202969fb63ca983a8f5d9d91cafc6aee88312f79cf9 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.3/bitbake-43dcb2b2a2b95a5c959be57bca94fb7190ea6257.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.3/bitbake-43dcb2b2a2b95a5c959be57bca94fb7190ea6257.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`honister </yocto-docs/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.3 </yocto-docs/tag/?h=yocto-3.4.3>` +- Git Revision: :yocto_git:`15f46f97d9cad558c19fc1dc19cfbe3720271d04 </yocto-docs/commit/?15f46f97d9cad558c19fc1dc19cfbe3720271d04>` diff --git a/documentation/migration-guides/release-notes-3.4.4.rst b/documentation/migration-guides/release-notes-3.4.4.rst new file mode 100644 index 0000000000..0bf9a16209 --- /dev/null +++ b/documentation/migration-guides/release-notes-3.4.4.rst @@ -0,0 +1,157 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 3.4.4 (honister) +---------------------------------- + +Security Fixes in 3.4.4 +~~~~~~~~~~~~~~~~~~~~~~~ + +- tiff: fix :cve:`2022-0865`, :cve:`2022-0891`, :cve:`2022-0907`, :cve:`2022-0908`, :cve:`2022-0909` and :cve:`2022-0924` +- xz: fix `CVE-2022-1271 <https://security-tracker.debian.org/tracker/CVE-2022-1271>`__ +- unzip: fix `CVE-2021-4217 <https://security-tracker.debian.org/tracker/CVE-2021-4217>`__ +- zlib: fix :cve:`2018-25032` +- grub: ignore :cve:`2021-46705` + +Fixes in 3.4.4 +~~~~~~~~~~~~~~ + +- alsa-tools: Ensure we install correctly +- bitbake.conf: mark all directories as safe for git to read +- bitbake: knotty: display active tasks when printing keepAlive() message +- bitbake: knotty: reduce keep-alive timeout from 5000s (83 minutes) to 10 minutes +- bitbake: server/process: Disable gc around critical section +- bitbake: server/xmlrpcserver: Add missing xmlrpcclient import +- bitbake: toaster: Fix :term:`IMAGE_INSTALL` issues with _append vs :append +- bitbake: toaster: fixtures replace gatesgarth +- build-appliance-image: Update to honister head revision +- conf.py/poky.yaml: Move version information to poky.yaml and read in conf.py +- conf/machine: fix QEMU x86 sound options +- devupstream: fix handling of :term:`SRC_URI` +- documentation: update for 3.4.4 release +- externalsrc/devtool: Fix to work with fixed export funcition flags handling +- gmp: add missing COPYINGv3 +- gnu-config: update :term:`SRC_URI` +- libxml2: fix CVE-2022-23308 regression +- libxml2: move to gitlab.gnome.org +- libxml2: update to 2.9.13 +- libxshmfence: Correct :term:`LICENSE` to HPND +- license_image.bbclass: close package.manifest file +- linux-firmware: correct license for ar3k firmware +- linux-firmware: upgrade 20220310 -> 20220411 +- linux-yocto-rt/5.10: update to -rt61 +- linux-yocto/5.10: cfg/debug: add configs for kcsan +- linux-yocto/5.10: split vtpm for more granular inclusion +- linux-yocto/5.10: update to v5.10.109 +- linux-yocto: nohz_full boot arg fix +- oe-pkgdata-util: Adapt to the new variable override syntax +- oeqa/selftest/devtool: ensure Git username is set before upgrade tests +- poky.conf: bump version for 3.4.4 release +- pseudo: Add patch to workaround paths with crazy lengths +- pseudo: Fix handling of absolute links +- sanity: Add warning for local hasheqiv server with remote sstate mirrors +- scripts/runqemu: Fix memory limits for qemux86-64 +- shadow-native: Simplify and fix syslog disable patch +- tiff: Add marker for CVE-2022-1056 being fixed +- toaster: Fix broken overrides usage +- u-boot: Inherit pkgconfig +- uninative: Upgrade to 3.6 with gcc 12 support +- vim: Upgrade 8.2.4524 -> 8.2.4681 +- virglrenderer: update :term:`SRC_URI` +- webkitgtk: update to 2.32.4 +- wireless-regdb: upgrade 2022.02.18 -> 2022.04.08 + +Known Issues +~~~~~~~~~~~~ + +There were a couple of known autobuilder intermittent bugs that occurred during release testing but these are not regressions in the release. + +Contributors to 3.4.4 +~~~~~~~~~~~~~~~~~~~~~ + +- Alexandre Belloni +- Anuj Mittal +- Bruce Ashfield +- Chee Yang Lee +- Dmitry Baryshkov +- Joe Slater +- Konrad Weihmann +- Martin Jansa +- Michael Opdenacker +- Minjae Kim +- Peter Kjellerstedt +- Ralph Siemsen +- Richard Purdie +- Ross Burton +- Tim Orling +- Wang Mingyu +- Zheng Ruoqin + +Repositories / Downloads for 3.4.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`honister </poky/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.4 </poky/tag/?h=yocto-3.4.4>` +- Git Revision: :yocto_git:`780eeec8851950ee6ac07a2a398ba937206bd2e4 </poky/commit/?id=780eeec8851950ee6ac07a2a398ba937206bd2e4>` +- Release Artefact: poky-780eeec8851950ee6ac07a2a398ba937206bd2e4 +- sha: 09558927064454ec2492da376156b716d9fd14aae57196435d742db7bfdb4b95 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.4/poky-780eeec8851950ee6ac07a2a398ba937206bd2e4.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.4/poky-780eeec8851950ee6ac07a2a398ba937206bd2e4.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`honister </openembedded-core/log/?h=honister>` +- Tag: :oe_git:`yocto-3.4.4 </openembedded-core/tag/?h=yocto-3.4.4>` +- Git Revision: :oe_git:`1a6f5e27249afb6fb4d47c523b62b5dd2482a69d </openembedded-core/commit/?id=1a6f5e27249afb6fb4d47c523b62b5dd2482a69d>` +- Release Artefact: oecore-1a6f5e27249afb6fb4d47c523b62b5dd2482a69d +- sha: b8354ca457756384139a579b9e51f1ba854013c99add90c0c4c6ef68421fede5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.4/oecore-1a6f5e27249afb6fb4d47c523b62b5dd2482a69d.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.4/oecore-1a6f5e27249afb6fb4d47c523b62b5dd2482a69d.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`honister </meta-mingw/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.4 </meta-mingw/tag/?h=yocto-3.4.4>` +- Git Revision: :yocto_git:`f5d761cbd5c957e4405c5d40b0c236d263c916a8 </meta-mingw/commit/?id=f5d761cbd5c957e4405c5d40b0c236d263c916a8>` +- Release Artefact: meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8 +- sha: d4305d638ef80948584526c8ca386a8cf77933dffb8a3b8da98d26a5c40fcc11 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.4/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.4/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`honister </meta-gplv2/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.4 </meta-gplv2/tag/?h=yocto-3.4.4>` +- Git Revision: :yocto_git:`f04e4369bf9dd3385165281b9fa2ed1043b0e400 </meta-gplv2/commit/?id=f04e4369bf9dd3385165281b9fa2ed1043b0e400>` +- Release Artefact: meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400 +- sha: ef8e2b1ec1fb43dbee4ff6990ac736315c7bc2d8c8e79249e1d337558657d3fe +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.4/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.4/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`1.52 </bitbake/log/?h=1.52>` +- Tag: :oe_git:`yocto-3.4.4 </bitbake/tag/?h=yocto-3.4.3>` +- Git Revision: :oe_git:`c2d8f9b2137bd4a98eb0f51519493131773e7517 </bitbake/commit/?id=c2d8f9b2137bd4a98eb0f51519493131773e7517>` +- Release Artefact: bitbake-c2d8f9b2137bd4a98eb0f51519493131773e7517 +- sha: a8b6217f2d63975bbf49f430e11046608023ee2827faa893b15d9a0d702cf833 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4.4/bitbake-c2d8f9b2137bd4a98eb0f51519493131773e7517.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4.4/bitbake-c2d8f9b2137bd4a98eb0f51519493131773e7517.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`honister </yocto-docs/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4.4 </yocto-docs/tag/?h=yocto-3.4.4>` +- Git Revision: :yocto_git:`5ead7d39aaf9044078dff27f462e29a8e31d89e4 </yocto-docs/commit/?5ead7d39aaf9044078dff27f462e29a8e31d89e4>` diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst new file mode 100644 index 0000000000..d76bb004b1 --- /dev/null +++ b/documentation/migration-guides/release-notes-3.4.rst @@ -0,0 +1,804 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 3.4 (honister) +-------------------------------- + +New Features / Enhancements in 3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades +- Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help +- Rust integrated into core, providing rust support for cross-compilation and SDK +- New :ref:`ref-classes-create-spdx` class for creating SPDX SBoM documents +- New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland +- Several optimisations to reduce unnecessary task dependencies for faster builds +- seccomp integrated into core, with additional enabling for gnutls, systemd, qemu +- New overlayfs class to help generate overlayfs mount units +- debuginfod support now enabled by default +- Switched several recipes over to using OpenSSL instead of GnuTLS (wpa-supplicant, curl, glib-networking) or disable GnuTLS (cups) by default +- Improvements to LTO plugin installation and reproducibility +- Architecture-specific enhancements: + + - glibc: Enable memory tagging for aarch64 + - testimage: remove aarch64 xorg exclusion + - arch-arm*: add better support for gcc march extensions + - tune-cortexm*: add support for all Arm Cortex-M processors + - tune-cortexr*: add support for all Arm Cortex-R processors + - arch-armv4: Allow -march=armv4 + - qemuarm*: use virtio graphics + - baremetal-helloworld: Enable RISC-V 64/32 port + - ldconfig-native: Add RISC-V support + - qemuriscv: Enable 4 core emulation + - Add ARC support in gdb, dpkg, dhcpcd + - conf/machine-sdk: Add ppc64 SDK machine + - libjpeg-turbo: Handle powerpc64le without Altivec + - pixman: Handle PowerPC without Altivec + - mesa: enable gallium Intel drivers when building for x86 + - mesa: enable crocus driver for older Intel graphics + +- Kernel-related enhancements: + + - Support zstd-compressed modules and :term:`Initramfs` images + - Allow opt-out of split kernel modules + - linux-yocto-dev: base :term:`AUTOREV` on specified version + - kernel-yocto: provide debug / summary information for metadata + - kernel-uboot: Handle gzip and lzo compression options + - linux-yocto/5.14: added devupstream support + - linux-yocto: add vfat to :term:`KERNEL_FEATURES` when :term:`MACHINE_FEATURES` include vfat + - linux-yocto: enable TYPEC_TCPCI in usbc fragment + +- Image-related enhancements: + + - New erofs, erofs-lz4 and erofs-lz4hc image types + - New squashfs-zst and cpio.zst image types + - New lic-pkgs :term:`IMAGE_FEATURES` item to install all license packages + - Added zsync metadata conversion support + - Use xargs to set file timestamps for significant (>90%) do_image speedup + - Find .ko.gz and .ko.xz kernel modules as well when determining need to run depmod on an image + - Show formatted error messages instead of tracebacks for systemctl errors + - No longer ignore installation failures in complementary package installation + - Remove ldconfig auxiliary cache when not needed + +- wic enhancements: + + - Added erofs filesystem support + - Added ``--extra-space argument`` to leave extra space after last partition + - Added ``--no-fstab-update`` part option to allow using the stock fstab + - bootimg-efi: added Unified Kernel Image option + - bootimg-pcbios: use label provided when formatting a DOS partition + +- SDK-related enhancements: + + - Enable :ref:`ref-tasks-populate_sdk` with multilibs + - New ``SDKPATHINSTALL`` variable decouples default install path from + built in path to avoid rebuilding :ref:`ref-classes-nativesdk` + components on e.g. :term:`DISTRO_VERSION` changes + - eSDK: Error if trying to generate an eSDK from a multiconfig + - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK + +- BitBake enhancements: + + - New bitbake-getvar helper command to query a variable value (with history) + - bitbake-layers: layerindex-fetch: add ``--fetchdir`` parameter + - bitbake-layers: show-recipes: add skip reason to output + - bitbake-diffsigs: sort diff output for consistency + - Allow setting upstream for local hash equivalence server + - fetch2/s3: allow to use credentials and switch profile from environment variables + - fetch2/s3: Add progress handler for S3 cp command + - fetch2/npm: Support npm archives with missing search directory mode + - fetch2/npmsw: Add support for local tarball and link sources + - fetch2/svn: Allow peg-revision functionality to be disabled + - fetch2/wget: verify certificates for HTTPS/FTPS by default + - fetch2/wget: Enable FTPS + - prserv: added read-only mode + - prserv: replaced XML RPC with modern asyncrpc implementation + - Numerous warning/error message improvements + +- New :term:`PACKAGECONFIG` options in btrfs-tools, ccache, coreutils, cups, dbus, elfutils, ffmpeg, findutils, glib-2.0, gstreamer1.0-plugins-bad, gstreamer1.0-plugins-base, libarchive, libnotify, libpsl, man-db, mesa, ovmf, parted, prelink, qemu, rpm, shadow, systemd, tar, vim, weston +- u-boot enhancements: + + - Make SPL suffix configurable + - Make ``UBOOT_BINARYNAME`` configurable + - Package ``extlinux.conf`` separately + - Allow deploying the u-boot DTB + +- opensbi: Add support for specifying a device tree +- busybox enhancements: + + - Added tmpdir option into mktemp applet + - Support mounting swap via labels + - Enable long options for enabled applets + +- Move tune files to architecture subdirectories +- buildstats: log host data on failure separately to task specific file +- buildstats: collect "at interval" and "on failure" logs in the same file +- Ptest enhancements: + + - ptest-runner: install script to collect system data on failure + - Added ptest support to python3-hypothesis, python3-jinja2, python3-markupsafe + - Enhanced ptest support in lttng, util-linux, and others + - New leaner ptest image recipes based upon core-image-minimal + +- scripts/contrib/image-manifest: add new script +- Add beginnings of Android target support +- devtool upgrade: rebase override-only patches as well +- devtool: print a warning on upgrades if :term:`PREFERRED_VERSION` is set +- systemd: set zstd as default compression option +- init-manager-systemd: add a weak VIRTUAL-RUNTIME_dev_manager assignment +- Add proper unpack dependency for .zst compressed archives +- util-linux: build chfn and chsh by default +- qemu: use 4 cores in qemu guests +- runqemu: decouple bios and kernel options +- qemu: add a hint on how to enable CPU render nodes when a suitable GPU is absent +- devupstream: Allow support of native class extensions +- Prelinking now disabled in default configuration +- python3: statistics module moved to its own python3-statistics package +- pypi: allow override of PyPI archive name +- Allow global override of golang GO_DYNLINK +- buildhistory enhancements: + + - Add option to strip path prefix + - Add output file listing package information + - Label packages providing per-file dependencies in depends.dot + +- New gi-docgen class for GNOME library documentation +- meson.bbclass: Make the default buildtype "debug" if :term:`DEBUG_BUILD` is 1 +- distro_features_check: expand with :term:`IMAGE_FEATURES` +- Add extended packagedata in JSON format +- local.conf.sample: Update sstate mirror entry with new hash equivalence setting +- poky: Use https in default :term:`PREMIRRORS` +- reproducible_build.bbclass: Enable -Wdate-time +- yocto-check-layer: ensure that all layer dependencies are tested too +- core-image-multilib-example: base on weston, and not sato +- npm.bbclass: Allow nodedir to be overridden by ``NPM_NODEDIR`` +- cve-extra-exclusions.inc: add exclusion list for intractable CVE's +- license_image.bbclass: Detect broken symlinks +- sysstat: make the service start automatically +- sanity: Add error check for '%' in build path +- sanity: Further improve directory sanity tests +- sanity.bbclass: mention ``CONNECTIVITY_CHECK_URIS`` in network failure message +- tzdata: Allow controlling zoneinfo binary format +- oe-time-dd-test.sh: add options and refactor +- vim: add option to disable NLS support +- zstd: Include pzstd in the build +- mirrors.bbclass: provide additional rule for git repo fallbacks +- own-mirrors: Add support for s3:// scheme in :term:`SOURCE_MIRROR_URL` +- common-licenses: add missing SPDX licences +- Add MAINTAINERS.md file to record subsystem maintainers + +Known Issues in 3.4 +~~~~~~~~~~~~~~~~~~~ + +- Build failures have been reported when running on host Linux systems with FIPS enabled (such as RHEL 8.0 with the FIPS mode enabled). For more details please see :yocto_bugs:`bug #14609 </show_bug.cgi?id=14609>`. + +Recipe Licenses changes in 3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +- acpica: correct :term:`LICENSE` to "Intel | BSD-3-Clause | GPLv2" +- dtc: correct :term:`LICENSE` to "GPLv2 | BSD-2-Clause" +- e2fsprogs: correct :term:`LICENSE` to "GPLv2 & LGPLv2 & BSD-3-Clause & MIT" +- ffmpeg: correct :term:`LICENSE` to "GPLv2+ & LGPLv2.1+ & ISC & MIT & BSD-2-Clause & BSD-3-Clause & IJG" +- flac: correct :term:`LICENSE` to "GFDL-1.2 & GPLv2+ & LGPLv2.1+ & BSD-3-Clause" +- flex: correct :term:`LICENSE` to "BSD-3-Clause & LGPL-2.0+" +- font-util: correct :term:`LICENSE` to "MIT & MIT-style & BSD-4-Clause & BSD-2-Clause" +- glib-2.0: correct :term:`LICENSE` to "LGPLv2.1+ & BSD-3-Clause & PD" +- gobject-introspection: correct :term:`LICENSE` to "LGPLv2+ & GPLv2+ & MIT" (add MIT license) +- hdparm: correct :term:`LICENSE` to "BSD-2-Clause & GPLv2 & hdparm" +- iputils: correct :term:`LICENSE` to "BSD-3-Clause & GPLv2+" +- libcap: correct :term:`LICENSE` to "BSD-3-Clause | GPLv2" +- libevent: correct :term:`LICENSE` to "BSD-3-Clause & MIT" +- libjitterentropy: correct :term:`LICENSE` to "GPLv2+ | BSD-3-Clause" +- libpam: correct :term:`LICENSE` to "GPLv2+ | BSD-3-Clause" +- libwpe: correct :term:`LICENSE` to "BSD-2-Clause" +- libx11-compose-data: correct :term:`LICENSE` to "MIT & MIT-style & BSD-4-Clause & BSD-2-Clause" +- libx11: correct :term:`LICENSE` to "MIT & MIT-style & BSD-4-Clause & BSD-2-Clause" +- libxfont2: correct :term:`LICENSE` to "MIT & MIT-style & BSD-4-Clause & BSD-2-Clause" +- libxfont: correct :term:`LICENSE` to "MIT & MIT-style & BSD-3-Clause" +- lsof: correct :term:`LICENSE` to reflect that it uses a BSD-like (but not exactly BSD) license ("Spencer-94") +- nfs-utils: correct :term:`LICENSE` to "MIT & GPLv2+ & BSD-3-Clause" +- ovmf: correct license to "BSD-2-Clause-Patent" +- ppp: correct :term:`LICENSE` to "BSD-3-Clause & BSD-3-Clause-Attribution & GPLv2+ & LGPLv2+ & PD" +- python3-packaging: correct :term:`LICENSE` to "Apache-2.0 | BSD-2-Clause" +- python-async-test: correct :term:`LICENSE` to "BSD-3-Clause" +- quota: remove BSD license (only BSD licensed part of the code was removed in 4.05) +- shadow: correct :term:`LICENSE` to "BSD-3-Clause | Artistic-1.0" +- shadow-sysroot: set :term:`LICENSE` the same as shadow +- sudo: correct :term:`LICENSE` to "ISC & BSD-3-Clause & BSD-2-Clause & Zlib" +- swig: correct :term:`LICENSE` to "BSD-3-Clause & GPLv3" +- valgrind: correct license to "GPLv2 & GPLv2+ & BSD-3-Clause" +- webkitgtk: correct :term:`LICENSE` to "BSD-2-Clause & LGPLv2+" +- wpebackend-fdo: correct :term:`LICENSE` to "BSD-2-Clause" +- xinetd: correct :term:`LICENSE` to reflect that it uses a unique BSD-like (but not exactly BSD) license + +Other license-related notes: + +- When creating recipes for Python software, recipetool will now treat "BSD" as "BSD-3-Clause" for the purposes of setting :term:`LICENSE`, as that is the most common understanding. +- Please be aware that an :term:`Initramfs` bundled with the kernel using :term:`INITRAMFS_IMAGE_BUNDLE` should only contain GPLv2-compatible software; this is now mentioned in the documentation. + +Security Fixes in 3.4 +~~~~~~~~~~~~~~~~~~~~~ + +- apr: :cve:`2021-35940` +- aspell: :cve:`2019-25051` +- avahi: :cve:`2021-3468`, :cve:`2021-36217` +- binutils: :cve:`2021-20197` +- bluez: :cve:`2021-3658` +- busybox: :cve:`2021-28831` +- cairo: :cve:`2020-35492` +- cpio: :cve:`2021-38185` +- expat: :cve:`2013-0340` +- ffmpeg: :cve:`2020-20446`, :cve:`2020-22015`, :cve:`2020-22021`, :cve:`2020-22033`, :cve:`2020-22019`, :cve:`2021-33815`, :cve:`2021-38171`, :cve:`2020-20453` +- glibc: :cve:`2021-33574`, :cve:`2021-38604` +- inetutils: :cve:`2021-40491` +- libgcrypt: :cve:`2021-40528` +- linux-yocto/5.10, 5.14: :cve:`2021-3653`, :cve:`2021-3656` +- lz4: :cve:`2021-3520` +- nettle: :cve:`2021-20305` +- openssl: :cve:`2021-3711`, :cve:`2021-3712` +- perl: :cve:`2021-36770` +- python3: :cve:`2021-29921` +- python3-pip: :cve:`2021-3572` +- qemu: :cve:`2020-27821`, :cve:`2020-29443`, :cve:`2020-35517`, :cve:`2021-3392`, :cve:`2021-3409`, :cve:`2021-3416`, :cve:`2021-3527`, :cve:`2021-3544`, :cve:`2021-3545`, :cve:`2021-3546`, :cve:`2021-3682`, :cve:`2021-20181`, :cve:`2021-20221`, :cve:`2021-20257`, :cve:`2021-20263` +- rpm: :cve:`2021-3421`, :cve:`2021-20271` +- rsync: :cve:`2020-14387` +- util-linux: :cve:`2021-37600` +- vim: :cve:`2021-3770`, :cve:`2021-3778` +- wpa-supplicant: :cve:`2021-30004` +- xdg-utils: :cve:`2020-27748` +- xserver-xorg: :cve:`2021-3472` + +Recipe Upgrades in 3.4 +~~~~~~~~~~~~~~~~~~~~~~ + +- acl 2.2.53 -> 2.3.1 +- acpica 20210105 -> 20210730 +- alsa-lib 1.2.4 -> 1.2.5.1 +- alsa-plugins 1.2.2 -> 1.2.5 +- alsa-tools 1.2.2 -> 1.2.5 +- alsa-topology-conf 1.2.4 -> 1.2.5.1 +- alsa-ucm-conf 1.2.4 -> 1.2.5.1 +- alsa-utils 1.2.4 -> 1.2.5.1 +- alsa-utils-scripts 1.2.4 -> 1.2.5.1 +- apt 2.2.2 -> 2.2.4 +- at 3.2.1 -> 3.2.2 +- at-spi2-core 2.38.0 -> 2.40.3 +- autoconf-archive 2019.01.06 -> 2021.02.19 +- babeltrace2 2.0.3 -> 2.0.4 +- bash 5.1 -> 5.1.8 +- bind 9.16.16 -> 9.16.20 +- binutils 2.36.1 -> 2.37 +- binutils-cross 2.36.1 -> 2.37 +- binutils-cross-canadian 2.36.1 -> 2.37 +- binutils-cross-testsuite 2.36.1 -> 2.37 +- binutils-crosssdk 2.36.1 -> 2.37 +- bison 3.7.5 -> 3.7.6 +- blktrace 1.2.0+gitX -> 1.3.0+gitX +- bluez5 5.56 -> 5.61 +- boost 1.75.0 -> 1.77.0 +- boost-build-native 4.3.0 -> 4.4.1 +- btrfs-tools 5.10.1 -> 5.13.1 +- busybox 1.33.1 -> 1.34.0 +- busybox-inittab 1.33.0 -> 1.34.0 +- ccache 4.2 -> 4.4 +- cmake 3.19.5 -> 3.21.1 +- cmake-native 3.19.5 -> 3.21.1 +- connman 1.39 -> 1.40 +- createrepo-c 0.17.0 -> 0.17.4 +- cronie 1.5.5 -> 1.5.7 +- cross-localedef-native 2.33 -> 2.34 +- cups 2.3.3 -> 2.3.3op2 +- curl 7.75.0 -> 7.78.0 +- dbus-glib 0.110 -> 0.112 +- dejagnu 1.6.2 -> 1.6.3 +- diffoscope 172 -> 181 +- diffutils 3.7 -> 3.8 +- distcc 3.3.5 -> 3.4 +- dnf 4.6.0 -> 4.8.0 +- dpkg 1.20.7.1 -> 1.20.9 +- dtc 1.6.0 -> 1.6.1 +- e2fsprogs 1.46.1 -> 1.46.4 +- elfutils 0.183 -> 0.185 +- ell 0.38 -> 0.43 +- enchant2 2.2.15 -> 2.3.1 +- epiphany 3.38.2 -> 40.3 +- ethtool 5.10 -> 5.13 +- expat 2.2.10 -> 2.4.1 +- ffmpeg 4.3.2 -> 4.4 +- file 5.39 -> 5.40 +- freetype 2.10.4 -> 2.11.0 +- gcc 10.2.0 -> 11.2.0 +- gcc-cross 10.2.0 -> 11.2.0 +- gcc-cross-canadian 10.2.0 -> 11.2.0 +- gcc-crosssdk 10.2.0 -> 11.2.0 +- gcc-runtime 10.2.0 -> 11.2.0 +- gcc-sanitizers 10.2.0 -> 11.2.0 +- gcc-source 10.2.0 -> 11.2.0 +- gcr 3.38.1 -> 3.40.0 +- gdb 10.1 -> 10.2 +- gdb-cross 10.1 -> 10.2 +- gdb-cross-canadian 10.1 -> 10.2 +- gdk-pixbuf 2.40.0 -> 2.42.6 +- ghostscript 9.53.3 -> 9.54.0 +- git 2.31.1 -> 2.33.0 +- glib-2.0 2.66.7 -> 2.68.4 +- glib-networking 2.66.0 -> 2.68.2 +- glibc 2.33 -> 2.34 +- glibc-locale 2.33 -> 2.34 +- glibc-mtrace 2.33 -> 2.34 +- glibc-scripts 2.33 -> 2.34 +- glibc-testsuite 2.33 -> 2.34 +- glslang 11.2.0 -> 11.5.0 +- gnome-desktop-testing 2018.1 -> 2021.1 +- gnu-config 20210125+gitX -> 20210722+gitX +- gnu-efi 3.0.12 -> 3.0.14 +- gnupg 2.2.27 -> 2.3.1 +- gobject-introspection 1.66.1 -> 1.68.0 +- gpgme 1.15.1 -> 1.16.0 +- gptfdisk 1.0.7 -> 1.0.8 +- grep 3.6 -> 3.7 +- grub 2.04+2.06~rc1 -> 2.06 +- grub-efi 2.04+2.06~rc1 -> 2.06 +- gsettings-desktop-schemas 3.38.0 -> 40.0 +- gtk+3 3.24.25 -> 3.24.30 +- harfbuzz 2.7.4 -> 2.9.0 +- hdparm 9.60 -> 9.62 +- help2man 1.48.2 -> 1.48.4 +- hwlatdetect 1.10 -> 2.1 +- i2c-tools 4.2 -> 4.3 +- icu 68.2 -> 69.1 +- igt-gpu-tools 1.25+gitX -> 1.26 +- inetutils 2.0 -> 2.1 +- iproute2 5.11.0 -> 5.13.0 +- iputils s20200821 -> 20210722 +- json-glib 1.6.2 -> 1.6.4 +- kexec-tools 2.0.21 -> 2.0.22 +- kmod 28 -> 29 +- kmod-native 28 -> 29 +- less 563 -> 590 +- libassuan 2.5.4 -> 2.5.5 +- libcap 2.48 -> 2.51 +- libcgroup 0.41 -> 2.0 +- libcomps 0.1.15 -> 0.1.17 +- libconvert-asn1-perl 0.27 -> 0.31 +- libdazzle 3.38.0 -> 3.40.0 +- libdnf 0.58.0 -> 0.63.1 +- libdrm 2.4.104 -> 2.4.107 +- libedit 20210216-3.1 -> 20210714-3.1 +- libepoxy 1.5.5 -> 1.5.9 +- liberation-fonts 2.00.1 -> 2.1.4 +- libffi 3.3 -> 3.4.2 +- libfm 1.3.1 -> 1.3.2 +- libgcc 10.2.0 -> 11.2.0 +- libgcc-initial 10.2.0 -> 11.2.0 +- libgcrypt 1.9.3 -> 1.9.4 +- libgfortran 10.2.0 -> 11.2.0 +- libgit2 1.1.0 -> 1.1.1 +- libglu 9.0.1 -> 9.0.2 +- libgpg-error 1.41 -> 1.42 +- libgudev 234 -> 237 +- libhandy 1.2.0 -> 1.2.3 +- libical 3.0.9 -> 3.0.10 +- libidn2 2.3.0 -> 2.3.2 +- libinput 1.16.4 -> 1.18.1 +- libjitterentropy 3.0.1 -> 3.1.0 +- libjpeg-turbo 2.0.6 -> 2.1.1 +- libksba 1.5.0 -> 1.6.0 +- libmodulemd 2.12.0 -> 2.13.0 +- libnsl2 1.3.0 -> 2.0.0 +- libnss-mdns 0.14.1 -> 0.15.1 +- libogg 1.3.4 -> 1.3.5 +- libpcap 1.10.0 -> 1.10.1 +- libpcre 8.44 -> 8.45 +- libpcre2 10.36 -> 10.37 +- libportal 0.3 -> 0.4 +- librepo 1.13.0 -> 1.14.1 +- libsdl2 2.0.14 -> 2.0.16 +- libsolv 0.7.17 -> 0.7.19 +- libtasn1 4.16.0 -> 4.17.0 +- libtest-needs-perl 0.002006 -> 0.002009 +- libtirpc 1.3.1 -> 1.3.2 +- libubootenv 0.3.1 -> 0.3.2 +- libucontext 0.10+X -> 1.1+X +- liburcu 0.12.2 -> 0.13.0 +- libuv 1.41.0 -> 1.42.0 +- libva 2.10.0 -> 2.12.0 +- libva-initial 2.10.0 -> 2.12.0 +- libva-utils 2.10.0 -> 2.12.0 +- libwebp 1.2.0 -> 1.2.1 +- libwpe 1.8.0 -> 1.10.1 +- libx11 1.7.0 -> 1.7.2 +- libxcrypt 4.4.18 -> 4.4.25 +- libxcrypt-compat 4.4.18 -> 4.4.25 +- libxfixes 5.0.3 -> 6.0.0 +- libxfont2 2.0.4 -> 2.0.5 +- libxft 2.3.3 -> 2.3.4 +- libxi 1.7.10 -> 1.7.99.2 +- libxkbcommon 1.0.3 -> 1.3.0 +- libxml2 2.9.10 -> 2.9.12 +- libxres 1.2.0 -> 1.2.1 +- linux-libc-headers 5.10 -> 5.14 +- linux-yocto 5.4.144+gitX, 5.10.63+gitX -> 5.10.70+gitX, 5.14.9+gitX +- linux-yocto-dev 5.12++gitX -> 5.15++gitX +- linux-yocto-rt 5.4.144+gitX, 5.10.63+gitX -> 5.10.70+gitX, 5.14.9+gitX +- linux-yocto-tiny 5.4.144+gitX, 5.10.63+gitX -> 5.10.70+gitX, 5.14.9+gitX +- llvm 11.1.0 -> 12.0.1 +- log4cplus 2.0.6 -> 2.0.7 +- logrotate 3.18.0 -> 3.18.1 +- ltp 20210121 -> 20210524 +- lttng-modules 2.12.6 -> 2.13.0 +- lttng-tools 2.12.4 -> 2.13.0 +- lttng-ust 2.12.1 -> 2.13.0 +- m4 1.4.18 -> 1.4.19 +- m4-native 1.4.18 -> 1.4.19 +- man-pages 5.10 -> 5.12 +- mc 4.8.26 -> 4.8.27 +- mesa 21.0.3 -> 21.2.1 +- mesa-gl 21.0.3 -> 21.2.1 +- meson 0.57.1 -> 0.58.1 +- mmc-utils 0.1+gitX (73d6c59af8d1...) -> 0.1+gitX (43282e80e174...) +- mobile-broadband-provider-info 20201225 -> 20210805 +- mpg123 1.26.4 -> 1.28.2 +- mtd-utils 2.1.2 -> 2.1.3 +- mtools 4.0.26 -> 4.0.35 +- musl 1.2.2+gitX (e5d2823631bb...) -> 1.2.2+gitX (3f701faace7a...) +- nativesdk-meson 0.57.1 -> 0.58.1 +- netbase 6.2 -> 6.3 +- nfs-utils 2.5.3 -> 2.5.4 +- ofono 1.31 -> 1.32 +- openssh 8.5p1 -> 8.7p1 +- opkg 0.4.4 -> 0.4.5 +- opkg-utils 0.4.3 -> 0.4.5 +- ovmf edk2-stable202102 -> edk2-stable202105 +- p11-kit 0.23.22 -> 0.24.0 +- pango 1.48.2 -> 1.48.9 +- patchelf 0.12 -> 0.13 +- perl 5.32.1 -> 5.34.0 +- piglit 1.0+gitrX (d4d9353b7290...) -> 1.0+gitrX (6a4be9e9946d...) +- pkgconf 1.7.3 -> 1.8.0 +- powertop 2.13 -> 2.14 +- pseudo 1.9.0+gitX (b988b0a6b8af...) -> 1.9.0+gitX (0cda3ba5f94a...) +- pulseaudio 14.2 -> 15.0 +- puzzles 0.0+gitX (84cb4c6701e0...) -> 0.0+gitX (8f3413c31ffd...) +- python3 3.9.5 -> 3.9.6 +- python3-attrs 20.3.0 -> 21.2.0 +- python3-cython 0.29.22 -> 0.29.24 +- python3-dbus 1.2.16 -> 1.2.18 +- python3-dbusmock 0.22.0 -> 0.23.1 +- python3-docutils 0.16 -> 0.17.1 +- python3-git 3.1.14 -> 3.1.20 +- python3-gitdb 4.0.5 -> 4.0.7 +- python3-hypothesis 6.2.0 -> 6.15.0 +- python3-importlib-metadata 3.4.0 -> 4.6.4 +- python3-iniparse 0.4 -> 0.5 +- python3-jinja2 2.11.3 -> 3.0.1 +- python3-libarchive-c 2.9 -> 3.1 +- python3-magic 0.4.22 -> 0.4.24 +- python3-mako 1.1.4 -> 1.1.5 +- python3-markupsafe 1.1.1 -> 2.0.1 +- python3-more-itertools 8.7.0 -> 8.8.0 +- python3-numpy 1.20.1 -> 1.21.2 +- python3-packaging 20.9 -> 21.0 +- python3-pathlib2 2.3.5 -> 2.3.6 +- python3-pbr 5.4.4 -> 5.6.0 +- python3-pip 20.0.2 -> 21.2.4 +- python3-pluggy 0.13.1 -> 1.0.0 +- python3-pycairo 1.20.0 -> 1.20.1 +- python3-pygments 2.8.1 -> 2.10.0 +- python3-pygobject 3.38.0 -> 3.40.1 +- python3-pytest 6.2.2 -> 6.2.4 +- python3-scons 3.1.2 -> 4.2.0 +- python3-scons-native 3.1.2 -> 4.2.0 +- python3-setuptools 54.1.1 -> 57.4.0 +- python3-setuptools-scm 5.0.1 -> 6.0.1 +- python3-six 1.15.0 -> 1.16.0 +- python3-sortedcontainers 2.3.0 -> 2.4.0 +- python3-testtools 2.4.0 -> 2.5.0 +- python3-zipp 3.4.1 -> 3.5.0 +- qemu 5.2.0 -> 6.0.0 +- qemu-native 5.2.0 -> 6.0.0 +- qemu-system-native 5.2.0 -> 6.0.0 +- re2c 2.0.3 -> 2.2 +- rng-tools 6.11 -> 6.14 +- rpcbind 1.2.5 -> 1.2.6 +- rt-tests 1.10 -> 2.1 +- ruby 3.0.1 -> 3.0.2 +- rxvt-unicode 9.22 -> 9.26 +- shaderc 2020.5 -> 2021.1 +- shadow 4.8.1 -> 4.9 +- spirv-tools 2020.7 -> 2021.2 +- sqlite3 3.35.0 -> 3.36.0 +- squashfs-tools 4.4 -> 4.5 +- strace 5.11 -> 5.14 +- stress-ng 0.12.05 -> 0.13.00 +- sudo 1.9.6p1 -> 1.9.7p2 +- swig 3.0.12 -> 4.0.2 +- sysklogd 2.2.2 -> 2.2.3 +- systemd 247.6 -> 249.3 +- systemd-boot 247.6 -> 249.3 +- systemd-conf 247.6 -> 1.0 +- systemtap 4.4 -> 4.5 +- systemtap-native 4.4 -> 4.5 +- systemtap-uprobes 4.4 -> 4.5 +- tcf-agent 1.7.0+gitX (a022ef2f1acf...) -> 1.7.0+gitX (2735e3d6b7ec...) +- texinfo 6.7 -> 6.8 +- tiff 4.2.0 -> 4.3.0 +- u-boot 2021.01 -> 2021.07 +- u-boot-tools 2021.01 -> 2021.07 +- usbutils 013 -> 014 +- util-linux 2.36.2 -> 2.37.2 +- util-linux-libuuid 2.36.2 -> 2.37.2 +- vala 0.50.4 -> 0.52.5 +- valgrind 3.16.1 -> 3.17.0 +- virglrenderer 0.8.2 -> 0.9.1 +- vte 0.62.2 -> 0.64.2 +- vulkan-headers 1.2.170.0 -> 1.2.182.0 +- vulkan-loader 1.2.170.0 -> 1.2.182.0 +- vulkan-samples git (55cebd9e7cc4...) -> git (d2187278cb66...) +- vulkan-tools 1.2.170.0 -> 1.2.182.0 +- wayland-protocols 1.20 -> 1.21 +- webkitgtk 2.30.5 -> 2.32.3 +- wireless-regdb 2021.04.21 -> 2021.07.14 +- wpebackend-fdo 1.8.0 -> 1.10.0 +- x264 r3039+gitX (544c61f08219...) -> r3039+gitX (5db6aa6cab1b...) +- xeyes 1.1.2 -> 1.2.0 +- xf86-input-libinput 0.30.0 -> 1.1.0 +- xkbcomp 1.4.4 -> 1.4.5 +- xkeyboard-config 2.32 -> 2.33 +- xorgproto 2020.1 -> 2021.4.99.2 +- xserver-xorg 1.20.10 -> 1.20.13 +- zstd 1.4.9 -> 1.5.0 + +Contributors to 3.4 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +- Adam Romanek +- Alejandro Hernandez Samaniego +- Alexander Kanavin +- Alexandre Belloni +- Alexey Brodkin +- Alex Stewart +- Alistair Francis +- Anatol Belski +- Anders Wallin +- Andrea Adami +- Andreas Müller +- Andrej Valek +- Andres Beltran +- Andrey Zhizhikin +- Anibal Limon +- Anthony Bagwell +- Anton Blanchard +- Anuj Mittal +- Armin Kuster +- Asfak Rahman +- Bastian Krause +- Bernhard Rosenkränzer +- Bruce Ashfield +- Carlos Rafael Giani +- Chandana kalluri +- Changhyeok Bae +- Changqing Li +- Chanho Park +- Chen Qi +- Chris Laplante +- Christophe Chapuis +- Christoph Muellner +- Claudius Heine +- Damian Wrobel +- Daniel Ammann +- Daniel Gomez +- Daniel McGregor +- Daniel Wagenknecht +- Denys Dmytriyenko +- Devendra Tewari +- Diego Sueiro +- Dmitry Baryshkov +- Douglas Royds +- Dragos-Marian Panait +- Drew Moseley +- Enrico Scholz +- Fabio Berton +- Florian Amstutz +- Gavin Li +- Guillaume Champagne +- Harald Brinkmann +- Henning Schild +- He Zhe +- Hongxu Jia +- Hsia-Jun (Randy) Li +- Jean Bouchard +- Joe Slater +- Jonas Höppner +- Jon Mason +- Jose Quaresma +- Joshua Watt +- Justin Bronder +- Kai Kang +- Kenfe-Mickael Laventure +- Kevin Hao +- Khairul Rohaizzat Jamaluddin +- Khem Raj +- Kiran Surendran +- Konrad Weihmann +- Kristian Klausen +- Kyle Russell +- Lee Chee Yang +- Lei Maohui +- Luca Boccassi +- Marco Felsch +- Marcus Comstedt +- Marek Vasut +- Mark Hatle +- Markus Volk +- Marta Rybczynska +- Martin Jansa +- Matthias Klein +- Matthias Schiffer +- Matt Madison +- Matt Spencer +- Max Krummenacher +- Michael Halstead +- Michael Ho +- Michael Opdenacker +- Mike Crowe +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Minjae Kim +- Nicolas Dechesne +- Niels Avonds +- Nikolay Papenkov +- Nisha Parrakat +- Olaf Mandel +- Oleksandr Kravchuk +- Oleksandr Popovych +- Oliver Kranz +- Otavio Salvador +- Patrick Williams +- Paul Barker +- Paul Eggleton +- Paul Gortmaker +- Paulo Cesar Zaneti +- Peter Bergin +- Peter Budny +- Peter Kjellerstedt +- Petr Vorel +- Przemyslaw Gorszkowski +- Purushottam Choudhary +- Qiang Zhang +- Quentin Schulz +- Ralph Siemsen +- Randy MacLeod +- Ranjitsinh Rathod +- Rasmus Villemoes +- Reto Schneider +- Richard Purdie +- Richard Weinberger +- Robert Joslyn +- Robert P. J. Day +- Robert Yang +- Romain Naour +- Ross Burton +- Sakib Sajal +- Samuli Piippo +- Saul Wold +- Scott Murray +- Scott Weaver +- Stefan Ghinea +- Stefan Herbrechtsmeier +- Stefano Babic +- Stefan Wiehler +- Steve Sakoman +- Teoh Jay Shen +- Thomas Perrot +- Tim Orling +- Tom Pollard +- Tom Rini +- Tony Battersby +- Tony Tascioglu +- Trevor Gamblin +- Trevor Woerner +- Ulrich Ölmann +- Valentin Danaila +- Vinay Kumar +- Vineela Tummalapalli +- Vinícius Ossanes Aquino +- Vivien Didelot +- Vyacheslav Yurkov +- Wang Mingyu +- Wes Lindauer +- William A. Kennington III +- Yanfei Xu +- Yann Dirson +- Yi Fan Yu +- Yi Zhao +- Zang Ruochen +- Zheng Ruoqin +- Zoltan Boszormenyi + +Repositories / Downloads for 3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`honister </poky/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4 </poky/tag/?h=yocto-3.4>` +- Git Revision: :yocto_git:`f6d1126fff213460dc6954a5d5fc168606d76b66 </poky/commit/?id=f6d1126fff213460dc6954a5d5fc168606d76b66>` +- Release Artefact: poky-f6d1126fff213460dc6954a5d5fc168606d76b66 +- sha: 11e8f5760f704eed1ac37a5b09b1a831b5254d66459be75b06a72128c63e0411 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/poky-f6d1126fff213460dc6954a5d5fc168606d76b66.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/poky-f6d1126fff213460dc6954a5d5fc168606d76b66.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`honister </openembedded-core/log/?h=honister>` +- Tag: :oe_git:`2021-10-honister </openembedded-core/tag/?h=2021-10-honister>` +- Git Revision: :oe_git:`bb1dea6806f084364b6017db2567f438e805aef0 </openembedded-core/commit/?id=bb1dea6806f084364b6017db2567f438e805aef0>` +- Release Artefact: oecore-bb1dea6806f084364b6017db2567f438e805aef0 +- sha: 9a356c407c567b1c26e535cad235204b0462cb79321fefb0844324a6020b31f4 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/oecore-bb1dea6806f084364b6017db2567f438e805aef0.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/oecore-bb1dea6806f084364b6017db2567f438e805aef0.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`honister </meta-mingw/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4 </meta-mingw/tag/?h=yocto-3.4>` +- Git Revision: :yocto_git:`f5d761cbd5c957e4405c5d40b0c236d263c916a8 </meta-mingw/commit/?id=f5d761cbd5c957e4405c5d40b0c236d263c916a8>` +- Release Artefact: meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8 +- sha: d4305d638ef80948584526c8ca386a8cf77933dffb8a3b8da98d26a5c40fcc11 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/meta-mingw-f5d761cbd5c957e4405c5d40b0c236d263c916a8.tar.bz2 + +meta-intel + +- Repository Location: :yocto_git:`/meta-intel` +- Branch: :yocto_git:`honister </meta-intel/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4 </meta-intel/tag/?h=yocto-3.4>` +- Git Revision: :yocto_git:`90170cf85fe35b4e8dc00eee50053c0205276b63 </meta-intel/commit/?id=90170cf85fe35b4e8dc00eee50053c0205276b63>` +- Release Artefact: meta-intel-90170cf85fe35b4e8dc00eee50053c0205276b63 +- sha: 2b3b43386dfcaaa880d819c1ae88b1251b55fb12c622af3d0936c3dc338491fc +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/meta-intel-90170cf85fe35b4e8dc00eee50053c0205276b63.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/meta-intel-90170cf85fe35b4e8dc00eee50053c0205276b63.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`honister </meta-gplv2/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4 </meta-gplv2/tag/?h=yocto-3.4>` +- Git Revision: :yocto_git:`f04e4369bf9dd3385165281b9fa2ed1043b0e400 </meta-gplv2/commit/?id=f04e4369bf9dd3385165281b9fa2ed1043b0e400>` +- Release Artefact: meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400 +- sha: ef8e2b1ec1fb43dbee4ff6990ac736315c7bc2d8c8e79249e1d337558657d3fe +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/meta-gplv2-f04e4369bf9dd3385165281b9fa2ed1043b0e400.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`1.52 </bitbake/log/?h=1.52>` +- Tag: :oe_git:`2021-10-honister </bitbake/tag/?h=2021-10-honister>` +- Git Revision: :oe_git:`c78ebac71ec976fdf27ea24767057882870f5c60 </bitbake/commit/?id=c78ebac71ec976fdf27ea24767057882870f5c60>` +- Release Artefact: bitbake-c78ebac71ec976fdf27ea24767057882870f5c60 +- sha: 8077c7e7528cd73ef488ef74de3943ec66cae361459e5b630fb3cbe89c498d3d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-3.4/bitbake-c78ebac71ec976fdf27ea24767057882870f5c60.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-3.4/bitbake-c78ebac71ec976fdf27ea24767057882870f5c60.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`honister </yocto-docs/log/?h=honister>` +- Tag: :yocto_git:`yocto-3.4 </yocto-docs/tag/?h=yocto-3.4>` +- Git Revision: :yocto_git:`d75c5450ecf56c8ac799a633ee9ac459e88f91fc </yocto-docs/commit/?id=d75c5450ecf56c8ac799a633ee9ac459e88f91fc>` + diff --git a/documentation/migration-guides/release-notes-4.0.1.rst b/documentation/migration-guides/release-notes-4.0.1.rst new file mode 100644 index 0000000000..5529f71c6f --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.1.rst @@ -0,0 +1,250 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 4.0.1 (kirkstone) +----------------------------------- + +Security Fixes in 4.0.1 +~~~~~~~~~~~~~~~~~~~~~~~ + +- linux-yocto/5.15: fix :cve:`2022-28796` +- python3: ignore :cve:`2015-20107` +- e2fsprogs: fix :cve:`2022-1304` +- lua: fix :cve:`2022-28805` +- busybox: fix :cve:`2022-28391` + +Fixes in 4.0.1 +~~~~~~~~~~~~~~ + +- abi_version/sstate: Bump hashequiv and sstate versions due to git changes +- apt: add apt selftest to test signed package feeds +- apt: upgrade 2.4.4 -> 2.4.5 +- arch-armv8-2a.inc: fix a typo in TUNEVALID variable +- babeltrace: Disable warnings as errors +- base: Avoid circular references to our own scripts +- base: Drop git intercept +- build-appliance-image: Update to kirkstone head revision +- build-appliance: Switch to kirkstone branch +- buildtools-tarball: Only add cert envvars if certs are included +- busybox: Use base_bindir instead of hardcoding /bin path +- cases/buildepoxy.py: fix typo +- create-spdx: delete virtual/kernel dependency to fix FreeRTOS build +- create-spdx: fix error when symlink cannot be created +- cve-check: add JSON format to summary output +- cve-check: fix symlinks where link and output path are equal +- cve-check: no need to depend on the fetch task +- cve-update-db-native: let the user to drive the update interval +- cve-update-db-native: update the CVE database once a day only +- cve_check: skip remote patches that haven't been fetched when searching for CVE tags +- dev-manual: add command used to add the signed-off-by line. +- devshell.bbclass: Allow devshell & pydevshell to use the network +- docs: conf.py: fix cve extlinks caption for sphinx <4.0 +- docs: migration-guides: migration-3.4: mention that hardcoded password are supported if hashed +- docs: migration-guides: release-notes-4.0: fix risc-v typo +- docs: migration-guides: release-notes-4.0: replace kernel placeholder with correct recipe name +- docs: ref-manual: variables: add hashed password example in :term:`EXTRA_USERS_PARAMS` +- docs: set_versions.py: add information about obsolescence of a release +- docs: set_versions.py: fix latest release of a branch being shown twice in switchers.js +- docs: set_versions.py: fix latest version of an active release shown as obsolete +- docs: set_versions.py: mark as obsolete only branches and old tags from obsolete releases +- docs: sphinx-static: switchers.js.in: do not mark branches as outdated +- docs: sphinx-static: switchers.js.in: fix broken switcher for branches +- docs: sphinx-static: switchers.js.in: improve obsolete version detection +- docs: sphinx-static: switchers.js.in: remove duplicate for outdated versions +- docs: sphinx-static: switchers.js.in: rename all_versions to switcher_versions +- docs: update Bitbake objects.inv location for master branch +- documentation/brief-yoctoprojectqs: add directory for local.conf +- gcompat: Fix build when usrmerge distro feature is enabled +- git: correct license +- git: upgrade 2.35.2 -> 2.35.3 +- glib: upgrade 2.72.0 -> 2.72.1 +- glibc: ptest: Fix glibc-tests package issue +- gnupg: Disable FORTIFY_SOURCES on mips +- go.bbclass: disable the use of the default configuration file +- gstreamer1.0-plugins-bad: drop patch +- gstreamer1.0-plugins-good: Fix libsoup dependency +- gstreamer1.0: Minor documentation addition +- install/devshell: Introduce git intercept script due to fakeroot issues +- kernel-yocto.bbclass: Fixup do_kernel_configcheck usage of KMETA +- libc-glibc: Use libxcrypt to provide virtual/crypt +- libgit2: upgrade 1.4.2 -> 1.4.3 +- libsoup: upgrade 3.0.5 -> 3.0.6 +- libusb1: upgrade 1.0.25 -> 1.0.26 +- linux-firmware: correct license for ar3k firmware +- linux-firmware: upgrade 20220310 -> 20220411 +- linux-yocto/5.10: base: enable kernel crypto userspace API +- linux-yocto/5.10: update to v5.10.112 +- linux-yocto/5.15: arm: poky-tiny cleanup and fixes +- linux-yocto/5.15: base: enable kernel crypto userspace API +- linux-yocto/5.15: fix -standard kernel build issue +- linux-yocto/5.15: fix ppc boot +- linux-yocto/5.15: fix qemuarm graphical boot +- linux-yocto/5.15: kasan: fix BUG: sleeping function called from invalid context +- linux-yocto/5.15: netfilter: conntrack: avoid useless indirection during conntrack destruction +- linux-yocto/5.15: update to v5.15.36 +- linux-yocto: enable powerpc-debug fragment +- mdadm: Drop clang specific cflags +- migration-3.4: add missing entry on :term:`EXTRA_USERS_PARAMS` +- migration-guides: add release notes for 4.0 +- migration-guides: complete migration guide for 4.0 +- migration-guides: release-notes-4.0: mention :term:`LTS` release +- migration-guides: release-notes-4.0: update 'Repositories / Downloads' section +- migration-guides: stop including documents with ".. include" +- musl: Fix build when usrmerge distro feature is enabled +- ncurses: use COPYING file +- neard: Switch :term:`SRC_URI` to git repo +- oeqa/selftest: add test for git working correctly inside pseudo +- openssl: minor security upgrade 3.0.2 -> 3.0.3 +- package.bbclass: Prevent perform_packagecopy from removing /sysroot-only +- package: Ensure we track whether PRSERV was active or not +- package_manager: fix missing dependency on gnupg when signing deb package feeds +- poky-tiny: enable qemuarmv5/qemuarm64 and cleanups +- poky.conf: bump version for 4.0.1 release +- qemu.bbclass: Extend ppc/ppc64 extra options +- qemuarm64: use virtio pci interfaces +- qemuarmv5: use arm-versatile-926ejs :term:`KMACHINE` +- ref-manual: Add :term:`XZ_THREADS` and :term:`XZ_MEMLIMIT` +- ref-manual: add :term:`KERNEL_DEBUG_TIMESTAMPS` +- ref-manual: add :term:`ZSTD_THREADS` +- ref-manual: add a note about hard-coded passwords +- ref-manual: add empty-dirs QA check and QA_EMPTY_DIRS* +- ref-manual: add mention of vendor filtering to :term:`CVE_PRODUCT` +- ref-manual: mention wildcarding support in :term:`INCOMPATIBLE_LICENSE` +- releases: update for yocto 4.0 +- rootfs-postcommands: fix symlinks where link and output path are equal +- ruby: upgrade 3.1.1 -> 3.1.2 +- sanity: skip make 4.2.1 warning for debian +- scripts/git: Ensure we don't have circular references +- scripts: Make git intercept global +- seatd: Disable overflow warning as error on ppc64/musl +- selftest/lic_checksum: Add test for filename containing space +- set_versions: update for 4.0 release +- staging: Ensure we filter out ourselves +- strace: fix ptest failure in landlock +- subversion: upgrade to 1.14.2 +- systemd-boot: remove outdated EFI_LD comment +- systemtap: Fix build with gcc-12 +- terminal.py: Restore error output from Terminal +- u-boot: Correct the :term:`SRC_URI` +- u-boot: Inherit pkgconfig +- update_udev_hwdb: fix multilib issue with systemd +- util-linux: Create u-a symlink for findfs utility +- virgl: skip headless test on alma 8.6 +- webkitgtk: adjust patch status +- wic: do not use PARTLABEL for msdos partition tables +- wireless-regdb: upgrade 2022.02.18 -> 2022.04.08 +- xserver-xorg: Fix build with gcc12 +- yocto-bsps: update to v5.15.36 + +Contributors to 4.0.1 +~~~~~~~~~~~~~~~~~~~~~ + +- Abongwa Amahnui Bonalais +- Alexander Kanavin +- Bruce Ashfield +- Carlos Rafael Giani +- Chen Qi +- Davide Gardenal +- Dmitry Baryshkov +- Ferry Toth +- Henning Schild +- Jon Mason +- Justin Bronder +- Kai Kang +- Khem Raj +- Konrad Weihmann +- Lee Chee Yang +- Marta Rybczynska +- Martin Jansa +- Matt Madison +- Michael Halstead +- Michael Opdenacker +- Naveen Saini +- Nicolas Dechesne +- Paul Eggleton +- Paul Gortmaker +- Paulo Neves +- Peter Kjellerstedt +- Peter Marko +- Pgowda +- Portia +- Quentin Schulz +- Rahul Kumar +- Richard Purdie +- Robert Joslyn +- Robert Yang +- Roland Hieber +- Ross Burton +- Russ Dill +- Steve Sakoman +- Wang Mingyu +- Zheng Ruoqin + +Repositories / Downloads for 4.0.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.1 </poky/tag/?h=yocto-4.0.1>` +- Git Revision: :yocto_git:`8c489602f218bcf21de0d3c9f8cf620ea5f06430 </poky/commit/?id=8c489602f218bcf21de0d3c9f8cf620ea5f06430>` +- Release Artefact: poky-8c489602f218bcf21de0d3c9f8cf620ea5f06430 +- sha: 65c545a316bd8efb13ae1358eeccc8953543be908008103b51f7f90aed960d00 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.1/poky-8c489602f218bcf21de0d3c9f8cf620ea5f06430.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.1/poky-8c489602f218bcf21de0d3c9f8cf620ea5f06430.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.1 </openembedded-core/tag/?h=yocto-4.0>` +- Git Revision: :oe_git:`cb8647c08959abb1d6b7c2b3a34b4b415f66d7ee </openembedded-core/commit/?id=cb8647c08959abb1d6b7c2b3a34b4b415f66d7ee>` +- Release Artefact: oecore-cb8647c08959abb1d6b7c2b3a34b4b415f66d7ee +- sha: 43981b8fad82f601618a133dffbec839524f0d0a055efc3d8f808cbfd811ab17 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.1/oecore-cb8647c08959abb1d6b7c2b3a34b4b415f66d7ee.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.1/oecore-cb8647c08959abb1d6b7c2b3a34b4b415f66d7ee.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.1 </meta-mingw/tag/?h=yocto-4.0.1>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.1/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.1/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.1 </meta-gplv2/tag/?h=yocto-4.0.1>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-mingw/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.1/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.1/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0 </bitbake/tag/?h=yocto-4.0>` +- Git Revision: :oe_git:`59c16ae6c55c607c56efd2287537a1b97ba2bf52 </bitbake/commit/?id=59c16ae6c55c607c56efd2287537a1b97ba2bf52>` +- Release Artefact: bitbake-59c16ae6c55c607c56efd2287537a1b97ba2bf52 +- sha: 3ae466c31f738fc45c3d7c6f665952d59f01697f2667ea42f0544d4298dd6ef0 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.1/bitbake-59c16ae6c55c607c56efd2287537a1b97ba2bf52.tar.bz2, + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.1/bitbake-59c16ae6c55c607c56efd2287537a1b97ba2bf52.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.1 </yocto-docs/tag/?h=yocto-4.0>` +- Git Revision: :yocto_git:`4ec9df3336a425719a9a35532504731ce56984ca </yocto-docs/commit/?id=4ec9df3336a425719a9a35532504731ce56984ca>` diff --git a/documentation/migration-guides/release-notes-4.0.10.rst b/documentation/migration-guides/release-notes-4.0.10.rst new file mode 100644 index 0000000000..f37c3471ea --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.10.rst @@ -0,0 +1,180 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.10 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.10 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- binutils: Fix :cve:`2023-1579`, :cve:`2023-1972`, :cve_mitre:`2023-25584`, :cve_mitre:`2023-25585` and :cve_mitre:`2023-25588` +- cargo : Ignore :cve:`2022-46176` +- connman: Fix :cve:`2023-28488` +- curl: Fix :cve:`2023-27533`, :cve:`2023-27534`, :cve:`2023-27535`, :cve:`2023-27536` and :cve:`2023-27538` +- ffmpeg: Fix :cve:`2022-48434` +- freetype: Fix :cve:`2023-2004` +- ghostscript: Fix :cve_mitre:`2023-29979` +- git: Fix :cve:`2023-25652` and :cve:`2023-29007` +- go: Fix :cve:`2022-41722`, :cve:`2022-41724`, :cve:`2022-41725`, :cve:`2023-24534`, :cve:`2023-24537` and :cve:`2023-24538` +- go: Ignore :cve:`2022-41716` +- libxml2: Fix :cve:`2023-28484` and :cve:`2023-29469` +- libxpm: Fix :cve:`2022-44617`, :cve:`2022-46285` and :cve:`2022-4883` +- linux-yocto: Ignore :cve:`2021-3759`, :cve:`2021-4135`, :cve:`2021-4155`, :cve:`2022-0168`, :cve:`2022-0171`, :cve:`2022-1016`, :cve:`2022-1184`, :cve:`2022-1198`, :cve:`2022-1199`, :cve:`2022-1462`, :cve:`2022-1734`, :cve:`2022-1852`, :cve:`2022-1882`, :cve:`2022-1998`, :cve:`2022-2078`, :cve:`2022-2196`, :cve:`2022-2318`, :cve:`2022-2380`, :cve:`2022-2503`, :cve:`2022-26365`, :cve:`2022-2663`, :cve:`2022-2873`, :cve:`2022-2905`, :cve:`2022-2959`, :cve:`2022-3028`, :cve:`2022-3078`, :cve:`2022-3104`, :cve:`2022-3105`, :cve:`2022-3106`, :cve:`2022-3107`, :cve:`2022-3111`, :cve:`2022-3112`, :cve:`2022-3113`, :cve:`2022-3115`, :cve:`2022-3202`, :cve:`2022-32250`, :cve:`2022-32296`, :cve:`2022-32981`, :cve:`2022-3303`, :cve:`2022-33740`, :cve:`2022-33741`, :cve:`2022-33742`, :cve:`2022-33743`, :cve:`2022-33744`, :cve:`2022-33981`, :cve:`2022-3424`, :cve:`2022-3435`, :cve:`2022-34918`, :cve:`2022-3521`, :cve:`2022-3545`, :cve:`2022-3564`, :cve:`2022-3586`, :cve:`2022-3594`, :cve:`2022-36123`, :cve:`2022-3621`, :cve:`2022-3623`, :cve:`2022-3629`, :cve:`2022-3633`, :cve:`2022-3635`, :cve:`2022-3646`, :cve:`2022-3649`, :cve:`2022-36879`, :cve:`2022-36946`, :cve:`2022-3707`, :cve:`2022-39188`, :cve:`2022-39190`, :cve:`2022-39842`, :cve:`2022-40307`, :cve:`2022-40768`, :cve:`2022-4095`, :cve:`2022-41218`, :cve:`2022-4139`, :cve:`2022-41849`, :cve:`2022-41850`, :cve:`2022-41858`, :cve:`2022-42328`, :cve:`2022-42329`, :cve:`2022-42703`, :cve:`2022-42721`, :cve:`2022-42722`, :cve:`2022-42895`, :cve:`2022-4382`, :cve:`2022-4662`, :cve:`2022-47518`, :cve:`2022-47519`, :cve:`2022-47520`, :cve:`2022-47929`, :cve:`2023-0179`, :cve:`2023-0394`, :cve:`2023-0461`, :cve:`2023-0590`, :cve:`2023-1073`, :cve:`2023-1074`, :cve:`2023-1077`, :cve:`2023-1078`, :cve:`2023-1079`, :cve:`2023-1095`, :cve:`2023-1118`, :cve:`2023-1249`, :cve:`2023-1252`, :cve:`2023-1281`, :cve:`2023-1382`, :cve:`2023-1513`, :cve:`2023-1829`, :cve:`2023-1838`, :cve:`2023-1998`, :cve:`2023-2006`, :cve:`2023-2008`, :cve:`2023-2162`, :cve:`2023-2166`, :cve:`2023-2177`, :cve:`2023-22999`, :cve:`2023-23002`, :cve:`2023-23004`, :cve:`2023-23454`, :cve:`2023-23455`, :cve:`2023-23559`, :cve:`2023-25012`, :cve:`2023-26545`, :cve:`2023-28327` and :cve:`2023-28328` +- nasm: Fix :cve:`2022-44370` +- python3-cryptography: Fix :cve:`2023-23931` +- qemu: Ignore :cve:`2023-0664` +- ruby: Fix :cve:`2023-28755` and :cve:`2023-28756` +- screen: Fix :cve:`2023-24626` +- shadow: Fix :cve:`2023-29383` +- tiff: Fix :cve:`2022-4645` +- webkitgtk: Fix :cve:`2022-32888` and :cve:`2022-32923` +- xserver-xorg: Fix :cve:`2023-1393` + + +Fixes in Yocto-4.0.10 +~~~~~~~~~~~~~~~~~~~~~ + +- bitbake: bin/utils: Ensure locale en_US.UTF-8 is available on the system +- build-appliance-image: Update to kirkstone head revision +- cmake: add CMAKE_SYSROOT to generated toolchain file +- glibc: stable 2.35 branch updates. +- kernel-devsrc: depend on python3-core instead of python3 +- kernel: improve initramfs bundle processing time +- libarchive: Enable acls, xattr for native as well as target +- libbsd: Add correct license for all packages +- libpam: Fix the xtests/tst-pam_motd[1|3] failures +- libxpm: upgrade to 3.5.15 +- linux-firmware: upgrade to 20230404 +- linux-yocto/5.15: upgrade to v5.15.108 +- migration-guides: add release-notes for 4.0.9 +- oeqa/utils/metadata.py: Fix running oe-selftest running with no distro set +- openssl: Move microblaze to linux-latomic config +- package.bbclass: correct check for /build in copydebugsources() +- poky.conf: bump version for 4.0.10 +- populate_sdk_base: add zip options +- populate_sdk_ext.bbclass: set :term:`METADATA_REVISION` with an :term:`DISTRO` override +- run-postinsts: Set dependency for ldconfig to avoid boot issues +- update-alternatives.bbclass: fix old override syntax +- wic/bootimg-efi: if fixed-size is set then use that for mkdosfs +- wpebackend-fdo: upgrade to 1.14.2 +- xorg-lib-common: Add variable to set tarball type +- xserver-xorg: upgrade to 21.1.8 + + +Known Issues in Yocto-4.0.10 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.10 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Archana Polampalli +- Arturo Buzarra +- Bruce Ashfield +- Christoph Lauer +- Deepthi Hemraj +- Dmitry Baryshkov +- Frank de Brabander +- Hitendra Prajapati +- Joe Slater +- Kai Kang +- Kyle Russell +- Lee Chee Yang +- Mark Hatle +- Martin Jansa +- Mingli Yu +- Narpat Mali +- Pascal Bach +- Pawan Badganchi +- Peter Bergin +- Peter Marko +- Piotr Łobacz +- Randolph Sapp +- Ranjitsinh Rathod +- Ross Burton +- Shubham Kulkarni +- Siddharth Doshi +- Steve Sakoman +- Sundeep KOKKONDA +- Thomas Roos +- Virendra Thakur +- Vivek Kumbhar +- Wang Mingyu +- Xiangyu Chen +- Yash Shinde +- Yoann Congal +- Yogita Urade +- Zhixiong Chi + + +Repositories / Downloads for Yocto-4.0.10 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.10 </poky/log/?h=yocto-4.0.10>` +- Git Revision: :yocto_git:`f53ab3a2ff206a130cdc843839dd0ea5ec4ad02f </poky/commit/?id=f53ab3a2ff206a130cdc843839dd0ea5ec4ad02f>` +- Release Artefact: poky-f53ab3a2ff206a130cdc843839dd0ea5ec4ad02f +- sha: 8820aeac857ce6bbd1c7ef26cadbb86eca02be93deded253b4a5f07ddd69255d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.10/poky-f53ab3a2ff206a130cdc843839dd0ea5ec4ad02f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.10/poky-f53ab3a2ff206a130cdc843839dd0ea5ec4ad02f.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.10 </openembedded-core/log/?h=yocto-4.0.10>` +- Git Revision: :oe_git:`d2713785f9cd2d58731df877bc8b7bcc71b6c8e6 </openembedded-core/commit/?id=d2713785f9cd2d58731df877bc8b7bcc71b6c8e6>` +- Release Artefact: oecore-d2713785f9cd2d58731df877bc8b7bcc71b6c8e6 +- sha: 78e084a1aceaaa6ec022702f29f80eaffade3159e9c42b6b8985c1b7ddd2fbab +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.10/oecore-d2713785f9cd2d58731df877bc8b7bcc71b6c8e6.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.10/oecore-d2713785f9cd2d58731df877bc8b7bcc71b6c8e6.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.10 </meta-mingw/log/?h=yocto-4.0.10>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.10/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.10/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.10 </meta-gplv2/log/?h=yocto-4.0.10>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.10/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.10/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.10 </bitbake/log/?h=yocto-4.0.10>` +- Git Revision: :oe_git:`0c6f86b60cfba67c20733516957c0a654eb2b44c </bitbake/commit/?id=0c6f86b60cfba67c20733516957c0a654eb2b44c>` +- Release Artefact: bitbake-0c6f86b60cfba67c20733516957c0a654eb2b44c +- sha: 4caa94ee4d644017b0cc51b702e330191677f7d179018cbcec8b1793949ebc74 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.10/bitbake-0c6f86b60cfba67c20733516957c0a654eb2b44c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.10/bitbake-0c6f86b60cfba67c20733516957c0a654eb2b44c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.10 </yocto-docs/log/?h=yocto-4.0.10>` +- Git Revision: :yocto_git:`8388be749806bd0bf4fccf1005dae8f643aa4ef4 </yocto-docs/commit/?id=8388be749806bd0bf4fccf1005dae8f643aa4ef4>` + diff --git a/documentation/migration-guides/release-notes-4.0.11.rst b/documentation/migration-guides/release-notes-4.0.11.rst new file mode 100644 index 0000000000..8a15884908 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.11.rst @@ -0,0 +1,214 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.11 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.11 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- cups: Fix :cve:`2023-32324` +- curl: Fix :cve:`2023-28319`, :cve:`2023-28320`, :cve:`2023-28321` and :cve:`2023-28322` +- git: Ignore :cve:`2023-25815` +- go: Fix :cve:`2023-24539` and :cve:`2023-24540` +- nasm: Fix :cve:`2022-46457` +- openssh: Fix :cve:`2023-28531` +- openssl: Fix :cve:`2023-1255` and :cve:`2023-2650` +- perl: Fix :cve:`2023-31484` +- python3-requests: Fix for :cve:`2023-32681` +- sysstat: Fix :cve:`2023-33204` +- vim: Fix :cve:`2023-2426` +- webkitgtk: fix :cve:`2022-42867`, :cve:`2022-46691`, :cve:`2022-46699` and :cve:`2022-46700` + + +Fixes in Yocto-4.0.11 +~~~~~~~~~~~~~~~~~~~~~ + +- Revert "docs: conf.py: fix cve extlinks caption for sphinx <4.0" +- Revert "ipk: Decode byte data to string in manifest handling" +- avahi: fix D-Bus introspection +- build-appliance-image: Update to kirkstone head revision +- conf.py: add macro for Mitre CVE links +- conf: add nice level to the hash config ignred variables +- cpio: Fix wrong CRC with ASCII CRC for large files +- cve-update-nvd2-native: added the missing http import +- cve-update-nvd2-native: new CVE database fetcher +- dhcpcd: use git instead of tarballs +- e2fsprogs: fix ptest bug for second running +- gcc-runtime: Use static dummy libstdc++ +- glibc: stable 2.35 branch updates (cbceb903c4d7) +- go.bbclass: don't use test to check output from ls +- gstreamer1.0: Upgrade to 1.20.6 +- iso-codes: Upgrade to 4.15.0 +- kernel-devicetree: allow specification of dtb directory +- kernel-devicetree: make shell scripts posix compliant +- kernel-devicetree: recursively search for dtbs +- kernel: don't force PAHOLE=false +- kmscube: Correct :term:`DEPENDS` to avoid overwrite +- lib/terminal.py: Add urxvt terminal +- license.bbclass: Include :term:`LICENSE` in the output when it fails to parse +- linux-yocto/5.10: Upgrade to v5.10.180 +- linux-yocto/5.15: Upgrade to v5.15.113 +- llvm: backport a fix for build with gcc-13 +- maintainers.inc: Fix email address typo +- maintainers.inc: Move repo to unassigned +- migration-guides: add release notes for 4.0.10 +- migration-guides: use new cve_mitre macro +- nghttp2: Deleted the entries for -client and -server, and removed a dependency on them from the main package. +- oeqa/selftest/cases/devtool.py: skip all tests require folder a git repo +- openssh: Remove BSD-4-clause contents completely from codebase +- openssl: Upgrade to 3.0.9 +- overview-manual: concepts.rst: Fix a typo +- p11-kit: add native to :term:`BBCLASSEXTEND` +- package: enable recursion on file globs +- package_manager/ipk: fix config path generation in _create_custom_config() +- piglit: Add :term:`PACKAGECONFIG` for glx and opencl +- piglit: Add missing glslang dependencies +- piglit: Fix build time dependency +- poky.conf: bump version for 4.0.11 +- profile-manual: fix blktrace remote usage instructions +- quilt: Fix merge.test race condition +- ref-manual: add clarification for :term:`SRCREV` +- selftest/reproducible: Allow native/cross reuse in test +- staging.bbclass: do not add extend_recipe_sysroot to prefuncs of prepare_recipe_sysroot +- systemd-networkd: backport fix for rm unmanaged wifi +- systemd-systemctl: fix instance template WantedBy symlink construction +- systemd-systemctl: support instance expansion in WantedBy +- uninative: Upgrade to 3.10 to support gcc 13 +- uninative: Upgrade to 4.0 to include latest gcc 13.1.1 +- vim: Upgrade to 9.0.1527 +- waffle: Upgrade to 1.7.2 +- weston: add xwayland to :term:`DEPENDS` for :term:`PACKAGECONFIG` xwayland + + +Known Issues in Yocto-4.0.11 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.11 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Andrew Jeffery +- Archana Polampalli +- Bhabu Bindu +- Bruce Ashfield +- C. Andy Martin +- Chen Qi +- Daniel Ammann +- Deepthi Hemraj +- Ed Beroset +- Eero Aaltonen +- Enrico Jörns +- Hannu Lounento +- Hitendra Prajapati +- Ian Ray +- Jan Luebbe +- Jan Vermaete +- Khem Raj +- Lee Chee Yang +- Lei Maohui +- Lorenzo Arena +- Marek Vasut +- Marta Rybczynska +- Martin Jansa +- Martin Siegumfeldt +- Michael Halstead +- Michael Opdenacker +- Ming Liu +- Narpat Mali +- Omkar Patil +- Pablo Saavedra +- Pavel Zhukov +- Peter Kjellerstedt +- Peter Marko +- Qiu Tingting +- Quentin Schulz +- Randolph Sapp +- Randy MacLeod +- Ranjitsinh Rathod +- Richard Purdie +- Riyaz Khan +- Sakib Sajal +- Sanjay Chitroda +- Soumya Sambu +- Steve Sakoman +- Thomas Roos +- Tom Hochstein +- Vivek Kumbhar +- Wang Mingyu +- Yogita Urade +- Zoltan Boszormenyi + + +Repositories / Downloads for Yocto-4.0.11 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.11 </poky/log/?h=yocto-4.0.11>` +- Git Revision: :yocto_git:`fc697fe87412b9b179ae3a68d266ace85bb1fcc6 </poky/commit/?id=fc697fe87412b9b179ae3a68d266ace85bb1fcc6>` +- Release Artefact: poky-fc697fe87412b9b179ae3a68d266ace85bb1fcc6 +- sha: d42ab1b76b9d8ab164d86dc0882c908658f6b5be0742b13a71531068f6a5ee98 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.11/poky-fc697fe87412b9b179ae3a68d266ace85bb1fcc6.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.11/poky-fc697fe87412b9b179ae3a68d266ace85bb1fcc6.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.11 </openembedded-core/log/?h=yocto-4.0.11>` +- Git Revision: :oe_git:`7949e786cf8e50f716ff1f1c4797136637205e0c </openembedded-core/commit/?id=7949e786cf8e50f716ff1f1c4797136637205e0c>` +- Release Artefact: oecore-7949e786cf8e50f716ff1f1c4797136637205e0c +- sha: 3bda3f7d15961bad5490faf3194709528591a97564b5eae3da7345b63be20334 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.11/oecore-7949e786cf8e50f716ff1f1c4797136637205e0c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.11/oecore-7949e786cf8e50f716ff1f1c4797136637205e0c.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.11 </meta-mingw/log/?h=yocto-4.0.11>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.11/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.11/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.11 </meta-gplv2/log/?h=yocto-4.0.11>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.11/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.11/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.11 </bitbake/log/?h=yocto-4.0.11>` +- Git Revision: :oe_git:`0c6f86b60cfba67c20733516957c0a654eb2b44c </bitbake/commit/?id=0c6f86b60cfba67c20733516957c0a654eb2b44c>` +- Release Artefact: bitbake-0c6f86b60cfba67c20733516957c0a654eb2b44c +- sha: 4caa94ee4d644017b0cc51b702e330191677f7d179018cbcec8b1793949ebc74 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.11/bitbake-0c6f86b60cfba67c20733516957c0a654eb2b44c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.11/bitbake-0c6f86b60cfba67c20733516957c0a654eb2b44c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.11 </yocto-docs/log/?h=yocto-4.0.11>` +- Git Revision: :yocto_git:`6d16d2bde0aa32276a035ee49703e6eea7c7b29a </yocto-docs/commit/?id=6d16d2bde0aa32276a035ee49703e6eea7c7b29a>` + diff --git a/documentation/migration-guides/release-notes-4.0.12.rst b/documentation/migration-guides/release-notes-4.0.12.rst new file mode 100644 index 0000000000..0ea92a453d --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.12.rst @@ -0,0 +1,277 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.12 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.12 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-2828` and :cve:`2023-2911` +- cups: Fix :cve:`2023-34241` +- curl: Added :cve:`2023-28320` Follow-up patch +- dbus: Fix :cve:`2023-34969` +- dmidecode: fix :cve:`2023-30630` +- ghostscript: fix :cve:`2023-36664` +- go: fix :cve_mitre:`2023-24531`, :cve:`2023-24536`, :cve:`2023-29400`, :cve:`2023-29402`, :cve:`2023-29404`, :cve:`2023-29405` and :cve:`2023-29406` +- libarchive: Ignore :cve:`2023-30571` +- libcap: Fix :cve:`2023-2602` and :cve:`2023-2603` +- libjpeg-turbo: Fix :cve:`2023-2804` +- libpcre2: Fix :cve:`2022-41409` +- libtiff: fix :cve:`2023-26965` +- libwebp: Fix :cve:`2023-1999` +- libx11: Fix :cve:`2023-3138` +- libxpm: Fix :cve:`2022-44617` +- ninja: Ignore :cve:`2021-4336` +- openssh: Fix :cve:`2023-38408` +- openssl: Fix :cve:`2023-2975`, :cve:`2023-3446` and :cve:`2023-3817` +- perl: Fix :cve:`2023-31486` +- python3: Ignore :cve:`2023-36632` +- qemu: Fix :cve:`2023-0330`, :cve_mitre:`2023-2861`, :cve_mitre:`2023-3255` and :cve_mitre:`2023-3301` +- sqlite3: Fix :cve:`2023-36191` +- tiff: Fix :cve:`2023-0795`, :cve:`2023-0796`, :cve:`2023-0797`, :cve:`2023-0798`, :cve:`2023-0799`, :cve:`2023-25433`, :cve:`2023-25434` and :cve:`2023-25435` +- vim: :cve:`2023-2609` and :cve:`2023-2610` + + +Fixes in Yocto-4.0.12 +~~~~~~~~~~~~~~~~~~~~~ + +- babeltrace2: Always use BFD linker when building tests with ld-is-lld distro feature +- babeltrace2: upgrade to 2.0.5 +- bitbake.conf: add unzstd in :term:`HOSTTOOLS` +- bitbake: bitbake-layers: initialize tinfoil before registering command line arguments +- bitbake: runqueue: Fix deferred task/multiconfig race issue +- blktrace: ask for python3 specifically +- build-appliance-image: Update to kirkstone head revision +- cmake: Fix CMAKE_SYSTEM_PROCESSOR setting for SDK +- connman: fix warning by specifying runstatedir at configure time +- cpio: Replace fix wrong CRC with ASCII CRC for large files with upstream backport +- cve-update-nvd2-native: actually use API keys +- cve-update-nvd2-native: always pass str for json.loads() +- cve-update-nvd2-native: fix cvssV3 metrics +- cve-update-nvd2-native: handle all configuration nodes, not just first +- cve-update-nvd2-native: increase retry count +- cve-update-nvd2-native: log a little more +- cve-update-nvd2-native: retry all errors and sleep between retries +- cve-update-nvd2-native: use exact times, don't truncate +- dbus: upgrade to 1.14.8 +- devtool: Fix the wrong variable in srcuri_entry +- diffutils: upgrade to 3.10 +- docs: ref-manual: terms: fix typos in :term:`SPDX` term +- fribidi: upgrade to 1.0.13 +- gcc: upgrade to v11.4 +- gcc-testsuite: Fix ppc cpu specification +- gcc: don't pass --enable-standard-branch-protection +- gcc: fix runpath errors in cc1 binary +- grub: submit determinism.patch upstream +- image_types: Fix reproducible builds for initramfs and UKI img +- kernel: add missing path to search for debug files +- kmod: remove unused ptest.patch +- layer.conf: Add missing dependency exclusion +- libassuan: upgrade to 2.5.6 +- libksba: upgrade to 1.6.4 +- libpng: Add ptest for libpng +- libxcrypt: fix build with perl-5.38 and use master branch +- libxcrypt: fix hard-coded ".so" extension +- libxpm: upgrade to 3.5.16 +- linux-firmware: upgrade to 20230515 +- linux-yocto/5.10: cfg: fix DECNET configuration warning +- linux-yocto/5.10: update to v5.10.185 +- linux-yocto/5.15: cfg: fix DECNET configuration warning +- linux-yocto/5.15: update to v5.15.120 +- logrotate: Do not create logrotate.status file +- lttng-ust: upgrade to 2.13.6 +- machine/arch-arm64: add -mbranch-protection=standard +- maintainers.inc: correct Carlos Rafael Giani's email address +- maintainers.inc: correct unassigned entries +- maintainers.inc: unassign Adrian Bunk from wireless-regdb +- maintainers.inc: unassign Alistair Francis from opensbi +- maintainers.inc: unassign Andreas Müller from itstool entry +- maintainers.inc: unassign Pascal Bach from cmake entry +- maintainers.inc: unassign Ricardo Neri from ovmf +- maintainers.inc: unassign Richard Weinberger from erofs-utils entry +- mdadm: fix 07revert-inplace ptest +- mdadm: fix segfaults when running ptests +- mdadm: fix util-linux ptest dependency +- mdadm: skip running known broken ptests +- meson.bbclass: Point to llvm-config from native sysroot +- meta: lib: oe: npm_registry: Add more safe caracters +- migration-guides: add release notes for 4.0.11 +- minicom: remove unused patch files +- mobile-broadband-provider-info: upgrade to 20230416 +- oe-depends-dot: Handle new format for task-depends.dot +- oeqa/runtime/cases/rpm: fix wait_for_no_process_for_user failure case +- oeqa/selftest/bbtests: add non-existent prefile/postfile tests +- oeqa/selftest/devtool: add unit test for "devtool add -b" +- openssl: Upgrade to 3.0.10 +- openssl: add PERLEXTERNAL path to test its existence +- openssl: use a glob on the PERLEXTERNAL to track updates on the path +- package.bbclass: moving field data process before variable process in process_pkgconfig +- pm-utils: fix multilib conflictions +- poky.conf: bump version for 4.0.12 +- psmisc: Set :term:`ALTERNATIVE` for pstree to resolve conflict with busybox +- pybootchartgui: show elapsed time for each task +- python3: fix missing comma in get_module_deps3.py +- python3: upgrade to 3.10.12 +- recipetool: Fix inherit in created -native* recipes +- ref-manual: add LTS and Mixin terms +- ref-manual: document image-specific variant of :term:`INCOMPATIBLE_LICENSE` +- ref-manual: release-process: update for LTS releases +- rust-llvm: backport a fix for build with gcc-13 +- scripts/runqemu: allocate unfsd ports in a way that doesn't race or clash with unrelated processes +- scripts/runqemu: split lock dir creation into a reusable function +- sdk.py: error out when moving file fails +- sdk.py: fix moving dnf contents +- selftest reproducible.py: support different build targets +- selftest/license: Exclude from world +- selftest/reproducible: Allow chose the package manager +- serf: upgrade to 1.3.10 +- strace: Disable failing test +- strace: Merge two similar patches +- strace: Update patches/tests with upstream fixes +- sysfsutils: fetch a supported fork from github +- systemd-systemctl: fix errors in instance name expansion +- systemd: Backport nspawn: make sure host root can write to the uidmapped mounts we prepare for the container payload +- tzdata: upgrade to 2023c +- uboot-extlinux-config.bbclass: fix old override syntax in comment +- unzip: fix configure check for cross compilation +- useradd-staticids.bbclass: improve error message +- util-linux: add alternative links for ipcs,ipcrm +- v86d: Improve kernel dependency +- vim: upgrade to 9.0.1592 +- wget: upgrade to 1.21.4 +- wic: Add dependencies for erofs-utils +- wireless-regdb: upgrade to 2023.05.03 +- xdpyinfo: upgrade to 1.3.4 +- zip: fix configure check by using _Static_assert + + +Known Issues in Yocto-4.0.12 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.12 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alberto Planas +- Alexander Kanavin +- Alexander Sverdlin +- Andrej Valek +- Archana Polampalli +- BELOUARGA Mohamed +- Benjamin Bouvier +- Bruce Ashfield +- Charlie Wu +- Chen Qi +- Etienne Cordonnier +- Fabien Mahot +- Frieder Paape +- Frieder Schrempf +- Heiko Thole +- Hitendra Prajapati +- Jermain Horsman +- Jose Quaresma +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Marc Ferland +- Marek Vasut +- Martin Jansa +- Mauro Queiros +- Michael Opdenacker +- Mikko Rapeli +- Nikhil R +- Ovidiu Panait +- Peter Marko +- Poonam Jadhav +- Quentin Schulz +- Richard Purdie +- Ross Burton +- Rusty Howell +- Sakib Sajal +- Soumya Sambu +- Steve Sakoman +- Sundeep KOKKONDA +- Tim Orling +- Tom Hochstein +- Trevor Gamblin +- Vijay Anusuri +- Vivek Kumbhar +- Wang Mingyu +- Xiangyu Chen +- Yoann Congal +- Yogita Urade +- Yuta Hayama + + +Repositories / Downloads for Yocto-4.0.12 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.12 </poky/log/?h=yocto-4.0.12>` +- Git Revision: :yocto_git:`d6b8790370500b99ca11f0d8a05c39b661ab2ba6 </poky/commit/?id=d6b8790370500b99ca11f0d8a05c39b661ab2ba6>` +- Release Artefact: poky-d6b8790370500b99ca11f0d8a05c39b661ab2ba6 +- sha: 35f0390e0c5a12f403ed471c0b1254c13cbb9d7c7b46e5a3538e63e36c1ac280 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.12/poky-d6b8790370500b99ca11f0d8a05c39b661ab2ba6.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.12/poky-d6b8790370500b99ca11f0d8a05c39b661ab2ba6.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.12 </openembedded-core/log/?h=yocto-4.0.12>` +- Git Revision: :oe_git:`e1a604db8d2cf8782038b4016cc2e2052467333b </openembedded-core/commit/?id=e1a604db8d2cf8782038b4016cc2e2052467333b>` +- Release Artefact: oecore-e1a604db8d2cf8782038b4016cc2e2052467333b +- sha: 8b302eb3f3ffe5643f88bc6e4ae8f9a5cda63544d67e04637ecc4197e9750a1d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.12/oecore-e1a604db8d2cf8782038b4016cc2e2052467333b.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.12/oecore-e1a604db8d2cf8782038b4016cc2e2052467333b.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.12 </meta-mingw/log/?h=yocto-4.0.12>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.12/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.12/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.12 </meta-gplv2/log/?h=yocto-4.0.12>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.12/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.12/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.12 </bitbake/log/?h=yocto-4.0.12>` +- Git Revision: :oe_git:`41b6684489d0261753344956042be2cc4adb0159 </bitbake/commit/?id=41b6684489d0261753344956042be2cc4adb0159>` +- Release Artefact: bitbake-41b6684489d0261753344956042be2cc4adb0159 +- sha: efa2b1c4d0be115ed3960750d1e4ed958771b2db6d7baee2d13ad386589376e8 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.12/bitbake-41b6684489d0261753344956042be2cc4adb0159.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.12/bitbake-41b6684489d0261753344956042be2cc4adb0159.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.12 </yocto-docs/log/?h=yocto-4.0.12>` +- Git Revision: :yocto_git:`4dfef81ac6164764c6541e39a9fef81d49227096 </yocto-docs/commit/?id=4dfef81ac6164764c6541e39a9fef81d49227096>` + diff --git a/documentation/migration-guides/release-notes-4.0.13.rst b/documentation/migration-guides/release-notes-4.0.13.rst new file mode 100644 index 0000000000..3c096c356f --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.13.rst @@ -0,0 +1,271 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.13 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.13 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-2829` +- binutils: Fix :cve:`2022-48065` +- busybox: Fix :cve:`2022-48174` +- cups: Fix :cve:`2023-32360` +- curl: Fix :cve:`2023-32001` +- dmidecode: Fix :cve:`2023-30630` +- dropbear: Fix :cve:`2023-36328` +- ffmpeg: Ignored :cve:`2023-39018` +- file: Fix :cve:`2022-48554` +- flac: Fix :cve:`2020-22219` +- gcc: Fix :cve:`2023-4039` +- gdb: Fix :cve:`2023-39128` +- ghostscript: Fix :cve:`2023-38559` +- glib-2.0: Fix :cve:`2023-29499`, :cve:`2023-32611`, :cve:`2023-32636`, :cve:`2023-32643` and :cve:`2023-32665` +- go: Fix :cve:`2023-29409` and :cve:`2023-39319` +- gstreamer1.0-plugins-bad: Fix :cve_mitre:`2023-37329` +- gstreamer1.0-plugins-base: Fix :cve_mitre:`2023-37328` +- gstreamer1.0-plugins-good: Fix :cve_mitre:`2023-37327` +- inetutils: Fix :cve:`2023-40303` +- json-c: Fix :cve:`2021-32292` +- librsvg: Fix :cve:`2023-38633` +- libssh2: Fix :cve:`2020-22218` +- libtiff: Fix :cve:`2023-26966` +- libxml2: Fix :cve:`2023-39615` +- linux-yocto/5.15: Ignore :cve:`2003-1604`, :cve:`2004-0230`, :cve:`2006-3635`, :cve:`2006-5331`, :cve:`2006-6128`, :cve:`2007-4774`, :cve:`2007-6761`, :cve:`2007-6762`, :cve:`2008-7316`, :cve:`2009-2692`, :cve:`2010-0008`, :cve:`2010-3432`, :cve:`2010-4648`, :cve:`2010-5313`, :cve:`2010-5328`, :cve:`2010-5329`, :cve:`2010-5331`, :cve:`2010-5332`, :cve:`2011-4098`, :cve:`2011-4131`, :cve:`2011-4915`, :cve:`2011-5321`, :cve:`2011-5327`, :cve:`2012-0957`, :cve:`2012-2119`, :cve:`2012-2136`, :cve:`2012-2137`, :cve:`2012-2313`, :cve:`2012-2319`, :cve:`2012-2372`, :cve:`2012-2375`, :cve:`2012-2390`, :cve:`2012-2669`, :cve:`2012-2744`, :cve:`2012-2745`, :cve:`2012-3364`, :cve:`2012-3375`, :cve:`2012-3400`, :cve:`2012-3412`, :cve:`2012-3430`, :cve:`2012-3510`, :cve:`2012-3511`, :cve:`2012-3520`, :cve:`2012-3552`, :cve:`2012-4398`, :cve:`2012-4444`, :cve:`2012-4461`, :cve:`2012-4467`, :cve:`2012-4508`, :cve:`2012-4530`, :cve:`2012-4565`, :cve:`2012-5374`, :cve:`2012-5375`, :cve:`2012-5517`, :cve:`2012-6536`, :cve:`2012-6537`, :cve:`2012-6538`, :cve:`2012-6539`, :cve:`2012-6540`, :cve:`2012-6541`, :cve:`2012-6542`, :cve:`2012-6543`, :cve:`2012-6544`, :cve:`2012-6545`, :cve:`2012-6546`, :cve:`2012-6547`, :cve:`2012-6548`, :cve:`2012-6549`, :cve:`2012-6638`, :cve:`2012-6647`, :cve:`2012-6657`, :cve:`2012-6689`, :cve:`2012-6701`, :cve:`2012-6703`, :cve:`2012-6704`, :cve:`2012-6712`, :cve:`2013-0160`, :cve:`2013-0190`, :cve:`2013-0216`, :cve:`2013-0217`, :cve:`2013-0228`, :cve:`2013-0231`, :cve:`2013-0268`, :cve:`2013-0290`, :cve:`2013-0309`, :cve:`2013-0310`, :cve:`2013-0311`, :cve:`2013-0313`, :cve:`2013-0343`, :cve:`2013-0349`, :cve:`2013-0871`, :cve:`2013-0913`, :cve:`2013-0914`, :cve:`2013-1059`, :cve:`2013-1763`, :cve:`2013-1767`, :cve:`2013-1772`, :cve:`2013-1773`, :cve:`2013-1774`, :cve:`2013-1792`, :cve:`2013-1796`, :cve:`2013-1797`, :cve:`2013-1798`, :cve:`2013-1819`, :cve:`2013-1826`, :cve:`2013-1827`, :cve:`2013-1828`, :cve:`2013-1848`, :cve:`2013-1858`, :cve:`2013-1860`, :cve:`2013-1928`, :cve:`2013-1929`, :cve:`2013-1943`, :cve:`2013-1956`, :cve:`2013-1957`, :cve:`2013-1958`, :cve:`2013-1959`, :cve:`2013-1979`, :cve:`2013-2015`, :cve:`2013-2017`, :cve:`2013-2058`, :cve:`2013-2094`, :cve:`2013-2128`, :cve:`2013-2140`, :cve:`2013-2141`, :cve:`2013-2146`, :cve:`2013-2147`, :cve:`2013-2148`, :cve:`2013-2164`, :cve:`2013-2206`, :cve:`2013-2232`, :cve:`2013-2234`, :cve:`2013-2237`, :cve:`2013-2546`, :cve:`2013-2547`, :cve:`2013-2548`, :cve:`2013-2596`, :cve:`2013-2634`, :cve:`2013-2635`, :cve:`2013-2636`, :cve:`2013-2850`, :cve:`2013-2851`, :cve:`2013-2852`, :cve:`2013-2888`, :cve:`2013-2889`, :cve:`2013-2890`, :cve:`2013-2891`, :cve:`2013-2892`, :cve:`2013-2893`, :cve:`2013-2894`, :cve:`2013-2895`, :cve:`2013-2896`, :cve:`2013-2897`, :cve:`2013-2898`, :cve:`2013-2899`, :cve:`2013-2929`, :cve:`2013-2930`, :cve:`2013-3076`, :cve:`2013-3222`, :cve:`2013-3223`, :cve:`2013-3224`, :cve:`2013-3225`, :cve:`2013-3226`, :cve:`2013-3227`, :cve:`2013-3228`, :cve:`2013-3229`, :cve:`2013-3230`, :cve:`2013-3231`, :cve:`2013-3232`, :cve:`2013-3233`, :cve:`2013-3234`, :cve:`2013-3235`, :cve:`2013-3236`, :cve:`2013-3237`, :cve:`2013-3301`, :cve:`2013-3302`, :cve:`2013-4125`, :cve:`2013-4127`, :cve:`2013-4129`, :cve:`2013-4162`, :cve:`2013-4163`, :cve:`2013-4205`, :cve:`2013-4220`, :cve:`2013-4247`, :cve:`2013-4254`, :cve:`2013-4270`, :cve:`2013-4299`, :cve:`2013-4300`, :cve:`2013-4312`, :cve:`2013-4343`, :cve:`2013-4345`, :cve:`2013-4348`, :cve:`2013-4350`, :cve:`2013-4387`, :cve:`2013-4470`, :cve:`2013-4483`, :cve:`2013-4511`, :cve:`2013-4512`, :cve:`2013-4513`, :cve:`2013-4514`, :cve:`2013-4515`, :cve:`2013-4516`, :cve:`2013-4563`, :cve:`2013-4579`, :cve:`2013-4587`, :cve:`2013-4588`, :cve:`2013-4591`, :cve:`2013-4592`, :cve:`2013-5634`, :cve:`2013-6282`, :cve:`2013-6367`, :cve:`2013-6368`, :cve:`2013-6376`, :cve:`2013-6378`, :cve:`2013-6380`, :cve:`2013-6381`, :cve:`2013-6382`, :cve:`2013-6383`, :cve:`2013-6431`, :cve:`2013-6432`, :cve:`2013-6885`, :cve:`2013-7026`, :cve:`2013-7027`, :cve:`2013-7263`, :cve:`2013-7264`, :cve:`2013-7265`, :cve:`2013-7266`, :cve:`2013-7267`, :cve:`2013-7268`, :cve:`2013-7269`, :cve:`2013-7270`, :cve:`2013-7271`, :cve:`2013-7281`, :cve:`2013-7339`, :cve:`2013-7348`, :cve:`2013-7421`, :cve:`2013-7446`, :cve:`2013-7470`, :cve:`2014-0038`, :cve:`2014-0049`, :cve:`2014-0055`, :cve:`2014-0069`, :cve:`2014-0077`, :cve:`2014-0100`, :cve:`2014-0101`, :cve:`2014-0102`, :cve:`2014-0131`, :cve:`2014-0155`, :cve:`2014-0181`, :cve:`2014-0196`, :cve:`2014-0203`, :cve:`2014-0205`, :cve:`2014-0206`, :cve:`2014-1438`, :cve:`2014-1444`, :cve:`2014-1445`, :cve:`2014-1446`, :cve:`2014-1690`, :cve:`2014-1737`, :cve:`2014-1738`, :cve:`2014-1739`, :cve:`2014-1874`, :cve:`2014-2038`, :cve:`2014-2039`, :cve:`2014-2309`, :cve:`2014-2523`, :cve:`2014-2568`, :cve:`2014-2580`, :cve:`2014-2672`, :cve:`2014-2673`, :cve:`2014-2678`, :cve:`2014-2706`, :cve:`2014-2739`, :cve:`2014-2851`, :cve:`2014-2889`, :cve:`2014-3122`, :cve:`2014-3144`, :cve:`2014-3145`, :cve:`2014-3153`, :cve:`2014-3180`, :cve:`2014-3181`, :cve:`2014-3182`, :cve:`2014-3183`, :cve:`2014-3184`, :cve:`2014-3185`, :cve:`2014-3186`, :cve:`2014-3534`, :cve:`2014-3535`, :cve:`2014-3601`, :cve:`2014-3610`, :cve:`2014-3611`, :cve:`2014-3631`, :cve:`2014-3645`, :cve:`2014-3646`, :cve:`2014-3647`, :cve:`2014-3673`, :cve:`2014-3687`, :cve:`2014-3688`, :cve:`2014-3690`, :cve:`2014-3917`, :cve:`2014-3940`, :cve:`2014-4014`, :cve:`2014-4027`, :cve:`2014-4157`, :cve:`2014-4171`, :cve:`2014-4508`, :cve:`2014-4608`, :cve:`2014-4611`, :cve:`2014-4652`, :cve:`2014-4653`, :cve:`2014-4654`, :cve:`2014-4655`, :cve:`2014-4656`, :cve:`2014-4667`, :cve:`2014-4699`, :cve:`2014-4943`, :cve:`2014-5045`, :cve:`2014-5077`, :cve:`2014-5206`, :cve:`2014-5207`, :cve:`2014-5471`, :cve:`2014-5472`, :cve:`2014-6410`, :cve:`2014-6416`, :cve:`2014-6417`, :cve:`2014-6418`, :cve:`2014-7145`, :cve:`2014-7283`, :cve:`2014-7284`, :cve:`2014-7822`, :cve:`2014-7825`, :cve:`2014-7826`, :cve:`2014-7841`, :cve:`2014-7842`, :cve:`2014-7843`, :cve:`2014-7970`, :cve:`2014-7975`, :cve:`2014-8086`, :cve:`2014-8133`, :cve:`2014-8134`, :cve:`2014-8159`, :cve:`2014-8160`, :cve:`2014-8171`, :cve:`2014-8172`, :cve:`2014-8173`, :cve:`2014-8369`, :cve:`2014-8480`, :cve:`2014-8481`, :cve:`2014-8559`, :cve:`2014-8709`, :cve:`2014-8884`, :cve:`2014-8989`, :cve:`2014-9090`, :cve:`2014-9322`, :cve:`2014-9419`, :cve:`2014-9420`, :cve:`2014-9428`, :cve:`2014-9529`, :cve:`2014-9584`, :cve:`2014-9585`, :cve:`2014-9644`, :cve:`2014-9683`, :cve:`2014-9710`, :cve:`2014-9715`, :cve:`2014-9717`, :cve:`2014-9728`, :cve:`2014-9729`, :cve:`2014-9730`, :cve:`2014-9731`, :cve:`2014-9803`, :cve:`2014-9870`, :cve:`2014-9888`, :cve:`2014-9895`, :cve:`2014-9903`, :cve:`2014-9904`, :cve:`2014-9914`, :cve:`2014-9922`, :cve:`2014-9940`, :cve:`2015-0239`, :cve:`2015-0274`, :cve:`2015-0275`, :cve:`2015-1333`, :cve:`2015-1339`, :cve:`2015-1350`, :cve:`2015-1420`, :cve:`2015-1421`, :cve:`2015-1465`, :cve:`2015-1573`, :cve:`2015-1593`, :cve:`2015-1805`, :cve:`2015-2041`, :cve:`2015-2042`, :cve:`2015-2150`, :cve:`2015-2666`, :cve:`2015-2672`, :cve:`2015-2686`, :cve:`2015-2830`, :cve:`2015-2922`, :cve:`2015-2925`, :cve:`2015-3212`, :cve:`2015-3214`, :cve:`2015-3288`, :cve:`2015-3290`, :cve:`2015-3291`, :cve:`2015-3331`, :cve:`2015-3339`, :cve:`2015-3636`, :cve:`2015-4001`, :cve:`2015-4002`, :cve:`2015-4003`, :cve:`2015-4004`, :cve:`2015-4036`, :cve:`2015-4167`, :cve:`2015-4170`, :cve:`2015-4176`, :cve:`2015-4177`, :cve:`2015-4178`, :cve:`2015-4692`, :cve:`2015-4700`, :cve:`2015-5156`, :cve:`2015-5157`, :cve:`2015-5257`, :cve:`2015-5283`, :cve:`2015-5307`, :cve:`2015-5327`, :cve:`2015-5364`, :cve:`2015-5366`, :cve:`2015-5697`, :cve:`2015-5706`, :cve:`2015-5707`, :cve:`2015-6252`, :cve:`2015-6526`, :cve:`2015-6937`, :cve:`2015-7509`, :cve:`2015-7513`, :cve:`2015-7515`, :cve:`2015-7550`, :cve:`2015-7566`, :cve:`2015-7613`, :cve:`2015-7799`, :cve:`2015-7833`, :cve:`2015-7872`, :cve:`2015-7884`, :cve:`2015-7885`, :cve:`2015-7990`, :cve:`2015-8104`, :cve:`2015-8215`, :cve:`2015-8324`, :cve:`2015-8374`, :cve:`2015-8539`, :cve:`2015-8543`, :cve:`2015-8550`, :cve:`2015-8551`, :cve:`2015-8552`, :cve:`2015-8553`, :cve:`2015-8569`, :cve:`2015-8575`, :cve:`2015-8660`, :cve:`2015-8709`, :cve:`2015-8746`, :cve:`2015-8767`, :cve:`2015-8785`, :cve:`2015-8787`, :cve:`2015-8812`, :cve:`2015-8816`, :cve:`2015-8830`, :cve:`2015-8839`, :cve:`2015-8844`, :cve:`2015-8845`, :cve:`2015-8950`, :cve:`2015-8952`, :cve:`2015-8953`, :cve:`2015-8955`, :cve:`2015-8956`, :cve:`2015-8961`, :cve:`2015-8962`, :cve:`2015-8963`, :cve:`2015-8964`, :cve:`2015-8966`, :cve:`2015-8967`, :cve:`2015-8970`, :cve:`2015-9004`, :cve:`2015-9016`, :cve:`2015-9289`, :cve:`2016-0617`, :cve:`2016-0723`, :cve:`2016-0728`, :cve:`2016-0758`, :cve:`2016-0821`, :cve:`2016-0823`, :cve:`2016-10044`, :cve:`2016-10088`, :cve:`2016-10147`, :cve:`2016-10150`, :cve:`2016-10153`, :cve:`2016-10154`, :cve:`2016-10200`, :cve:`2016-10208`, :cve:`2016-10229`, :cve:`2016-10318`, :cve:`2016-10723`, :cve:`2016-10741`, :cve:`2016-10764`, :cve:`2016-10905`, :cve:`2016-10906`, :cve:`2016-10907`, :cve:`2016-1237`, :cve:`2016-1575`, :cve:`2016-1576`, :cve:`2016-1583`, :cve:`2016-2053`, :cve:`2016-2069`, :cve:`2016-2070`, :cve:`2016-2085`, :cve:`2016-2117`, :cve:`2016-2143`, :cve:`2016-2184`, :cve:`2016-2185`, :cve:`2016-2186`, :cve:`2016-2187`, :cve:`2016-2188`, :cve:`2016-2383`, :cve:`2016-2384`, :cve:`2016-2543`, :cve:`2016-2544`, :cve:`2016-2545`, :cve:`2016-2546`, :cve:`2016-2547`, :cve:`2016-2548`, :cve:`2016-2549`, :cve:`2016-2550`, :cve:`2016-2782`, :cve:`2016-2847`, :cve:`2016-3044`, :cve:`2016-3070`, :cve:`2016-3134`, :cve:`2016-3135`, :cve:`2016-3136`, :cve:`2016-3137`, :cve:`2016-3138`, :cve:`2016-3139`, :cve:`2016-3140`, :cve:`2016-3156`, :cve:`2016-3157`, :cve:`2016-3672`, :cve:`2016-3689`, :cve:`2016-3713`, :cve:`2016-3841`, :cve:`2016-3857`, :cve:`2016-3951`, :cve:`2016-3955`, :cve:`2016-3961`, :cve:`2016-4440`, :cve:`2016-4470`, :cve:`2016-4482`, :cve:`2016-4485`, :cve:`2016-4486`, :cve:`2016-4557`, :cve:`2016-4558`, :cve:`2016-4565`, :cve:`2016-4568`, :cve:`2016-4569`, :cve:`2016-4578`, :cve:`2016-4580`, :cve:`2016-4581`, :cve:`2016-4794`, :cve:`2016-4805`, :cve:`2016-4913`, :cve:`2016-4951`, :cve:`2016-4997`, :cve:`2016-4998`, :cve:`2016-5195`, :cve:`2016-5243`, :cve:`2016-5244`, :cve:`2016-5400`, :cve:`2016-5412`, :cve:`2016-5696`, :cve:`2016-5728`, :cve:`2016-5828`, :cve:`2016-5829`, :cve:`2016-6130`, :cve:`2016-6136`, :cve:`2016-6156`, :cve:`2016-6162`, :cve:`2016-6187`, :cve:`2016-6197`, :cve:`2016-6198`, :cve:`2016-6213`, :cve:`2016-6327`, :cve:`2016-6480`, :cve:`2016-6516`, :cve:`2016-6786`, :cve:`2016-6787`, :cve:`2016-6828`, :cve:`2016-7039`, :cve:`2016-7042`, :cve:`2016-7097`, :cve:`2016-7117`, :cve:`2016-7425`, :cve:`2016-7910`, :cve:`2016-7911`, :cve:`2016-7912`, :cve:`2016-7913`, :cve:`2016-7914`, :cve:`2016-7915`, :cve:`2016-7916`, :cve:`2016-7917`, :cve:`2016-8399`, :cve:`2016-8405`, :cve:`2016-8630`, :cve:`2016-8632`, :cve:`2016-8633`, :cve:`2016-8636`, :cve:`2016-8645`, :cve:`2016-8646`, :cve:`2016-8650`, :cve:`2016-8655`, :cve:`2016-8658`, :cve:`2016-8666`, :cve:`2016-9083`, :cve:`2016-9084`, :cve:`2016-9120`, :cve:`2016-9178`, :cve:`2016-9191`, :cve:`2016-9313`, :cve:`2016-9555`, :cve:`2016-9576`, :cve:`2016-9588`, :cve:`2016-9604`, :cve:`2016-9685`, :cve:`2016-9754`, :cve:`2016-9755`, :cve:`2016-9756`, :cve:`2016-9777`, :cve:`2016-9793`, :cve:`2016-9794`, :cve:`2016-9806`, :cve:`2016-9919`, :cve:`2017-0605`, :cve:`2017-0627`, :cve:`2017-0750`, :cve:`2017-0786`, :cve:`2017-0861`, :cve:`2017-1000`, :cve:`2017-1000111`, :cve:`2017-1000112`, :cve:`2017-1000251`, :cve:`2017-1000252`, :cve:`2017-1000253`, :cve:`2017-1000255`, :cve:`2017-1000363`, :cve:`2017-1000364`, :cve:`2017-1000365`, :cve:`2017-1000370`, :cve:`2017-1000371`, :cve:`2017-1000379`, :cve:`2017-1000380`, :cve:`2017-1000405`, :cve:`2017-1000407`, :cve:`2017-1000410`, :cve:`2017-10661`, :cve:`2017-10662`, :cve:`2017-10663`, :cve:`2017-10810`, :cve:`2017-10911`, :cve:`2017-11089`, :cve:`2017-11176`, :cve:`2017-11472`, :cve:`2017-11473`, :cve:`2017-11600`, :cve:`2017-12134`, :cve:`2017-12146`, :cve:`2017-12153`, :cve:`2017-12154`, :cve:`2017-12168`, :cve:`2017-12188`, :cve:`2017-12190`, :cve:`2017-12192`, :cve:`2017-12193`, :cve:`2017-12762`, :cve:`2017-13080`, :cve:`2017-13166`, :cve:`2017-13167`, :cve:`2017-13168`, :cve:`2017-13215`, :cve:`2017-13216`, :cve:`2017-13220`, :cve:`2017-13305`, :cve:`2017-13686`, :cve:`2017-13695`, :cve:`2017-13715`, :cve:`2017-14051`, :cve:`2017-14106`, :cve:`2017-14140`, :cve:`2017-14156`, :cve:`2017-14340`, :cve:`2017-14489`, :cve:`2017-14497`, :cve:`2017-14954`, :cve:`2017-14991`, :cve:`2017-15102`, :cve:`2017-15115`, :cve:`2017-15116`, :cve:`2017-15121`, :cve:`2017-15126`, :cve:`2017-15127`, :cve:`2017-15128`, :cve:`2017-15129`, :cve:`2017-15265`, :cve:`2017-15274`, :cve:`2017-15299`, :cve:`2017-15306`, :cve:`2017-15537`, :cve:`2017-15649`, :cve:`2017-15868`, :cve:`2017-15951`, :cve:`2017-16525`, :cve:`2017-16526`, :cve:`2017-16527`, :cve:`2017-16528`, :cve:`2017-16529`, :cve:`2017-16530`, :cve:`2017-16531`, :cve:`2017-16532`, :cve:`2017-16533`, :cve:`2017-16534`, :cve:`2017-16535`, :cve:`2017-16536`, :cve:`2017-16537`, :cve:`2017-16538`, :cve:`2017-16643`, :cve:`2017-16644`, :cve:`2017-16645`, :cve:`2017-16646`, :cve:`2017-16647`, :cve:`2017-16648`, :cve:`2017-16649`, :cve:`2017-16650`, :cve:`2017-16911`, :cve:`2017-16912`, :cve:`2017-16913`, :cve:`2017-16914`, :cve:`2017-16939`, :cve:`2017-16994`, :cve:`2017-16995`, :cve:`2017-16996`, :cve:`2017-17052`, :cve:`2017-17053`, :cve:`2017-17448`, :cve:`2017-17449`, :cve:`2017-17450`, :cve:`2017-17558`, :cve:`2017-17712`, :cve:`2017-17741`, :cve:`2017-17805`, :cve:`2017-17806`, :cve:`2017-17807`, :cve:`2017-17852`, :cve:`2017-17853`, :cve:`2017-17854`, :cve:`2017-17855`, :cve:`2017-17856`, :cve:`2017-17857`, :cve:`2017-17862`, :cve:`2017-17863`, :cve:`2017-17864`, :cve:`2017-17975`, :cve:`2017-18017`, :cve:`2017-18075`, :cve:`2017-18079`, :cve:`2017-18174`, :cve:`2017-18193`, :cve:`2017-18200`, :cve:`2017-18202`, :cve:`2017-18203`, :cve:`2017-18204`, :cve:`2017-18208`, :cve:`2017-18216`, :cve:`2017-18218`, :cve:`2017-18221`, :cve:`2017-18222`, :cve:`2017-18224`, :cve:`2017-18232`, :cve:`2017-18241`, :cve:`2017-18249`, :cve:`2017-18255`, :cve:`2017-18257`, :cve:`2017-18261`, :cve:`2017-18270`, :cve:`2017-18344`, :cve:`2017-18360`, :cve:`2017-18379`, :cve:`2017-18509`, :cve:`2017-18549`, :cve:`2017-18550`, :cve:`2017-18551`, :cve:`2017-18552`, :cve:`2017-18595`, :cve:`2017-2583`, :cve:`2017-2584`, :cve:`2017-2596`, :cve:`2017-2618`, :cve:`2017-2634`, :cve:`2017-2636`, :cve:`2017-2647`, :cve:`2017-2671`, :cve:`2017-5123`, :cve:`2017-5546`, :cve:`2017-5547`, :cve:`2017-5548`, :cve:`2017-5549`, :cve:`2017-5550`, :cve:`2017-5551`, :cve:`2017-5576`, :cve:`2017-5577`, :cve:`2017-5669`, :cve:`2017-5715`, :cve:`2017-5753`, :cve:`2017-5754`, :cve:`2017-5897`, :cve:`2017-5967`, :cve:`2017-5970`, :cve:`2017-5972`, :cve:`2017-5986`, :cve:`2017-6001`, :cve:`2017-6074`, :cve:`2017-6214`, :cve:`2017-6345`, :cve:`2017-6346`, :cve:`2017-6347`, :cve:`2017-6348`, :cve:`2017-6353`, :cve:`2017-6874`, :cve:`2017-6951`, :cve:`2017-7184`, :cve:`2017-7187`, :cve:`2017-7261`, :cve:`2017-7273`, :cve:`2017-7277`, :cve:`2017-7294`, :cve:`2017-7308`, :cve:`2017-7346`, :cve:`2017-7374`, :cve:`2017-7472`, :cve:`2017-7477`, :cve:`2017-7482`, :cve:`2017-7487`, :cve:`2017-7495`, :cve:`2017-7518`, :cve:`2017-7533`, :cve:`2017-7541`, :cve:`2017-7542`, :cve:`2017-7558`, :cve:`2017-7616`, :cve:`2017-7618`, :cve:`2017-7645`, :cve:`2017-7889`, :cve:`2017-7895`, :cve:`2017-7979`, :cve:`2017-8061`, :cve:`2017-8062`, :cve:`2017-8063`, :cve:`2017-8064`, :cve:`2017-8065`, :cve:`2017-8066`, :cve:`2017-8067`, :cve:`2017-8068`, :cve:`2017-8069`, :cve:`2017-8070`, :cve:`2017-8071`, :cve:`2017-8072`, :cve:`2017-8106`, :cve:`2017-8240`, :cve:`2017-8797`, :cve:`2017-8824`, :cve:`2017-8831`, :cve:`2017-8890`, :cve:`2017-8924`, :cve:`2017-8925`, :cve:`2017-9059`, :cve:`2017-9074`, :cve:`2017-9075`, :cve:`2017-9076`, :cve:`2017-9077`, :cve:`2017-9150`, :cve:`2017-9211`, :cve:`2017-9242`, :cve:`2017-9605`, :cve:`2017-9725`, :cve:`2017-9984`, :cve:`2017-9985`, :cve:`2017-9986`, :cve:`2018-1000004`, :cve:`2018-1000026`, :cve:`2018-1000028`, :cve:`2018-1000199`, :cve:`2018-1000200`, :cve:`2018-1000204`, :cve:`2018-10021`, :cve:`2018-10074`, :cve:`2018-10087`, :cve:`2018-10124`, :cve:`2018-10322`, :cve:`2018-10323`, :cve:`2018-1065`, :cve:`2018-1066`, :cve:`2018-10675`, :cve:`2018-1068`, :cve:`2018-10840`, :cve:`2018-10853`, :cve:`2018-1087`, :cve:`2018-10876`, :cve:`2018-10877`, :cve:`2018-10878`, :cve:`2018-10879`, :cve:`2018-10880`, :cve:`2018-10881`, :cve:`2018-10882`, :cve:`2018-10883`, :cve:`2018-10901`, :cve:`2018-10902`, :cve:`2018-1091`, :cve:`2018-1092`, :cve:`2018-1093`, :cve:`2018-10938`, :cve:`2018-1094`, :cve:`2018-10940`, :cve:`2018-1095`, :cve:`2018-1108`, :cve:`2018-1118`, :cve:`2018-1120`, :cve:`2018-11232`, :cve:`2018-1128`, :cve:`2018-1129`, :cve:`2018-1130`, :cve:`2018-11412`, :cve:`2018-11506`, :cve:`2018-11508`, :cve:`2018-12126`, :cve:`2018-12127`, :cve:`2018-12130`, :cve:`2018-12207`, :cve:`2018-12232`, :cve:`2018-12233`, :cve:`2018-12633`, :cve:`2018-12714`, :cve:`2018-12896`, :cve:`2018-12904`, :cve:`2018-13053`, :cve:`2018-13093`, :cve:`2018-13094`, :cve:`2018-13095`, :cve:`2018-13096`, :cve:`2018-13097`, :cve:`2018-13098`, :cve:`2018-13099`, :cve:`2018-13100`, :cve:`2018-13405`, :cve:`2018-13406`, :cve:`2018-14609`, :cve:`2018-14610`, :cve:`2018-14611`, :cve:`2018-14612`, :cve:`2018-14613`, :cve:`2018-14614`, :cve:`2018-14615`, :cve:`2018-14616`, :cve:`2018-14617`, :cve:`2018-14619`, :cve:`2018-14625`, :cve:`2018-14633`, :cve:`2018-14634`, :cve:`2018-14641`, :cve:`2018-14646`, :cve:`2018-14656`, :cve:`2018-14678`, :cve:`2018-14734`, :cve:`2018-15471`, :cve:`2018-15572`, :cve:`2018-15594`, :cve:`2018-16276`, :cve:`2018-16597`, :cve:`2018-16658`, :cve:`2018-16862`, :cve:`2018-16871`, :cve:`2018-16880`, :cve:`2018-16882`, :cve:`2018-16884`, :cve:`2018-17182`, :cve:`2018-17972`, :cve:`2018-18021`, :cve:`2018-18281`, :cve:`2018-18386`, :cve:`2018-18397`, :cve:`2018-18445`, :cve:`2018-18559`, :cve:`2018-18690`, :cve:`2018-18710`, :cve:`2018-18955`, :cve:`2018-19406`, :cve:`2018-19407`, :cve:`2018-19824`, :cve:`2018-19854`, :cve:`2018-19985`, :cve:`2018-20169`, :cve:`2018-20449`, :cve:`2018-20509`, :cve:`2018-20510`, :cve:`2018-20511`, :cve:`2018-20669`, :cve:`2018-20784`, :cve:`2018-20836`, :cve:`2018-20854`, :cve:`2018-20855`, :cve:`2018-20856`, :cve:`2018-20961`, :cve:`2018-20976`, :cve:`2018-21008`, :cve:`2018-25015`, :cve:`2018-25020`, :cve:`2018-3620`, :cve:`2018-3639`, :cve:`2018-3646`, :cve:`2018-3665`, :cve:`2018-3693`, :cve:`2018-5332`, :cve:`2018-5333`, :cve:`2018-5344`, :cve:`2018-5390`, :cve:`2018-5391`, :cve:`2018-5703`, :cve:`2018-5750`, :cve:`2018-5803`, :cve:`2018-5814`, :cve:`2018-5848`, :cve:`2018-5873`, :cve:`2018-5953`, :cve:`2018-5995`, :cve:`2018-6412`, :cve:`2018-6554`, :cve:`2018-6555`, :cve:`2018-6927`, :cve:`2018-7191`, :cve:`2018-7273`, :cve:`2018-7480`, :cve:`2018-7492`, :cve:`2018-7566`, :cve:`2018-7740`, :cve:`2018-7754`, :cve:`2018-7755`, :cve:`2018-7757`, :cve:`2018-7995`, :cve:`2018-8043`, :cve:`2018-8087`, :cve:`2018-8781`, :cve:`2018-8822`, :cve:`2018-8897`, :cve:`2018-9363`, :cve:`2018-9385`, :cve:`2018-9415`, :cve:`2018-9422`, :cve:`2018-9465`, :cve:`2018-9516`, :cve:`2018-9517`, :cve:`2018-9518`, :cve:`2018-9568`, :cve:`2019-0136`, :cve:`2019-0145`, :cve:`2019-0146`, :cve:`2019-0147`, :cve:`2019-0148`, :cve:`2019-0149`, :cve:`2019-0154`, :cve:`2019-0155`, :cve:`2019-10124`, :cve:`2019-10125`, :cve:`2019-10126`, :cve:`2019-10142`, :cve:`2019-10207`, :cve:`2019-10220`, :cve:`2019-10638`, :cve:`2019-10639`, :cve:`2019-11085`, :cve:`2019-11091`, :cve:`2019-11135`, :cve:`2019-11190`, :cve:`2019-11191`, :cve:`2019-1125`, :cve:`2019-11477`, :cve:`2019-11478`, :cve:`2019-11479`, :cve:`2019-11486`, :cve:`2019-11487`, :cve:`2019-11599`, :cve:`2019-11683`, :cve:`2019-11810`, :cve:`2019-11811`, :cve:`2019-11815`, :cve:`2019-11833`, :cve:`2019-11884`, :cve:`2019-12378`, :cve:`2019-12379`, :cve:`2019-12380`, :cve:`2019-12381`, :cve:`2019-12382`, :cve:`2019-12454`, :cve:`2019-12455`, :cve:`2019-12614`, :cve:`2019-12615`, :cve:`2019-12817`, :cve:`2019-12818`, :cve:`2019-12819`, :cve:`2019-12881`, :cve:`2019-12984`, :cve:`2019-13233`, :cve:`2019-13272`, :cve:`2019-13631`, :cve:`2019-13648`, :cve:`2019-14283`, :cve:`2019-14284`, :cve:`2019-14615`, :cve:`2019-14763`, :cve:`2019-14814`, :cve:`2019-14815`, :cve:`2019-14816`, :cve:`2019-14821`, :cve:`2019-14835`, :cve:`2019-14895`, :cve:`2019-14896`, :cve:`2019-14897`, :cve:`2019-14901`, :cve:`2019-15030`, :cve:`2019-15031`, :cve:`2019-15090`, :cve:`2019-15098`, :cve:`2019-15099`, :cve:`2019-15117`, :cve:`2019-15118`, :cve:`2019-15211`, :cve:`2019-15212`, :cve:`2019-15213`, :cve:`2019-15214`, :cve:`2019-15215`, :cve:`2019-15216`, :cve:`2019-15217`, :cve:`2019-15218`, :cve:`2019-15219`, :cve:`2019-15220`, :cve:`2019-15221`, :cve:`2019-15222`, :cve:`2019-15223`, :cve:`2019-15291`, :cve:`2019-15292`, :cve:`2019-15504`, :cve:`2019-15505`, :cve:`2019-15538`, :cve:`2019-15666`, :cve:`2019-15794`, :cve:`2019-15807`, :cve:`2019-15916`, :cve:`2019-15917`, :cve:`2019-15918`, :cve:`2019-15919`, :cve:`2019-15920`, :cve:`2019-15921`, :cve:`2019-15922`, :cve:`2019-15923`, :cve:`2019-15924`, :cve:`2019-15925`, :cve:`2019-15926`, :cve:`2019-15927`, :cve:`2019-16229`, :cve:`2019-16230`, :cve:`2019-16231`, :cve:`2019-16232`, :cve:`2019-16233`, :cve:`2019-16234`, :cve:`2019-16413`, :cve:`2019-16714`, :cve:`2019-16746`, :cve:`2019-16921`, :cve:`2019-16994`, :cve:`2019-16995`, :cve:`2019-17052`, :cve:`2019-17053`, :cve:`2019-17054`, :cve:`2019-17055`, :cve:`2019-17056`, :cve:`2019-17075`, :cve:`2019-17133`, :cve:`2019-17351`, :cve:`2019-17666`, :cve:`2019-18198`, :cve:`2019-18282`, :cve:`2019-18660`, :cve:`2019-18675`, :cve:`2019-18683`, :cve:`2019-18786`, :cve:`2019-18805`, :cve:`2019-18806`, :cve:`2019-18807`, :cve:`2019-18808`, :cve:`2019-18809`, :cve:`2019-18810`, :cve:`2019-18811`, :cve:`2019-18812`, :cve:`2019-18813`, :cve:`2019-18814`, :cve:`2019-18885`, :cve:`2019-19036`, :cve:`2019-19037`, :cve:`2019-19039`, :cve:`2019-19043`, :cve:`2019-19044`, :cve:`2019-19045`, :cve:`2019-19046`, :cve:`2019-19047`, :cve:`2019-19048`, :cve:`2019-19049`, :cve:`2019-19050`, :cve:`2019-19051`, :cve:`2019-19052`, :cve:`2019-19053`, :cve:`2019-19054`, :cve:`2019-19055`, :cve:`2019-19056`, :cve:`2019-19057`, :cve:`2019-19058`, :cve:`2019-19059`, :cve:`2019-19060`, :cve:`2019-19061`, :cve:`2019-19062`, :cve:`2019-19063`, :cve:`2019-19064`, :cve:`2019-19065`, :cve:`2019-19066`, :cve:`2019-19067`, :cve:`2019-19068`, :cve:`2019-19069`, :cve:`2019-19070`, :cve:`2019-19071`, :cve:`2019-19072`, :cve:`2019-19073`, :cve:`2019-19074`, :cve:`2019-19075`, :cve:`2019-19076`, :cve:`2019-19077`, :cve:`2019-19078`, :cve:`2019-19079`, :cve:`2019-19080`, :cve:`2019-19081`, :cve:`2019-19082`, :cve:`2019-19083`, :cve:`2019-19227`, :cve:`2019-19241`, :cve:`2019-19252`, :cve:`2019-19318`, :cve:`2019-19319`, :cve:`2019-19332`, :cve:`2019-19338`, :cve:`2019-19377`, :cve:`2019-19447`, :cve:`2019-19448`, :cve:`2019-19449`, :cve:`2019-19462`, :cve:`2019-19523`, :cve:`2019-19524`, :cve:`2019-19525`, :cve:`2019-19526`, :cve:`2019-19527`, :cve:`2019-19528`, :cve:`2019-19529`, :cve:`2019-19530`, :cve:`2019-19531`, :cve:`2019-19532`, :cve:`2019-19533`, :cve:`2019-19534`, :cve:`2019-19535`, :cve:`2019-19536`, :cve:`2019-19537`, :cve:`2019-19543`, :cve:`2019-19602`, :cve:`2019-19767`, :cve:`2019-19768`, :cve:`2019-19769`, :cve:`2019-19770`, :cve:`2019-19807`, :cve:`2019-19813`, :cve:`2019-19815`, :cve:`2019-19816`, :cve:`2019-19922`, :cve:`2019-19927`, :cve:`2019-19947`, :cve:`2019-19965` and :cve:`2019-1999` +- nasm: Fix :cve:`2020-21528` +- ncurses: Fix :cve:`2023-29491` +- nghttp2: Fix :cve:`2023-35945` +- procps: Fix :cve:`2023-4016` +- python3-certifi: Fix :cve:`2023-37920` +- python3-git: Fix :cve:`2022-24439` and :cve:`2023-40267` +- python3-pygments: Fix :cve:`2022-40896` +- python3: Fix :cve:`2023-40217` +- qemu: Fix :cve:`2020-14394`, :cve:`2021-3638`, :cve_mitre:`2023-2861`, :cve:`2023-3180` and :cve:`2023-3354` +- tiff: fix :cve:`2023-2908`, :cve:`2023-3316` and :cve:`2023-3618` +- vim: Fix :cve:`2023-3896`, :cve:`2023-4733`, :cve:`2023-4734`, :cve:`2023-4735`, :cve:`2023-4736`, :cve:`2023-4738`, :cve:`2023-4750` and :cve:`2023-4752` +- webkitgtk: fix :cve:`2022-48503` and :cve:`2023-23529` + + + +Fixes in Yocto-4.0.13 +~~~~~~~~~~~~~~~~~~~~~ + +- acl/attr: ptest fixes and improvements +- automake: fix buildtest patch +- bind: Upgrade to 9.18.17 +- binutils: stable 2.38 branch updates +- build-appliance-image: Update to kirkstone head revision +- build-sysroots: Add :term:`SUMMARY` field +- cargo.bbclass: set up cargo environment in common do_compile +- contributor-guide: recipe-style-guide: add Upstream-Status +- dbus: Specify runstatedir configure option +- dev-manual: common-tasks: mention faster "find" command to trim sstate cache +- dev-manual: disk-space: improve wording for obsolete sstate cache files +- dev-manual: licenses: mention :term:`SPDX` for license compliance +- dev-manual: licenses: update license manifest location +- dev-manual: new-recipe.rst fix inconsistency with contributor guide +- dev-manual: split common-tasks.rst +- dev-manual: wic.rst: Update native tools build command +- documentation/README: align with master +- efivar: backport 5 patches to fix build with gold +- externalsrc: fix dependency chain issues +- glibc-locale: use stricter matching for metapackages' runtime dependencies +- glibc/check-test-wrapper: don't emit warnings from ssh +- glibc: stable 2.35 branch updates +- gst-devtools: Upgrade to 1.20.7 +- gstreamer1.0-libav: Upgrade to 1.20.7 +- gstreamer1.0-omx: Upgrade to 1.20.7 +- gstreamer1.0-plugins-bad: Upgrade to 1.20.7 +- gstreamer1.0-plugins-base: Upgrade to 1.20.7 +- gstreamer1.0-plugins-good: Upgrade to 1.20.7 +- gstreamer1.0-plugins-ugly: Upgrade to 1.20.7 +- gstreamer1.0-python: Upgrade to 1.20.7 +- gstreamer1.0-rtsp-server: Upgrade to 1.20.7 +- gstreamer1.0-vaapi: Upgrade to 1.20.7 +- gstreamer1.0: Upgrade to 1.20.7 +- kernel: Fix path comparison in kernel staging dir symlinking +- lib/package_manager: Improve repo artefact filtering +- libdnf: resolve cstdint inclusion for newer gcc versions +- libnss-nis: Upgrade to 3.2 +- librsvg: Upgrade to 2.52.10 +- libxcrypt: update :term:`PV` to match :term:`SRCREV` +- linux-firmware : Add firmware of RTL8822 serie +- linux-firmware: Fix mediatek mt7601u firmware path +- linux-firmware: package firmware for Dragonboard 410c +- linux-firmware: split platform-specific Adreno shaders to separate packages +- linux-firmware: Upgrade to 20230625 +- linux-yocto/5.10: update to v5.10.188 +- linux-yocto/5.15: update to v5.15.124 +- linux-yocto: add script to generate kernel :term:`CVE_CHECK_IGNORE` entries +- linux/cve-exclusion: add generated CVE_CHECK_IGNORES. +- linux/cve-exclusion: remove obsolete manual entries +- manuals: add new contributor guide +- manuals: document "mime-xdg" class and :term:`MIME_XDG_PACKAGES` +- manuals: update former references to dev-manual/common-tasks +- mdadm: add util-linux-blockdev ptest dependency +- migration-guides: add release notes for 4.0.12 +- npm.bbclass: avoid DeprecationWarning with new python +- oeqa/runtime/ltp: Increase ltp test output timeout +- oeqa/ssh: Further improve process exit handling +- oeqa/target/ssh: Ensure EAGAIN doesn't truncate output +- oeqa/utils/nfs: allow requesting non-udp ports +- pixman: Remove duplication of license MIT +- poky.conf: bump version for 4.0.13 +- poky.conf: update :term:`SANITY_TESTED_DISTROS` to match autobuilder +- pseudo: Fix to work with glibc 2.38 +- python3-git: Upgrade to 3.1.32 +- python3: upgrade to 3.10.13 +- ref-manual: add Initramfs term +- ref-manual: add meson class and variables +- ref-manual: add new variables +- ref-manual: qa-checks: align with master +- ref-manual: system-requirements: update supported distros +- resulttool/report: Avoid divide by zero +- resulttool/resultutils: allow index generation despite corrupt json +- rootfs: Add debugfs package db file copy and cleanup +- rpm2cpio.sh: update to the last 4.x version +- rpm: Pick debugfs package db files/dirs explicitly +- scripts/create-pull-request: update URLs to git repositories +- scripts/rpm2cpio.sh: Use bzip2 instead of bunzip2 +- sdk-manual: extensible.rst: align with master branch +- selftest/cases/glibc.py: fix the override syntax +- selftest/cases/glibc.py: increase the memory for testing +- selftest/cases/glibc.py: switch to using NFS over TCP +- shadow-sysroot: add license information +- sysklogd: fix integration with systemd-journald +- tar: Upgrade to 1.35 +- target/ssh: Ensure exit code set for commands +- tcl: prevent installing another copy of tzdata +- template: fix typo in section header +- vim: Upgrade to 9.0.1894 +- vim: update obsolete comment +- wic: fix wrong attempt to create file system in unpartitioned regions +- yocto-uninative: Update to 4.2 for glibc 2.38 +- yocto-uninative: Update to 4.3 + + +Known Issues in Yocto-4.0.13 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.13 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Abe Kohandel +- Adrian Freihofer +- Alberto Planas +- Alex Kiernan +- Alexander Kanavin +- Alexis Lothoré +- Anuj Mittal +- Archana Polampalli +- Ashish Sharma +- BELOUARGA Mohamed +- Bruce Ashfield +- Changqing Li +- Dmitry Baryshkov +- Enrico Scholz +- Etienne Cordonnier +- Hitendra Prajapati +- Julien Stephan +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Marek Vasut +- Markus Niebel +- Martin Jansa +- Meenali Gupta +- Michael Halstead +- Michael Opdenacker +- Narpat Mali +- Ovidiu Panait +- Pavel Zhukov +- Peter Marko +- Peter Suti +- Poonam Jadhav +- Richard Purdie +- Roland Hieber +- Ross Burton +- Sanjana +- Siddharth Doshi +- Soumya Sambu +- Staffan Rydén +- Steve Sakoman +- Trevor Gamblin +- Vijay Anusuri +- Vivek Kumbhar +- Wang Mingyu +- Yogita Urade + + +Repositories / Downloads for Yocto-4.0.13 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.13 </poky/log/?h=yocto-4.0.13>` +- Git Revision: :yocto_git:`e51bf557f596c4da38789a948a3228ba11455e3c </poky/commit/?id=e51bf557f596c4da38789a948a3228ba11455e3c>` +- Release Artefact: poky-e51bf557f596c4da38789a948a3228ba11455e3c +- sha: afddadb367a90154751f04993077bceffdc1413f9ba9b8c03acb487d0437286e +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.13/poky-e51bf557f596c4da38789a948a3228ba11455e3c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.13/poky-e51bf557f596c4da38789a948a3228ba11455e3c.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.13 </openembedded-core/log/?h=yocto-4.0.13>` +- Git Revision: :oe_git:`d90e4d5e3cca9cffe8f60841afc63667a9ac39fa </openembedded-core/commit/?id=d90e4d5e3cca9cffe8f60841afc63667a9ac39fa>` +- Release Artefact: oecore-d90e4d5e3cca9cffe8f60841afc63667a9ac39fa +- sha: 56e3bdac81b3628e74dfef2132a54be4db7d87373139a00ed64f5c9a354d716a +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.13/oecore-d90e4d5e3cca9cffe8f60841afc63667a9ac39fa.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.13/oecore-d90e4d5e3cca9cffe8f60841afc63667a9ac39fa.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.13 </meta-mingw/log/?h=yocto-4.0.13>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.13/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.13/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.13 </meta-gplv2/log/?h=yocto-4.0.13>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.13/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.13/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.13 </bitbake/log/?h=yocto-4.0.13>` +- Git Revision: :oe_git:`41b6684489d0261753344956042be2cc4adb0159 </bitbake/commit/?id=41b6684489d0261753344956042be2cc4adb0159>` +- Release Artefact: bitbake-41b6684489d0261753344956042be2cc4adb0159 +- sha: efa2b1c4d0be115ed3960750d1e4ed958771b2db6d7baee2d13ad386589376e8 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.13/bitbake-41b6684489d0261753344956042be2cc4adb0159.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.13/bitbake-41b6684489d0261753344956042be2cc4adb0159.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.13 </yocto-docs/log/?h=yocto-4.0.13>` +- Git Revision: :yocto_git:`8f02741de867125f11a37822b2d206be180d4ee3 </yocto-docs/commit/?id=8f02741de867125f11a37822b2d206be180d4ee3>` + diff --git a/documentation/migration-guides/release-notes-4.0.14.rst b/documentation/migration-guides/release-notes-4.0.14.rst new file mode 100644 index 0000000000..02253f33f7 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.14.rst @@ -0,0 +1,227 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.14 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.14 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-3341` and :cve:`2023-4236` +- binutils: Fix :cve:`2022-44840`, :cve:`2022-45703`, :cve:`2022-47008`, :cve:`2022-47011`, :cve:`2022-47673`, :cve:`2022-47695`, :cve:`2022-47696` and :cve:`2022-48063` +- cups: Fix :cve:`2023-4504` +- curl: Fix :cve:`2023-38545` and :cve:`2023-38546` +- gawk: Fix :cve:`2023-4156` +- ghostscript: Fix :cve:`2023-43115` +- glibc: Fix :cve:`2023-4806`, :cve:`2023-4813`, :cve:`2023-4911` and :cve:`2023-5156` +- glibc: Ignore :cve:`2023-4527` +- go: Fix :cve:`2023-24538` and :cve:`2023-39318` +- gstreamer1.0-plugins-bad: fix :cve_mitre:`2023-40474`, :cve_mitre:`2023-40475` and :cve_mitre:`2023-40476` +- libtiff: Fix :cve:`2022-40090` and :cve:`2023-1916` +- libwebp: Fix :cve:`2023-5129` +- libx11: Fix :cve:`2023-43785`, :cve:`2023-43786` and :cve:`2023-43787` +- libxml2: Fix :cve:`2023-45322` +- libxpm: Fix :cve:`2023-43788` and :cve:`2023-43789` +- linux-firmware: Fix :cve:`2022-40982`, :cve:`2023-20569` and :cve:`2023-20593` +- linux-yocto: update CVE exclusions +- linux-yocto/5.10: Ignore :cve:`2003-1604`, :cve:`2004-0230`, :cve:`2006-3635`, :cve:`2006-5331`, :cve:`2006-6128`, :cve:`2007-4774`, :cve:`2007-6761`, :cve:`2007-6762`, :cve:`2008-7316`, :cve:`2009-2692`, :cve:`2010-0008`, :cve:`2010-3432`, :cve:`2010-4648`, :cve:`2010-5313`, :cve:`2010-5328`, :cve:`2010-5329`, :cve:`2010-5331`, :cve:`2010-5332`, :cve:`2011-4098`, :cve:`2011-4131`, :cve:`2011-4915`, :cve:`2011-5321`, :cve:`2011-5327`, :cve:`2012-0957`, :cve:`2012-2119`, :cve:`2012-2136`, :cve:`2012-2137`, :cve:`2012-2313`, :cve:`2012-2319`, :cve:`2012-2372`, :cve:`2012-2375`, :cve:`2012-2390`, :cve:`2012-2669`, :cve:`2012-2744`, :cve:`2012-2745`, :cve:`2012-3364`, :cve:`2012-3375`, :cve:`2012-3400`, :cve:`2012-3412`, :cve:`2012-3430`, :cve:`2012-3510`, :cve:`2012-3511`, :cve:`2012-3520`, :cve:`2012-3552`, :cve:`2012-4398`, :cve:`2012-4444`, :cve:`2012-4461`, :cve:`2012-4467`, :cve:`2012-4508`, :cve:`2012-4530`, :cve:`2012-4565`, :cve:`2012-5374`, :cve:`2012-5375`, :cve:`2012-5517`, :cve:`2012-6536`, :cve:`2012-6537`, :cve:`2012-6538`, :cve:`2012-6539`, :cve:`2012-6540`, :cve:`2012-6541`, :cve:`2012-6542`, :cve:`2012-6543`, :cve:`2012-6544`, :cve:`2012-6545`, :cve:`2012-6546`, :cve:`2012-6547`, :cve:`2012-6548`, :cve:`2012-6549`, :cve:`2012-6638`, :cve:`2012-6647`, :cve:`2012-6657`, :cve:`2012-6689`, :cve:`2012-6701`, :cve:`2012-6703`, :cve:`2012-6704`, :cve:`2012-6712`, :cve:`2013-0160`, :cve:`2013-0190`, :cve:`2013-0216`, :cve:`2013-0217`, :cve:`2013-0228`, :cve:`2013-0231`, :cve:`2013-0268`, :cve:`2013-0290`, :cve:`2013-0309`, :cve:`2013-0310`, :cve:`2013-0311`, :cve:`2013-0313`, :cve:`2013-0343`, :cve:`2013-0349`, :cve:`2013-0871`, :cve:`2013-0913`, :cve:`2013-0914`, :cve:`2013-1059`, :cve:`2013-1763`, :cve:`2013-1767`, :cve:`2013-1772`, :cve:`2013-1773`, :cve:`2013-1774`, :cve:`2013-1792`, :cve:`2013-1796`, :cve:`2013-1797`, :cve:`2013-1798`, :cve:`2013-1819`, :cve:`2013-1826`, :cve:`2013-1827`, :cve:`2013-1828`, :cve:`2013-1848`, :cve:`2013-1858`, :cve:`2013-1860`, :cve:`2013-1928`, :cve:`2013-1929`, :cve:`2013-1943`, :cve:`2013-1956`, :cve:`2013-1957`, :cve:`2013-1958`, :cve:`2013-1959`, :cve:`2013-1979`, :cve:`2013-2015`, :cve:`2013-2017`, :cve:`2013-2058`, :cve:`2013-2094`, :cve:`2013-2128`, :cve:`2013-2140`, :cve:`2013-2141`, :cve:`2013-2146`, :cve:`2013-2147`, :cve:`2013-2148`, :cve:`2013-2164`, :cve:`2013-2206`, :cve:`2013-2232`, :cve:`2013-2234`, :cve:`2013-2237`, :cve:`2013-2546`, :cve:`2013-2547`, :cve:`2013-2548`, :cve:`2013-2596`, :cve:`2013-2634`, :cve:`2013-2635`, :cve:`2013-2636`, :cve:`2013-2850`, :cve:`2013-2851`, :cve:`2013-2852`, :cve:`2013-2888`, :cve:`2013-2889`, :cve:`2013-2890`, :cve:`2013-2891`, :cve:`2013-2892`, :cve:`2013-2893`, :cve:`2013-2894`, :cve:`2013-2895`, :cve:`2013-2896`, :cve:`2013-2897`, :cve:`2013-2898`, :cve:`2013-2899`, :cve:`2013-2929`, :cve:`2013-2930`, :cve:`2013-3076`, :cve:`2013-3222`, :cve:`2013-3223`, :cve:`2013-3224`, :cve:`2013-3225`, :cve:`2013-3226`, :cve:`2013-3227`, :cve:`2013-3228`, :cve:`2013-3229`, :cve:`2013-3230`, :cve:`2013-3231`, :cve:`2013-3232`, :cve:`2013-3233`, :cve:`2013-3234`, :cve:`2013-3235`, :cve:`2013-3236`, :cve:`2013-3237`, :cve:`2013-3301`, :cve:`2013-3302`, :cve:`2013-4125`, :cve:`2013-4127`, :cve:`2013-4129`, :cve:`2013-4162`, :cve:`2013-4163`, :cve:`2013-4205`, :cve:`2013-4220`, :cve:`2013-4247`, :cve:`2013-4254`, :cve:`2013-4270`, :cve:`2013-4299`, :cve:`2013-4300`, :cve:`2013-4312`, :cve:`2013-4343`, :cve:`2013-4345`, :cve:`2013-4348`, :cve:`2013-4350`, :cve:`2013-4387`, :cve:`2013-4470`, :cve:`2013-4483`, :cve:`2013-4511`, :cve:`2013-4512`, :cve:`2013-4513`, :cve:`2013-4514`, :cve:`2013-4515`, :cve:`2013-4516`, :cve:`2013-4563`, :cve:`2013-4579`, :cve:`2013-4587`, :cve:`2013-4588`, :cve:`2013-4591`, :cve:`2013-4592`, :cve:`2013-5634`, :cve:`2013-6282`, :cve:`2013-6367`, :cve:`2013-6368`, :cve:`2013-6376`, :cve:`2013-6378`, :cve:`2013-6380`, :cve:`2013-6381`, :cve:`2013-6382`, :cve:`2013-6383`, :cve:`2013-6431`, :cve:`2013-6432`, :cve:`2013-6885`, :cve:`2013-7026`, :cve:`2013-7027`, :cve:`2013-7263`, :cve:`2013-7264`, :cve:`2013-7265`, :cve:`2013-7266`, :cve:`2013-7267`, :cve:`2013-7268`, :cve:`2013-7269`, :cve:`2013-7270`, :cve:`2013-7271`, :cve:`2013-7281`, :cve:`2013-7339`, :cve:`2013-7348`, :cve:`2013-7421`, :cve:`2013-7446`, :cve:`2013-7470`, :cve:`2014-0038`, :cve:`2014-0049`, :cve:`2014-0055`, :cve:`2014-0069`, :cve:`2014-0077`, :cve:`2014-0100`, :cve:`2014-0101`, :cve:`2014-0102`, :cve:`2014-0131`, :cve:`2014-0155`, :cve:`2014-0181`, :cve:`2014-0196`, :cve:`2014-0203`, :cve:`2014-0205`, :cve:`2014-0206`, :cve:`2014-1438`, :cve:`2014-1444`, :cve:`2014-1445`, :cve:`2014-1446`, :cve:`2014-1690`, :cve:`2014-1737`, :cve:`2014-1738`, :cve:`2014-1739`, :cve:`2014-1874`, :cve:`2014-2038`, :cve:`2014-2039`, :cve:`2014-2309`, :cve:`2014-2523`, :cve:`2014-2568`, :cve:`2014-2580`, :cve:`2014-2672`, :cve:`2014-2673`, :cve:`2014-2678`, :cve:`2014-2706`, :cve:`2014-2739`, :cve:`2014-2851`, :cve:`2014-2889`, :cve:`2014-3122`, :cve:`2014-3144`, :cve:`2014-3145`, :cve:`2014-3153`, :cve:`2014-3180`, :cve:`2014-3181`, :cve:`2014-3182`, :cve:`2014-3183`, :cve:`2014-3184`, :cve:`2014-3185`, :cve:`2014-3186`, :cve:`2014-3534`, :cve:`2014-3535`, :cve:`2014-3601`, :cve:`2014-3610`, :cve:`2014-3611`, :cve:`2014-3631`, :cve:`2014-3645`, :cve:`2014-3646`, :cve:`2014-3647`, :cve:`2014-3673`, :cve:`2014-3687`, :cve:`2014-3688`, :cve:`2014-3690`, :cve:`2014-3917`, :cve:`2014-3940`, :cve:`2014-4014`, :cve:`2014-4027`, :cve:`2014-4157`, :cve:`2014-4171`, :cve:`2014-4508`, :cve:`2014-4608`, :cve:`2014-4611`, :cve:`2014-4652`, :cve:`2014-4653`, :cve:`2014-4654`, :cve:`2014-4655`, :cve:`2014-4656`, :cve:`2014-4667`, :cve:`2014-4699`, :cve:`2014-4943`, :cve:`2014-5045`, :cve:`2014-5077`, :cve:`2014-5206`, :cve:`2014-5207`, :cve:`2014-5471`, :cve:`2014-5472`, :cve:`2014-6410`, :cve:`2014-6416`, :cve:`2014-6417`, :cve:`2014-6418`, :cve:`2014-7145`, :cve:`2014-7283`, :cve:`2014-7284`, :cve:`2014-7822`, :cve:`2014-7825`, :cve:`2014-7826`, :cve:`2014-7841`, :cve:`2014-7842`, :cve:`2014-7843`, :cve:`2014-7970`, :cve:`2014-7975`, :cve:`2014-8086`, :cve:`2014-8133`, :cve:`2014-8134`, :cve:`2014-8159`, :cve:`2014-8160`, :cve:`2014-8171`, :cve:`2014-8172`, :cve:`2014-8173`, :cve:`2014-8369`, :cve:`2014-8480`, :cve:`2014-8481`, :cve:`2014-8559`, :cve:`2014-8709`, :cve:`2014-8884`, :cve:`2014-8989`, :cve:`2014-9090`, :cve:`2014-9322`, :cve:`2014-9419`, :cve:`2014-9420`, :cve:`2014-9428`, :cve:`2014-9529`, :cve:`2014-9584`, :cve:`2014-9585`, :cve:`2014-9644`, :cve:`2014-9683`, :cve:`2014-9710`, :cve:`2014-9715`, :cve:`2014-9717`, :cve:`2014-9728`, :cve:`2014-9729`, :cve:`2014-9730`, :cve:`2014-9731`, :cve:`2014-9803`, :cve:`2014-9870`, :cve:`2014-9888`, :cve:`2014-9895`, :cve:`2014-9903`, :cve:`2014-9904`, :cve:`2014-9914`, :cve:`2014-9922`, :cve:`2014-9940`, :cve:`2015-0239`, :cve:`2015-0274`, :cve:`2015-0275`, :cve:`2015-1333`, :cve:`2015-1339`, :cve:`2015-1350`, :cve:`2015-1420`, :cve:`2015-1421`, :cve:`2015-1465`, :cve:`2015-1573`, :cve:`2015-1593`, :cve:`2015-1805`, :cve:`2015-2041`, :cve:`2015-2042`, :cve:`2015-2150`, :cve:`2015-2666`, :cve:`2015-2672`, :cve:`2015-2686`, :cve:`2015-2830`, :cve:`2015-2922`, :cve:`2015-2925`, :cve:`2015-3212`, :cve:`2015-3214`, :cve:`2015-3288`, :cve:`2015-3290`, :cve:`2015-3291`, :cve:`2015-3331`, :cve:`2015-3339`, :cve:`2015-3636`, :cve:`2015-4001`, :cve:`2015-4002`, :cve:`2015-4003`, :cve:`2015-4004`, :cve:`2015-4036`, :cve:`2015-4167`, :cve:`2015-4170`, :cve:`2015-4176`, :cve:`2015-4177`, :cve:`2015-4178`, :cve:`2015-4692`, :cve:`2015-4700`, :cve:`2015-5156`, :cve:`2015-5157`, :cve:`2015-5257`, :cve:`2015-5283`, :cve:`2015-5307`, :cve:`2015-5327`, :cve:`2015-5364`, :cve:`2015-5366`, :cve:`2015-5697`, :cve:`2015-5706`, :cve:`2015-5707`, :cve:`2015-6252`, :cve:`2015-6526`, :cve:`2015-6937`, :cve:`2015-7509`, :cve:`2015-7513`, :cve:`2015-7515`, :cve:`2015-7550`, :cve:`2015-7566`, :cve:`2015-7613`, :cve:`2015-7799`, :cve:`2015-7833`, :cve:`2015-7872`, :cve:`2015-7884`, :cve:`2015-7885`, :cve:`2015-7990`, :cve:`2015-8104`, :cve:`2015-8215`, :cve:`2015-8324`, :cve:`2015-8374`, :cve:`2015-8539`, :cve:`2015-8543`, :cve:`2015-8550`, :cve:`2015-8551`, :cve:`2015-8552`, :cve:`2015-8553`, :cve:`2015-8569`, :cve:`2015-8575`, :cve:`2015-8660`, :cve:`2015-8709`, :cve:`2015-8746`, :cve:`2015-8767`, :cve:`2015-8785`, :cve:`2015-8787`, :cve:`2015-8812`, :cve:`2015-8816`, :cve:`2015-8830`, :cve:`2015-8839`, :cve:`2015-8844`, :cve:`2015-8845`, :cve:`2015-8950`, :cve:`2015-8952`, :cve:`2015-8953`, :cve:`2015-8955`, :cve:`2015-8956`, :cve:`2015-8961`, :cve:`2015-8962`, :cve:`2015-8963`, :cve:`2015-8964`, :cve:`2015-8966`, :cve:`2015-8967`, :cve:`2015-8970`, :cve:`2015-9004`, :cve:`2015-9016`, :cve:`2015-9289`, :cve:`2016-0617`, :cve:`2016-0723`, :cve:`2016-0728`, :cve:`2016-0758`, :cve:`2016-0821`, :cve:`2016-0823`, :cve:`2016-10044`, :cve:`2016-10088`, :cve:`2016-10147`, :cve:`2016-10150`, :cve:`2016-10153`, :cve:`2016-10154`, :cve:`2016-10200`, :cve:`2016-10208`, :cve:`2016-10229`, :cve:`2016-10318`, :cve:`2016-10723`, :cve:`2016-10741`, :cve:`2016-10764`, :cve:`2016-10905`, :cve:`2016-10906`, :cve:`2016-10907`, :cve:`2016-1237`, :cve:`2016-1575`, :cve:`2016-1576`, :cve:`2016-1583`, :cve:`2016-2053`, :cve:`2016-2069`, :cve:`2016-2070`, :cve:`2016-2085`, :cve:`2016-2117`, :cve:`2016-2143`, :cve:`2016-2184`, :cve:`2016-2185`, :cve:`2016-2186`, :cve:`2016-2187`, :cve:`2016-2188`, :cve:`2016-2383`, :cve:`2016-2384`, :cve:`2016-2543`, :cve:`2016-2544`, :cve:`2016-2545`, :cve:`2016-2546`, :cve:`2016-2547`, :cve:`2016-2548`, :cve:`2016-2549`, :cve:`2016-2550`, :cve:`2016-2782`, :cve:`2016-2847`, :cve:`2016-3044`, :cve:`2016-3070`, :cve:`2016-3134`, :cve:`2016-3135`, :cve:`2016-3136`, :cve:`2016-3137`, :cve:`2016-3138`, :cve:`2016-3139`, :cve:`2016-3140`, :cve:`2016-3156`, :cve:`2016-3157`, :cve:`2016-3672`, :cve:`2016-3689`, :cve:`2016-3713`, :cve:`2016-3841`, :cve:`2016-3857`, :cve:`2016-3951`, :cve:`2016-3955`, :cve:`2016-3961`, :cve:`2016-4440`, :cve:`2016-4470`, :cve:`2016-4482`, :cve:`2016-4485`, :cve:`2016-4486`, :cve:`2016-4557`, :cve:`2016-4558`, :cve:`2016-4565`, :cve:`2016-4568`, :cve:`2016-4569`, :cve:`2016-4578`, :cve:`2016-4580`, :cve:`2016-4581`, :cve:`2016-4794`, :cve:`2016-4805`, :cve:`2016-4913`, :cve:`2016-4951`, :cve:`2016-4997`, :cve:`2016-4998`, :cve:`2016-5195`, :cve:`2016-5243`, :cve:`2016-5244`, :cve:`2016-5400`, :cve:`2016-5412`, :cve:`2016-5696`, :cve:`2016-5728`, :cve:`2016-5828`, :cve:`2016-5829`, :cve:`2016-6130`, :cve:`2016-6136`, :cve:`2016-6156`, :cve:`2016-6162`, :cve:`2016-6187`, :cve:`2016-6197`, :cve:`2016-6198`, :cve:`2016-6213`, :cve:`2016-6327`, :cve:`2016-6480`, :cve:`2016-6516`, :cve:`2016-6786`, :cve:`2016-6787`, :cve:`2016-6828`, :cve:`2016-7039`, :cve:`2016-7042`, :cve:`2016-7097`, :cve:`2016-7117`, :cve:`2016-7425`, :cve:`2016-7910`, :cve:`2016-7911`, :cve:`2016-7912`, :cve:`2016-7913`, :cve:`2016-7914`, :cve:`2016-7915`, :cve:`2016-7916`, :cve:`2016-7917`, :cve:`2016-8399`, :cve:`2016-8405`, :cve:`2016-8630`, :cve:`2016-8632`, :cve:`2016-8633`, :cve:`2016-8636`, :cve:`2016-8645`, :cve:`2016-8646`, :cve:`2016-8650`, :cve:`2016-8655`, :cve:`2016-8658`, :cve:`2016-8666`, :cve:`2016-9083`, :cve:`2016-9084`, :cve:`2016-9120`, :cve:`2016-9178`, :cve:`2016-9191`, :cve:`2016-9313`, :cve:`2016-9555`, :cve:`2016-9576`, :cve:`2016-9588`, :cve:`2016-9604`, :cve:`2016-9685`, :cve:`2016-9754`, :cve:`2016-9755`, :cve:`2016-9756`, :cve:`2016-9777`, :cve:`2016-9793`, :cve:`2016-9794`, :cve:`2016-9806`, :cve:`2016-9919`, :cve:`2017-0605`, :cve:`2017-0627`, :cve:`2017-0750`, :cve:`2017-0786`, :cve:`2017-0861`, :cve:`2017-1000`, :cve:`2017-1000111`, :cve:`2017-1000112`, :cve:`2017-1000251`, :cve:`2017-1000252`, :cve:`2017-1000253`, :cve:`2017-1000255`, :cve:`2017-1000363`, :cve:`2017-1000364`, :cve:`2017-1000365`, :cve:`2017-1000370`, :cve:`2017-1000371`, :cve:`2017-1000379`, :cve:`2017-1000380`, :cve:`2017-1000405`, :cve:`2017-1000407`, :cve:`2017-1000410`, :cve:`2017-10661`, :cve:`2017-10662`, :cve:`2017-10663`, :cve:`2017-10810`, :cve:`2017-10911`, :cve:`2017-11089`, :cve:`2017-11176`, :cve:`2017-11472`, :cve:`2017-11473`, :cve:`2017-11600`, :cve:`2017-12134`, :cve:`2017-12146`, :cve:`2017-12153`, :cve:`2017-12154`, :cve:`2017-12168`, :cve:`2017-12188`, :cve:`2017-12190`, :cve:`2017-12192`, :cve:`2017-12193`, :cve:`2017-12762`, :cve:`2017-13080`, :cve:`2017-13166`, :cve:`2017-13167`, :cve:`2017-13168`, :cve:`2017-13215`, :cve:`2017-13216`, :cve:`2017-13220`, :cve:`2017-13305`, :cve:`2017-13686`, :cve:`2017-13695`, :cve:`2017-13715`, :cve:`2017-14051`, :cve:`2017-14106`, :cve:`2017-14140`, :cve:`2017-14156`, :cve:`2017-14340`, :cve:`2017-14489`, :cve:`2017-14497`, :cve:`2017-14954`, :cve:`2017-14991`, :cve:`2017-15102`, :cve:`2017-15115`, :cve:`2017-15116`, :cve:`2017-15121`, :cve:`2017-15126`, :cve:`2017-15127`, :cve:`2017-15128`, :cve:`2017-15129`, :cve:`2017-15265`, :cve:`2017-15274`, :cve:`2017-15299`, :cve:`2017-15306`, :cve:`2017-15537`, :cve:`2017-15649`, :cve:`2017-15868`, :cve:`2017-15951`, :cve:`2017-16525`, :cve:`2017-16526`, :cve:`2017-16527`, :cve:`2017-16528`, :cve:`2017-16529`, :cve:`2017-16530`, :cve:`2017-16531`, :cve:`2017-16532`, :cve:`2017-16533`, :cve:`2017-16534`, :cve:`2017-16535`, :cve:`2017-16536`, :cve:`2017-16537`, :cve:`2017-16538`, :cve:`2017-16643`, :cve:`2017-16644`, :cve:`2017-16645`, :cve:`2017-16646`, :cve:`2017-16647`, :cve:`2017-16648`, :cve:`2017-16649`, :cve:`2017-16650`, :cve:`2017-16911`, :cve:`2017-16912`, :cve:`2017-16913`, :cve:`2017-16914`, :cve:`2017-16939`, :cve:`2017-16994`, :cve:`2017-16995`, :cve:`2017-16996`, :cve:`2017-17052`, :cve:`2017-17053`, :cve:`2017-17448`, :cve:`2017-17449`, :cve:`2017-17450`, :cve:`2017-17558`, :cve:`2017-17712`, :cve:`2017-17741`, :cve:`2017-17805`, :cve:`2017-17806`, :cve:`2017-17807`, :cve:`2017-17852`, :cve:`2017-17853`, :cve:`2017-17854`, :cve:`2017-17855`, :cve:`2017-17856`, :cve:`2017-17857`, :cve:`2017-17862`, :cve:`2017-17863`, :cve:`2017-17864`, :cve:`2017-17975`, :cve:`2017-18017`, :cve:`2017-18075`, :cve:`2017-18079`, :cve:`2017-18174`, :cve:`2017-18193`, :cve:`2017-18200`, :cve:`2017-18202`, :cve:`2017-18203`, :cve:`2017-18204`, :cve:`2017-18208`, :cve:`2017-18216`, :cve:`2017-18218`, :cve:`2017-18221`, :cve:`2017-18222`, :cve:`2017-18224`, :cve:`2017-18232`, :cve:`2017-18241`, :cve:`2017-18249`, :cve:`2017-18255`, :cve:`2017-18257`, :cve:`2017-18261`, :cve:`2017-18270`, :cve:`2017-18344`, :cve:`2017-18360`, :cve:`2017-18379`, :cve:`2017-18509`, :cve:`2017-18549`, :cve:`2017-18550`, :cve:`2017-18551`, :cve:`2017-18552`, :cve:`2017-18595`, :cve:`2017-2583`, :cve:`2017-2584`, :cve:`2017-2596`, :cve:`2017-2618`, :cve:`2017-2634`, :cve:`2017-2636`, :cve:`2017-2647`, :cve:`2017-2671`, :cve:`2017-5123`, :cve:`2017-5546`, :cve:`2017-5547`, :cve:`2017-5548`, :cve:`2017-5549`, :cve:`2017-5550`, :cve:`2017-5551`, :cve:`2017-5576`, :cve:`2017-5577`, :cve:`2017-5669`, :cve:`2017-5715`, :cve:`2017-5753`, :cve:`2017-5754`, :cve:`2017-5897`, :cve:`2017-5967`, :cve:`2017-5970`, :cve:`2017-5972`, :cve:`2017-5986`, :cve:`2017-6001`, :cve:`2017-6074`, :cve:`2017-6214`, :cve:`2017-6345`, :cve:`2017-6346`, :cve:`2017-6347`, :cve:`2017-6348`, :cve:`2017-6353`, :cve:`2017-6874`, :cve:`2017-6951`, :cve:`2017-7184`, :cve:`2017-7187`, :cve:`2017-7261`, :cve:`2017-7273`, :cve:`2017-7277`, :cve:`2017-7294`, :cve:`2017-7308`, :cve:`2017-7346`, :cve:`2017-7374`, :cve:`2017-7472`, :cve:`2017-7477`, :cve:`2017-7482`, :cve:`2017-7487`, :cve:`2017-7495`, :cve:`2017-7518`, :cve:`2017-7533`, :cve:`2017-7541`, :cve:`2017-7542`, :cve:`2017-7558`, :cve:`2017-7616`, :cve:`2017-7618`, :cve:`2017-7645`, :cve:`2017-7889`, :cve:`2017-7895`, :cve:`2017-7979`, :cve:`2017-8061`, :cve:`2017-8062`, :cve:`2017-8063`, :cve:`2017-8064`, :cve:`2017-8065`, :cve:`2017-8066`, :cve:`2017-8067`, :cve:`2017-8068`, :cve:`2017-8069`, :cve:`2017-8070`, :cve:`2017-8071`, :cve:`2017-8072`, :cve:`2017-8106`, :cve:`2017-8240`, :cve:`2017-8797`, :cve:`2017-8824`, :cve:`2017-8831`, :cve:`2017-8890`, :cve:`2017-8924`, :cve:`2017-8925`, :cve:`2017-9059`, :cve:`2017-9074`, :cve:`2017-9075`, :cve:`2017-9076`, :cve:`2017-9077`, :cve:`2017-9150`, :cve:`2017-9211`, :cve:`2017-9242`, :cve:`2017-9605`, :cve:`2017-9725`, :cve:`2017-9984`, :cve:`2017-9985`, :cve:`2017-9986`, :cve:`2018-1000004`, :cve:`2018-1000026`, :cve:`2018-1000028`, :cve:`2018-1000199`, :cve:`2018-1000200`, :cve:`2018-1000204`, :cve:`2018-10021`, :cve:`2018-10074`, :cve:`2018-10087`, :cve:`2018-10124`, :cve:`2018-10322`, :cve:`2018-10323`, :cve:`2018-1065`, :cve:`2018-1066`, :cve:`2018-10675`, :cve:`2018-1068`, :cve:`2018-10840`, :cve:`2018-10853`, :cve:`2018-1087`, :cve:`2018-10876`, :cve:`2018-10877`, :cve:`2018-10878`, :cve:`2018-10879`, :cve:`2018-10880`, :cve:`2018-10881`, :cve:`2018-10882`, :cve:`2018-10883`, :cve:`2018-10901`, :cve:`2018-10902`, :cve:`2018-1091`, :cve:`2018-1092`, :cve:`2018-1093`, :cve:`2018-10938`, :cve:`2018-1094`, :cve:`2018-10940`, :cve:`2018-1095`, :cve:`2018-1108`, :cve:`2018-1118`, :cve:`2018-1120`, :cve:`2018-11232`, :cve:`2018-1128`, :cve:`2018-1129`, :cve:`2018-1130`, :cve:`2018-11412`, :cve:`2018-11506`, :cve:`2018-11508`, :cve:`2018-12126`, :cve:`2018-12127`, :cve:`2018-12130`, :cve:`2018-12207`, :cve:`2018-12232`, :cve:`2018-12233`, :cve:`2018-12633`, :cve:`2018-12714`, :cve:`2018-12896`, :cve:`2018-12904`, :cve:`2018-13053`, :cve:`2018-13093`, :cve:`2018-13094`, :cve:`2018-13095`, :cve:`2018-13096`, :cve:`2018-13097`, :cve:`2018-13098`, :cve:`2018-13099`, :cve:`2018-13100`, :cve:`2018-13405`, :cve:`2018-13406`, :cve:`2018-14609`, :cve:`2018-14610`, :cve:`2018-14611`, :cve:`2018-14612`, :cve:`2018-14613`, :cve:`2018-14614`, :cve:`2018-14615`, :cve:`2018-14616`, :cve:`2018-14617`, :cve:`2018-14619`, :cve:`2018-14625`, :cve:`2018-14633`, :cve:`2018-14634`, :cve:`2018-14641`, :cve:`2018-14646`, :cve:`2018-14656`, :cve:`2018-14678`, :cve:`2018-14734`, :cve:`2018-15471`, :cve:`2018-15572`, :cve:`2018-15594`, :cve:`2018-16276`, :cve:`2018-16597`, :cve:`2018-16658`, :cve:`2018-16862`, :cve:`2018-16871`, :cve:`2018-16880`, :cve:`2018-16882`, :cve:`2018-16884`, :cve:`2018-17182`, :cve:`2018-17972`, :cve:`2018-18021`, :cve:`2018-18281`, :cve:`2018-18386`, :cve:`2018-18397`, :cve:`2018-18445`, :cve:`2018-18559`, :cve:`2018-18690`, :cve:`2018-18710`, :cve:`2018-18955`, :cve:`2018-19406`, :cve:`2018-19407`, :cve:`2018-19824`, :cve:`2018-19854`, :cve:`2018-19985`, :cve:`2018-20169`, :cve:`2018-20449`, :cve:`2018-20509`, :cve:`2018-20510`, :cve:`2018-20511`, :cve:`2018-20669`, :cve:`2018-20784`, :cve:`2018-20836`, :cve:`2018-20854`, :cve:`2018-20855`, :cve:`2018-20856`, :cve:`2018-20961`, :cve:`2018-20976`, :cve:`2018-21008`, :cve:`2018-25015`, :cve:`2018-25020`, :cve:`2018-3620`, :cve:`2018-3639`, :cve:`2018-3646`, :cve:`2018-3665`, :cve:`2018-3693`, :cve:`2018-5332`, :cve:`2018-5333`, :cve:`2018-5344`, :cve:`2018-5390`, :cve:`2018-5391`, :cve:`2018-5703`, :cve:`2018-5750`, :cve:`2018-5803`, :cve:`2018-5814`, :cve:`2018-5848`, :cve:`2018-5873`, :cve:`2018-5953`, :cve:`2018-5995`, :cve:`2018-6412`, :cve:`2018-6554`, :cve:`2018-6555`, :cve:`2018-6927`, :cve:`2018-7191`, :cve:`2018-7273`, :cve:`2018-7480`, :cve:`2018-7492`, :cve:`2018-7566`, :cve:`2018-7740`, :cve:`2018-7754`, :cve:`2018-7755`, :cve:`2018-7757`, :cve:`2018-7995`, :cve:`2018-8043`, :cve:`2018-8087`, :cve:`2018-8781`, :cve:`2018-8822`, :cve:`2018-8897`, :cve:`2018-9363`, :cve:`2018-9385`, :cve:`2018-9415`, :cve:`2018-9422`, :cve:`2018-9465`, :cve:`2018-9516`, :cve:`2018-9517`, :cve:`2018-9518`, :cve:`2018-9568`, :cve:`2019-0136`, :cve:`2019-0145`, :cve:`2019-0146`, :cve:`2019-0147`, :cve:`2019-0148`, :cve:`2019-0149`, :cve:`2019-0154`, :cve:`2019-0155`, :cve:`2019-10124`, :cve:`2019-10125`, :cve:`2019-10126`, :cve:`2019-10142`, :cve:`2019-10207`, :cve:`2019-10220`, :cve:`2019-10638`, :cve:`2019-10639`, :cve:`2019-11085`, :cve:`2019-11091`, :cve:`2019-11135`, :cve:`2019-11190`, :cve:`2019-11191`, :cve:`2019-1125`, :cve:`2019-11477`, :cve:`2019-11478`, :cve:`2019-11479`, :cve:`2019-11486`, :cve:`2019-11487`, :cve:`2019-11599`, :cve:`2019-11683`, :cve:`2019-11810`, :cve:`2019-11811`, :cve:`2019-11815`, :cve:`2019-11833`, :cve:`2019-11884`, :cve:`2019-12378`, :cve:`2019-12379`, :cve:`2019-12380`, :cve:`2019-12381`, :cve:`2019-12382`, :cve:`2019-12454`, :cve:`2019-12455`, :cve:`2019-12614`, :cve:`2019-12615`, :cve:`2019-12817`, :cve:`2019-12818`, :cve:`2019-12819`, :cve:`2019-12881`, :cve:`2019-12984`, :cve:`2019-13233`, :cve:`2019-13272`, :cve:`2019-13631`, :cve:`2019-13648`, :cve:`2019-14283`, :cve:`2019-14284`, :cve:`2019-14615`, :cve:`2019-14763`, :cve:`2019-14814`, :cve:`2019-14815`, :cve:`2019-14816`, :cve:`2019-14821`, :cve:`2019-14835`, :cve:`2019-14895`, :cve:`2019-14896`, :cve:`2019-14897`, :cve:`2019-14901`, :cve:`2019-15030`, :cve:`2019-15031`, :cve:`2019-15090`, :cve:`2019-15098`, :cve:`2019-15099`, :cve:`2019-15117`, :cve:`2019-15118`, :cve:`2019-15211`, :cve:`2019-15212`, :cve:`2019-15213`, :cve:`2019-15214`, :cve:`2019-15215`, :cve:`2019-15216`, :cve:`2019-15217`, :cve:`2019-15218`, :cve:`2019-15219`, :cve:`2019-15220`, :cve:`2019-15221`, :cve:`2019-15222`, :cve:`2019-15223`, :cve:`2019-15291`, :cve:`2019-15292`, :cve:`2019-15504`, :cve:`2019-15505`, :cve:`2019-15538`, :cve:`2019-15666`, :cve:`2019-15807`, :cve:`2019-15916`, :cve:`2019-15917`, :cve:`2019-15918`, :cve:`2019-15919`, :cve:`2019-15920`, :cve:`2019-15921`, :cve:`2019-15922`, :cve:`2019-15923`, :cve:`2019-15924`, :cve:`2019-15925`, :cve:`2019-15926`, :cve:`2019-15927`, :cve:`2019-16229`, :cve:`2019-16230`, :cve:`2019-16231`, :cve:`2019-16232`, :cve:`2019-16233`, :cve:`2019-16234`, :cve:`2019-16413`, :cve:`2019-16714`, :cve:`2019-16746`, :cve:`2019-16921`, :cve:`2019-16994`, :cve:`2019-16995`, :cve:`2019-17052`, :cve:`2019-17053`, :cve:`2019-17054`, :cve:`2019-17055`, :cve:`2019-17056`, :cve:`2019-17075`, :cve:`2019-17133`, :cve:`2019-17351`, :cve:`2019-17666`, :cve:`2019-18198`, :cve:`2019-18282`, :cve:`2019-18660`, :cve:`2019-18675`, :cve:`2019-18683`, :cve:`2019-18786`, :cve:`2019-18805`, :cve:`2019-18806`, :cve:`2019-18807`, :cve:`2019-18808`, :cve:`2019-18809`, :cve:`2019-18810`, :cve:`2019-18811`, :cve:`2019-18812`, :cve:`2019-18813`, :cve:`2019-18814`, :cve:`2019-18885`, :cve:`2019-19036`, :cve:`2019-19037`, :cve:`2019-19039`, :cve:`2019-19043`, :cve:`2019-19044`, :cve:`2019-19045`, :cve:`2019-19046`, :cve:`2019-19047`, :cve:`2019-19048`, :cve:`2019-19049`, :cve:`2019-19050`, :cve:`2019-19051`, :cve:`2019-19052`, :cve:`2019-19053`, :cve:`2019-19054`, :cve:`2019-19055`, :cve:`2019-19056`, :cve:`2019-19057`, :cve:`2019-19058`, :cve:`2019-19059`, :cve:`2019-19060`, :cve:`2019-19061`, :cve:`2019-19062`, :cve:`2019-19063`, :cve:`2019-19064`, :cve:`2019-19065`, :cve:`2019-19066`, :cve:`2019-19067`, :cve:`2019-19068`, :cve:`2019-19069`, :cve:`2019-19070`, :cve:`2019-19071`, :cve:`2019-19072`, :cve:`2019-19073`, :cve:`2019-19074`, :cve:`2019-19075`, :cve:`2019-19076`, :cve:`2019-19077`, :cve:`2019-19078`, :cve:`2019-19079`, :cve:`2019-19080`, :cve:`2019-19081`, :cve:`2019-19082`, :cve:`2019-19083`, :cve:`2019-19227`, :cve:`2019-19241`, :cve:`2019-19252`, :cve:`2019-19318`, :cve:`2019-19319`, :cve:`2019-19332`, :cve:`2019-19338`, :cve:`2019-19377`, :cve:`2019-19447`, :cve:`2019-19448`, :cve:`2019-19449`, :cve:`2019-19462`, :cve:`2019-19523`, :cve:`2019-19524`, :cve:`2019-19525`, :cve:`2019-19526`, :cve:`2019-19527`, :cve:`2019-19528`, :cve:`2019-19529`, :cve:`2019-19530`, :cve:`2019-19531`, :cve:`2019-19532`, :cve:`2019-19533`, :cve:`2019-19534`, :cve:`2019-19535`, :cve:`2019-19536`, :cve:`2019-19537`, :cve:`2019-19543`, :cve:`2019-19602`, :cve:`2019-19767`, :cve:`2019-19768`, :cve:`2019-19769`, :cve:`2019-19770`, :cve:`2019-19807`, :cve:`2019-19813`, :cve:`2019-19815`, :cve:`2019-19816`, :cve:`2019-19922`, :cve:`2019-19927`, :cve:`2019-19947`, :cve:`2019-19965`, :cve:`2019-19966`, :cve:`2019-1999`, :cve:`2019-20054`, :cve:`2019-20095`, :cve:`2019-20096`, :cve:`2019-2024`, :cve:`2019-2025`, :cve:`2019-20422`, :cve:`2019-2054`, :cve:`2019-20636`, :cve:`2019-20806`, :cve:`2019-20810`, :cve:`2019-20811`, :cve:`2019-20812`, :cve:`2019-20908`, :cve:`2019-20934`, :cve:`2019-2101`, :cve:`2019-2181`, :cve:`2019-2182`, :cve:`2019-2213`, :cve:`2019-2214`, :cve:`2019-2215`, :cve:`2019-25044`, :cve:`2019-25045`, :cve:`2019-3016`, :cve:`2019-3459`, :cve:`2019-3460`, :cve:`2019-3701`, :cve:`2019-3819`, :cve:`2019-3837`, :cve:`2019-3846`, :cve:`2019-3874`, :cve:`2019-3882`, :cve:`2019-3887`, :cve:`2019-3892`, :cve:`2019-3896`, :cve:`2019-3900`, :cve:`2019-3901`, :cve:`2019-5108`, :cve:`2019-6133`, :cve:`2019-6974`, :cve:`2019-7221`, :cve:`2019-7222`, :cve:`2019-7308`, :cve:`2019-8912`, :cve:`2019-8956`, :cve:`2019-8980`, :cve:`2019-9003`, :cve:`2019-9162`, :cve:`2019-9213`, :cve:`2019-9245`, :cve:`2019-9444`, :cve:`2019-9445`, :cve:`2019-9453`, :cve:`2019-9454`, :cve:`2019-9455`, :cve:`2019-9456`, :cve:`2019-9457`, :cve:`2019-9458`, :cve:`2019-9466`, :cve:`2019-9500`, :cve:`2019-9503`, :cve:`2019-9506`, :cve:`2019-9857`, :cve:`2020-0009`, :cve:`2020-0030`, :cve:`2020-0041`, :cve:`2020-0066`, :cve:`2020-0067`, :cve:`2020-0110`, :cve:`2020-0255`, :cve:`2020-0305`, :cve:`2020-0404`, :cve:`2020-0423`, :cve:`2020-0427`, :cve:`2020-0429`, :cve:`2020-0430`, :cve:`2020-0431`, :cve:`2020-0432`, :cve:`2020-0433`, :cve:`2020-0435`, :cve:`2020-0444`, :cve:`2020-0465`, :cve:`2020-0466`, :cve:`2020-0543`, :cve:`2020-10135`, :cve:`2020-10690`, :cve:`2020-10711`, :cve:`2020-10720`, :cve:`2020-10732`, :cve:`2020-10742`, :cve:`2020-10751`, :cve:`2020-10757`, :cve:`2020-10766`, :cve:`2020-10767`, :cve:`2020-10768`, :cve:`2020-10769`, :cve:`2020-10773`, :cve:`2020-10781`, :cve:`2020-10942`, :cve:`2020-11494`, :cve:`2020-11565`, :cve:`2020-11608`, :cve:`2020-11609`, :cve:`2020-11668`, :cve:`2020-11669`, :cve:`2020-11884`, :cve:`2020-12114`, :cve:`2020-12351`, :cve:`2020-12352`, :cve:`2020-12464`, :cve:`2020-12465`, :cve:`2020-12652`, :cve:`2020-12653`, :cve:`2020-12654`, :cve:`2020-12655`, :cve:`2020-12656`, :cve:`2020-12657`, :cve:`2020-12659`, :cve:`2020-12768`, :cve:`2020-12769`, :cve:`2020-12770`, :cve:`2020-12771`, :cve:`2020-12826`, :cve:`2020-12888`, :cve:`2020-12912`, :cve:`2020-13143`, :cve:`2020-13974`, :cve:`2020-14305`, :cve:`2020-14314`, :cve:`2020-14331`, :cve:`2020-14351`, :cve:`2020-14353`, :cve:`2020-14356`, :cve:`2020-14381`, :cve:`2020-14385`, :cve:`2020-14386`, :cve:`2020-14390`, :cve:`2020-14416`, :cve:`2020-15393`, :cve:`2020-15436`, :cve:`2020-15437`, :cve:`2020-15780`, :cve:`2020-15852`, :cve:`2020-16119`, :cve:`2020-16120`, :cve:`2020-16166`, :cve:`2020-1749`, :cve:`2020-24394`, :cve:`2020-24490`, :cve:`2020-24586`, :cve:`2020-24587`, :cve:`2020-24588`, :cve:`2020-25211`, :cve:`2020-25212`, :cve:`2020-25221`, :cve:`2020-25284`, :cve:`2020-25285`, :cve:`2020-25639`, :cve:`2020-25641`, :cve:`2020-25643`, :cve:`2020-25645`, :cve:`2020-25656`, :cve:`2020-25668`, :cve:`2020-25669`, :cve:`2020-25670`, :cve:`2020-25671`, :cve:`2020-25672`, :cve:`2020-25673`, :cve:`2020-25704`, :cve:`2020-25705`, :cve:`2020-26088`, :cve:`2020-26139`, :cve:`2020-26141`, :cve:`2020-26145`, :cve:`2020-26147`, :cve:`2020-26541`, :cve:`2020-26555`, :cve:`2020-26558`, :cve:`2020-27066`, :cve:`2020-27067`, :cve:`2020-27068`, :cve:`2020-27152`, :cve:`2020-27170`, :cve:`2020-27171`, :cve:`2020-27194`, :cve:`2020-2732`, :cve:`2020-27418`, :cve:`2020-27673`, :cve:`2020-27675`, :cve:`2020-27777`, :cve:`2020-27784`, :cve:`2020-27786`, :cve:`2020-27815`, :cve:`2020-27820`, :cve:`2020-27825`, :cve:`2020-27830`, :cve:`2020-27835`, :cve:`2020-28097`, :cve:`2020-28374`, :cve:`2020-28588`, :cve:`2020-28915`, :cve:`2020-28941`, :cve:`2020-28974`, :cve:`2020-29368`, :cve:`2020-29369`, :cve:`2020-29370`, :cve:`2020-29371`, :cve:`2020-29372`, :cve:`2020-29373`, :cve:`2020-29374`, :cve:`2020-29534`, :cve:`2020-29568`, :cve:`2020-29569`, :cve:`2020-29660`, :cve:`2020-29661`, :cve:`2020-35499`, :cve:`2020-35508`, :cve:`2020-35513`, :cve:`2020-35519`, :cve:`2020-36158`, :cve:`2020-36310`, :cve:`2020-36311`, :cve:`2020-36312`, :cve:`2020-36313`, :cve:`2020-36322`, :cve:`2020-36385`, :cve:`2020-36386`, :cve:`2020-36387`, :cve:`2020-36516`, :cve:`2020-36557`, :cve:`2020-36558`, :cve:`2020-36691`, :cve:`2020-36694`, :cve:`2020-36766`, :cve:`2020-3702`, :cve:`2020-4788`, :cve:`2020-7053`, :cve:`2020-8428`, :cve:`2020-8647`, :cve:`2020-8648`, :cve:`2020-8649`, :cve:`2020-8694`, :cve:`2020-8834`, :cve:`2020-8835`, :cve:`2020-8992`, :cve:`2020-9383`, :cve:`2020-9391`, :cve:`2021-0129`, :cve:`2021-0342`, :cve_mitre:`2021-0447`, :cve_mitre:`2021-0448`, :cve:`2021-0512`, :cve:`2021-0605`, :cve:`2021-0707`, :cve:`2021-0920`, :cve:`2021-0929`, :cve:`2021-0935`, :cve_mitre:`2021-0937`, :cve:`2021-0938`, :cve:`2021-0941`, :cve:`2021-1048`, :cve:`2021-20177`, :cve:`2021-20194`, :cve:`2021-20226`, :cve:`2021-20239`, :cve:`2021-20261`, :cve:`2021-20265`, :cve:`2021-20268`, :cve:`2021-20292`, :cve:`2021-20317`, :cve:`2021-20320`, :cve:`2021-20321`, :cve:`2021-20322`, :cve:`2021-21781`, :cve:`2021-22543`, :cve:`2021-22555`, :cve:`2021-22600`, :cve:`2021-23133`, :cve:`2021-23134`, :cve:`2021-26401`, :cve:`2021-26708`, :cve:`2021-26930`, :cve:`2021-26931`, :cve:`2021-26932`, :cve:`2021-27363`, :cve:`2021-27364`, :cve:`2021-27365`, :cve:`2021-28038`, :cve:`2021-28039`, :cve:`2021-28375`, :cve:`2021-28660`, :cve:`2021-28688`, :cve:`2021-28691`, :cve:`2021-28711`, :cve:`2021-28712`, :cve:`2021-28713`, :cve:`2021-28714`, :cve:`2021-28715`, :cve:`2021-28950`, :cve:`2021-28951`, :cve:`2021-28952`, :cve:`2021-28964`, :cve:`2021-28971`, :cve:`2021-28972`, :cve:`2021-29154`, :cve:`2021-29155`, :cve:`2021-29264`, :cve:`2021-29265`, :cve:`2021-29266`, :cve:`2021-29646`, :cve:`2021-29647`, :cve:`2021-29648`, :cve:`2021-29649`, :cve:`2021-29650`, :cve:`2021-29657`, :cve:`2021-30002`, :cve:`2021-30178`, :cve:`2021-31440`, :cve:`2021-3178`, :cve:`2021-31829`, :cve:`2021-31916`, :cve:`2021-32399`, :cve:`2021-32606`, :cve:`2021-33033`, :cve:`2021-33034`, :cve:`2021-33098`, :cve:`2021-33135`, :cve:`2021-33200`, :cve:`2021-3347`, :cve:`2021-3348`, :cve:`2021-33624`, :cve:`2021-33655`, :cve:`2021-33656`, :cve:`2021-33909`, :cve:`2021-3411`, :cve:`2021-3428`, :cve:`2021-3444`, :cve:`2021-34556`, :cve:`2021-34693`, :cve:`2021-3483`, :cve:`2021-34866`, :cve:`2021-3489`, :cve:`2021-3490`, :cve:`2021-3491`, :cve_mitre:`2021-34981`, :cve:`2021-3501`, :cve:`2021-35039`, :cve:`2021-3506`, :cve:`2021-3543`, :cve:`2021-35477`, :cve:`2021-3564`, :cve:`2021-3573`, :cve:`2021-3587`, :cve_mitre:`2021-3600`, :cve:`2021-3609`, :cve:`2021-3612`, :cve:`2021-3635`, :cve:`2021-3640`, :cve:`2021-3653`, :cve:`2021-3655`, :cve:`2021-3656`, :cve:`2021-3659`, :cve:`2021-3679`, :cve:`2021-3715`, :cve:`2021-37159`, :cve:`2021-3732`, :cve:`2021-3736`, :cve:`2021-3739`, :cve:`2021-3743`, :cve:`2021-3744`, :cve:`2021-3752`, :cve:`2021-3753`, :cve:`2021-37576`, :cve:`2021-3759`, :cve:`2021-3760`, :cve:`2021-3764`, :cve:`2021-3772`, :cve:`2021-38160`, :cve:`2021-38166`, :cve:`2021-38198`, :cve:`2021-38199`, :cve:`2021-38200`, :cve:`2021-38201`, :cve:`2021-38202`, :cve:`2021-38203`, :cve:`2021-38204`, :cve:`2021-38205`, :cve:`2021-38206`, :cve:`2021-38207`, :cve:`2021-38208`, :cve:`2021-38209`, :cve:`2021-38300`, :cve:`2021-3894`, :cve:`2021-3896`, :cve:`2021-3923`, :cve:`2021-39633`, :cve:`2021-39634`, :cve:`2021-39636`, :cve:`2021-39648`, :cve:`2021-39656`, :cve:`2021-39657`, :cve:`2021-39685`, :cve:`2021-39686`, :cve:`2021-39698`, :cve:`2021-39711`, :cve:`2021-39713`, :cve:`2021-39714`, :cve:`2021-4001`, :cve:`2021-4002`, :cve:`2021-4028`, :cve:`2021-4032`, :cve:`2021-4037`, :cve:`2021-40490`, :cve:`2021-4083`, :cve:`2021-4090`, :cve:`2021-4093`, :cve:`2021-4095`, :cve:`2021-41073`, :cve:`2021-4135`, :cve:`2021-4148`, :cve:`2021-4149`, :cve:`2021-4154`, :cve:`2021-4155`, :cve:`2021-4157`, :cve:`2021-4159`, :cve:`2021-41864`, :cve:`2021-4197`, :cve:`2021-42008`, :cve:`2021-4202`, :cve:`2021-4203`, :cve:`2021-4218`, :cve:`2021-42252`, :cve:`2021-42327`, :cve:`2021-42739`, :cve:`2021-43056`, :cve:`2021-43057`, :cve:`2021-43267`, :cve:`2021-43389`, :cve:`2021-43975`, :cve:`2021-43976`, :cve:`2021-44733`, :cve:`2021-45095`, :cve:`2021-45100`, :cve:`2021-45402`, :cve:`2021-45469`, :cve:`2021-45480`, :cve:`2021-45485`, :cve:`2021-45486`, :cve:`2021-45868`, :cve:`2021-46283`, :cve:`2022-0001`, :cve:`2022-0002`, :cve:`2022-0168`, :cve:`2022-0171`, :cve:`2022-0185`, :cve:`2022-0264`, :cve:`2022-0286`, :cve:`2022-0322`, :cve:`2022-0330`, :cve:`2022-0433`, :cve:`2022-0435`, :cve:`2022-0487`, :cve:`2022-0492`, :cve:`2022-0494`, :cve:`2022-0516`, :cve:`2022-0617`, :cve:`2022-0644`, :cve:`2022-0646`, :cve:`2022-0742`, :cve:`2022-0812`, :cve:`2022-0847`, :cve:`2022-0850`, :cve:`2022-0854`, :cve:`2022-0995`, :cve:`2022-1011`, :cve:`2022-1012`, :cve:`2022-1015`, :cve:`2022-1016`, :cve:`2022-1043`, :cve:`2022-1048`, :cve:`2022-1055`, :cve:`2022-1158`, :cve:`2022-1184`, :cve:`2022-1195`, :cve:`2022-1198`, :cve:`2022-1199`, :cve:`2022-1204`, :cve:`2022-1205`, :cve:`2022-1353`, :cve:`2022-1419`, :cve:`2022-1462`, :cve:`2022-1516`, :cve:`2022-1651`, :cve:`2022-1652`, :cve:`2022-1671`, :cve:`2022-1678`, :cve:`2022-1679`, :cve:`2022-1729`, :cve:`2022-1734`, :cve:`2022-1786`, :cve:`2022-1789`, :cve:`2022-1836`, :cve:`2022-1852`, :cve:`2022-1882`, :cve:`2022-1943`, :cve:`2022-1966`, :cve:`2022-1972`, :cve:`2022-1973`, :cve:`2022-1974`, :cve:`2022-1975`, :cve:`2022-1976`, :cve:`2022-1998`, :cve:`2022-20008`, :cve:`2022-20132`, :cve:`2022-20141`, :cve:`2022-20153`, :cve:`2022-20154`, :cve:`2022-20158`, :cve:`2022-20166`, :cve:`2022-20368`, :cve:`2022-20369`, :cve:`2022-20421`, :cve:`2022-20422`, :cve:`2022-20423`, :cve_mitre:`2022-20565`, :cve:`2022-20566`, :cve:`2022-20567`, :cve:`2022-20572`, :cve:`2022-2078`, :cve:`2022-21123`, :cve:`2022-21125`, :cve:`2022-21166`, :cve:`2022-21385`, :cve:`2022-21499`, :cve_mitre:`2022-21505`, :cve:`2022-2153`, :cve:`2022-2196`, :cve_mitre:`2022-22942`, :cve:`2022-23036`, :cve:`2022-23037`, :cve:`2022-23038`, :cve:`2022-23039`, :cve:`2022-23040`, :cve:`2022-23041`, :cve:`2022-23042`, :cve:`2022-2308`, :cve:`2022-2318`, :cve:`2022-2380`, :cve:`2022-23816`, :cve:`2022-23960`, :cve:`2022-24122`, :cve:`2022-24448`, :cve:`2022-24958`, :cve:`2022-24959`, :cve:`2022-2503`, :cve:`2022-25258`, :cve:`2022-25375`, :cve:`2022-25636`, :cve_mitre:`2022-2585`, :cve_mitre:`2022-2586`, :cve_mitre:`2022-2588`, :cve:`2022-2590`, :cve_mitre:`2022-2602`, :cve:`2022-26365`, :cve:`2022-26373`, :cve:`2022-2639`, :cve:`2022-26490`, :cve:`2022-2663`, :cve:`2022-26966`, :cve:`2022-27223`, :cve:`2022-27666`, :cve:`2022-2785`, :cve:`2022-27950`, :cve:`2022-28356`, :cve:`2022-28388`, :cve:`2022-28389`, :cve:`2022-28390`, :cve:`2022-2873`, :cve:`2022-28796`, :cve:`2022-28893`, :cve:`2022-2905`, :cve:`2022-29156`, :cve:`2022-2938`, :cve:`2022-29581`, :cve:`2022-29582`, :cve:`2022-2959`, :cve:`2022-2964`, :cve:`2022-2977`, :cve:`2022-2978`, :cve:`2022-29900`, :cve:`2022-29901`, :cve:`2022-29968`, :cve:`2022-3028`, :cve:`2022-30594`, :cve:`2022-3061`, :cve:`2022-3077`, :cve:`2022-3078`, :cve:`2022-3103`, :cve:`2022-3104`, :cve:`2022-3105`, :cve:`2022-3106`, :cve:`2022-3107`, :cve:`2022-3110`, :cve:`2022-3111`, :cve:`2022-3112`, :cve:`2022-3113`, :cve:`2022-3114`, :cve:`2022-3115`, :cve:`2022-3169`, :cve:`2022-3170`, :cve:`2022-3202`, :cve:`2022-32250`, :cve:`2022-32296`, :cve:`2022-3239`, :cve:`2022-32981`, :cve:`2022-3303`, :cve:`2022-33740`, :cve:`2022-33741`, :cve:`2022-33742`, :cve:`2022-33743`, :cve:`2022-33744`, :cve:`2022-33981`, :cve:`2022-3424`, :cve:`2022-3435`, :cve:`2022-34494`, :cve:`2022-34495`, :cve:`2022-34918`, :cve:`2022-3521`, :cve:`2022-3524`, :cve:`2022-3526`, :cve:`2022-3531`, :cve:`2022-3532`, :cve:`2022-3534`, :cve:`2022-3535`, :cve:`2022-3541`, :cve:`2022-3542`, :cve:`2022-3543`, :cve:`2022-3545`, :cve:`2022-3564`, :cve:`2022-3565`, :cve:`2022-3577`, :cve:`2022-3586`, :cve:`2022-3594`, :cve:`2022-36123`, :cve:`2022-3619`, :cve:`2022-3621`, :cve:`2022-3623`, :cve:`2022-3625`, :cve:`2022-3628`, :cve:`2022-36280`, :cve:`2022-3629`, :cve:`2022-3630`, :cve:`2022-3633`, :cve:`2022-3635`, :cve:`2022-3640`, :cve:`2022-3643`, :cve:`2022-3646`, :cve:`2022-3649`, :cve:`2022-36879`, :cve:`2022-36946`, :cve:`2022-3707`, :cve:`2022-3910`, :cve:`2022-39189`, :cve:`2022-39190`, :cve:`2022-3977`, :cve:`2022-39842`, :cve:`2022-40307`, :cve:`2022-40476`, :cve:`2022-40768`, :cve:`2022-4095`, :cve:`2022-40982`, :cve:`2022-41218`, :cve:`2022-41222`, :cve:`2022-4127`, :cve:`2022-4128`, :cve:`2022-4129`, :cve:`2022-4139`, :cve:`2022-41674`, :cve:`2022-41849`, :cve:`2022-41850`, :cve:`2022-41858`, :cve:`2022-42328`, :cve:`2022-42329`, :cve:`2022-42432`, :cve:`2022-4269`, :cve:`2022-42703`, :cve:`2022-42719`, :cve:`2022-42720`, :cve:`2022-42721`, :cve:`2022-42722`, :cve:`2022-42895`, :cve:`2022-42896`, :cve:`2022-43750`, :cve:`2022-4378`, :cve:`2022-4379`, :cve:`2022-4382`, :cve:`2022-43945`, :cve:`2022-45869`, :cve:`2022-45886`, :cve:`2022-45887`, :cve:`2022-45888`, :cve:`2022-45919`, :cve:`2022-45934`, :cve:`2022-4662`, :cve:`2022-4744`, :cve:`2022-47518`, :cve:`2022-47519`, :cve:`2022-47520`, :cve:`2022-47521`, :cve:`2022-47929`, :cve:`2022-47938`, :cve:`2022-47939`, :cve:`2022-47940`, :cve:`2022-47941`, :cve:`2022-47942`, :cve:`2022-47943`, :cve:`2022-4842`, :cve:`2022-48423`, :cve:`2022-48424`, :cve:`2022-48425`, :cve:`2022-48502`, :cve:`2023-0030`, :cve:`2023-0045`, :cve:`2023-0047`, :cve:`2023-0122`, :cve:`2023-0160`, :cve:`2023-0179`, :cve:`2023-0210`, :cve:`2023-0240`, :cve:`2023-0266`, :cve:`2023-0394`, :cve:`2023-0458`, :cve:`2023-0459`, :cve:`2023-0461`, :cve:`2023-0468`, :cve:`2023-0469`, :cve:`2023-0590`, :cve:`2023-0615`, :cve_mitre:`2023-1032`, :cve:`2023-1073`, :cve:`2023-1074`, :cve:`2023-1076`, :cve:`2023-1077`, :cve:`2023-1078`, :cve:`2023-1079`, :cve:`2023-1095`, :cve:`2023-1118`, :cve:`2023-1192`, :cve:`2023-1194`, :cve:`2023-1195`, :cve:`2023-1206`, :cve:`2023-1249`, :cve:`2023-1252`, :cve:`2023-1281`, :cve:`2023-1380`, :cve:`2023-1382`, :cve:`2023-1390`, :cve:`2023-1513`, :cve:`2023-1582`, :cve:`2023-1583`, :cve:`2023-1611`, :cve:`2023-1637`, :cve:`2023-1652`, :cve:`2023-1670`, :cve:`2023-1829`, :cve:`2023-1838`, :cve:`2023-1855`, :cve:`2023-1859`, :cve:`2023-1989`, :cve:`2023-1990`, :cve:`2023-1998`, :cve:`2023-2002`, :cve:`2023-2006`, :cve:`2023-2008`, :cve:`2023-2019`, :cve:`2023-20569`, :cve:`2023-20588`, :cve:`2023-20593`, :cve:`2023-20938`, :cve:`2023-21102`, :cve:`2023-21106`, :cve:`2023-2124`, :cve:`2023-21255`, :cve:`2023-21264`, :cve:`2023-2156`, :cve:`2023-2162`, :cve:`2023-2163`, :cve:`2023-2166`, :cve:`2023-2177`, :cve:`2023-2194`, :cve:`2023-2235`, :cve:`2023-2236`, :cve:`2023-2248`, :cve:`2023-2269`, :cve:`2023-22996`, :cve:`2023-22997`, :cve:`2023-22998`, :cve:`2023-22999`, :cve:`2023-23001`, :cve:`2023-23002`, :cve:`2023-23003`, :cve:`2023-23004`, :cve:`2023-23005`, :cve:`2023-23006`, :cve:`2023-23454`, :cve:`2023-23455`, :cve:`2023-23559`, :cve:`2023-2483`, :cve:`2023-25012`, :cve:`2023-2513`, :cve:`2023-25775`, :cve:`2023-2598`, :cve:`2023-26544`, :cve:`2023-26545`, :cve:`2023-26605`, :cve:`2023-26606`, :cve:`2023-26607`, :cve:`2023-28327`, :cve:`2023-28328`, :cve:`2023-28410`, :cve:`2023-28464`, :cve:`2023-28466`, :cve:`2023-2860`, :cve:`2023-28772`, :cve:`2023-28866`, :cve:`2023-2898`, :cve:`2023-2985`, :cve:`2023-3006`, :cve:`2023-30456`, :cve:`2023-30772`, :cve:`2023-3090`, :cve:`2023-3106`, :cve:`2023-3111`, :cve:`2023-3117`, :cve:`2023-31248`, :cve:`2023-3141`, :cve:`2023-31436`, :cve:`2023-3159`, :cve:`2023-3161`, :cve:`2023-3212`, :cve:`2023-3220`, :cve:`2023-32233`, :cve:`2023-32247`, :cve:`2023-32248`, :cve:`2023-32250`, :cve:`2023-32252`, :cve:`2023-32254`, :cve:`2023-32257`, :cve:`2023-32258`, :cve:`2023-32269`, :cve:`2023-3268`, :cve:`2023-3269`, :cve:`2023-3312`, :cve:`2023-3317`, :cve:`2023-33203`, :cve:`2023-33250`, :cve:`2023-33288`, :cve:`2023-3338`, :cve:`2023-3355`, :cve:`2023-3357`, :cve:`2023-3358`, :cve:`2023-3359`, :cve:`2023-3390`, :cve:`2023-33951`, :cve:`2023-33952`, :cve:`2023-34255`, :cve:`2023-34256`, :cve:`2023-34319`, :cve:`2023-3439`, :cve:`2023-35001`, :cve:`2023-3567`, :cve:`2023-35788`, :cve:`2023-35823`, :cve:`2023-35824`, :cve:`2023-35826`, :cve:`2023-35828`, :cve:`2023-35829`, :cve:`2023-3609`, :cve:`2023-3610`, :cve:`2023-3611`, :cve:`2023-37453`, :cve:`2023-3772`, :cve:`2023-3773`, :cve:`2023-3776`, :cve:`2023-3777`, :cve:`2023-3812`, :cve:`2023-38409`, :cve:`2023-38426`, :cve:`2023-38427`, :cve:`2023-38428`, :cve:`2023-38429`, :cve:`2023-38430`, :cve:`2023-38431`, :cve:`2023-38432`, :cve:`2023-3863`, :cve_mitre:`2023-3865`, :cve_mitre:`2023-3866`, :cve_mitre:`2023-3867`, :cve:`2023-39189`, :cve:`2023-39192`, :cve:`2023-39193`, :cve:`2023-39194`, :cve:`2023-4004`, :cve:`2023-4015`, :cve:`2023-40283`, :cve:`2023-4128`, :cve:`2023-4132`, :cve:`2023-4147`, :cve:`2023-4155`, :cve:`2023-4194`, :cve:`2023-4206`, :cve:`2023-4207`, :cve:`2023-4208`, :cve:`2023-4273`, :cve:`2023-42752`, :cve:`2023-42753`, :cve:`2023-42755`, :cve:`2023-42756`, :cve:`2023-4385`, :cve:`2023-4387`, :cve:`2023-4389`, :cve:`2023-4394`, :cve:`2023-44466`, :cve:`2023-4459`, :cve:`2023-4569`, :cve:`2023-45862`, :cve:`2023-45871`, :cve:`2023-4611`, :cve:`2023-4623`, :cve:`2023-4732`, :cve:`2023-4921` and :cve:`2023-5345` +- linux-yocto/5.15: Ignore :cve:`2022-45886`, :cve:`2022-45887`, :cve:`2022-45919`, :cve:`2022-48502`, :cve:`2023-0160`, :cve:`2023-1206`, :cve:`2023-20593`, :cve:`2023-21264`, :cve:`2023-2898`, :cve:`2023-31248`, :cve:`2023-33250`, :cve:`2023-34319`, :cve:`2023-35001`, :cve:`2023-3611`, :cve:`2023-37453`, :cve:`2023-3773`, :cve:`2023-3776`, :cve:`2023-3777`, :cve:`2023-38432`, :cve:`2023-3863`, :cve_mitre:`2023-3865`, :cve_mitre:`2023-3866`, :cve:`2023-4004`, :cve:`2023-4015`, :cve:`2023-4132`, :cve:`2023-4147`, :cve:`2023-4194`, :cve:`2023-4385`, :cve:`2023-4387`, :cve:`2023-4389`, :cve:`2023-4394`, :cve:`2023-4459` and :cve:`2023-4611` +- openssl: Fix :cve:`2023-4807` and :cve:`2023-5363` +- python3-git: Fix :cve:`2023-40590` and :cve:`2023-41040` +- python3-urllib3: Fix :cve:`2023-43804` +- qemu: Ignore :cve:`2023-2680` +- ruby: Fix :cve:`2023-36617` +- shadow: Fix :cve_mitre:`2023-4641` +- tiff: Fix :cve:`2023-3576` and :cve:`2023-40745` +- vim: Fix :cve:`2023-5441` and :cve:`2023-5535` +- webkitgtk: Fix :cve:`2023-32439` +- xdg-utils: Fix :cve:`2022-4055` +- xserver-xorg: ignore :cve:`2022-3553` (XQuartz-specific) +- zlib: Fix :cve:`2023-45853` + + + +Fixes in Yocto-4.0.14 +~~~~~~~~~~~~~~~~~~~~~ + +- SECURITY.md: Add file +- apt: add missing <cstdint> for uint16_t +- bind: update to 9.18.19 +- bitbake: SECURITY.md: add file +- bitbake: bitbake-getvar: Add a quiet command line argument +- bitbake: bitbake-worker/runqueue: Avoid unnecessary bytes object copies +- brief-yoctoprojectqs: use new CDN mirror for sstate +- bsp-guide: bsp.rst: replace reference to wiki +- bsp-guide: bsp: skip Intel machines no longer supported in Poky +- build-appliance-image: Update to kirkstone head revision +- ccache: fix build with gcc-13 +- cml1: Fix KCONFIG_CONFIG_COMMAND not conveyed fully in do_menuconfig +- contributor-guide/style-guide: Add a note about task idempotence +- contributor-guide/style-guide: Refer to recipes, not packages +- contributor-guide: deprecate "Accepted" patch status +- contributor-guide: discourage marking patches as Inappropriate +- contributor-guide: recipe-style-guide: add more patch tagging examples +- contributor-guide: recipe-style-guide: add section about CVE patches +- contributor-guide: style-guide: discourage using Pending patch status +- dev-manual: add security team processes +- dev-manual: fix testimage usage instructions +- dev-manual: layers: Add notes about layer.conf +- dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" section +- dev-manual: new-recipe.rst: replace reference to wiki +- dev-manual: start.rst: remove obsolete reference +- dev-manual: wic: update "wic list images" output +- dev/ref-manual: Document :term:`INIT_MANAGER` +- fontcache.bbclass: avoid native recipes depending on target fontconfig +- glibc: Update to latest on stable 2.35 branch (c84018a05aec..) +- json-c: define :term:`CVE_VERSION` +- kernel.bbclass: Add force flag to rm calls +- libxpm: upgrade to 3.5.17 +- linux-firmware: create separate packages +- linux-firmware: upgrade to 20230804 +- linux-yocto/5.10: update to v5.10.197 +- linux-yocto: update CVE exclusions +- manuals: correct "yocto-linux" by "linux-yocto" +- manuals: update linux-yocto append examples +- migration-guides: add release notes for 4.0.13 +- openssl: Upgrade to 3.0.12 +- overview: Add note about non-reproducibility side effects +- package_rpm: Allow compression mode override +- poky.conf: bump version for 4.0.14 +- profile-manual: aesthetic cleanups +- python3-git: upgrade to 3.1.37 +- python3-jinja2: fix for the ptest result format +- python3-urllib3: upgrade to 1.26.17 +- ref-manual: Fix :term:`PACKAGECONFIG` term and add an example +- ref-manual: Warn about :term:`COMPATIBLE_MACHINE` skipping native recipes +- ref-manual: releases.svg: Scarthgap is now version 5.0 +- ref-manual: variables: add :term:`RECIPE_SYSROOT` and :term:`RECIPE_SYSROOT_NATIVE` +- ref-manual: variables: add :term:`TOOLCHAIN_OPTIONS` variable +- ref-manual: variables: add example for :term:`SYSROOT_DIRS` variable +- ref-manual: variables: provide no-match example for :term:`COMPATIBLE_MACHINE` +- sdk-manual: appendix-obtain: improve and update descriptions +- test-manual: reproducible-builds: stop mentioning LTO bug +- uboot-extlinux-config.bbclass: fix missed override syntax migration +- vim: Upgrade to 9.0.2048 + + +Known Issues in Yocto-4.0.14 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.14 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Archana Polampalli +- Armin Kuster +- Arne Schwerdt +- BELHADJ SALEM Talel +- Bruce Ashfield +- Chaitanya Vadrevu +- Colin McAllister +- Deepthi Hemraj +- Etienne Cordonnier +- Fahad Arslan +- Hitendra Prajapati +- Jaeyoon Jung +- Joshua Watt +- Khem Raj +- Lee Chee Yang +- Marta Rybczynska +- Martin Jansa +- Meenali Gupta +- Michael Opdenacker +- Narpat Mali +- Niko Mauno +- Paul Eggleton +- Paulo Neves +- Peter Marko +- Quentin Schulz +- Richard Purdie +- Robert P. J. Day +- Roland Hieber +- Ross Burton +- Ryan Eatmon +- Shubham Kulkarni +- Siddharth Doshi +- Soumya Sambu +- Steve Sakoman +- Tim Orling +- Trevor Gamblin +- Vijay Anusuri +- Wang Mingyu +- Yash Shinde +- Yogita Urade + + +Repositories / Downloads for Yocto-4.0.14 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.14 </poky/log/?h=yocto-4.0.14>` +- Git Revision: :yocto_git:`d8d6d921fad14b82167d9f031d4fca06b5e01883 </poky/commit/?id=d8d6d921fad14b82167d9f031d4fca06b5e01883>` +- Release Artefact: poky-d8d6d921fad14b82167d9f031d4fca06b5e01883 +- sha: 46a6301e3921ee67cfe6be7ea544d6257f0c0f02ef15c5091287e024ff02d5f5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.14/poky-d8d6d921fad14b82167d9f031d4fca06b5e01883.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.14/poky-d8d6d921fad14b82167d9f031d4fca06b5e01883.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.14 </openembedded-core/log/?h=yocto-4.0.14>` +- Git Revision: :oe_git:`0eb8e67aa6833df0cde29833568a70e65c21d7e5 </openembedded-core/commit/?id=0eb8e67aa6833df0cde29833568a70e65c21d7e5>` +- Release Artefact: oecore-0eb8e67aa6833df0cde29833568a70e65c21d7e5 +- sha: d510a7067b87ba935b8a7c9f9608d0e06b057009ea753ed190ddfacc7195ecc5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.14/oecore-0eb8e67aa6833df0cde29833568a70e65c21d7e5.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.14/oecore-0eb8e67aa6833df0cde29833568a70e65c21d7e5.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.14 </meta-mingw/log/?h=yocto-4.0.14>` +- Git Revision: :yocto_git:`f6b38ce3c90e1600d41c2ebb41e152936a0357d7 </meta-mingw/commit/?id=f6b38ce3c90e1600d41c2ebb41e152936a0357d7>` +- Release Artefact: meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7 +- sha: 7d57167c19077f4ab95623d55a24c2267a3a3fb5ed83688659b4c03586373b25 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.14/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.14/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.14 </meta-gplv2/log/?h=yocto-4.0.14>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.14/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.14/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.14 </bitbake/log/?h=yocto-4.0.14>` +- Git Revision: :oe_git:`6c1ffa9091d0c53a100e8c8c15122d28642034bd </bitbake/commit/?id=6c1ffa9091d0c53a100e8c8c15122d28642034bd>` +- Release Artefact: bitbake-6c1ffa9091d0c53a100e8c8c15122d28642034bd +- sha: 1ceffc3b3359063341530c989a3606c897d862b61111538e683f101b02a360a2 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.14/bitbake-6c1ffa9091d0c53a100e8c8c15122d28642034bd.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.14/bitbake-6c1ffa9091d0c53a100e8c8c15122d28642034bd.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.14 </yocto-docs/log/?h=yocto-4.0.14>` +- Git Revision: :yocto_git:`260b446a1a75d99399a3421cd8d6ba276f508f37 </yocto-docs/commit/?id=260b446a1a75d99399a3421cd8d6ba276f508f37>` + diff --git a/documentation/migration-guides/release-notes-4.0.15.rst b/documentation/migration-guides/release-notes-4.0.15.rst new file mode 100644 index 0000000000..b2731530e8 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.15.rst @@ -0,0 +1,189 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.15 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- avahi: Fix :cve:`2023-1981`, :cve:`2023-38469`, :cve:`2023-38470`, :cve:`2023-38471`, :cve:`2023-38472` and :cve:`2023-38473` +- binutils: Fix :cve:`2022-47007`, :cve:`2022-47010` and :cve:`2022-48064` +- bluez5: Fix :cve:`2023-45866` +- ghostscript: Ignore GhostPCL :cve:`2023-38560` +- gnutls: Fix :cve:`2023-5981` +- go: Ignore :cve:`2023-45283` and :cve:`2023-45284` +- grub: Fix :cve:`2023-4692` and :cve:`2023-4693` +- gstreamer1.0-plugins-bad: Fix :cve_mitre:`2023-44429` +- libsndfile: Fix :cve:`2022-33065` +- libwebp: Fix :cve:`2023-4863` +- openssl: Fix :cve:`2023-5678` +- python3-cryptography: Fix :cve:`2023-49083` +- qemu: Fix :cve:`2023-1544` +- sudo: :cve:`2023-42456` and :cve_mitre:`2023-42465` +- tiff: Fix :cve:`2023-41175` +- vim: Fix :cve:`2023-46246`, :cve:`2023-48231`, :cve:`2023-48232`, :cve:`2023-48233`, :cve:`2023-48234`, :cve:`2023-48235`, :cve:`2023-48236`, :cve:`2023-48237` and :cve:`2023-48706` +- xserver-xorg: Fix :cve:`2023-5367` and :cve:`2023-5380` +- xwayland: Fix :cve:`2023-5367` + + +Fixes in Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~ + +- bash: changes to SIGINT handler while waiting for a child +- bitbake: Fix disk space monitoring on cephfs +- bitbake: bitbake-getvar: Make --quiet work with --recipe +- bitbake: runqueue.py: fix PSI check logic +- bitbake: runqueue: Add pressure change logging +- bitbake: runqueue: convert deferral messages from bb.note to bb.debug +- bitbake: runqueue: fix PSI check calculation +- bitbake: runqueue: show more pressure data +- bitbake: runqueue: show number of currently running bitbake threads when pressure changes +- bitbake: tinfoil: Do not fail when logging is disabled and full config is used +- build-appliance-image: Update to kirkstone head revision +- cve-check: don't warn if a patch is remote +- cve-check: slightly more verbose warning when adding the same package twice +- cve-check: sort the package list in the JSON report +- cve-exclusion_5.10.inc: update for 5.10.202 +- go: Fix issue in DNS resolver +- goarch: Move Go architecture mapping to a library +- gstreamer1.0-plugins-base: enable glx/opengl support +- linux-yocto/5.10: update to v5.10.202 +- manuals: update class references +- migration-guide: add release notes for 4.0.14 +- native: Clear TUNE_FEATURES/ABIEXTENSION +- openssh: drop sudo from ptest dependencies +- overview-manual: concepts: Add Bitbake Tasks Map +- poky.conf: bump version for 4.0.15 +- python3-jinja2: Fixed ptest result output as per the standard +- ref-manual: classes: explain cml1 class name +- ref-manual: update :term:`SDK_NAME` variable documentation +- ref-manual: variables: add :term:`RECIPE_MAINTAINER` +- ref-manual: variables: document OEQA_REPRODUCIBLE_* variables +- ref-manual: variables: mention new CDN for :term:`SSTATE_MIRRORS` +- rust-common: Set llvm-target correctly for cross SDK targets +- rust-cross-canadian: Fix ordering of target json config generation +- rust-cross/rust-common: Merge arm target handling code to fix cross-canadian +- rust-cross: Simplfy the rust_gen_target calls +- rust-llvm: Allow overriding LLVM target archs +- sdk-manual: extensible.rst: remove instructions for using SDK functionality directly in a yocto build +- sudo: upgrade to 1.9.15p2 +- systemtap_git: fix used uninitialized error +- vim: Improve locale handling +- vim: Upgrade to 9.0.2130 +- vim: use upstream generated .po files + + +Known Issues in Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Archana Polampalli +- BELHADJ SALEM Talel +- Bruce Ashfield +- Chaitanya Vadrevu +- Chen Qi +- Deepthi Hemraj +- Denys Dmytriyenko +- Hitendra Prajapati +- Lee Chee Yang +- Li Wang +- Martin Jansa +- Meenali Gupta +- Michael Opdenacker +- Mikko Rapeli +- Narpat Mali +- Niko Mauno +- Ninad Palsule +- Niranjan Pradhan +- Paul Eggleton +- Peter Kjellerstedt +- Peter Marko +- Richard Purdie +- Ross Burton +- Samantha Jalabert +- Sanjana +- Soumya Sambu +- Steve Sakoman +- Tim Orling +- Vijay Anusuri +- Vivek Kumbhar +- Wenlin Kang +- Yogita Urade + + +Repositories / Downloads for Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.15 </poky/log/?h=yocto-4.0.15>` +- Git Revision: :yocto_git:`755632c2fcab43aa05cdcfa529727064b045073c </poky/commit/?id=755632c2fcab43aa05cdcfa529727064b045073c>` +- Release Artefact: poky-755632c2fcab43aa05cdcfa529727064b045073c +- sha: b40b43bd270d21a420c399981f9cfe0eb999f15e051fc2c89d124f249cdc0bd5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/poky-755632c2fcab43aa05cdcfa529727064b045073c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/poky-755632c2fcab43aa05cdcfa529727064b045073c.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.15 </openembedded-core/log/?h=yocto-4.0.15>` +- Git Revision: :oe_git:`eea685e1caafd8e8121006d3f8b5d0b8a4f2a933 </openembedded-core/commit/?id=eea685e1caafd8e8121006d3f8b5d0b8a4f2a933>` +- Release Artefact: oecore-eea685e1caafd8e8121006d3f8b5d0b8a4f2a933 +- sha: ddc3d4a2c8a097f2aa7132ae716affacc44b119c616a1eeffb7db56caa7fc79e +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/oecore-eea685e1caafd8e8121006d3f8b5d0b8a4f2a933.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/oecore-eea685e1caafd8e8121006d3f8b5d0b8a4f2a933.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.15 </meta-mingw/log/?h=yocto-4.0.15>` +- Git Revision: :yocto_git:`f6b38ce3c90e1600d41c2ebb41e152936a0357d7 </meta-mingw/commit/?id=f6b38ce3c90e1600d41c2ebb41e152936a0357d7>` +- Release Artefact: meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7 +- sha: 7d57167c19077f4ab95623d55a24c2267a3a3fb5ed83688659b4c03586373b25 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.15 </meta-gplv2/log/?h=yocto-4.0.15>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.15 </bitbake/log/?h=yocto-4.0.15>` +- Git Revision: :oe_git:`42a1c9fe698a03feb34c5bba223c6e6e0350925b </bitbake/commit/?id=42a1c9fe698a03feb34c5bba223c6e6e0350925b>` +- Release Artefact: bitbake-42a1c9fe698a03feb34c5bba223c6e6e0350925b +- sha: 64c684ccd661fa13e25c859dfc68d66bec79281da0f4f81b0d6a9995acb659b5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/bitbake-42a1c9fe698a03feb34c5bba223c6e6e0350925b.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/bitbake-42a1c9fe698a03feb34c5bba223c6e6e0350925b.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.15 </yocto-docs/log/?h=yocto-4.0.15>` +- Git Revision: :yocto_git:`08fda7a5601393617b1ecfe89229459e14a90b1d </yocto-docs/commit/?id=08fda7a5601393617b1ecfe89229459e14a90b1d>` + diff --git a/documentation/migration-guides/release-notes-4.0.16.rst b/documentation/migration-guides/release-notes-4.0.16.rst new file mode 100644 index 0000000000..0eb31832ab --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.16.rst @@ -0,0 +1,191 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.16 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.16 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- cpio: Fix :cve_mitre:`2023-7207` +- curl: Revert "curl: Backport fix CVE-2023-32001" +- curl: Fix :cve:`2023-46218` +- dropbear:Fix :cve:`2023-48795` +- ffmpeg: Fix :cve:`2022-3964` and :cve:`2022-3965` +- ghostscript: Fix :cve:`2023-46751` +- gnutls: Fix :cve:`2024-0553` and :cve:`2024-0567` +- go: Fix :cve:`2023-39326` +- openssh: Fix :cve:`2023-48795`, :cve:`2023-51384` and :cve:`2023-51385` +- openssl: Fix :cve:`2023-6129` and :cve_mitre:`2023-6237` +- pam: Fix :cve_mitre:`2024-22365` +- perl: Fix :cve:`2023-47038` +- qemu: Fix :cve:`2023-5088` +- sqlite3: Fix :cve:`2023-7104` +- systemd: Fix :cve:`2023-7008` +- tiff: Fix :cve:`2023-6228` +- xserver-xorg: Fix :cve:`2023-6377`, :cve:`2023-6478`, :cve:`2023-6816`, :cve_mitre:`2024-0229`, :cve:`2024-0408`, :cve:`2024-0409`, :cve_mitre:`2024-21885` and :cve_mitre:`2024-21886` +- zlib: Ignore :cve:`2023-6992` + + +Fixes in Yocto-4.0.16 +~~~~~~~~~~~~~~~~~~~~~ + +- bitbake: asyncrpc: Add context manager API +- bitbake: data: Add missing dependency handling of remove operator +- bitbake: lib/bb: Add workaround for libgcc issues with python 3.8 and 3.9 +- bitbake: toastergui: verify that an existing layer path is given +- build-appliance-image: Update to kirkstone head revision +- contributor-guide: add License-Update tag +- contributor-guide: fix command option +- contributor-guide: use "apt" instead of "aptitude" +- cpio: upgrade to 2.14 +- cve-update-nvd2-native: faster requests with API keys +- cve-update-nvd2-native: increase the delay between subsequent request failures +- cve-update-nvd2-native: make number of fetch attemtps configurable +- cve-update-nvd2-native: remove unused variable CVE_SOCKET_TIMEOUT +- dev-manual: Discourage the use of SRC_URI[md5sum] +- dev-manual: layers: update link to YP Compatible form +- dev-manual: runtime-testing: fix test module name +- dev-manual: start.rst: update use of Download page +- docs:what-i-wish-id-known.rst: fix URL +- docs: document VSCode extension +- docs:brief-yoctoprojectqs:index.rst: align variable order with default local.conf +- docs:migration-guides: add release notes for 4.0.15 +- docs:migration-guides: release 3.5 is actually 4.0 +- elfutils: Disable stringop-overflow warning for build host +- externalsrc: Ensure :term:`SRCREV` is processed before accessing :term:`SRC_URI` +- linux-firmware: upgrade to 20231030 +- manuals: Add :term:`CONVERSION_CMD` definition +- manuals: Add :term:`UBOOT_BINARY`, extend :term:`UBOOT_CONFIG` +- perl: upgrade to 5.34.3 +- poky.conf: bump version for 4.0.16 +- pybootchartgui: fix 2 SyntaxWarnings +- python3-ptest: skip test_storlines +- ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults +- ref-manual: classes: remove insserv bbclass +- ref-manual: releases.svg: update nanbield release status +- ref-manual: resources: sync with master branch +- ref-manual: update tested and supported distros +- test-manual: add links to python unittest +- test-manual: add or improve hyperlinks +- test-manual: explicit or fix file paths +- test-manual: resource updates +- test-manual: text and formatting fixes +- test-manual: use working example +- testimage: Exclude wtmp from target-dumper commands +- testimage: drop target_dumper, host_dumper, and monitor_dumper +- tzdata: Upgrade to 2023d + + +Known Issues in Yocto-4.0.16 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.16 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Aatir Manzur +- Archana Polampalli +- Dhairya Nagodra +- Dmitry Baryshkov +- Enguerrand de Ribaucourt +- Hitendra Prajapati +- Insu Park +- Joshua Watt +- Justin Bronder +- Jörg Sommer +- Khem Raj +- Lee Chee Yang +- mark.yang +- Marta Rybczynska +- Martin Jansa +- Maxin B. John +- Michael Opdenacker +- Paul Barker +- Peter Kjellerstedt +- Peter Marko +- Poonam Jadhav +- Richard Purdie +- Shubham Kulkarni +- Simone Weiß +- Soumya Sambu +- Sourav Pramanik +- Steve Sakoman +- Trevor Gamblin +- Vijay Anusuri +- Vivek Kumbhar +- Yoann Congal +- Yogita Urade + + +Repositories / Downloads for Yocto-4.0.16 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.16 </poky/log/?h=yocto-4.0.16>` +- Git Revision: :yocto_git:`54af8c5e80ebf63707ef4e51cc9d374f716da603 </poky/commit/?id=54af8c5e80ebf63707ef4e51cc9d374f716da603>` +- Release Artefact: poky-54af8c5e80ebf63707ef4e51cc9d374f716da603 +- sha: a53ec3a661cf56ca40c0fbf1500288c2c20abe94896d66a572bc5ccf5d92e9d6 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.16/poky-54af8c5e80ebf63707ef4e51cc9d374f716da603.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.16/poky-54af8c5e80ebf63707ef4e51cc9d374f716da603.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.16 </openembedded-core/log/?h=yocto-4.0.16>` +- Git Revision: :oe_git:`a744a897f0ea7d34c31c024c13031221f9a85f24 </openembedded-core/commit/?id=a744a897f0ea7d34c31c024c13031221f9a85f24>` +- Release Artefact: oecore-a744a897f0ea7d34c31c024c13031221f9a85f24 +- sha: 8c2bc9487597b0caa9f5a1d72b18cfcd1ddc7e6d91f0f051313563d6af95aeec +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.16/oecore-a744a897f0ea7d34c31c024c13031221f9a85f24.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.16/oecore-a744a897f0ea7d34c31c024c13031221f9a85f24.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.16 </meta-mingw/log/?h=yocto-4.0.16>` +- Git Revision: :yocto_git:`f6b38ce3c90e1600d41c2ebb41e152936a0357d7 </meta-mingw/commit/?id=f6b38ce3c90e1600d41c2ebb41e152936a0357d7>` +- Release Artefact: meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7 +- sha: 7d57167c19077f4ab95623d55a24c2267a3a3fb5ed83688659b4c03586373b25 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.16/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.16/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.16 </meta-gplv2/log/?h=yocto-4.0.16>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.16/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.16/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.16 </bitbake/log/?h=yocto-4.0.16>` +- Git Revision: :oe_git:`ee090484cc25d760b8c20f18add17b5eff485b40 </bitbake/commit/?id=ee090484cc25d760b8c20f18add17b5eff485b40>` +- Release Artefact: bitbake-ee090484cc25d760b8c20f18add17b5eff485b40 +- sha: 479e3a57ae9fbc2aa95292a7554caeef113bbfb28c226ed19547b8dde1c95314 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.16/bitbake-ee090484cc25d760b8c20f18add17b5eff485b40.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.16/bitbake-ee090484cc25d760b8c20f18add17b5eff485b40.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.16 </yocto-docs/log/?h=yocto-4.0.16>` +- Git Revision: :yocto_git:`aba67b58711019a6ba439b2b77337f813ed799ac </yocto-docs/commit/?id=aba67b58711019a6ba439b2b77337f813ed799ac>` + diff --git a/documentation/migration-guides/release-notes-4.0.17.rst b/documentation/migration-guides/release-notes-4.0.17.rst new file mode 100644 index 0000000000..07242584b8 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.17.rst @@ -0,0 +1,238 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.17 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.17 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-4408`, :cve:`2023-5517`, :cve:`2023-5679`, :cve:`2023-50868` and :cve:`2023-50387` +- binutils: Fix :cve:`2023-39129` and :cve:`2023-39130` +- curl: Fix :cve:`2023-46219` +- curl: Ignore :cve:`2023-42915` +- gcc: Ignore :cve:`2023-4039` +- gdb: Fix :cve:`2023-39129` and :cve:`2023-39130` +- glibc: Ignore :cve:`2023-0687` +- go: Fix :cve:`2023-29406`, :cve:`2023-45285`, :cve:`2023-45287`, :cve:`2023-45289`, :cve:`2023-45290`, :cve:`2024-24784` and :cve:`2024-24785` +- less: Fix :cve:`2022-48624` +- libgit2: Fix :cve:`2024-24575` and :cve:`2024-24577` +- libuv: fix :cve:`2024-24806` +- libxml2: Fix for :cve:`2024-25062` +- linux-yocto/5.15: Fix :cve:`2022-36402`, :cve:`2022-40982`, :cve:`2022-47940`, :cve:`2023-1193`, :cve:`2023-1194`, :cve:`2023-3772`, :cve_mitre:`2023-3867`, :cve:`2023-4128`, :cve:`2023-4206`, :cve:`2023-4207`, :cve:`2023-4208`, :cve:`2023-4244`, :cve:`2023-4273`, :cve:`2023-4563`, :cve:`2023-4569`, :cve:`2023-4623`, :cve:`2023-4881`, :cve:`2023-4921`, :cve:`2023-5158`, :cve:`2023-5717`, :cve:`2023-6040`, :cve:`2023-6121`, :cve:`2023-6176`, :cve:`2023-6546`, :cve:`2023-6606`, :cve:`2023-6622`, :cve:`2023-6817`, :cve:`2023-6915`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2023-20569`, :cve:`2023-20588`, :cve:`2023-25775`, :cve:`2023-31085`, :cve:`2023-32247`, :cve:`2023-32250`, :cve:`2023-32252`, :cve:`2023-32254`, :cve:`2023-32257`, :cve:`2023-32258`, :cve:`2023-34324`, :cve:`2023-35827`, :cve:`2023-38427`, :cve:`2023-38430`, :cve:`2023-38431`, :cve:`2023-39189`, :cve:`2023-39192`, :cve:`2023-39193`, :cve:`2023-39194`, :cve:`2023-39198`, :cve:`2023-40283`, :cve:`2023-42752`, :cve:`2023-42753`, :cve:`2023-42754`, :cve:`2023-42755`, :cve:`2023-45871`, :cve:`2023-46343`, :cve:`2023-46813`, :cve:`2023-46838`, :cve:`2023-46862`, :cve:`2023-51042`, :cve:`2023-51779`, :cve_mitre:`2023-52340`, :cve:`2023-52429`, :cve:`2023-52435`, :cve:`2023-52436`, :cve:`2023-52438`, :cve:`2023-52439`, :cve:`2023-52441`, :cve:`2023-52442`, :cve:`2023-52443`, :cve:`2023-52444`, :cve:`2023-52445`, :cve:`2023-52448`, :cve:`2023-52449`, :cve:`2023-52451`, :cve:`2023-52454`, :cve:`2023-52456`, :cve:`2023-52457`, :cve:`2023-52458`, :cve:`2023-52463`, :cve:`2023-52464`, :cve:`2024-0340`, :cve:`2024-0584`, :cve:`2024-0607`, :cve:`2024-0641`, :cve:`2024-0646`, :cve:`2024-1085`, :cve:`2024-1086`, :cve:`2024-1151`, :cve:`2024-22705`, :cve:`2024-23849`, :cve:`2024-23850`, :cve:`2024-23851`, :cve:`2024-24860`, :cve:`2024-26586`, :cve:`2024-26589`, :cve:`2024-26591`, :cve:`2024-26592`, :cve:`2024-26593`, :cve:`2024-26594`, :cve:`2024-26597` and :cve:`2024-26598` +- linux-yocto/5.15: Ignore :cve:`2020-27418`, :cve:`2020-36766`, :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-48619`, :cve:`2023-2430`, :cve:`2023-4610`, :cve:`2023-4732`, :cve:`2023-5090`, :cve:`2023-5178`, :cve:`2023-5197`, :cve:`2023-5345`, :cve:`2023-5633`, :cve:`2023-5972`, :cve:`2023-6111`, :cve:`2023-6200`, :cve:`2023-6531`, :cve:`2023-6679`, :cve:`2023-7192`, :cve:`2023-40791`, :cve:`2023-42756`, :cve:`2023-44466`, :cve:`2023-45862`, :cve:`2023-45863`, :cve:`2023-45898`, :cve:`2023-51043`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782`, :cve:`2023-52433`, :cve:`2023-52440`, :cve:`2023-52446`, :cve:`2023-52450`, :cve:`2023-52453`, :cve:`2023-52455`, :cve:`2023-52459`, :cve:`2023-52460`, :cve:`2023-52461`, :cve:`2023-52462`, :cve:`2024-0193`, :cve:`2024-0443`, :cve:`2024-0562`, :cve:`2024-0582`, :cve:`2024-0639`, :cve:`2024-0775`, :cve:`2024-26581`, :cve:`2024-26582`, :cve:`2024-26590`, :cve:`2024-26596` and :cve:`2024-26599` +- linux-yocto/5.10: Fix :cve:`2023-6040`, :cve:`2023-6121`, :cve:`2023-6606`, :cve:`2023-6817`, :cve:`2023-6915`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2023-39198`, :cve:`2023-46838`, :cve:`2023-51779`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782`, :cve_mitre:`2023-52340`, :cve:`2024-0584` and :cve:`2024-0646` +- linux-yocto/5.10: Ignore :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-1508`, :cve:`2022-36402`, :cve:`2022-48619`, :cve:`2023-2430`, :cve:`2023-4610`, :cve:`2023-5972`, :cve:`2023-6039`, :cve:`2023-6200`, :cve:`2023-6531`, :cve:`2023-6546`, :cve:`2023-6622`, :cve:`2023-6679`, :cve:`2023-7192`, :cve:`2023-46343`, :cve:`2023-51042`, :cve:`2023-51043`, :cve:`2024-0193`, :cve:`2024-0443`, :cve:`2024-0562`, :cve:`2024-0582`, :cve:`2024-0639`, :cve:`2024-0641`, :cve:`2024-0775`, :cve:`2024-1085` and :cve:`2024-22705` +- openssl: Fix :cve:`2024-0727` +- python3-pycryptodome: Fix :cve:`2023-52323` +- qemu: Fix :cve:`2023-6693`, :cve:`2023-42467` and :cve:`2024-24474` +- vim: Fix :cve:`2024-22667` +- xwayland: Fix :cve:`2023-6377` and :cve:`2023-6478` + + +Fixes in Yocto-4.0.17 +~~~~~~~~~~~~~~~~~~~~~ + +- bind: Upgrade to 9.18.24 +- bitbake: bitbake/codeparser.py: address ast module deprecations in py 3.12 +- bitbake: bitbake/lib/bs4/tests/test_tree.py: python 3.12 regex +- bitbake: codeparser: replace deprecated ast.Str and 's' +- bitbake: fetch2: Ensure that git LFS objects are available +- bitbake: tests/fetch: Add real git lfs tests and decorator +- bitbake: tests/fetch: git-lfs restore _find_git_lfs +- bitbake: toaster/toastergui: Bug-fix verify given layer path only if import/add local layer +- build-appliance-image: Update to kirkstone head revision +- cmake: Unset CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES +- contributor-guide: fix lore URL +- curl: don't enable debug builds +- cve_check: cleanup logging +- dbus: Add missing :term:`CVE_PRODUCT` +- dev-manual: sbom: Rephrase spdx creation +- dev-manual: runtime-testing: gen-tapdevs need iptables installed +- dev-manual: packages: clarify shared :term:`PR` service constraint +- dev-manual: packages: need enough free space +- dev-manual: start: remove idle line +- feature-microblaze-versions.inc: python 3.12 regex +- ghostscript: correct :term:`LICENSE` with AGPLv3 +- image-live.bbclass: LIVE_ROOTFS_TYPE support compression +- kernel.bbclass: Set pkg-config variables for building modules +- kernel.bbclass: introduce KERNEL_LOCALVERSION +- kernel: fix localversion in v6.3+ +- kernel: make LOCALVERSION consistent between recipes +- ldconfig-native: Fix to point correctly on the DT_NEEDED entries in an ELF file +- librsvg: Fix do_package_qa error for librsvg +- linux-firmware: upgrade to 20231211 +- linux-yocto/5.10: update to v5.10.210 +- linux-yocto/5.15: update to v5.15.150 +- manuals: add minimum RAM requirements +- manuals: suppress excess use of "following" word +- manuals: update disk space requirements +- manuals: update references to buildtools +- manuals: updates for building on Windows (WSL 2) +- meta/lib/oeqa: python 3.12 regex +- meta/recipes: python 3.12 regex +- migration-guide: add release notes for 4.0.16 +- oeqa/selftest/oelib/buildhistory: git default branch +- oeqa/selftest/recipetool: downgrade meson version to not use pyproject.toml +- oeqa/selftest/recipetool: expect meson.bb +- oeqa/selftest/recipetool: fix for python 3.12 +- oeqa/selftest/runtime_test: only run the virgl tests on qemux86-64 +- oeqa: replace deprecated assertEquals +- openssl: Upgrade to 3.0.13 +- poky.conf: bump version for 4.0.17 +- populate_sdk_ext: use ConfigParser instead of SafeConfigParser +- python3-jinja2: upgrade to 3.1.3 +- recipetool/create_buildsys_python: use importlib instead of imp +- ref-manual: system-requirements: recommend buildtools for not supported distros +- ref-manual: system-requirements: add info on buildtools-make-tarball +- ref-manual: release-process: grammar fix +- ref-manual: system-requirements: fix AlmaLinux variable name +- ref-manual: system-requirements: modify anchor +- ref-manual: system-requirements: remove outdated note +- ref-manual: system-requirements: simplify supported distro requirements +- ref-manual: system-requirements: update packages to build docs +- scripts/runqemu: add qmp socket support +- scripts/runqemu: direct mesa to use its own drivers, rather than ones provided by host distro +- scripts/runqemu: fix regex escape sequences +- scripts: python 3.12 regex +- selftest: skip virgl gtk/sdl test on ubuntu 18.04 +- systemd: Only add myhostname to nsswitch.conf if in :term:`PACKAGECONFIG` +- tzdata : Upgrade to 2024a +- u-boot: Move UBOOT_INITIAL_ENV back to u-boot.inc +- useradd-example: do not use unsupported clear text password +- vim: upgrade to v9.0.2190 +- yocto-bsp: update to v5.15.150 + + +Known Issues in Yocto-4.0.17 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.17 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Adrian Freihofer +- Alassane Yattara +- Alexander Kanavin +- Alexander Sverdlin +- Archana Polampalli +- Baruch Siach +- Bruce Ashfield +- Chen Qi +- Chris Laplante +- Deepthi Hemraj +- Dhairya Nagodra +- Fabien Mahot +- Fabio Estevam +- Hitendra Prajapati +- Hugo SIMELIERE +- Jermain Horsman +- Kai Kang +- Lee Chee Yang +- Ludovic Jozeau +- Michael Opdenacker +- Ming Liu +- Munehisa Kamata +- Narpat Mali +- Nikhil R +- Paul Eggleton +- Paulo Neves +- Peter Marko +- Philip Lorenz +- Poonam Jadhav +- Priyal Doshi +- Ross Burton +- Simone Weiß +- Soumya Sambu +- Steve Sakoman +- Tim Orling +- Trevor Gamblin +- Vijay Anusuri +- Vivek Kumbhar +- Wang Mingyu +- Zahir Hussain + + +Repositories / Downloads for Yocto-4.0.17 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.17 </poky/log/?h=yocto-4.0.17>` +- Git Revision: :yocto_git:`6d1a878bbf24c66f7186b270f823fcdf82e35383 </poky/commit/?id=6d1a878bbf24c66f7186b270f823fcdf82e35383>` +- Release Artefact: poky-6d1a878bbf24c66f7186b270f823fcdf82e35383 +- sha: 3bc3010340b674f7b0dd0a7997f0167b2240b794fbd4aa28c0c4217bddd15e30 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.17/poky-6d1a878bbf24c66f7186b270f823fcdf82e35383.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.17/poky-6d1a878bbf24c66f7186b270f823fcdf82e35383.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.17 </openembedded-core/log/?h=yocto-4.0.17>` +- Git Revision: :oe_git:`2501534c9581c6c3439f525d630be11554a57d24 </openembedded-core/commit/?id=2501534c9581c6c3439f525d630be11554a57d24>` +- Release Artefact: oecore-2501534c9581c6c3439f525d630be11554a57d24 +- sha: 52cc6cce9e920bdce078584b89136e81cc01e0c55616fab5fca6c3e04264c88e +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.17/oecore-2501534c9581c6c3439f525d630be11554a57d24.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.17/oecore-2501534c9581c6c3439f525d630be11554a57d24.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.17 </meta-mingw/log/?h=yocto-4.0.17>` +- Git Revision: :yocto_git:`f6b38ce3c90e1600d41c2ebb41e152936a0357d7 </meta-mingw/commit/?id=f6b38ce3c90e1600d41c2ebb41e152936a0357d7>` +- Release Artefact: meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7 +- sha: 7d57167c19077f4ab95623d55a24c2267a3a3fb5ed83688659b4c03586373b25 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.17/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.17/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.17 </meta-gplv2/log/?h=yocto-4.0.17>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.17/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.17/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +meta-clang + +- Repository Location: :yocto_git:`/meta-clang` +- Branch: :yocto_git:`kirkstone </meta-clang/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.17 </meta-clang/log/?h=yocto-4.0.17>` +- Git Revision: :yocto_git:`eebe4ff2e539f3ffb01c5060cc4ca8b226ea8b52 </meta-clang/commit/?id=eebe4ff2e539f3ffb01c5060cc4ca8b226ea8b52>` +- Release Artefact: meta-clang-eebe4ff2e539f3ffb01c5060cc4ca8b226ea8b52 +- sha: 3299e96e069a22c0971e903fbc191f2427efffc83d910ac51bf0237caad01d17 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.17/meta-clang-eebe4ff2e539f3ffb01c5060cc4ca8b226ea8b52.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.17/meta-clang-eebe4ff2e539f3ffb01c5060cc4ca8b226ea8b52.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.17 </bitbake/log/?h=yocto-4.0.17>` +- Git Revision: :oe_git:`40fd5f4eef7460ca67f32cfce8e229e67e1ff607 </bitbake/commit/?id=40fd5f4eef7460ca67f32cfce8e229e67e1ff607>` +- Release Artefact: bitbake-40fd5f4eef7460ca67f32cfce8e229e67e1ff607 +- sha: 5d20a0e4c5d0fce44bd84778168714a261a30a4b83f67c88df3b8a7e7115e444 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.17/bitbake-40fd5f4eef7460ca67f32cfce8e229e67e1ff607.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.17/bitbake-40fd5f4eef7460ca67f32cfce8e229e67e1ff607.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.17 </yocto-docs/log/?h=yocto-4.0.17>` +- Git Revision: :yocto_git:`08ce7db2aa3a38deb8f5aa59bafc78542986babb </yocto-docs/commit/?id=08ce7db2aa3a38deb8f5aa59bafc78542986babb>` + diff --git a/documentation/migration-guides/release-notes-4.0.2.rst b/documentation/migration-guides/release-notes-4.0.2.rst new file mode 100644 index 0000000000..2f724e33c4 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.2.rst @@ -0,0 +1,298 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.2 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- libxslt: Mark :cve:`2022-29824` as not applying +- tiff: Add jbig :term:`PACKAGECONFIG` and clarify IGNORE :cve:`2022-1210` +- tiff: mark :cve:`2022-1622` and :cve:`2022-1623` as invalid +- pcre2:fix :cve:`2022-1586` Out-of-bounds read +- curl: fix :cve:`2022-22576`, :cve:`2022-27775`, :cve:`2022-27776`, :cve:`2022-27774`, :cve:`2022-30115`, :cve:`2022-27780`, :cve:`2022-27781`, :cve:`2022-27779` and :cve:`2022-27782` +- qemu: fix :cve:`2021-4206` and :cve:`2021-4207` +- freetype: fix :cve:`2022-27404`, :cve:`2022-27405` and :cve:`2022-27406` + +Fixes in Yocto-4.0.2 +~~~~~~~~~~~~~~~~~~~~ + +- alsa-plugins: fix libavtp vs. avtp packageconfig +- archiver: don't use machine variables in shared recipes +- archiver: use bb.note instead of echo +- baremetal-image: fix broken symlink in do_rootfs +- base-passwd: Disable shell for default users +- bash: submit patch upstream +- bind: upgrade 9.18.1 -> 9.18.2 +- binutils: Bump to latest 2.38 release branch +- bitbake.conf: Make :term:`TCLIBC` and :term:`TCMODE` lazy assigned +- bitbake: build: Add clean_stamp API function to allow removal of task stamps +- bitbake: data: Do not depend on vardepvalueexclude flag +- bitbake: fetch2/osc: Small fixes for osc fetcher +- bitbake: server/process: Fix logging issues where only the first message was displayed +- build-appliance-image: Update to kirkstone head revision +- buildhistory.bbclass: fix shell syntax when using dash +- cairo: Add missing GPLv3 license checksum entry +- classes: rootfs-postcommands: add skip option to overlayfs_qa_check +- cronie: upgrade 1.6.0 -> 1.6.1 +- cups: upgrade 2.4.1 -> 2.4.2 +- cve-check.bbclass: Added do_populate_sdk[recrdeptask]. +- cve-check: Add helper for symlink handling +- cve-check: Allow warnings to be disabled +- cve-check: Fix report generation +- cve-check: Only include installed packages for rootfs manifest +- cve-check: add support for Ignored CVEs +- cve-check: fix return type in check_cves +- cve-check: move update_symlinks to a library +- cve-check: write empty fragment files in the text mode +- cve-extra-exclusions: Add kernel CVEs +- cve-update-db-native: make it possible to disable database updates +- devtool: Fix _copy_file() TypeError +- e2fsprogs: add alternatives handling of lsattr as well +- e2fsprogs: update upstream status +- efivar: add musl libc compatibility +- epiphany: upgrade 42.0 -> 42.2 +- ffmpeg: upgrade 5.0 -> 5.0.1 +- fribidi: upgrade 1.0.11 -> 1.0.12 +- gcc-cross-canadian: Add nativesdk-zstd dependency +- gcc-source: Fix incorrect task dependencies from ${B} +- gcc: Upgrade to 11.3 release +- gcc: depend on zstd-native +- git: fix override syntax in :term:`RDEPENDS` +- glib-2.0: upgrade 2.72.1 -> 2.72.2 +- glibc: Drop make-native dependency +- go: upgrade 1.17.8 -> 1.17.10 +- gst-devtools: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-libav: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-omx: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-plugins-bad: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-plugins-base: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-plugins-good: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-plugins-ugly: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-python: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-rtsp-server: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0-vaapi: upgrade 1.20.1 -> 1.20.2 +- gstreamer1.0: upgrade 1.20.1 -> 1.20.2 +- gtk+3: upgrade 3.24.33 -> 3.24.34 +- gtk-doc: Fix potential shebang overflow on gtkdoc-mkhtml2 +- image.bbclass: allow overriding dependency on virtual/kernel:do_deploy +- insane.bbclass: make sure to close .patch files +- iso-codes: upgrade 4.9.0 -> 4.10.0 +- kernel-yocto.bbclass: Reset to exiting on non-zero return code at end of task +- libcgroup: upgrade 2.0.1 -> 2.0.2 +- liberror-perl: Update sstate/equiv versions to clean cache +- libinput: upgrade 1.19.3 -> 1.19.4 +- libpcre2: upgrade 10.39 -> 10.40 +- librepo: upgrade 1.14.2 -> 1.14.3 +- libseccomp: Add missing files for ptests +- libseccomp: Correct :term:`LIC_FILES_CHKSUM` +- libxkbcommon: upgrade 1.4.0 -> 1.4.1 +- libxml2: Upgrade 2.9.13 -> 2.9.14 +- license.bbclass: Bound beginline and endline in copy_license_files() +- license_image.bbclass: Make QA errors fail the build +- linux-firmware: add support for building snapshots +- linux-firmware: package new Qualcomm firmware +- linux-firmware: replace mkdir by install +- linux-firmware: split ath3k firmware +- linux-firmware: upgrade to 20220610 +- linux-yocto/5.10: update to v5.10.119 +- linux-yocto/5.15: Enable MDIO bus config +- linux-yocto/5.15: bpf: explicitly disable unpriv eBPF by default +- linux-yocto/5.15: cfg/xen: Move x86 configs to separate file +- linux-yocto/5.15: update to v5.15.44 +- local.conf.sample: Update sstate url to new 'all' path +- logrotate: upgrade 3.19.0 -> 3.20.1 +- lttng-modules: Fix build failure for 5.10.119+ and 5.15.44+ kernel +- lttng-modules: fix build against 5.18-rc7+ +- lttng-modules: fix shell syntax +- lttng-ust: upgrade 2.13.2 -> 2.13.3 +- lzo: Add further info to a patch and mark as Inactive-Upstream +- makedevs: Don't use COPYING.patch just to add license file into ${S} +- manuals: switch to the sstate mirror shared between all versions +- mesa.inc: package 00-radv-defaults.conf +- mesa: backport a patch to support compositors without zwp_linux_dmabuf_v1 again +- mesa: upgrade to 22.0.3 +- meson.bbclass: add cython binary to cross/native toolchain config +- mmc-utils: upgrade to latest revision +- mobile-broadband-provider-info: upgrade 20220315 -> 20220511 +- ncurses: update to patchlevel 20220423 +- oeqa/selftest/cve_check: add tests for Ignored and partial reports +- oeqa/selftest/cve_check: add tests for recipe and image reports +- oescripts: change compare logic in OEListPackageconfigTests +- openssl: Backport fix for ptest cert expiry +- overlayfs: add docs about skipping QA check & service dependencies +- ovmf: Fix native build with gcc-12 +- patch.py: make sure that patches/series file exists before quilt pop +- pciutils: avoid lspci conflict with busybox +- perl: Add dependency on make-native to avoid race issues +- perl: Fix build with gcc-12 +- poky.conf: bump version for 4.0.2 +- popt: fix override syntax in :term:`RDEPENDS` +- pypi.bbclass: Set :term:`CVE_PRODUCT` to :term:`PYPI_PACKAGE` +- python3: Ensure stale empty python module directories don't break the build +- python3: Remove problematic paths from sysroot files +- python3: fix reproducibility issue with python3-core +- python3: use built-in distutils for ptest, rather than setuptools' 'fork' +- python: Avoid shebang overflow on python-config.py +- rootfs-postcommands.bbclass: correct comments +- rootfs.py: close kernel_abi_ver_file +- rootfs.py: find .ko.zst kernel modules +- rust-common: Drop LLVM_TARGET and simplify +- rust-common: Ensure sstate signatures have correct dependencues for do_rust_gen_targets +- rust-common: Fix for target definitions returning 'NoneType' for arm +- rust-common: Fix native signature dependency issues +- rust-common: Fix sstate signatures between arm hf and non-hf +- sanity: Don't warn about make 4.2.1 for mint +- sanity: Switch to make 4.0 as a minimum version +- sed: Specify shell for "nobody" user in run-ptest +- selftest/imagefeatures/overlayfs: Always append to :term:`DISTRO_FEATURES` +- selftest/multiconfig: Test that multiconfigs in separate layers works +- sqlite3: upgrade to 3.38.5 +- staging.bbclass: process direct dependencies in deterministic order +- staging: Fix rare sysroot corruption issue +- strace: Don't run ptest as "nobody" +- systemd: Correct 0001-pass-correct-parameters-to-getdents64.patch +- systemd: Correct path returned in sd_path_lookup() +- systemd: Document future actions needed for set of musl patches +- systemd: Drop 0001-test-parse-argument-Include-signal.h.patch +- systemd: Drop 0002-don-t-use-glibc-specific-qsort_r.patch +- systemd: Drop 0016-Hide-__start_BUS_ERROR_MAP-and-__stop_BUS_ERROR_MAP.patch +- systemd: Drop redundant musl patches +- systemd: Fix build regression with latest update +- systemd: Remove __compare_fn_t type in musl-specific patch +- systemd: Update patch status +- systemd: systemd-systemctl: Support instance conf files during enable +- systemd: update ``0008-add-missing-FTW_-macros-for-musl.patch`` +- systemd: upgrade 250.4 -> 250.5 +- uboot-sign: Fix potential index error issues +- valgrind: submit arm patches upstream +- vim: Upgrade to 8.2.5083 +- webkitgtk: upgrade to 2.36.3 +- wic/plugins/rootfs: Fix permissions when splitting rootfs folders across partitions +- xwayland: upgrade 22.1.0 -> 22.1.1 +- xxhash: fix build with gcc 12 +- zip/unzip: mark all submittable patches as Inactive-Upstream + +Known Issues in Yocto-4.0.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- There were build failures at the autobuilder due to a known scp issue on Fedora-36 hosts. + +Contributors to Yocto-4.0.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alex Kiernan +- Alexander Kanavin +- Aryaman Gupta +- Bruce Ashfield +- Claudius Heine +- Davide Gardenal +- Dmitry Baryshkov +- Ernst Sjöstrand +- Felix Moessbauer +- Gunjan Gupta +- He Zhe +- Hitendra Prajapati +- Jack Mitchell +- Jeremy Puhlman +- Jiaqing Zhao +- Joerg Vehlow +- Jose Quaresma +- Kai Kang +- Khem Raj +- Konrad Weihmann +- Marcel Ziswiler +- Markus Volk +- Marta Rybczynska +- Martin Jansa +- Michael Opdenacker +- Mingli Yu +- Naveen Saini +- Nick Potenski +- Paulo Neves +- Pavel Zhukov +- Peter Kjellerstedt +- Rasmus Villemoes +- Richard Purdie +- Robert Joslyn +- Ross Burton +- Samuli Piippo +- Sean Anderson +- Stefan Wiehler +- Steve Sakoman +- Sundeep Kokkonda +- Tomasz Dziendzielski +- Xiaobing Luo +- Yi Zhao +- leimaohui +- Wang Mingyu + +Repositories / Downloads for Yocto-4.0.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.2 </poky/log/?h=yocto-4.0.2>` +- Git Revision: :yocto_git:`a5ea426b1da472fc8549459fff3c1b8c6e02f4b5 </poky/commit/?id=a5ea426b1da472fc8549459fff3c1b8c6e02f4b5>` +- Release Artefact: poky-a5ea426b1da472fc8549459fff3c1b8c6e02f4b5 +- sha: 474ddfacfed6661be054c161597a1a5273188dfe021b31d6156955d93c6b7359 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.2/poky-a5ea426b1da472fc8549459fff3c1b8c6e02f4b5.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.2/poky-a5ea426b1da472fc8549459fff3c1b8c6e02f4b5.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.2 </openembedded-core/log/?h=yocto-4.0.2>` +- Git Revision: :oe_git:`eea52e0c3d24c79464f4afdbc3c397e1cb982231 </openembedded-core/commit/?id=eea52e0c3d24c79464f4afdbc3c397e1cb982231>` +- Release Artefact: oecore-eea52e0c3d24c79464f4afdbc3c397e1cb982231 +- sha: 252d5c2c2db7e14e7365fcc69d32075720b37d629894bae36305eba047a39907 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.2/oecore-eea52e0c3d24c79464f4afdbc3c397e1cb982231.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.2/oecore-eea52e0c3d24c79464f4afdbc3c397e1cb982231.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.2 </meta-mingw/log/?h=yocto-4.0.2>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.2/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.2/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.2 </meta-gplv2/log/?h=yocto-4.0.2>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.2/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.2/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.2 </bitbake/log/?h=yocto-4.0.2>` +- Git Revision: :oe_git:`b8fd6f5d9959d27176ea016c249cf6d35ac8ba03 </bitbake/commit/?id=b8fd6f5d9959d27176ea016c249cf6d35ac8ba03>` +- Release Artefact: bitbake-b8fd6f5d9959d27176ea016c249cf6d35ac8ba03 +- sha: 373818b1dee2c502264edf654d6d8f857b558865437f080e02d5ba6bb9e72cc3 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.2/bitbake-b8fd6f5d9959d27176ea016c249cf6d35ac8ba03.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.2/bitbake-b8fd6f5d9959d27176ea016c249cf6d35ac8ba03.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.2 </yocto-docs/log/?h=yocto-4.0.2>` +- Git Revision: :yocto_git:`662294dccd028828d5c7e9fd8f5c8e14df53df4b </yocto-docs/commit/?id=662294dccd028828d5c7e9fd8f5c8e14df53df4b>` diff --git a/documentation/migration-guides/release-notes-4.0.3.rst b/documentation/migration-guides/release-notes-4.0.3.rst new file mode 100644 index 0000000000..46fe858cb7 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.3.rst @@ -0,0 +1,316 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.3 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- binutils: fix :cve:`2019-1010204` +- busybox: fix :cve:`2022-30065` +- cups: ignore :cve:`2022-26691` +- curl: Fix :cve:`2022-32205`, :cve:`2022-32206`, :cve:`2022-32207` and :cve:`2022-32208` +- dpkg: fix :cve:`2022-1664` +- ghostscript: fix :cve:`2022-2085` +- harfbuzz: fix :cve:`2022-33068` +- libtirpc: fix :cve:`2021-46828` +- lua: fix :cve:`2022-33099` +- nasm: ignore :cve:`2020-18974` +- qemu: fix :cve:`2022-35414` +- qemu: ignore :cve:`2021-20255` and :cve:`2019-12067` +- tiff: fix :cve:`2022-1354`, :cve:`2022-1355`, :cve:`2022-2056`, :cve:`2022-2057` and :cve:`2022-2058` +- u-boot: fix :cve:`2022-34835` +- unzip: fix :cve:`2022-0529` and :cve:`2022-0530` + + +Fixes in Yocto-4.0.3 +~~~~~~~~~~~~~~~~~~~~ + +- alsa-state: correct license +- at: take tarballs from debian +- base.bbclass: Correct the test for obsolete license exceptions +- base/reproducible: Change Source Date Epoch generation methods +- bin_package: install into base_prefix +- bind: Remove legacy python3 :term:`PACKAGECONFIG` code +- bind: upgrade to 9.18.4 +- binutils: stable 2.38 branch updates +- build-appliance-image: Update to kirkstone head revision +- cargo_common.bbclass: enable bitbake vendoring for externalsrc +- coreutils: Tweak packaging variable names for coreutils-dev +- curl: backport openssl fix CN check error code +- cve-check: hook cleanup to the BuildCompleted event, not CookerExit +- cve-extra-exclusions: Clean up and ignore three CVEs (2xqemu and nasm) +- devtool: finish: handle patching when :term:`S` points to subdir of a git repo +- devtool: ignore pn- overrides when determining :term:`SRC_URI` overrides +- docs: BB_HASHSERVE_UPSTREAM: update to new host +- dropbear: break dependency on base package for -dev package +- efivar: fix import functionality +- encodings: update to 1.0.6 +- epiphany: upgrade to 42.3 +- externalsrc.bbclass: support crate fetcher on externalsrc +- font-util: update 1.3.2 -> 1.3.3 +- gcc-runtime: Fix build when using gold +- gcc-runtime: Fix missing :term:`MLPREFIX` in debug mappings +- gcc-runtime: Pass -nostartfiles when building dummy libstdc++.so +- gcc: Backport a fix for gcc bug 105039 +- git: upgrade to v2.35.4 +- glib-2.0: upgrade to 2.72.3 +- glib-networking: upgrade to 2.72.1 +- glibc : stable 2.35 branch updates +- glibc-tests: Avoid reproducibility issues +- glibc-tests: not clear :term:`BBCLASSEXTEND` +- glibc: revert one upstream change to work around broken :term:`DEBUG_BUILD` build +- glibc: stable 2.35 branch updates +- gnupg: upgrade to 2.3.7 +- go: upgrade to v1.17.12 +- gobject-introspection-data: Disable cache for g-ir-scanner +- gperf: Add a patch to work around reproducibility issues +- gperf: Switch to upstream patch +- gst-devtools: upgrade to 1.20.3 +- gstreamer1.0-libav: upgrade to 1.20.3 +- gstreamer1.0-omx: upgrade to 1.20.3 +- gstreamer1.0-plugins-bad: upgrade to 1.20.3 +- gstreamer1.0-plugins-base: upgrade to 1.20.3 +- gstreamer1.0-plugins-good: upgrade to 1.20.3 +- gstreamer1.0-plugins-ugly: upgrade to 1.20.3 +- gstreamer1.0-python: upgrade to 1.20.3 +- gstreamer1.0-rtsp-server: upgrade to 1.20.3 +- gstreamer1.0-vaapi: upgrade to 1.20.3 +- gstreamer1.0: upgrade to 1.20.3 +- gtk-doc: Remove hardcoded buildpath +- harfbuzz: Fix compilation with clang +- initramfs-framework: move storage mounts to actual rootfs +- initscripts: run umountnfs as a KILL script +- insane.bbclass: host-user-contaminated: Correct per package home path +- insane: Fix buildpaths test to work with special devices +- kernel-arch: Fix buildpaths leaking into external module compiles +- kernel-devsrc: fix reproducibility and buildpaths QA warning +- kernel-devsrc: ppc32: fix reproducibility +- kernel-uboot.bbclass: Use vmlinux.initramfs when :term:`INITRAMFS_IMAGE_BUNDLE` set +- kernel.bbclass: pass :term:`LD` also in savedefconfig +- libffi: fix native build being not portable +- libgcc: Fix standalone target builds with usrmerge distro feature +- libmodule-build-perl: Use env utility to find perl interpreter +- libsoup: upgrade to 3.0.7 +- libuv: upgrade to 1.44.2 +- linux-firmware: upgrade to 20220708 +- linux-firwmare: restore WHENCE_CHKSUM variable +- linux-yocto-rt/5.15: update to -rt48 (and fix -stable merge) +- linux-yocto/5.10: fix build_OID_registry/conmakehash buildpaths warning +- linux-yocto/5.10: fix buildpaths issue with gen-mach-types +- linux-yocto/5.10: fix buildpaths issue with pnmtologo +- linux-yocto/5.10: update to v5.10.135 +- linux-yocto/5.15: drop obselete GPIO sysfs ABI +- linux-yocto/5.15: fix build_OID_registry buildpaths warning +- linux-yocto/5.15: fix buildpaths issue with gen-mach-types +- linux-yocto/5.15: fix buildpaths issue with pnmtologo +- linux-yocto/5.15: fix qemuppc buildpaths warning +- linux-yocto/5.15: fix reproducibility issues +- linux-yocto/5.15: update to v5.15.59 +- log4cplus: upgrade to 2.0.8 +- lttng-modules: Fix build failure for kernel v5.15.58 +- lttng-modules: upgrade to 2.13.4 +- lua: Fix multilib buildpath reproducibility issues +- mkfontscale: upgrade to 1.2.2 +- oe-selftest-image: Ensure the image has sftp as well as dropbear +- oe-selftest: devtool: test modify git recipe building from a subdir +- oeqa/runtime/scp: Disable scp test for dropbear +- oeqa/runtime: add test that the kernel has CONFIG_PREEMPT_RT enabled +- oeqa/sdk: drop the nativesdk-python 2.x test +- openssh: Add openssh-sftp-server to openssh :term:`RDEPENDS` +- openssh: break dependency on base package for -dev package +- openssl: update to 3.0.5 +- package.bbclass: Avoid stripping signed kernel modules in splitdebuginfo +- package.bbclass: Fix base directory for debugsource files when using externalsrc +- package.bbclass: Fix kernel source handling when not using externalsrc +- package_manager/ipk: do not pipe stderr to stdout +- packagegroup-core-ssh-dropbear: Add openssh-sftp-server recommendation +- patch: handle if :term:`S` points to a subdirectory of a git repo +- perf: fix reproducibility in 5.19+ +- perf: fix reproduciblity in older releases of Linux +- perf: sort-pmuevents: really keep array terminators +- perl: don't install Makefile.old into perl-ptest +- poky.conf: bump version for 4.0.3 +- pulseaudio: add m4-native to :term:`DEPENDS` +- python3: Backport patch to fix an issue in subinterpreters +- qemu: Add :term:`PACKAGECONFIG` for brlapi +- qemu: Avoid accidental librdmacm linkage +- qemu: Avoid accidental libvdeplug linkage +- qemu: Fix slirp determinism issue +- qemu: add :term:`PACKAGECONFIG` for capstone +- recipetool/devtool: Fix python egg whitespace issues in :term:`PACKAGECONFIG` +- ref-manual: variables: remove sphinx directive from literal block +- rootfs-postcommands.bbclass: move host-user-contaminated.txt to ${S} +- ruby: add :term:`PACKAGECONFIG` for capstone +- rust: fix issue building cross-canadian tools for aarch64 on x86_64 +- sanity.bbclass: Add ftps to accepted URI protocols for mirrors sanity +- selftest/runtime_test/virgl: Disable for all almalinux +- sstatesig: Include all dependencies in SPDX task signatures +- strace: set :term:`COMPATIBLE_HOST` for riscv32 +- systemd: Added base_bindir into pkg_postinst:udev-hwdb. +- udev-extraconf/initrdscripts/parted: Rename mount.blacklist -> mount.ignorelist +- udev-extraconf/mount.sh: add LABELs to mountpoints +- udev-extraconf/mount.sh: ignore lvm in automount +- udev-extraconf/mount.sh: only mount devices on hotplug +- udev-extraconf/mount.sh: save mount name in our tmp filecache +- udev-extraconf: fix some systemd automount issues +- udev-extraconf: force systemd-udevd to use shared MountFlags +- udev-extraconf: let automount base directory configurable +- udev-extraconf:mount.sh: fix a umount issue +- udev-extraconf:mount.sh: fix path mismatching issues +- vala: Fix on target wrapper buildpaths issue +- vala: upgrade to 0.56.2 +- vim: upgrade to 9.0.0063 +- waffle: correctly request wayland-scanner executable +- webkitgtk: upgrade to 2.36.4 +- weston: upgrade to 10.0.1 +- wic/plugins/rootfs: Fix NameError for 'orig_path' +- wic: fix WicError message +- wireless-regdb: upgrade to 2022.06.06 +- xdpyinfo: upgrade to 1.3.3 +- xev: upgrade to 1.2.5 +- xf86-input-synaptics: upgrade to 1.9.2 +- xmodmap: upgrade to 1.0.11 +- xorg-app: Tweak handling of compression changes in :term:`SRC_URI` +- xserver-xorg: upgrade to 21.1.4 +- xwayland: upgrade to 22.1.3 +- yocto-bsps/5.10: fix buildpaths issue with gen-mach-types +- yocto-bsps/5.10: fix buildpaths issue with pnmtologo +- yocto-bsps/5.15: fix buildpaths issue with gen-mach-types +- yocto-bsps/5.15: fix buildpaths issue with pnmtologo +- yocto-bsps: buildpaths fixes +- yocto-bsps: update to v5.10.130 +- yocto-bsps: buildpaths fixes +- yocto-bsps: update to v5.15.54 + + +Known Issues in Yocto-4.0.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Ahmed Hossam +- Alejandro Hernandez Samaniego +- Alex Kiernan +- Alexander Kanavin +- Bruce Ashfield +- Chanho Park +- Christoph Lauer +- David Bagonyi +- Dmitry Baryshkov +- He Zhe +- Hitendra Prajapati +- Jose Quaresma +- Joshua Watt +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Lucas Stach +- Markus Volk +- Martin Jansa +- Maxime Roussin-Bélanger +- Michael Opdenacker +- Mihai Lindner +- Ming Liu +- Mingli Yu +- Muhammad Hamza +- Naveen +- Pascal Bach +- Paul Eggleton +- Pavel Zhukov +- Peter Bergin +- Peter Kjellerstedt +- Peter Marko +- Pgowda +- Raju Kumar Pothuraju +- Richard Purdie +- Robert Joslyn +- Ross Burton +- Sakib Sajal +- Shruthi Ravichandran +- Steve Sakoman +- Sundeep Kokkonda +- Thomas Roos +- Tom Hochstein +- Wentao Zhang +- Yi Zhao +- Yue Tao +- gr embeter +- leimaohui +- Wang Mingyu + + +Repositories / Downloads for Yocto-4.0.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.3 </poky/log/?h=yocto-4.0.3>` +- Git Revision: :yocto_git:`387ab5f18b17c3af3e9e30dc58584641a70f359f </poky/commit/?id=387ab5f18b17c3af3e9e30dc58584641a70f359f>` +- Release Artefact: poky-387ab5f18b17c3af3e9e30dc58584641a70f359f +- sha: fe674186bdb0684313746caa9472134fc19e6f1443c274fe02c06cb1e675b404 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.3/poky-387ab5f18b17c3af3e9e30dc58584641a70f359f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.3/poky-387ab5f18b17c3af3e9e30dc58584641a70f359f.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.3 </openembedded-core/log/?h=yocto-4.0.3>` +- Git Revision: :oe_git:`2cafa6ed5f0aa9df5a120b6353755d56c7c7800d </openembedded-core/commit/?id=2cafa6ed5f0aa9df5a120b6353755d56c7c7800d>` +- Release Artefact: oecore-2cafa6ed5f0aa9df5a120b6353755d56c7c7800d +- sha: 5181d3e8118c6112936637f01a07308b715e0e3d12c7eba338556747dfcabe92 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.3/oecore-2cafa6ed5f0aa9df5a120b6353755d56c7c7800d.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.3/oecore-2cafa6ed5f0aa9df5a120b6353755d56c7c7800d.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.3 </meta-mingw/log/?h=yocto-4.0.3>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.3/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.3/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.3 </meta-gplv2/log/?h=yocto-4.0.3>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.3/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.3/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.3 </bitbake/log/?h=yocto-4.0.3>` +- Git Revision: :oe_git:`b8fd6f5d9959d27176ea016c249cf6d35ac8ba03 </bitbake/commit/?id=b8fd6f5d9959d27176ea016c249cf6d35ac8ba03>` +- Release Artefact: bitbake-b8fd6f5d9959d27176ea016c249cf6d35ac8ba03 +- sha: 373818b1dee2c502264edf654d6d8f857b558865437f080e02d5ba6bb9e72cc3 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.3/bitbake-b8fd6f5d9959d27176ea016c249cf6d35ac8ba03.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.3/bitbake-b8fd6f5d9959d27176ea016c249cf6d35ac8ba03.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.3 </yocto-docs/log/?h=yocto-4.0.3>` +- Git Revision: :yocto_git:`d9b3dcf65ef25c06f552482aba460dd16862bf96 </yocto-docs/commit/?id=d9b3dcf65ef25c06f552482aba460dd16862bf96>` + diff --git a/documentation/migration-guides/release-notes-4.0.4.rst b/documentation/migration-guides/release-notes-4.0.4.rst new file mode 100644 index 0000000000..1d6e525bbc --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.4.rst @@ -0,0 +1,301 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.4 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- binutils : fix :cve:`2022-38533` +- curl: fix :cve:`2022-35252` +- sqlite: fix :cve:`2022-35737` +- grub2: fix :cve:`2021-3695`, :cve:`2021-3696`, :cve:`2021-3697`, :cve:`2022-28733`, :cve:`2022-28734` and :cve:`2022-28735` +- u-boot: fix :cve:`2022-30552` and :cve:`2022-33967` +- libxml2: Ignore :cve:`2016-3709` +- libtiff: fix :cve:`2022-34526` +- zlib: fix :cve:`2022-37434` +- gnutls: fix :cve:`2022-2509` +- u-boot: fix :cve:`2022-33103` +- qemu: fix :cve:`2021-3507`, :cve:`2021-3929`, :cve:`2021-4158`, :cve:`2022-0216` and :cve:`2022-0358` + + +Fixes in Yocto-4.0.4 +~~~~~~~~~~~~~~~~~~~~ + +- apr: Cache configure tests which use AC_TRY_RUN +- apr: Use correct strerror_r implementation based on libc type +- apt: fix nativesdk-apt build failure during the second time build +- archiver.bbclass: remove unsed do_deploy_archives[dirs] +- archiver.bbclass: some recipes that uses the kernelsrc bbclass uses the shared source +- autoconf: Fix strict prototype errors in generated tests +- autoconf: Update K & R stype functions +- bind: upgrade to 9.18.5 +- bitbake.conf: set :term:`BB_DEFAULT_UMASK` using ??= +- bitbake: ConfHandler/BBHandler: Improve comment error messages and add tests +- bitbake: ConfHandler: Remove lingering close +- bitbake: bb/utils: movefile: use the logger for printing +- bitbake: bb/utils: remove: check the path again the expand python glob +- bitbake: bitbake-user-manual: Correct description of the ??= operator +- bitbake: bitbake-user-manual: npm fetcher: improve description of :term:`SRC_URI` format +- bitbake: bitbake: bitbake-user-manual: hashserv can be accessed on a dedicated domain +- bitbake: bitbake: runqueue: add cpu/io pressure regulation +- bitbake: bitbake: runqueue: add memory pressure regulation +- bitbake: cooker: Drop sre_constants usage +- bitbake: doc: bitbake-user-manual: add explicit target for crates fetcher +- bitbake: doc: bitbake-user-manual: document npm and npmsw fetchers +- bitbake: event.py: ignore exceptions from stdout and sterr operations in atexit +- bitbake: fetch2: Ensure directory exists before creating symlink +- bitbake: fetch2: gitsm: fix incorrect handling of git submodule relative urls +- bitbake: runqueue: Change pressure file warning to a note +- bitbake: runqueue: Fix unihash cache mismatch issues +- bitbake: toaster: fix kirkstone version +- bitbake: utils: Pass lock argument in fileslocked +- bluez5: upgrade to 5.65 +- boost: fix install of fiber shared libraries +- cairo: Adapt the license information based on what is being built +- classes: cve-check: Get shared database lock +- cmake: remove CMAKE_ASM_FLAGS variable in toolchain file +- connman: Backports for security fixes +- core-image.bbclass: Exclude openssh complementary packages +- cracklib: Drop using register keyword +- cracklib: upgrade to 2.9.8 +- create-spdx: Fix supplier field +- create-spdx: handle links to inaccessible locations +- create-spdx: ignore packing control files from ipk and deb +- cve-check: Don't use f-strings +- cve-check: close cursors as soon as possible +- devtool/upgrade: catch bb.fetch2.decodeurl errors +- devtool/upgrade: correctly clean up when recipe filename isn't yet known +- devtool: error out when workspace is using old override syntax +- ell: upgrade to 0.50 +- epiphany: upgrade to 42.4 +- externalsrc: Don't wipe out src dir when EXPORT_FUNCTIONS is used. +- gcc-multilib-config: Fix i686 toolchain relocation issues +- gcr: Define _GNU_SOURCE +- gdk-pixbuf: upgrade to 2.42.9 +- glib-networking: upgrade to 2.72.2 +- go: upgrade to v1.17.13 +- insane.bbclass: Skip patches not in oe-core by full path +- iso-codes: upgrade to 4.11.0 +- kernel-fitimage.bbclass: add padding algorithm property in config nodes +- kernel-fitimage.bbclass: only package unique DTBs +- kernel: Always set :term:`CC` and :term:`LD` for the kernel build +- kernel: Use consistent make flags for menuconfig +- lib:npm_registry: initial checkin +- libatomic-ops: upgrade to 7.6.14 +- libcap: upgrade to 2.65 +- libjpeg-turbo: upgrade to 2.1.4 +- libpam: use /run instead of /var/run in systemd tmpfiles +- libtasn1: upgrade to 4.19.0 +- liburcu: upgrade to 0.13.2 +- libwebp: upgrade to 1.2.4 +- libwpe: upgrade to 1.12.3 +- libxml2: Port gentest.py to Python-3 +- lighttpd: upgrade to 1.4.66 +- linux-yocto/5.10: update genericx86* machines to v5.10.135 +- linux-yocto/5.10: update to v5.10.137 +- linux-yocto/5.15: update genericx86* machines to v5.15.59 +- linux-yocto/5.15: update to v5.15.62 +- linux-yocto: Fix :term:`COMPATIBLE_MACHINE` regex match +- linux-yocto: prepend the value with a space when append to :term:`KERNEL_EXTRA_ARGS` +- lttng-modules: fix 5.19+ build +- lttng-modules: fix build against mips and v5.19 kernel +- lttng-modules: fix build for kernel 5.10.137 +- lttng-modules: replace mips compaction fix with upstream change +- lz4: upgrade to 1.9.4 +- maintainers: update opkg maintainer +- meta: introduce :term:`UBOOT_MKIMAGE_KERNEL_TYPE` +- migration guides: add missing release notes +- mobile-broadband-provider-info: upgrade to 20220725 +- nativesdk: Clear :term:`TUNE_FEATURES` +- npm: replace 'npm pack' call by 'tar czf' +- npm: return content of 'package.json' in 'npm_pack' +- npm: take 'version' directly from 'package.json' +- npm: use npm_registry to cache package +- oeqa/gotoolchain: put writable files in the Go module cache +- oeqa/gotoolchain: set CGO_ENABLED=1 +- oeqa/parselogs: add qemuarmv5 arm-charlcd masking +- oeqa/qemurunner: add run_serial() comment +- oeqa/selftest: rename git.py to intercept.py +- oeqa: qemurunner: Report UNIX Epoch timestamp on login +- package_rpm: Do not replace square brackets in %files +- packagegroup-self-hosted: update for strace +- parselogs: Ignore xf86OpenConsole error +- perf: Fix reproducibility issues with 5.19 onwards +- pinentry: enable _XOPEN_SOURCE on musl for wchar usage in curses +- poky.conf: add ubuntu-22.04 to tested distros +- poky.conf: bump version for 4.0.4 +- pseudo: Update to include recent upstream minor fixes +- python3-pip: Fix :term:`RDEPENDS` after the update +- ref-manual: add numa to machine features +- relocate_sdk.py: ensure interpreter size error causes relocation to fail +- rootfs-postcommands.bbclass: avoid moving ssh host keys if etc is writable +- rootfs.py: dont try to list installed packages for baremetal images +- rootfspostcommands.py: Cleanup subid backup files generated by shadow-utils +- ruby: drop capstone support +- runqemu: Add missing space on default display option +- runqemu: display host uptime when starting +- sanity: add a comment to ensure CONNECTIVITY_CHECK_URIS is correct +- scripts/oe-setup-builddir: make it known where configurations come from +- scripts/runqemu.README: fix typos and trailing whitespaces +- selftest/wic: Tweak test case to not depend on kernel size +- shadow: Avoid nss warning/error with musl +- shadow: Enable subid support +- system-requirements.rst: Add Ubuntu 22.04 to list of supported distros +- systemd: Add 'no-dns-fallback' :term:`PACKAGECONFIG` option +- systemd: Fix unwritable /var/lock when no sysvinit handling +- sysvinit-inittab/start_getty: Fix respawn too fast +- tcp-wrappers: Fix implicit-function-declaration warnings +- tzdata: upgrade to 2022b +- util-linux: Remove --enable-raw from :term:`EXTRA_OECONF` +- vala: upgrade to 0.56.3 +- vim: Upgrade to 9.0.0453 +- watchdog: Include needed system header for function decls +- webkitgtk: upgrade to 2.36.5 +- weston: upgrade to 10.0.2 +- wic/bootimg-efi: use cross objcopy when building unified kernel image +- wic: add target tools to PATH when executing native commands +- wic: depend on cross-binutils +- wireless-regdb: upgrade to 2022.08.12 +- wpebackend-fdo: upgrade to 1.12.1 +- xinetd: Pass missing -D_GNU_SOURCE +- xz: update to 5.2.6 + + +Known Issues in Yocto-4.0.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alejandro Hernandez Samaniego +- Alex Stewart +- Alexander Kanavin +- Alexandre Belloni +- Andrei Gherzan +- Anuj Mittal +- Aryaman Gupta +- Awais Belal +- Beniamin Sandu +- Bertrand Marquis +- Bruce Ashfield +- Changqing Li +- Chee Yang Lee +- Daiane Angolini +- Enrico Scholz +- Ernst Sjöstrand +- Gennaro Iorio +- Hitendra Prajapati +- Jacob Kroon +- Jon Mason +- Jose Quaresma +- Joshua Watt +- Kai Kang +- Khem Raj +- Kristian Amlie +- LUIS ENRIQUEZ +- Mark Hatle +- Martin Beeger +- Martin Jansa +- Mateusz Marciniec +- Michael Opdenacker +- Mihai Lindner +- Mikko Rapeli +- Ming Liu +- Niko Mauno +- Ola x Nilsson +- Otavio Salvador +- Paul Eggleton +- Pavel Zhukov +- Peter Bergin +- Peter Kjellerstedt +- Peter Marko +- Rajesh Dangi +- Randy MacLeod +- Rasmus Villemoes +- Richard Purdie +- Robert Joslyn +- Roland Hieber +- Ross Burton +- Sakib Sajal +- Shubham Kulkarni +- Steve Sakoman +- Ulrich Ölmann +- Yang Xu +- Yongxin Liu +- ghassaneben +- pgowda +- Wang Mingyu + +Repositories / Downloads for Yocto-4.0.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.4 </poky/log/?h=yocto-4.0.4>` +- Git Revision: :yocto_git:`d64bef1c7d713b92a51228e5ade945835e5a94a4 </poky/commit/?id=d64bef1c7d713b92a51228e5ade945835e5a94a4>` +- Release Artefact: poky-d64bef1c7d713b92a51228e5ade945835e5a94a4 +- sha: b5e92506b31f88445755bad2f45978b747ad1a5bea66ca897370542df5f1e7db +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.4/poky-d64bef1c7d713b92a51228e5ade945835e5a94a4.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.4/poky-d64bef1c7d713b92a51228e5ade945835e5a94a4.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.4 </openembedded-core/log/?h=yocto-4.0.4>` +- Git Revision: :oe_git:`f7766da462905ec67bf549d46b8017be36cd5b2a </openembedded-core/commit/?id=f7766da462905ec67bf549d46b8017be36cd5b2a>` +- Release Artefact: oecore-f7766da462905ec67bf549d46b8017be36cd5b2a +- sha: ce0ac011474db5e5f0bb1be3fb97f890a02e46252a719dbcac5813268e48ff16 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.4/oecore-f7766da462905ec67bf549d46b8017be36cd5b2a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.4/oecore-f7766da462905ec67bf549d46b8017be36cd5b2a.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.4 </meta-mingw/log/?h=yocto-4.0.4>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.4/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.4/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.4 </meta-gplv2/log/?h=yocto-4.0.4>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.4/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.4/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.4 </bitbake/log/?h=yocto-4.0.4>` +- Git Revision: :oe_git:`ac576d6fad6bba0cfea931883f25264ea83747ca </bitbake/commit/?id=ac576d6fad6bba0cfea931883f25264ea83747ca>` +- Release Artefact: bitbake-ac576d6fad6bba0cfea931883f25264ea83747ca +- sha: 526c2768874eeda61ade8c9ddb3113c90d36ef44a026d6690f02de6f3dd0ea12 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.4/bitbake-ac576d6fad6bba0cfea931883f25264ea83747ca.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.4/bitbake-ac576d6fad6bba0cfea931883f25264ea83747ca.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.4 </yocto-docs/log/?h=yocto-4.0.4>` +- Git Revision: :yocto_git:`f632dad24c39778f948014029e74db3c871d9d21 </yocto-docs/commit/?id=f632dad24c39778f948014029e74db3c871d9d21>` diff --git a/documentation/migration-guides/release-notes-4.0.5.rst b/documentation/migration-guides/release-notes-4.0.5.rst new file mode 100644 index 0000000000..cdfe85b750 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.5.rst @@ -0,0 +1,198 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.5 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.5 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- qemu: fix :cve:`2021-3750`, :cve:`2021-3611` and :cve:`2022-2962` +- binutils : fix :cve:`2022-38126`, :cve:`2022-38127` and :cve:`2022-38128` +- tff: fix :cve:`2022-2867`, :cve:`2022-2868` and :cve:`2022-2869` +- inetutils: fix :cve:`2022-39028` +- go: fix :cve:`2022-27664` + +Fixes in Yocto-4.0.5 +~~~~~~~~~~~~~~~~~~~~ + +- Revert "gcc-cross-canadian: Add symlink to real-ld alongside other symlinks" +- bind: upgrade to 9.18.7 +- binutils: stable 2.38 branch updates (dc2474e7) +- bitbake: Fix npm to use https rather than http +- bitbake: asyncrpc/client: Fix unix domain socket chdir race issues +- bitbake: bitbake: Add copyright headers where missing +- bitbake: gitsm: Error out if submodule refers to parent repo +- bitbake: runqueue: Drop deadlock breaking force fail +- bitbake: runqueue: Ensure deferred tasks are sorted by multiconfig +- bitbake: runqueue: Improve deadlock warning messages +- bitbake: siggen: Fix insufficent entropy in sigtask file names +- bitbake: tests/fetch: Allow handling of a file:// url within a submodule +- build-appliance-image: Update to kirkstone head revision (4a88ada) +- busybox: add devmem 128-bit support +- classes: files: Extend overlayfs-etc class +- coreutils: add openssl :term:`PACKAGECONFIG` +- create-pull-request: don't switch the git remote protocol to git:// +- dev-manual: fix reference to BitBake user manual +- expat: upgrade 2.4.8 -> 2.4.9 +- files: overlayfs-etc: refactor preinit template +- gcc-cross-canadian: add default plugin linker +- gcc: add arm-v9 support +- git: upgrade 2.35.4 -> 2.35.5 +- glibc-locale: explicitly remove empty dirs in ${libdir} +- glibc-tests: use += instead of :append +- glibc: stable 2.35 branch updates.(8d125a1f) +- go-native: switch from SRC_URI:append to :term:`SRC_URI` += +- image_types_wic.bbclass: fix cross binutils dependency +- kern-tools: allow 'y' or 'm' to avoid config audit warnings +- kern-tools: fix queue processing in relative :term:`TOPDIR` configurations +- kernel-yocto: allow patch author date to be commit date +- libpng: upgrade to 1.6.38 +- linux-firmware: package new Qualcomm firmware +- linux-firmware: upgrade 20220708 -> 20220913 +- linux-libc-headers: switch from SRC_URI:append to :term:`SRC_URI` += +- linux-yocto-dev: add qemuarm64 +- linux-yocto/5.10: update to v5.10.149 +- linux-yocto/5.15: cfg: fix ACPI warnings for -tiny +- linux-yocto/5.15: update to v5.15.68 +- local.conf.sample: correct the location of public hashserv +- ltp: Fix pread02 case trigger the glibc overflow detection +- lttng-modules: Fix crash on powerpc64 +- lttng-tools: Disable on qemuriscv32 +- lttng-tools: Disable on riscv32 +- migration-guides: add 4.0.4 release notes +- oeqa/runtime/dnf: fix typo +- own-mirrors: add crate +- perf: Fix for recent kernel upgrades +- poky.conf: bump version for 4.0.5 +- poky.yaml.in: update version requirements +- python3-rfc3986-validator: switch from SRC_URI:append to :term:`SRC_URI` += +- python3: upgrade 3.10.4 -> 3.10.7 +- qemu: Backport patches from upstream to support float128 on qemu-ppc64 +- rpm: Remove -Wimplicit-function-declaration warnings +- rpm: update to 4.17.1 +- rsync: update to 3.2.5 +- stress-cpu: disable float128 math on powerpc64 to avoid SIGILL +- tune-neoversen2: support tune-neoversen2 base on armv9a +- tzdata: update to 2022d +- u-boot: switch from append to += in :term:`SRC_URI` +- uninative: Upgrade to 3.7 to work with glibc 2.36 +- vim: Upgrade to 9.0.0598 +- webkitgtk: Update to 2.36.7 + + +Known Issues in Yocto-4.0.5 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- There are recent CVEs in key components such as openssl. They are not included in this release as it was built before the issues were known and fixes were available but these are now available on the kirkstone branch. + + +Contributors to Yocto-4.0.5 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Adrian Freihofer +- Alexander Kanavin +- Alexandre Belloni +- Bhabu Bindu +- Bruce Ashfield +- Chen Qi +- Daniel McGregor +- Denys Dmytriyenko +- Dmitry Baryshkov +- Florin Diaconescu +- He Zhe +- Joshua Watt +- Khem Raj +- Martin Jansa +- Michael Halstead +- Michael Opdenacker +- Mikko Rapeli +- Mingli Yu +- Neil Horman +- Pavel Zhukov +- Richard Purdie +- Robert Joslyn +- Ross Burton +- Ruiqiang Hao +- Samuli Piippo +- Steve Sakoman +- Sundeep KOKKONDA +- Teoh Jay Shen +- Tim Orling +- Virendra Thakur +- Vyacheslav Yurkov +- Xiangyu Chen +- Yash Shinde +- pgowda +- Wang Mingyu + + +Repositories / Downloads for Yocto-4.0.5 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.5 </poky/log/?h=yocto-4.0.5>` +- Git Revision: :yocto_git:`2e79b199114b25d81bfaa029ccfb17676946d20d </poky/commit/?id=2e79b199114b25d81bfaa029ccfb17676946d20d>` +- Release Artefact: poky-2e79b199114b25d81bfaa029ccfb17676946d20d +- sha: 7bcf3f901d4c5677fc95944ab096e9e306f4c758a658dde5befd16861ad2b8ea +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.5/poky-2e79b199114b25d81bfaa029ccfb17676946d20d.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.5/poky-2e79b199114b25d81bfaa029ccfb17676946d20d.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.5 </openembedded-core/log/?h=yocto-4.0.5>` +- Git Revision: :oe_git:`fbdf93f43ff4b876487e1f26752598ec8abcb46e </openembedded-core/commit/?id=fbdf93f43ff4b876487e1f26752598ec8abcb46e>` +- Release Artefact: oecore-fbdf93f43ff4b876487e1f26752598ec8abcb46e +- sha: 2d9b5a8e9355b633bb57633cc8c2d319ba13fe4721f79204e61116b3faa6cbf1 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.5/oecore-fbdf93f43ff4b876487e1f26752598ec8abcb46e.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.5/oecore-fbdf93f43ff4b876487e1f26752598ec8abcb46e.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.5 </meta-mingw/log/?h=yocto-4.0.5>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.5/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.5/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.5 </meta-gplv2/log/?h=yocto-4.0.5>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.5/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.5/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.5 </bitbake/log/?h=yocto-4.0.5>` +- Git Revision: :oe_git:`c90d57497b9bcd237c3ae810ee8edb5b0d2d575a </bitbake/commit/?id=c90d57497b9bcd237c3ae810ee8edb5b0d2d575a>` +- Release Artefact: bitbake-c90d57497b9bcd237c3ae810ee8edb5b0d2d575a +- sha: 5698d548ce179036e46a24f80b213124c8825a4f443fa1d6be7ab0f70b01a9ff +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.5/bitbake-c90d57497b9bcd237c3ae810ee8edb5b0d2d575a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.5/bitbake-c90d57497b9bcd237c3ae810ee8edb5b0d2d575a.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.5 </yocto-docs/log/?h=yocto-4.0.5>` +- Git Revision: :yocto_git:`8c2f9f54e29781f4ee72e81eeaa12ceaa82dc2d3 </yocto-docs/commit/?id=8c2f9f54e29781f4ee72e81eeaa12ceaa82dc2d3>` + diff --git a/documentation/migration-guides/release-notes-4.0.6.rst b/documentation/migration-guides/release-notes-4.0.6.rst new file mode 100644 index 0000000000..76d23fcf0c --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.6.rst @@ -0,0 +1,313 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.6 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.6 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bash: Fix :cve:`2022-3715` +- curl: Fix :cve:`2022-32221`, :cve:`2022-42915` and :cve:`2022-42916` +- dbus: Fix :cve:`2022-42010`, :cve:`2022-42011` and :cve:`2022-42012` +- dropbear: Fix :cve:`2021-36369` +- ffmpeg: Fix :cve:`2022-3964`, :cve:`2022-3965` +- go: Fix :cve:`2022-2880` +- grub2: Fix :cve:`2022-2601`, :cve:`2022-3775` and :cve:`2022-28736` +- libarchive: Fix :cve:`2022-36227` +- libpam: Fix :cve:`2022-28321` +- libsndfile1: Fix :cve:`2021-4156` +- lighttpd: Fix :cve:`2022-41556` +- openssl: Fix :cve:`2022-3358` +- pixman: Fix :cve:`2022-44638` +- python3-mako: Fix :cve:`2022-40023` +- python3: Fix :cve:`2022-42919` +- qemu: Fix :cve:`2022-3165` +- sysstat: Fix :cve:`2022-39377` +- systemd: Fix :cve:`2022-3821` +- tiff: Fix :cve:`2022-2953`, :cve:`2022-3599`, :cve:`2022-3597`, :cve:`2022-3626`, :cve:`2022-3627`, :cve:`2022-3570`, :cve:`2022-3598` and :cve:`2022-3970` +- vim: Fix :cve:`2022-3352`, :cve:`2022-3705` and :cve:`2022-4141` +- wayland: Fix :cve:`2021-3782` +- xserver-xorg: Fix :cve:`2022-3550` and :cve:`2022-3551` + + +Fixes in Yocto-4.0.6 +~~~~~~~~~~~~~~~~~~~~ + +- archiver: avoid using machine variable as it breaks multiconfig +- babeltrace: upgrade to 1.5.11 +- bind: upgrade to 9.18.8 +- bitbake.conf: Drop export of SOURCE_DATE_EPOCH_FALLBACK +- bitbake: gitsm: Fix regression in gitsm submodule path parsing +- bitbake: runqueue: Fix race issues around hash equivalence and sstate reuse +- bluez5: Point hciattach bcm43xx firmware search path to /lib/firmware +- bluez5: add dbus to RDEPENDS +- build-appliance-image: Update to kirkstone head revision +- buildtools-tarball: export certificates to python and curl +- cargo_common.bbclass: Fix typos +- classes: make TOOLCHAIN more permissive for kernel +- cmake-native: Fix host tool contamination (Bug: 14951) +- common-tasks.rst: fix oeqa runtime test path +- create-spdx.bbclass: remove unused SPDX_INCLUDE_PACKAGED +- create-spdx: Remove ";name=..." for downloadLocation +- create-spdx: default share_src for shared sources +- cve-update-db-native: add timeout to urlopen() calls +- dbus: upgrade to 1.14.4 +- dhcpcd: fix to work with systemd +- expat: upgrade to 2.5.0 +- externalsrc.bbclass: Remove a trailing slash from ${B} +- externalsrc.bbclass: fix git repo detection +- externalsrc: git submodule--helper list unsupported +- gcc-shared-source: Fix source date epoch handling +- gcc-source: Drop gengtype manipulation +- gcc-source: Ensure deploy_source_date_epoch sstate hash doesn't change +- gcc-source: Fix gengtypes race +- gdk-pixbuf: upgrade to 2.42.10 +- get_module_deps3.py: Check attribute '__file__' +- glib-2.0: fix rare GFileInfo test case failure +- glibc-locale: Do not INHIBIT_DEFAULT_DEPS +- gnomebase.bbclass: return the whole version for tarball directory if it is a number +- gnutls: Unified package names to lower-case +- groff: submit patches upstream +- gstreamer1.0-libav: fix errors with ffmpeg 5.x +- gstreamer1.0: upgrade to 1.20.4 +- ifupdown: upgrade to 0.8.39 +- insane.bbclass: Allow hashlib version that only accepts on parameter +- iso-codes: upgrade to 4.12.0 +- kea: submit patch upstream (fix-multilib-conflict.patch) +- kern-tools: fix relative path processing +- kern-tools: integrate ZFS speedup patch +- kernel-yocto: improve fatal error messages of symbol_why.py +- kernel.bbclass: Include randstruct seed assets in STAGING_KERNEL_BUILDDIR +- kernel.bbclass: make KERNEL_DEBUG_TIMESTAMPS work at rebuild +- kernel: Clear SYSROOT_DIRS instead of replacing sysroot_stage_all +- libcap: upgrade to 2.66 +- libepoxy: convert to git +- libepoxy: update to 1.5.10 +- libffi: submit patch upstream (0001-arm-sysv-reverted-clang-VFP-mitigation.patch ) +- libffi: upgrade to 3.4.4 +- libical: upgrade to 3.0.16 +- libksba: upgrade to 1.6.2 +- libuv: fixup SRC_URI +- libxcrypt: upgrade to 4.4.30 +- lighttpd: upgrade to 1.4.67 +- linux-firmware: add new fw file to ${PN}-qcom-adreno-a530 +- linux-firmware: don't put the firmware into the sysroot +- linux-firmware: package amdgpu firmware +- linux-firmware: split rtl8761 firmware +- linux-firmware: upgrade to 20221109 +- linux-yocto/5.10: update genericx86* machines to v5.10.149 +- linux-yocto/5.15: fix CONFIG_CRYPTO_CCM mismatch warnings +- linux-yocto/5.15: update genericx86* machines to v5.15.72 +- linux-yocto/5.15: update to v5.15.78 +- ltp: backport clock_gettime04 fix from upstream +- lttng-modules: upgrade to 2.13.7 +- lttng-tools: Upgrade to 2.13.8 +- lttng-tools: submit determinism.patch upstream +- lttng-ust: upgrade to 2.13.5 +- meson: make wrapper options sub-command specific +- meta-selftest/staticids: add render group for systemd +- mirrors.bbclass: update CPAN_MIRROR +- mirrors.bbclass: use shallow tarball for binutils-native +- mobile-broadband-provider-info: upgrade 20220725 -> 20221107 +- mtd-utils: upgrade 2.1.4 -> 2.1.5 +- numactl: upgrade to 2.0.16 +- oe/packagemanager/rpm: don't leak file objects +- oeqa/selftest/lic_checksum: Cleanup changes to emptytest include +- oeqa/selftest/minidebuginfo: Create selftest for minidebuginfo +- oeqa/selftest/tinfoil: Add test for separate config_data with recipe_parse_file() +- openssl: Fix SSL_CERT_FILE to match ca-certs location +- openssl: upgrade to 3.0.7 +- openssl: export necessary env vars in SDK +- opkg-utils: use a git clone, not a dynamic snapshot +- opkg: Set correct info_dir and status_file in opkg.conf +- overlayfs: Allow not used mount points +- ovmf: correct patches status +- package: Fix handling of minidebuginfo with newer binutils +- perf: Depend on native setuptools3 +- poky.conf: bump version for 4.0.6 +- psplash: add psplash-default in rdepends +- psplash: consider the situation of psplash not exist for systemd +- python3: advance to version 3.10.8 +- qemu-helper-native: Correctly pass program name as argv[0] +- qemu-helper-native: Re-write bridge helper as C program +- qemu-native: Add PACKAGECONFIG option for jack +- qemu: add io_uring PACKAGECONFIG +- quilt: backport a patch to address grep 3.8 failures +- resolvconf: make it work +- rm_work: exclude the SSTATETASKS from the rm_work tasks sinature +- runqemu: Do not perturb script environment +- runqemu: Fix gl-es argument from causing other arguments to be ignored +- sanity: Drop data finalize call +- sanity: check for GNU tar specifically +- scripts/oe-check-sstate: cleanup +- scripts/oe-check-sstate: force build to run for all targets, specifically populate_sysroot +- scripts: convert-overrides: Allow command-line customizations +- socat: upgrade to 1.7.4.4 +- SPDX and CVE documentation updates +- sstate: Allow optimisation of do_deploy_archives task dependencies +- sstatesig: emit more helpful error message when not finding sstate manifest +- sstatesig: skip the rm_work task signature +- sudo: upgrade to 1.9.12p1 +- systemd: Consider PACKAGECONFIG in RRECOMMENDS +- systemd: add group render to udev package +- tcl: correct patch status +- tiff: refresh with devtool +- tiff: add CVE tag to b258ed69a485a9cfb299d9f060eb2a46c54e5903.patch +- u-boot: Remove duplicate inherit of cml1 +- uboot-sign: Fix using wrong KEY_REQ_ARGS +- vala: install vapigen-wrapper into /usr/bin/crosscripts and stage only that +- valgrind: remove most hidden tests for arm64 +- vim: Upgrade to 9.0.0947 +- vulkan-samples: add lfs=0 to SRC_URI to avoid git smudge errors in do_unpack +- wic: honor the SOURCE_DATE_EPOCH in case of updated fstab +- wic: make ext2/3/4 images reproducible +- wic: swap partitions are not added to fstab +- wpebackend-fdo: upgrade to 1.14.0 +- xserver-xorg: move some recommended dependencies in required +- xwayland: upgrade to 22.1.5 + + +Known Issues in Yocto-4.0.6 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.6 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alex Kiernan +- Alexander Kanavin +- Alexey Smirnov +- Bartosz Golaszewski +- Bernhard Rosenkränzer +- Bhabu Bindu +- Bruce Ashfield +- Chee Yang Lee +- Chen Qi +- Christian Eggers +- Claus Stovgaard +- Diego Sueiro +- Dmitry Baryshkov +- Ed Tanous +- Enrico Jörns +- Etienne Cordonnier +- Frank de Brabander +- Harald Seiler +- Hitendra Prajapati +- Jan-Simon Moeller +- Jeremy Puhlman +- Joe Slater +- John Edward Broadbent +- Jose Quaresma +- Joshua Watt +- Kai Kang +- Keiya Nobuta +- Khem Raj +- Konrad Weihmann +- Leon Anavi +- Liam Beguin +- Marek Vasut +- Mark Hatle +- Martin Jansa +- Michael Opdenacker +- Mikko Rapeli +- Narpat Mali +- Nathan Rossi +- Niko Mauno +- Pavel Zhukov +- Peter Kjellerstedt +- Peter Marko +- Polampalli, Archana +- Qiu, Zheng +- Ravula Adhitya Siddartha +- Richard Purdie +- Ross Burton +- Sakib Sajal +- Sean Anderson +- Sergei Zhmylev +- Steve Sakoman +- Teoh Jay Shen +- Thomas Perrot +- Tim Orling +- Vincent Davis Jr +- Vivek Kumbhar +- Vyacheslav Yurkov +- Wang Mingyu +- Xiangyu Chen +- Zheng Qiu +- Ciaran Courtney +- Wang Mingyu + + +Repositories / Downloads for Yocto-4.0.6 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.6 </poky/log/?h=yocto-4.0.6>` +- Git Revision: :yocto_git:`c4e08719a782fd4119eaf643907b80cebf57f88f </poky/commit/?id=c4e08719a782fd4119eaf643907b80cebf57f88f>` +- Release Artefact: poky-c4e08719a782fd4119eaf643907b80cebf57f88f +- sha: 2eb3b323dd2ccd25f9442bfbcbde82bc081fad5afd146a8e6dde439db24a99d4 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.6/poky-c4e08719a782fd4119eaf643907b80cebf57f88f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.6/poky-c4e08719a782fd4119eaf643907b80cebf57f88f.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.6 </openembedded-core/log/?h=yocto-4.0.6>` +- Git Revision: :oe_git:`45a8b4101b14453aa3020d3f2b8a76b4dc0ae3f2 </openembedded-core/commit/?id=45a8b4101b14453aa3020d3f2b8a76b4dc0ae3f2>` +- Release Artefact: oecore-45a8b4101b14453aa3020d3f2b8a76b4dc0ae3f2 +- sha: de8b443365927befe67cc443b60db57563ff0726377223f836a3f3971cf405ec +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.6/oecore-45a8b4101b14453aa3020d3f2b8a76b4dc0ae3f2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.6/oecore-45a8b4101b14453aa3020d3f2b8a76b4dc0ae3f2.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.6 </meta-mingw/log/?h=yocto-4.0.6>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.6/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.6/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.6 </meta-gplv2/log/?h=yocto-4.0.6>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.6/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.6/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.6 </bitbake/log/?h=yocto-4.0.6>` +- Git Revision: :oe_git:`7e268c107bb0240d583d2c34e24a71e373382509 </bitbake/commit/?id=7e268c107bb0240d583d2c34e24a71e373382509>` +- Release Artefact: bitbake-7e268c107bb0240d583d2c34e24a71e373382509 +- sha: c3e2899012358c95962c7a5c85cf98dc30c58eae0861c374124e96d9556bb901 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.6/bitbake-7e268c107bb0240d583d2c34e24a71e373382509.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.6/bitbake-7e268c107bb0240d583d2c34e24a71e373382509.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.6 </yocto-docs/log/?h=yocto-4.0.6>` +- Git Revision: :yocto_git:`c10d65ef3bbdf4fe3abc03e3aef3d4ca8c2ad87f </yocto-docs/commit/?id=c10d65ef3bbdf4fe3abc03e3aef3d4ca8c2ad87f>` + + diff --git a/documentation/migration-guides/release-notes-4.0.7.rst b/documentation/migration-guides/release-notes-4.0.7.rst new file mode 100644 index 0000000000..c3885d9e0e --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.7.rst @@ -0,0 +1,242 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.7 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.7 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- binutils: Fix :cve:`2022-4285` +- curl: Fix :cve:`2022-43551` and :cve_mitre:`2022-43552` +- ffmpeg: Fix :cve:`2022-3109` and :cve:`2022-3341` +- go: Fix :cve:`2022-41715` and :cve:`2022-41717` +- libX11: Fix :cve:`2022-3554` and :cve:`2022-3555` +- libarchive: Fix :cve:`2022-36227` +- libksba: Fix :cve:`2022-47629` +- libpng: Fix :cve:`2019-6129` +- libxml2: Fix :cve:`2022-40303` and :cve:`2022-40304` +- openssl: Fix :cve:`2022-3996` +- python3: Fix :cve:`2022-45061` +- python3-git: Fix :cve:`2022-24439` +- python3-setuptools: Fix :cve:`2022-40897` +- python3-wheel: Fix :cve:`2022-40898` +- qemu: Fix :cve:`2022-4144` +- sqlite: Fix :cve:`2022-46908` +- systemd: Fix :cve:`2022-45873` +- vim: Fix :cve:`2023-0049`, :cve:`2023-0051`, :cve:`2023-0054` and :cve:`2023-0088` +- webkitgtk: Fix :cve:`2022-32886`, :cve_mitre:`2022-32891` and :cve:`2022-32912` + + +Fixes in Yocto-4.0.7 +~~~~~~~~~~~~~~~~~~~~ + +- Revert "gstreamer1.0: disable flaky gstbin:test_watch_for_state_change test" +- at: Change when files are copied +- baremetal-image: Avoid overriding qemu variables from IMAGE_CLASSES +- base.bbclass: Fix way to check ccache path +- bc: extend to nativesdk +- bind: upgrade to 9.18.10 +- busybox: always start do_compile with orig config files +- busybox: rm temporary files if do_compile was interrupted +- cairo: fix CVE patches assigned wrong CVE number +- cairo: update patch for :cve:`2019-6461` with upstream solution +- classes/create-spdx: Add SPDX_PRETTY option +- classes: image: Set empty weak default IMAGE_LINGUAS +- combo-layer: add sync-revs command +- combo-layer: dont use bb.utils.rename +- combo-layer: remove unused import +- curl: Correct LICENSE from MIT-open-group to curl +- cve-check: write the cve manifest to IMGDEPLOYDIR +- cve-update-db-native: avoid incomplete updates +- cve-update-db-native: show IP on failure +- dbus: Add missing CVE product name +- devtool/upgrade: correctly handle recipes where S is a subdir of upstream tree +- devtool: process local files only for the main branch +- dhcpcd: backport two patches to fix runtime error +- docs: kernel-dev: faq: update tip on how to not include kernel in image +- docs: migration-4.0: specify variable name change for kernel inclusion in image recipe +- efibootmgr: update compilation with musl +- externalsrc: fix lookup for .gitmodules +- ffmpeg: refresh patches to apply cleanly +- freetype:update mirror site. +- gcc: Refactor linker patches and fix linker on arm with usrmerge +- glibc: stable 2.35 branch updates. +- go-crosssdk: avoid host contamination by GOCACHE +- gstreamer1.0: Fix race conditions in gstbin tests +- gstreamer1.0: upgrade to 1.20.5 +- gtk-icon-cache: Fix GTKIC_CMD if-else condition +- harfbuzz: remove bindir only if it exists +- kernel-fitimage: Adjust order of dtb/dtbo files +- kernel-fitimage: Allow user to select dtb when multiple dtb exists +- kernel.bbclass: remove empty module directories to prevent QA issues +- lib/buildstats: fix parsing of trees with reduced_proc_pressure directories +- lib/oe/reproducible: Use git log without gpg signature +- libepoxy: remove upstreamed patch +- libnewt: update 0.52.21 -> 0.52.23 +- libseccomp: fix typo in DESCRIPTION +- libxcrypt-compat: upgrade 4.4.30 -> 4.4.33 +- libxml2: fix test data checksums +- linux-firmware: upgrade 20221109 -> 20221214 +- linux-yocto/5.10: update to v5.10.152 +- linux-yocto/5.10: update to v5.10.154 +- linux-yocto/5.10: update to v5.10.160 +- linux-yocto/5.15: fix perf build with clang +- linux-yocto/5.15: libbpf: Fix build warning on ref_ctr_off +- linux-yocto/5.15: ltp and squashfs fixes +- linux-yocto/5.15: powerpc: Fix reschedule bug in KUAP-unlocked user copy +- linux-yocto/5.15: update to v5.15.84 +- lsof: add update-alternatives logic +- lttng-modules: update 2.13.7 -> 2.13.8 +- manuals: add 4.0.5 and 4.0.6 release notes +- manuals: document SPDX_PRETTY variable +- mpfr: upgrade 4.1.0 -> 4.1.1 +- oeqa/concurrencytest: Add number of failures to summary output +- oeqa/rpm.py: Increase timeout and add debug output +- oeqa/selftest/externalsrc: add test for srctree_hash_files +- openssh: remove RRECOMMENDS to rng-tools for sshd package +- poky.conf: bump version for 4.0.7 +- qemuboot.bbclass: make sure runqemu boots bundled initramfs kernel image +- rm_work.bbclass: use HOSTTOOLS 'rm' binary exclusively +- rm_work: adjust dependency to make do_rm_work_all depend on do_rm_work +- ruby: merge .inc into .bb +- ruby: update 3.1.2 -> 3.1.3 +- selftest/virgl: use pkg-config from the host +- tiff: Add packageconfig knob for webp +- toolchain-scripts: compatibility with unbound variable protection +- tzdata: update 2022d -> 2022g +- valgrind: skip the boost_thread test on arm +- xserver-xorg: upgrade 21.1.4 -> 21.1.6 +- xwayland: libxshmfence is needed when dri3 is enabled +- xwayland: upgrade 22.1.5 -> 22.1.7 +- yocto-check-layer: Allow OE-Core to be tested + + +Known Issues in Yocto-4.0.7 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.7 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alejandro Hernandez Samaniego +- Alex Kiernan +- Alex Stewart +- Alexander Kanavin +- Antonin Godard +- Benoît Mauduit +- Bhabu Bindu +- Bruce Ashfield +- Carlos Alberto Lopez Perez +- Changqing Li +- Chen Qi +- Daniel Gomez +- Florin Diaconescu +- He Zhe +- Hitendra Prajapati +- Jagadeesh Krishnanjanappa +- Jan Kircher +- Jermain Horsman +- Jose Quaresma +- Joshua Watt +- KARN JYE LAU +- Kai Kang +- Khem Raj +- Luis +- Marta Rybczynska +- Martin Jansa +- Mathieu Dubois-Briand +- Michael Opdenacker +- Narpat Mali +- Ovidiu Panait +- Pavel Zhukov +- Peter Marko +- Petr Kubizňák +- Quentin Schulz +- Randy MacLeod +- Ranjitsinh Rathod +- Richard Purdie +- Robert Andersson +- Ross Burton +- Sandeep Gundlupet Raju +- Saul Wold +- Steve Sakoman +- Vivek Kumbhar +- Wang Mingyu +- Xiangyu Chen +- Yash Shinde +- Yogita Urade + + +Repositories / Downloads for Yocto-4.0.7 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.7 </poky/log/?h=yocto-4.0.7>` +- Git Revision: :yocto_git:`65dafea22018052fe7b2e17e6e4d7eb754224d38 </poky/commit/?id=65dafea22018052fe7b2e17e6e4d7eb754224d38>` +- Release Artefact: poky-65dafea22018052fe7b2e17e6e4d7eb754224d38 +- sha: 6b1b67600b84503e2d5d29bcd6038547339f4f9413b830cd2408df825eda642d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.7/poky-65dafea22018052fe7b2e17e6e4d7eb754224d38.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.7/poky-65dafea22018052fe7b2e17e6e4d7eb754224d38.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.7 </openembedded-core/log/?h=yocto-4.0.7>` +- Git Revision: :oe_git:`a8c82902384f7430519a31732a4bb631f21693ac </openembedded-core/commit/?id=a8c82902384f7430519a31732a4bb631f21693ac>` +- Release Artefact: oecore-a8c82902384f7430519a31732a4bb631f21693ac +- sha: 6f2dbc4ea1e388620ef77ac3a7bbb2b5956bb8bf9349b0c16cd7610e9996f5ea +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.7/oecore-a8c82902384f7430519a31732a4bb631f21693ac.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.7/oecore-a8c82902384f7430519a31732a4bb631f21693ac.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.7 </meta-mingw/log/?h=yocto-4.0.7>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.7/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.7/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.7 </meta-gplv2/log/?h=yocto-4.0.7>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.7/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.7/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.7 </bitbake/log/?h=yocto-4.0.7>` +- Git Revision: :oe_git:`7e268c107bb0240d583d2c34e24a71e373382509 </bitbake/commit/?id=7e268c107bb0240d583d2c34e24a71e373382509>` +- Release Artefact: bitbake-7e268c107bb0240d583d2c34e24a71e373382509 +- sha: c3e2899012358c95962c7a5c85cf98dc30c58eae0861c374124e96d9556bb901 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.7/bitbake-7e268c107bb0240d583d2c34e24a71e373382509.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.7/bitbake-7e268c107bb0240d583d2c34e24a71e373382509.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.7 </yocto-docs/log/?h=yocto-4.0.7>` +- Git Revision: :yocto_git:`5883e897c34f25401b358a597fb6e18d80f7f90b </yocto-docs/commit/?id=5883e897c34f25401b358a597fb6e18d80f7f90b>` + + diff --git a/documentation/migration-guides/release-notes-4.0.8.rst b/documentation/migration-guides/release-notes-4.0.8.rst new file mode 100644 index 0000000000..223b74fbaf --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.8.rst @@ -0,0 +1,217 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.8 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.8 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- apr-util: Fix :cve:`2022-25147` +- apr: Fix :cve:`2022-24963`, :cve:`2022-28331` and :cve:`2021-35940` +- bind: Fix :cve:`2022-3094`, :cve:`2022-3736` and :cve:`2022-3924` +- git: Ignore :cve:`2022-41953` +- git: Fix :cve:`2022-23521` and :cve:`2022-41903` +- libgit2: Fix :cve:`2023-22742` +- ppp: Fix :cve:`2022-4603` +- python3-certifi: Fix :cve:`2022-23491` +- sudo: Fix :cve:`2023-22809` +- tar: Fix :cve:`2022-48303` + + +Fixes in Yocto-4.0.8 +~~~~~~~~~~~~~~~~~~~~ + +- core-image.bbclass: Fix missing leading whitespace with ':append' +- populate_sdk_ext.bbclass: Fix missing leading whitespace with ':append' +- ptest-packagelists.inc: Fix missing leading whitespace with ':append' +- apr-util: upgrade to 1.6.3 +- apr: upgrade to 1.7.2 +- apt: fix do_package_qa failure +- bind: upgrade to 9.18.11 +- bitbake: bb/utils: include SSL certificate paths in export_proxies +- bitbake: bitbake-diffsigs: Make PEP8 compliant +- bitbake: bitbake-diffsigs: break on first dependent task difference +- bitbake: fetch2/git: Clarify the meaning of namespace +- bitbake: fetch2/git: Prevent git fetcher from fetching gitlab repository metadata +- bitbake: fetch2/git: show SRCREV and git repo in error message about fixed SRCREV +- bitbake: siggen: Fix inefficient string concatenation +- bitbake: utils/ply: Update md5 to better report errors with hashlib +- bootchart2: Fix usrmerge support +- bsp-guide: fix broken git URLs and missing word +- build-appliance-image: Update to kirkstone head revision +- buildtools-tarball: set pkg-config search path +- classes/fs-uuid: Fix command output decoding issue +- dev-manual: common-tasks.rst: add link to FOSDEM 2023 video +- dev-manual: fix old override syntax +- devshell: Do not add scripts/git-intercept to PATH +- devtool: fix devtool finish when gitmodules file is empty +- diffutils: upgrade to 3.9 +- gdk-pixbuf: do not use tools from gdk-pixbuf-native when building tests +- git: upgrade to 2.35.7 +- glslang: branch rename master -> main +- httpserver: add error handler that write to the logger +- image.bbclass: print all QA functions exceptions +- kernel/linux-kernel-base: Fix kernel build artefact determinism issues +- libc-locale: Fix on target locale generation +- libgit2: upgrade to 1.4.5 +- libjpeg-turbo: upgrade to 2.1.5 +- libtirpc: Check if file exists before operating on it +- libusb1: Link with latomic only if compiler has no atomic builtins +- libusb1: Strip trailing whitespaces +- linux-firmware: upgrade to 20230117 +- linux-yocto/5.15: update to v5.15.91 +- lsof: fix old override syntax +- lttng-modules: Fix for 5.10.163 kernel version +- lttng-tools: upgrade to 2.13.9 +- make-mod-scripts: Ensure kernel build output is deterministic +- manuals: update patchwork instance URL +- meta: remove True option to getVar and getVarFlag calls (again) +- migration-guides: add release-notes for 4.0.7 +- native: Drop special variable handling +- numactl: skip test case when target platform doesn't have 2 CPU node +- oeqa context.py: fix --target-ip comment to include ssh port number +- oeqa dump.py: add error counter and stop after 5 failures +- oeqa qemurunner.py: add timeout to QMP calls +- oeqa qemurunner.py: try to avoid reading one character at a time +- oeqa qemurunner: read more data at a time from serial +- oeqa ssh.py: add connection keep alive options to ssh client +- oeqa ssh.py: move output prints to new line +- oeqa/qemurunner: do not use Popen.poll() when terminating runqemu with a signal +- oeqa/selftest/bbtests: Update message lookup for test_git_unpack_nonetwork_fail +- oeqa/selftest/locales: Add selftest for locale generation/presence +- poky.conf: Update SANITY_TESTED_DISTROS to match autobuilder +- poky.conf: bump version for 4.0.8 +- profile-manual: update WireShark hyperlinks +- python3-pytest: depend on python3-tomli instead of python3-toml +- qemu: fix compile error +- quilt: fix intermittent failure in faildiff.test +- quilt: use upstreamed faildiff.test fix +- recipe_sanity: fix old override syntax +- ref-manual: document SSTATE_EXCLUDEDEPS_SYSROOT +- scons.bbclass: Make MAXLINELENGTH overridable +- scons: Pass MAXLINELENGTH to scons invocation +- sdkext/cases/devtool: pass a logger to HTTPService +- spirv-headers: set correct branch name +- sudo: upgrade to 1.9.12p2 +- system-requirements.rst: add Fedora 36 and AlmaLinux 8.7 to list of supported distros +- testimage: Fix error message to reflect new syntax +- update-alternatives: fix typos +- vulkan-samples: branch rename master -> main + + +Known Issues in Yocto-4.0.8 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.8 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alejandro Hernandez Samaniego +- Alexander Kanavin +- Alexandre Belloni +- Armin Kuster +- Arnout Vandecappelle +- Bruce Ashfield +- Changqing Li +- Chee Yang Lee +- Etienne Cordonnier +- Harald Seiler +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Louis Rannou +- Marek Vasut +- Marius Kriegerowski +- Mark Hatle +- Martin Jansa +- Mauro Queiros +- Michael Opdenacker +- Mikko Rapeli +- Mingli Yu +- Narpat Mali +- Niko Mauno +- Pawel Zalewski +- Peter Kjellerstedt +- Richard Purdie +- Rodolfo Quesada Zumbado +- Ross Burton +- Sakib Sajal +- Schmidt, Adriaan +- Steve Sakoman +- Thomas Roos +- Ulrich Ölmann +- Xiangyu Chen + + +Repositories / Downloads for Yocto-4.0.8 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.8 </poky/log/?h=yocto-4.0.8>` +- Git Revision: :yocto_git:`a361fb3df9c87cf12963a9d785a9f99faa839222 </poky/commit/?id=a361fb3df9c87cf12963a9d785a9f99faa839222>` +- Release Artefact: poky-a361fb3df9c87cf12963a9d785a9f99faa839222 +- sha: af4e8d64be27d3a408357c49b7952ce04c6d8bb0b9d7b50c48848d9355de7fc2 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.8/poky-a361fb3df9c87cf12963a9d785a9f99faa839222.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.8/poky-a361fb3df9c87cf12963a9d785a9f99faa839222.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.8 </openembedded-core/log/?h=yocto-4.0.8>` +- Git Revision: :oe_git:`b20e2134daec33fbb8ce358d984751d887752bd5 </openembedded-core/commit/?id=b20e2134daec33fbb8ce358d984751d887752bd5>` +- Release Artefact: oecore-b20e2134daec33fbb8ce358d984751d887752bd5 +- sha: 63cce6f1caf8428eefc1471351ab024affc8a41d8d7777f525e3aa9ea454d2cd +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.8/oecore-b20e2134daec33fbb8ce358d984751d887752bd5.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.8/oecore-b20e2134daec33fbb8ce358d984751d887752bd5.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.8 </meta-mingw/log/?h=yocto-4.0.8>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.8/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.8/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.8 </meta-gplv2/log/?h=yocto-4.0.8>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.8/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.8/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.8 </bitbake/log/?h=yocto-4.0.8>` +- Git Revision: :oe_git:`9bbdedc0ba7ca819b898e2a29a151d6a2014ca11 </bitbake/commit/?id=9bbdedc0ba7ca819b898e2a29a151d6a2014ca11>` +- Release Artefact: bitbake-9bbdedc0ba7ca819b898e2a29a151d6a2014ca11 +- sha: 8e724411f4df00737e81b33eb568f1f97d2a00d5364342c0a212c46abb7b005b +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.8/bitbake-9bbdedc0ba7ca819b898e2a29a151d6a2014ca11.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.8/bitbake-9bbdedc0ba7ca819b898e2a29a151d6a2014ca11.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.8 </yocto-docs/log/?h=yocto-4.0.8>` +- Git Revision: :yocto_git:`16ecbe028f2b9cc021267817a5413054e070b563 </yocto-docs/commit/?id=16ecbe028f2b9cc021267817a5413054e070b563>` + diff --git a/documentation/migration-guides/release-notes-4.0.9.rst b/documentation/migration-guides/release-notes-4.0.9.rst new file mode 100644 index 0000000000..236477443a --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.9.rst @@ -0,0 +1,249 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.9 (Kirkstone) +----------------------------------------- + +Security Fixes in Yocto-4.0.9 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- binutils: Fix :cve:`2023-22608` +- curl: Fix :cve:`2023-23914`, :cve:`2023-23915` and :cve:`2023-23916` +- epiphany: Fix :cve:`2023-26081` +- git: Ignore :cve:`2023-22743` +- glibc: Fix :cve:`2023-0687` +- gnutls: Fix :cve:`2023-0361` +- go: Fix :cve:`2022-2879`, :cve:`2022-41720` and :cve:`2022-41723` +- harfbuzz: Fix :cve:`2023-25193` +- less: Fix :cve:`2022-46663` +- libmicrohttpd: Fix :cve:`2023-27371` +- libsdl2: Fix :cve:`2022-4743` +- openssl: Fix :cve:`2022-3996`, :cve:`2023-0464`, :cve:`2023-0465` and :cve:`2023-0466` +- pkgconf: Fix :cve:`2023-24056` +- python3: Fix :cve:`2023-24329` +- shadow: Ignore :cve:`2016-15024` +- systemd: Fix :cve:`2022-4415` +- tiff: Fix :cve:`2023-0800`, :cve:`2023-0801`, :cve:`2023-0802`, :cve:`2023-0803` and :cve:`2023-0804` +- vim: Fix :cve:`2023-0433`, :cve:`2023-0512`, :cve:`2023-1127`, :cve:`2023-1170`, :cve:`2023-1175`, :cve:`2023-1264` and :cve:`2023-1355` +- xserver-xorg: Fix :cve:`2023-0494` +- xwayland: Fix :cve:`2023-0494` + + +Fixes in Yocto-4.0.9 +~~~~~~~~~~~~~~~~~~~~ + +- base-files: Drop localhost.localdomain from hosts file +- binutils: Fix nativesdk ld.so search +- bitbake: cookerdata: Drop dubious exception handling code +- bitbake: cookerdata: Improve early exception handling +- bitbake: cookerdata: Remove incorrect SystemExit usage +- bitbake: fetch/git: Fix local clone url to make it work with repo +- bitbake: utils: Allow to_boolean to support int values +- bmap-tools: switch to main branch +- buildtools-tarball: Handle spaces within user $PATH +- busybox: Fix depmod patch +- cracklib: update github branch to 'main' +- cups: add/fix web interface packaging +- cups: check PACKAGECONFIG for pam feature +- cups: use BUILDROOT instead of DESTDIR +- curl: fix dependencies when building with ldap/ldaps +- cve-check: Fix false negative version issue +- dbus: upgrade to 1.14.6 +- devtool/upgrade: do not delete the workspace/recipes directory +- dhcpcd: Fix install conflict when enable multilib. +- dhcpcd: fix dhcpcd start failure on qemuppc64 +- gcc-shared-source: do not use ${S}/.. in deploy_source_date_epoch +- glibc: Add missing binutils dependency +- image_types: fix multiubi var init +- iso-codes: upgrade to 4.13.0 +- json-c: Add ptest for json-c +- kernel-yocto: fix kernel-meta data detection +- lib/buildstats: handle tasks that never finished +- lib/resulttool: fix typo breaking resulttool log --ptest +- libjpeg-turbo: upgrade to 2.1.5.1 +- libmicrohttpd: upgrade to 0.9.76 +- libseccomp: fix for the ptest result format +- libssh2: Clean up ptest patch/coverage +- linux-firmware: add yamato fw files to qcom-adreno-a2xx package +- linux-firmware: properly set license for all Qualcomm firmware +- linux-firmware: upgrade to 20230210 +- linux-yocto-rt/5.15: update to -rt59 +- linux-yocto/5.10: upgrade to v5.10.175 +- linux-yocto/5.15: upgrade to v5.15.103 +- linux: inherit pkgconfig in kernel.bbclass +- lttng-modules: fix for kernel 6.2+ +- lttng-modules: upgrade to v2.13.9 +- lua: Fix install conflict when enable multilib. +- mdadm: Fix raid0, 06wrmostly and 02lineargrow tests +- meson: Fix wrapper handling of implicit setup command +- migration-guides: add 4.0.8 release notes +- nghttp2: never build python bindings +- oeqa rtc.py: skip if read-only-rootfs +- oeqa ssh.py: fix hangs in run() +- oeqa/sdk: Improve Meson test +- oeqa/selftest/prservice: Improve debug output for failure +- oeqa/selftest/resulttooltests: fix minor typo +- openssl: upgrade to 3.0.8 +- package.bbclase: Add check for /build in copydebugsources() +- patchelf: replace a rejected patch with an equivalent uninative.bbclass tweak +- poky.conf: bump version for 4.0.9 +- populate_sdk_ext: Handle spaces within user $PATH +- pybootchartui: Fix python syntax issue +- python3-git: fix indent error +- python3-setuptools-rust-native: Add direct dependency of native python3 modules +- qemu: Revert "fix :cve:`2021-3507`" as not applicable for qemu 6.2 +- rsync: Add missing prototypes to function declarations +- rsync: Turn on -pedantic-errors at the end of 'configure' +- runqemu: kill qemu if it hangs +- scripts/lib/buildstats: handle top-level build_stats not being complete +- selftest/recipetool: Stop test corrupting tinfoil class +- selftest/runtime_test/virgl: Disable for all Rocky Linux +- selftest: devtool: set BB_HASHSERVE_UPSTREAM when setting SSTATE_MIRROR +- sstatesig: Improve output hash calculation +- staging/multilib: Fix manifest corruption +- staging: Separate out different multiconfig manifests +- sudo: update 1.9.12p2 -> 1.9.13p3 +- systemd.bbclass: Add /usr/lib/systemd to searchpaths as well +- systemd: add group sgx to udev package +- systemd: fix wrong nobody-group assignment +- timezone: use 'tz' subdir instead of ${WORKDIR} directly +- toolchain-scripts: Handle spaces within user $PATH +- tzcode-native: fix build with gcc-13 on host +- tzdata: use separate B instead of WORKDIR for zic output +- uninative: upgrade to 3.9 to include libgcc and glibc 2.37 +- vala: Fix install conflict when enable multilib. +- vim: add missing pkgconfig inherit +- vim: set modified-by to the recipe MAINTAINER +- vim: upgrade to 9.0.1429 +- wic: Fix usage of fstype=none in wic +- wireless-regdb: upgrade to 2023.02.13 +- xserver-xorg: upgrade to 21.1.7 +- xwayland: upgrade to 22.1.8 + + +Known Issues in Yocto-4.0.9 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.9 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Alexis Lothoré +- Bruce Ashfield +- Changqing Li +- Chee Yang Lee +- Dmitry Baryshkov +- Federico Pellegrin +- Geoffrey GIRY +- Hitendra Prajapati +- Hongxu Jia +- Joe Slater +- Kai Kang +- Kenfe-Mickael Laventure +- Khem Raj +- Martin Jansa +- Mateusz Marciniec +- Michael Halstead +- Michael Opdenacker +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Narpat Mali +- Pavel Zhukov +- Pawan Badganchi +- Peter Marko +- Piotr Łobacz +- Poonam Jadhav +- Randy MacLeod +- Richard Purdie +- Robert Yang +- Romuald Jeanne +- Ross Burton +- Sakib Sajal +- Saul Wold +- Shubham Kulkarni +- Siddharth Doshi +- Simone Weiss +- Steve Sakoman +- Tim Orling +- Tom Hochstein +- Trevor Woerner +- Ulrich Ölmann +- Vivek Kumbhar +- Wang Mingyu +- Xiangyu Chen +- Yash Shinde + + +Repositories / Downloads for Yocto-4.0.9 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.9 </poky/log/?h=yocto-4.0.9>` +- Git Revision: :yocto_git:`09def309f91929f47c6cce386016ccb777bd2cfc </poky/commit/?id=09def309f91929f47c6cce386016ccb777bd2cfc>` +- Release Artefact: poky-09def309f91929f47c6cce386016ccb777bd2cfc +- sha: 5c7ce209c8a6b37ec2898e5ca21858234d91999c11fa862880ba98e8bde62f63 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.9/poky-09def309f91929f47c6cce386016ccb777bd2cfc.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.9/poky-09def309f91929f47c6cce386016ccb777bd2cfc.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.9 </openembedded-core/log/?h=yocto-4.0.9>` +- Git Revision: :oe_git:`ff4b57ffff903a93b710284c7c7f916ddd74712f </openembedded-core/commit/?id=ff4b57ffff903a93b710284c7c7f916ddd74712f>` +- Release Artefact: oecore-ff4b57ffff903a93b710284c7c7f916ddd74712f +- sha: 726778ffc291136db1704316b196de979f68df9f96476b785e1791957fbb66b3 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.9/oecore-ff4b57ffff903a93b710284c7c7f916ddd74712f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.9/oecore-ff4b57ffff903a93b710284c7c7f916ddd74712f.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.9 </meta-mingw/log/?h=yocto-4.0.9>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.9/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.9/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.9 </meta-gplv2/log/?h=yocto-4.0.9>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.9/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.9/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.9 </bitbake/log/?h=yocto-4.0.9>` +- Git Revision: :oe_git:`2802adb572eb73a3eb2725a74a9bbdaafc543fa7 </bitbake/commit/?id=2802adb572eb73a3eb2725a74a9bbdaafc543fa7>` +- Release Artefact: bitbake-2802adb572eb73a3eb2725a74a9bbdaafc543fa7 +- sha: 5c6e713b5e26b3835c0773095c7a1bc1f8affa28316b33597220ed86f1f1b643 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.9/bitbake-2802adb572eb73a3eb2725a74a9bbdaafc543fa7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.9/bitbake-2802adb572eb73a3eb2725a74a9bbdaafc543fa7.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.9 </yocto-docs/log/?h=yocto-4.0.9>` +- Git Revision: :yocto_git:`86d0b38a97941ad52b1af220c7b801a399d50e93 </yocto-docs/commit/?id=86d0b38a97941ad52b1af220c7b801a399d50e93>` + diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst new file mode 100644 index 0000000000..a5d66c0410 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.rst @@ -0,0 +1,937 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 4.0 (kirkstone) +--------------------------------- + +This is a Long Term Support release, published in April 2022, and supported at least for two years (April 2024). + +New Features / Enhancements in 4.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 5.15, glibc 2.35 and ~300 other recipe upgrades + +- Reproducibility: this release fixes the reproducibility issues with + ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully + reproducible. Functionality previously in the optional "reproducible" + class has been merged into the :ref:`ref-classes-base` class. + +- Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) + +- The Yocto Project now allows you to reuse the Shared State cache from + its autobuilder. If the network connection between our server and your + machine is faster than you would build recipes from source, you can + try to speed up your builds by using such Shared State and Hash + Equivalence by setting:: + + BB_SIGNATURE_HANDLER = "OEEquivHash" + BB_HASHSERVE = "auto" + BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687" + SSTATE_MIRRORS ?= "file://.* https://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH" + +- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__ + in line with the upstream direction. + +- New :ref:`ref-classes-overlayfs` and :ref:`ref-classes-overlayfs-etc` classes and + ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to + overlay read-only filesystems (for example) with + :wikipedia:`OverlayFS <OverlayFS>`. + +- Inclusive language adjustments to some variable names - see the + :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. + +- New recipes: + + - ``buildtools-docs-tarball`` + - ``libptytty`` + - ``libxcvt`` + - ``lua`` + - ``nghttp2`` + - ``python3-alabaster`` + - ``python3-asn1crypto`` + - ``python3-babel`` + - ``python3-bcrypt`` + - ``python3-certifi`` + - ``python3-cffi`` + - ``python3-chardet`` + - ``python3-cryptography`` + - ``python3-cryptography-vectors`` + - ``python3-dtschema`` + - ``python3-flit-core`` + - ``python3-idna`` + - ``python3-imagesize`` + - ``python3-installer`` + - ``python3-iso8601`` + - ``python3-jsonpointer`` + - ``python3-jsonschema`` + - ``python3-ndg-httpsclient`` + - ``python3-ply`` + - ``python3-poetry-core`` + - ``python3-pretend`` + - ``python3-psutil`` + - ``python3-pyasn1`` + - ``python3-pycparser`` + - ``python3-pyopenssl`` + - ``python3-pyrsistent`` + - ``python3-pysocks`` + - ``python3-pytest-runner`` + - ``python3-pytest-subtests`` + - ``python3-pytz`` + - ``python3-requests`` + - ``python3-rfc3339-validator`` + - ``python3-rfc3986-validator`` + - ``python3-rfc3987`` + - ``python3-ruamel-yaml`` + - ``python3-semantic-version`` + - ``python3-setuptools-rust-native`` + - ``python3-snowballstemmer`` + - ``python3-sphinx`` + - ``python3-sphinxcontrib-applehelp`` + - ``python3-sphinxcontrib-devhelp`` + - ``python3-sphinxcontrib-htmlhelp`` + - ``python3-sphinxcontrib-jsmath`` + - ``python3-sphinxcontrib-qthelp`` + - ``python3-sphinxcontrib-serializinghtml`` + - ``python3-sphinx-rtd-theme`` + - ``python3-strict-rfc3339`` + - ``python3-tomli`` + - ``python3-typing-extensions`` + - ``python3-urllib3`` + - ``python3-vcversioner`` + - ``python3-webcolors`` + - ``python3-wheel`` + - ``repo`` + - ``seatd`` + +- Extended recipes to ``native``: ``wayland``, ``wayland-protocols`` + +- Shared state (sstate) improvements: + + - Switched to :wikipedia:`ZStandard (zstd) <Zstd>` instead + of Gzip, for better performance. + - Allow validation of sstate signatures against a list of keys + - Improved error messages and exception handling + +- BitBake enhancements: + + - Fetcher enhancements: + + - New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages + - Added striplevel support to unpack + - git: Add a warning asking users to set a branch in git urls + - git: Allow git fetcher to support subdir param + - git: canonicalize ids in generated tarballs + - git: stop generated tarballs from leaking info + - npm: Put all downloaded files in the npm2 directory + - npmsw: Add support for duplicate dependencies without url + - npmsw: Add support for github prefix in npm shrinkwrap version + - ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username + - wget: add redirectauth parameter + - wget: add 30s timeout for checkstatus calls + + - Show warnings for append/prepend/remove operators combined with +=/.= + - Add bb.warnonce() and bb.erroronce() log methods + - Improved setscene task display + - Show elapsed time also for tasks with progress bars + - Improved cleanup on forced shutdown (either because of errors or Ctrl+C) + - contrib: Add Dockerfile for building PR service container + - Change file format of siginfo files to use zstd compressed json + - Display active tasks when printing keep-alive message to help debugging + +- Architecture-specific enhancements: + + - ARM: + + - tune-cortexa72: Enable the crc extension by default for cortexa72 + - qemuarm64: Add tiny ktype to qemuarm64 bsp + - armv9a/tune: Add the support for the Neoverse N2 core + - arch-armv8-5a.inc: Add tune include for armv8.5a + - grub-efi: Add xen_boot support when 'xen' is in :term:`DISTRO_FEATURES` for aarch64 + - tune-cortexa73: Introduce cortexa73-crypto tune + - libacpi: Build libacpi also for 'aarch64' machines + - core-image-tiny-initramfs: Mark recipe as 32 bit ARM compatible + + - PowerPC: + + - weston-init: Use pixman rendering for qemuppc64 + - rust: add support for big endian 64-bit PowerPC + - rust: Add snapshot checksums for powerpc64le + + - RISC-V: + + - libunwind: Enable for rv64 + - systemtap: Enable for riscv64 + - linux-yocto-dev: add qemuriscv32 + - packagegroup-core-tools-profile: Enable systemtap for riscv64 + - qemuriscv: Use virtio-tablet-pci for mouse + + - x86: + + - kernel-yocto: conditionally enable stack protection checking on x86-64 + +- Kernel-related enhancements: + + - Allow :term:`Initramfs` to be built from a separate multiconfig + - Make kernel-base recommend kernel-image, not depend (allowing images containing kernel modules without kernel image) + - linux-yocto: split vtpm for more granular inclusion + - linux-yocto: cfg/debug: add configs for kcsan + - linux-yocto: cfg: add kcov feature fragment + - linux-yocto: export pkgconfig variables to devshell + - linux-yocto-dev: use versioned branch as default + - New :term:`KERNEL_DEBUG_TIMESTAMPS` variable (to replace removed ``BUILD_REPRODUCIBLE_BINARIES`` for the kernel) + - Introduce python3-dtschema-wrapper in preparation for mandatory schema checking on dtb files in 5.16 + - Allow disabling kernel artifact symlink creation + - Allow changing default .bin kernel artifact extension + +- FIT image related enhancements: + + - New ``FIT_SUPPORTED_INITRAMFS_FSTYPES`` variable to allow extending :term:`Initramfs` image types to look for + - New ``FIT_CONF_PREFIX`` variable to allow overriding FIT configuration prefix + - Use 'bbnote' for better logging + +- New :term:`PACKAGECONFIG` options in ``curl``, ``dtc``, ``epiphany``, ``git``, ``git``, ``gstreamer1.0-plugins-bad``, ``linux-yocto-dev``, ``kmod``, ``mesa``, ``piglit``, ``qemu``, ``rpm``, ``systemd``, ``webkitgtk``, ``weston-init`` +- ptest enhancements in ``findutils``, ``lttng-tools``, ``openssl``, ``gawk``, ``strace``, ``lttng-tools``, ``valgrind``, ``perl``, ``libxml-parser-perl``, ``openssh``, ``python3-cryptography``, ``popt`` + +- Sysroot dependencies have been further optimised +- Significant effort to upstream / rationalise patches across a variety of recipes +- Allow the creation of block devices on top of UBI volumes +- archiver: new ARCHIVER_MODE[compression] to set tarball compression, and switch default to xz +- yocto-check-layer: add ability to perform tests from a global bbclass +- yocto-check-layer: improved README checks +- cve-check: add json output format +- cve-check: add coverage statistics on recipes with/without CVEs +- Added mirrors for kernel sources and uninative binaries on kernel.org +- glibc and binutils recipes now use shallow mirror tarballs for faster fetching +- When patching fails, show more information on the fatal error + +- wic Image Creator enhancements: + + - Support rootdev identified by partition label + - rawcopy: Add support for packed images + - partition: Support valueless keys in sourceparams + +- QA check enhancements: + + - Allow treating license issues as errors + - Added a check that Upstream-Status patch tag is present and correctly formed + - Added a check for directories that are expected to be empty + - Ensure addition of patch-fuzz retriggers do_qa_patch + - Added a sanity check for allarch packagegroups + +- :ref:`ref-classes-create-spdx` class improvements: + + - Get SPDX-License-Identifier from source files + - Generate manifest also for SDKs + - New SPDX_ORG variable to allow changing the Organization field value + - Added packageSupplier field + - Added create_annotation function + +- devtool add / recipetool create enhancements: + + - Extend curl detection when creating recipes + - Handle GitLab URLs like we do GitHub + - Recognize more standard license text variants + - Separate licenses with & operator + - Detect more known licenses in Python code + - Move license md5sums data into CSV files + - npm: Use README as license fallback + +- SDK-related enhancements: + + - Extended recipes to :ref:`ref-classes-nativesdk`: ``cargo``, + ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` + - Enabled :ref:`ref-classes-nativesdk` recipes to find a correct version + of the rust cross compiler + - Support creating per-toolchain cmake file in SDK + +- Rust enhancements: + + - New python_setuptools3_rust class to enable building python extensions in Rust + - classes/meson: Add optional rust definitions + +- QEMU / runqemu enhancements: + + - qemu: Add knob for enabling PMDK pmem support + - qemu: add tpm string section to qemu acpi table + - qemu: Build on musl targets + - runqemu: support rootfs mounted ro + - runqemu: add :term:`DEPLOY_DIR_IMAGE` replacement in QB_OPT_APPEND + - runqemu: Allow auto-detection of the correct graphics options + +- Capped ``cpu_count()`` (used to set parallelisation defaults) to 64 since any higher usually hurts parallelisation +- Adjust some GL-using recipes so that they only require virtual/egl +- package_rpm: use zstd instead of xz +- npm: new ``EXTRA_OENPM`` variable (to set node-gyp variables for example) +- npm: new ``NPM_NODEDIR`` variable +- perl: Enable threading +- u-boot: Convert ${UBOOT_ENV}.cmd into ${UBOOT_ENV}.scr +- u-boot: Split do_configure logic into separate file +- go.bbclass: Allow adding parameters to go ldflags +- go: log build id computations +- scons: support out-of-tree builds +- scripts: Add a conversion script to use SPDX license names +- scripts: Add convert-variable-renames script for inclusive language variable renaming +- binutils-cross-canadian: enable gold for mingw +- grub-efi: Add option to include all available modules +- bitbake.conf: allow wayland distro feature through for native/SDK builds +- weston-init: Pass --continue-without-input when launching weston +- weston: wrapper for weston modules argument +- weston: Add a knob to control simple clients +- uninative: Add version to uninative tarball name +- volatile-binds: SELinux and overlayfs extensions in mount-copybind +- gtk-icon-cache: Allow using gtk4 +- kmod: Add an exclude directive to depmod +- os-release: add os-release-initrd package for use in systemd-based :term:`Initramfs` images +- gstreamer1.0-plugins-base: add support for graphene +- gpg-sign: Add parameters to gpg signature function +- package_manager: sign DEB package feeds +- zstd: add libzstd package +- libical: build gobject and vala introspection +- dhcpcd: add option to set DBDIR location +- rpcbind: install rpcbind.conf +- mdadm: install mdcheck +- boost: add json lib +- libxkbcommon: allow building of API documentation +- libxkbcommon: split libraries and xkbcli into separate packages +- systemd: move systemd shared library into its own package +- systemd: Minimize udev package size if :term:`DISTRO_FEATURES` doen't contain sysvinit + +Known Issues in 4.0 +~~~~~~~~~~~~~~~~~~~ + +- ``make`` version 4.2.1 is known to be buggy on non-Ubuntu systems. If this ``make`` + version is detected on host distributions other than Ubuntu at build start time, + then a warning will be displayed. + +Recipe License changes in 4.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +* cmake: add BSD-1-Clause & MIT & BSD-2-Clause to :term:`LICENSE` due to additional vendored libraries in native/target context +* gettext: extend :term:`LICENSE` conditional upon :term:`PACKAGECONFIG` (due to vendored libraries) +* gstreamer1.0: update licenses of all modules to LGPL-2.1-or-later (with some exceptions that are GPL-2.0-or-later) +* gstreamer1.0-plugins-bad/ugly: use the GPL-2.0-or-later only when it is in use +* kern-tools-native: add missing MIT license due to Kconfiglib +* libcap: add pam_cap license to :term:`LIC_FILES_CHKSUM` if pam is enabled +* libidn2: add Unicode-DFS-2016 license +* libsdl2: add BSD-2-Clause to :term:`LICENSE` due to default yuv2rgb and hidapi inclusion +* libx11-compose-data: update :term:`LICENSE` to "MIT & MIT-style & BSD-1-Clause & HPND & HPND-sell-variant" to better reflect reality +* libx11: update :term:`LICENSE` to "MIT & MIT-style & BSD-1-Clause & HPND & HPND-sell-variant" to better reflect reality +* libxshmfence: correct :term:`LICENSE` - MIT -> HPND +* newlib: add BSD-3-Clause to :term:`LICENSE` +* python3-idna: correct :term:`LICENSE` - Unicode -> Unicode-TOU +* python3-pip: add "Apache-2.0 & MPL-2.0 & LGPL-2.1-only & BSD-3-Clause & PSF-2.0 & BSD-2-Clause" to :term:`LICENSE` due to vendored libraries + +Other license-related notes: + +- The ambiguous "BSD" license has been removed from the ``common-licenses`` directory. + Each recipe that fetches or builds BSD-licensed code should specify the proper + version of the BSD license in its :term:`LICENSE` value. + +- :term:`LICENSE` definitions now have to use `SPDX identifiers <https://spdx.org/licenses/>`__. + A :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` + script can be used to update your recipes. + + + +Security Fixes in 4.0 +~~~~~~~~~~~~~~~~~~~~~ + +- binutils: :cve:`2021-42574`, :cve:`2021-45078` +- curl: :cve:`2021-22945`, :cve:`2021-22946`, :cve:`2021-22947` +- epiphany: :cve:`2021-45085`, :cve:`2021-45086`, :cve:`2021-45087`, :cve:`2021-45088` +- expat: :cve:`2021-45960`, :cve:`2021-46143`, :cve:`2022-22822`, :cve:`2022-22823`, :cve:`2022-22824`, :cve:`2022-22825`, :cve:`2022-22826`, :cve:`2022-22827`, :cve:`2022-23852`, :cve:`2022-23990`, :cve:`2022-25235`, :cve:`2022-25236`, :cve:`2022-25313`, :cve:`2022-25314`, :cve:`2022-25315` +- ffmpeg: :cve:`2021-38114` +- gcc: :cve:`2021-35465`, :cve:`2021-42574`, :cve:`2021-46195`, :cve:`2022-24765` +- glibc: :cve:`2021-3998`, :cve:`2021-3999`, :cve:`2021-43396`, :cve:`2022-23218`, :cve:`2022-23219` +- gmp: :cve:`2021-43618` +- go: :cve:`2021-41771` and :cve:`2021-41772` +- grub2: :cve:`2021-3981` +- gzip: :cve:`2022-1271` +- libarchive : :cve:`2021-31566`, :cve:`2021-36976` +- libxml2: :cve:`2022-23308` +- libxslt: :cve:`2021-30560` +- lighttpd: :cve:`2022-22707` +- linux-yocto/5.10: amdgpu: :cve:`2021-42327` +- lua: :cve:`2021-43396` +- openssl: :cve:`2021-4044`, :cve:`2022-0778` +- qemu: :cve:`2022-1050`, :cve:`2022-26353`, :cve:`2022-26354` +- rpm: :cve:`2021-3521` +- seatd: :cve:`2022-25643` +- speex: :cve:`2020-23903` +- squashfs-tools: :cve:`2021-41072` +- systemd: :cve:`2021-4034` +- tiff: :cve:`2022-0561`, :cve:`2022-0562`, :cve:`2022-0865`, :cve:`2022-0891`, :cve:`2022-0907`, :cve:`2022-0908`, :cve:`2022-0909`, :cve:`2022-0924`, :cve:`2022-1056`, :cve:`2022-22844` +- unzip: :cve:`2021-4217` +- vim: :cve:`2021-3796`, :cve:`2021-3872`, :cve:`2021-3875`, :cve:`2021-3927`, :cve:`2021-3928`, :cve:`2021-3968`, :cve:`2021-3973`, :cve:`2021-4187`, :cve:`2022-0128`, :cve:`2022-0156`, :cve:`2022-0158`, :cve:`2022-0261`, :cve:`2022-0318`, :cve:`2022-0319`, :cve:`2022-0554`, :cve:`2022-0696`, :cve:`2022-0714`, :cve:`2022-0729`, :cve:`2022-0943` +- virglrenderer: :cve:`2022-0135`, :cve:`2022-0175` +- webkitgtk: :cve:`2022-22589`, :cve:`2022-22590`, :cve:`2022-22592` +- xz: :cve:`2022-1271` +- zlib: :cve:`2018-25032` + + + +Recipe Upgrades in 4.0 +~~~~~~~~~~~~~~~~~~~~~~ + +- acpica: upgrade 20210730 -> 20211217 +- acpid: upgrade 2.0.32 -> 2.0.33 +- adwaita-icon-theme: update 3.34/38 -> 41.0 +- alsa-ucm-conf: upgrade 1.2.6.2 -> 1.2.6.3 +- alsa: upgrade 1.2.5 -> 1.2.6 +- apt: upgrade 2.2.4 -> 2.4.3 +- asciidoc: upgrade 9.1.0 -> 10.0.0 +- atk: upgrade 2.36.0 -> 2.38.0 +- at-spi2-core: upgrade 2.40.3 -> 2.42.0 +- at: update 3.2.2 -> 3.2.5 +- autoconf-archive: upgrade 2021.02.19 -> 2022.02.11 +- automake: update 1.16.3 -> 1.16.5 +- bash: upgrade 5.1.8 -> 5.1.16 +- bind: upgrade 9.16.20 -> 9.18.1 +- binutils: Bump to latest 2.38 release branch +- bison: upgrade 3.7.6 -> 3.8.2 +- bluez5: upgrade 5.61 -> 5.64 +- boost: update 1.77.0 -> 1.78.0 +- btrfs-tools: upgrade 5.13.1 -> 5.16.2 +- buildtools-installer: Update to use 3.4 +- busybox: 1.34.0 -> 1.35.0 +- ca-certificates: update 20210119 -> 20211016 +- cantarell-fonts: update 0.301 -> 0.303.1 +- ccache: upgrade 4.4 -> 4.6 +- cmake: update 3.21.1 -> 3.22.3 +- connman: update 1.40 -> 1.41 +- coreutils: update 8.32 -> 9.0 +- cracklib: update 2.9.5 -> 2.9.7 +- createrepo-c: upgrade 0.17.4 -> 0.19.0 +- cronie: upgrade 1.5.7 -> 1.6.0 +- cups: update 2.3.3op2 -> 2.4.1 +- curl: update 7.78.0 -> 7.82.0 +- dbus: upgrade 1.12.20 -> 1.14.0 +- debianutils: update 4.11.2 -> 5.7 +- dhcpcd: upgrade 9.4.0 -> 9.4.1 +- diffoscope: upgrade 181 -> 208 +- dnf: upgrade 4.8.0 -> 4.11.1 +- dpkg: update 1.20.9 -> 1.21.4 +- e2fsprogs: upgrade 1.46.4 -> 1.46.5 +- ed: upgrade 1.17 -> 1.18 +- efivar: update 37 -> 38 +- elfutils: update 0.185 -> 0.186 +- ell: upgrade 0.43 -> 0.49 +- enchant2: upgrade 2.3.1 -> 2.3.2 +- epiphany: update 40.3 -> 42.0 +- erofs-utils: update 1.3 -> 1.4 +- ethtool: update to 5.16 +- expat: upgrade 2.4.1 -> 2.4.7 +- ffmpeg: update 4.4 -> 5.0 +- file: upgrade 5.40 -> 5.41 +- findutils: upgrade 4.8.0 -> 4.9.0 +- flac: upgrade 1.3.3 -> 1.3.4 +- freetype: upgrade 2.11.0 -> 2.11.1 +- fribidi: upgrade 1.0.10 -> 1.0.11 +- gawk: update 5.1.0 -> 5.1.1 +- gcompat: Update to latest +- gdbm: upgrade 1.19 -> 1.23 +- gdb: Upgrade to 11.2 +- ghostscript: update 9.54.0 -> 9.55.0 +- gi-docgen: upgrade 2021.7 -> 2022.1 +- git: update 2.33.0 -> 2.35.2 +- glib-2.0: update 2.68.4 -> 2.72.0 +- glibc: Upgrade to 2.35 +- glib-networking: update 2.68.2 -> 2.72.0 +- glslang: update 11.5.0 -> 11.8.0 +- gnu-config: update to latest revision +- gnupg: update 2.3.1 -> 2.3.4 +- gnutls: update 3.7.2 -> 3.7.4 +- gobject-introspection: upgrade 1.68.0 -> 1.72.0 +- go-helloworld: update to latest revision +- go: update 1.16.7 -> 1.17.8 +- gpgme: upgrade 1.16.0 -> 1.17.1 +- gsettings-desktop-schemas: upgrade 40.0 -> 42.0 +- gst-devtools: 1.18.4 -> 1.20.1 +- gst-examples: 1.18.4 -> 1.18.6 +- gstreamer1.0: 1.18.4 -> 1.20.1 +- gstreamer1.0-libav: 1.18.4 -> 1.20.1 +- gstreamer1.0-omx: 1.18.4 -> 1.20.1 +- gstreamer1.0-plugins-bad: 1.18.4 1.20.1 +- gstreamer1.0-plugins-base: 1.18.4 -> 1.20.1 +- gstreamer1.0-plugins-good: 1.18.4 -> 1.20.1 +- gstreamer1.0-plugins-ugly: 1.18.4 -> 1.20.1 +- gstreamer1.0-python: 1.18.4 -> 1.20.1 +- gstreamer1.0-rtsp-server: 1.18.4 -> 1.20.1 +- gstreamer1.0-vaapi: 1.18.4 -> 1.20.1 +- gtk+3: upgrade 3.24.30 -> 3.24.33 +- gzip: upgrade 1.10 -> 1.12 +- harfbuzz: upgrade 2.9.0 -> 4.0.1 +- hdparm: upgrade 9.62 -> 9.63 +- help2man: upgrade 1.48.4 -> 1.49.1 +- icu: update 69.1 -> 70.1 +- ifupdown: upgrade 0.8.36 -> 0.8.37 +- inetutils: update 2.1 -> 2.2 +- init-system-helpers: upgrade 1.60 -> 1.62 +- iproute2: update to 5.17.0 +- iputils: update 20210722 to 20211215 +- iso-codes: upgrade 4.6.0 -> 4.9.0 +- itstool: update 2.0.6 -> 2.0.7 +- iw: upgrade 5.9 -> 5.16 +- json-glib: upgrade 1.6.4 -> 1.6.6 +- kea: update 1.8.2 -> 2.0.2 +- kexec-tools: update 2.0.22 -> 2.0.23 +- less: upgrade 590 -> 600 +- libarchive: upgrade 3.5.1 -> 3.6.1 +- libatomic-ops: upgrade 7.6.10 -> 7.6.12 +- libbsd: upgrade 0.11.3 -> 0.11.5 +- libcap: update 2.51 -> 2.63 +- libcgroup: upgrade 2.0 -> 2.0.1 +- libcomps: upgrade 0.1.17 -> 0.1.18 +- libconvert-asn1-perl: upgrade 0.31 -> 0.33 +- libdazzle: upgrade 3.40.0 -> 3.44.0 +- libdnf: update 0.63.1 -> 0.66.0 +- libdrm: upgrade 2.4.107 -> 2.4.110 +- libedit: upgrade 20210714-3.1 -> 20210910-3.1 +- liberation-fonts: update 2.1.4 -> 2.1.5 +- libevdev: upgrade 1.11.0 -> 1.12.1 +- libexif: update 0.6.22 -> 0.6.24 +- libgit2: update 1.1.1 -> 1.4.2 +- libgpg-error: update 1.42 -> 1.44 +- libhandy: update 1.2.3 -> 1.5.0 +- libical: upgrade 3.0.10 -> 3.0.14 +- libinput: update to 1.19.3 +- libjitterentropy: update 3.1.0 -> 3.4.0 +- libjpeg-turbo: upgrade 2.1.1 -> 2.1.3 +- libmd: upgrade 1.0.3 -> 1.0.4 +- libmicrohttpd: upgrade 0.9.73 -> 0.9.75 +- libmodulemd: upgrade 2.13.0 -> 2.14.0 +- libpam: update 1.5.1 -> 1.5.2 +- libpcre2: upgrade 10.37 -> 10.39 +- libpipeline: upgrade 1.5.3 -> 1.5.5 +- librepo: upgrade 1.14.1 -> 1.14.2 +- librsvg: update 2.40.21 -> 2.52.7 +- libsamplerate0: update 0.1.9 -> 0.2.2 +- libsdl2: update 2.0.16 -> 2.0.20 +- libseccomp: update to 2.5.3 +- libsecret: upgrade 0.20.4 -> 0.20.5 +- libsndfile1: bump to version 1.0.31 +- libsolv: upgrade 0.7.19 -> 0.7.22 +- libsoup-2.4: upgrade 2.72.0 -> 2.74.2 +- libsoup: add a recipe for 3.0.5 +- libssh2: update 1.9.0 -> 1.10.0 +- libtasn1: upgrade 4.17.0 -> 4.18.0 +- libtool: Upgrade 2.4.6 -> 2.4.7 +- libucontext: Upgrade to 1.2 release +- libunistring: update 0.9.10 -> 1.0 +- libunwind: upgrade 1.5.0 -> 1.6.2 +- liburcu: upgrade 0.13.0 -> 0.13.1 +- libusb1: upgrade 1.0.24 -> 1.0.25 +- libuv: update 1.42.0 -> 1.44.1 +- libva: update 2.12.0 -> 2.14.0 +- libva-utils: upgrade 2.13.0 -> 2.14.0 +- libwebp: 1.2.1 -> 1.2.2 +- libwpe: upgrade 1.10.1 -> 1.12.0 +- libx11: update to 1.7.3.1 +- libxcrypt: upgrade 4.4.26 -> 4.4.27 +- libxcrypt-compat: upgrade 4.4.26 -> 4.4.27 +- libxi: update to 1.8 +- libxkbcommon: update to 1.4.0 +- libxml2: update to 2.9.13 +- libxslt: update to v1.1.35 +- lighttpd: update 1.4.59 -> 1.4.64 +- linux-firmware: upgrade 20210818 -> 20220310 +- linux-libc-headers: update to v5.16 +- linux-yocto/5.10: update to v5.10.109 +- linux-yocto/5.15: introduce recipes (v5.15.32) +- linux-yocto-dev: update to v5.18+ +- linux-yocto-rt/5.10: update to -rt61 +- linux-yocto-rt/5.15: update to -rt34 +- llvm: update 12.0.1 -> 13.0.1 +- logrotate: update 3.18.1 -> 3.19.0 +- lsof: update 4.91 -> 4.94.0 +- ltp: update 20210927 -> 20220121 +- ltp: Update to 20210927 +- lttng-modules: update devupstream to latest 2.13 +- lttng-modules: update to 2.13.3 +- lttng-tools: upgrade 2.13.0 -> 2.13.4 +- lttng-ust: upgrade 2.13.0 -> 2.13.2 +- lua: update 5.3.6 -> 5.4.4 +- lzip: upgrade 1.22 -> 1.23 +- man-db: upgrade 2.9.4 -> 2.10.2 +- man-pages: update to 5.13 +- mdadm: update 4.1 -> 4.2 +- mesa: upgrade 21.2.1 -> 22.0.0 +- meson: update 0.58.1 -> 0.61.3 +- minicom: Upgrade 2.7.1 -> 2.8 +- mmc-utils: upgrade to latest revision +- mobile-broadband-provider-info: upgrade 20210805 -> 20220315 +- mpg123: upgrade 1.28.2 -> 1.29.3 +- msmtp: upgrade 1.8.15 -> 1.8.20 +- mtd-utils: upgrade 2.1.3 -> 2.1.4 +- mtools: upgrade 4.0.35 -> 4.0.38 +- musl: Update to latest master +- ncurses: update 6.2 -> 6.3 +- newlib: Upgrade 4.1.0 -> 4.2.0 +- nfs-utils: upgrade 2.5.4 -> 2.6.1 +- nghttp2: upgrade 1.45.1 -> 1.47.0 +- ofono: upgrade 1.32 -> 1.34 +- opensbi: Upgrade to 1.0 +- openssh: upgrade 8.7p1 -> 8.9 +- openssl: update 1.1.1l -> 3.0.2 +- opkg: upgrade 0.4.5 -> 0.5.0 +- opkg-utils: upgrade 0.4.5 -> 0.5.0 +- ovmf: update 202105 -> 202202 +- p11-kit: update 0.24.0 -> 0.24.1 +- pango: upgrade 1.48.9 -> 1.50.4 +- patchelf: upgrade 0.13 -> 0.14.5 +- perl-cross: update 1.3.6 -> 1.3.7 +- perl: update 5.34.0 -> 5.34.1 +- piglit: upgrade to latest revision +- pigz: upgrade 2.6 -> 2.7 +- pinentry: update 1.1.1 -> 1.2.0 +- pkgconfig: Update to latest +- psplash: upgrade to latest revision +- puzzles: upgrade to latest revision +- python3-asn1crypto: upgrade 1.4.0 -> 1.5.1 +- python3-attrs: upgrade 21.2.0 -> 21.4.0 +- python3-cryptography: Upgrade to 36.0.2 +- python3-cryptography-vectors: upgrade to 36.0.2 +- python3-cython: upgrade 0.29.24 -> 0.29.28 +- python3-dbusmock: update to 0.27.3 +- python3-docutils: upgrade 0.17.1 0.18.1 +- python3-dtschema: upgrade 2021.10 -> 2022.1 +- python3-gitdb: upgrade 4.0.7 -> 4.0.9 +- python3-git: update to 3.1.27 +- python3-hypothesis: upgrade 6.15.0 -> 6.39.5 +- python3-imagesize: upgrade 1.2.0 -> 1.3.0 +- python3-importlib-metadata: upgrade 4.6.4 -> 4.11.3 +- python3-jinja2: upgrade 3.0.1 -> 3.1.1 +- python3-jsonschema: upgrade 3.2.0 -> 4.4.0 +- python3-libarchive-c: upgrade 3.1 -> 4.0 +- python3-magic: upgrade 0.4.24 -> 0.4.25 +- python3-mako: upgrade 1.1.5 -> 1.1.6 +- python3-markdown: upgrade 3.3.4 -> 3.3.6 +- python3-markupsafe: upgrade 2.0.1 -> 2.1.1 +- python3-more-itertools: upgrade 8.8.0 -> 8.12.0 +- python3-numpy: upgrade 1.21.2 -> 1.22.3 +- python3-packaging: upgrade 21.0 -> 21.3 +- python3-pathlib2: upgrade 2.3.6 -> 2.3.7 +- python3-pbr: upgrade 5.6.0 -> 5.8.1 +- python3-pip: update 21.2.4 -> 22.0.3 +- python3-pycairo: upgrade 1.20.1 -> 1.21.0 +- python3-pycryptodome: upgrade 3.10.1 -> 3.14.1 +- python3-pyelftools: upgrade 0.27 -> 0.28 +- python3-pygments: upgrade 2.10.0 -> 2.11.2 +- python3-pygobject: upgrade 3.40.1 -> 3.42.0 +- python3-pyparsing: update to 3.0.7 +- python3-pyrsistent: upgrade 0.18.0 -> 0.18.1 +- python3-pytest-runner: upgrade 5.3.1 -> 6.0.0 +- python3-pytest-subtests: upgrade 0.6.0 -> 0.7.0 +- python3-pytest: upgrade 6.2.4 -> 7.1.1 +- python3-pytz: upgrade 2021.3 -> 2022.1 +- python3-py: upgrade 1.10.0 -> 1.11.0 +- python3-pyyaml: upgrade 5.4.1 -> 6.0 +- python3-ruamel-yaml: upgrade 0.17.16 -> 0.17.21 +- python3-scons: upgrade 4.2.0 -> 4.3.0 +- python3-setuptools-scm: upgrade 6.0.1 -> 6.4.2 +- python3-setuptools: update to 59.5.0 +- python3-smmap: update to 5.0.0 +- python3-tomli: upgrade 1.2.1 -> 2.0.1 +- python3: update to 3.10.3 +- python3-urllib3: upgrade 1.26.8 -> 1.26.9 +- python3-zipp: upgrade 3.5.0 -> 3.7.0 +- qemu: update 6.0.0 -> 6.2.0 +- quilt: upgrade 0.66 -> 0.67 +- re2c: upgrade 2.2 -> 3.0 +- readline: upgrade 8.1 -> 8.1.2 +- repo: upgrade 2.17.3 -> 2.22 +- resolvconf: update 1.87 -> 1.91 +- rng-tools: upgrade 6.14 -> 6.15 +- rpcsvc-proto: upgrade 1.4.2 -> 1.4.3 +- rpm: update 4.16.1.3 -> 4.17.0 +- rt-tests: update 2.1 -> 2.3 +- ruby: update 3.0.2 -> 3.1.1 +- rust: update 1.54.0 -> 1.59.0 +- rxvt-unicode: upgrade 9.26 -> 9.30 +- screen: upgrade 4.8.0 -> 4.9.0 +- shaderc: update 2021.1 -> 2022.1 +- shadow: upgrade 4.9 -> 4.11.1 +- socat: upgrade 1.7.4.1 -> 1.7.4.3 +- spirv-headers: bump to b42ba6 revision +- spirv-tools: update 2021.2 -> 2022.1 +- sqlite3: upgrade 3.36.0 -> 3.38.2 +- strace: update 5.14 -> 5.16 +- stress-ng: upgrade 0.13.00 -> 0.13.12 +- sudo: update 1.9.7p2 -> 1.9.10 +- sysklogd: upgrade 2.2.3 -> 2.3.0 +- sysstat: upgrade 12.4.3 -> 12.4.5 +- systemd: update 249.3 -> 250.4 +- systemtap: upgrade 4.5 -> 4.6 +- sysvinit: upgrade 2.99 -> 3.01 +- tzdata: update to 2022a +- u-boot: upgrade 2021.07 -> 2022.01 +- uninative: Upgrade to 3.6 with gcc 12 support +- util-linux: update 2.37.2 -> 2.37.4 +- vala: upgrade 0.52.5 -> 0.56.0 +- valgrind: update 3.17.0 -> 3.18.1 +- vim: upgrade to 8.2 patch 4681 +- vte: upgrade 0.64.2 -> 0.66.2 +- vulkan-headers: upgrade 1.2.182 -> 1.2.191 +- vulkan-loader: upgrade 1.2.182 -> 1.2.198.1 +- vulkan-samples: update to latest revision +- vulkan-tools: upgrade 1.2.182 -> 1.2.191 +- vulkan: update 1.2.191.0 -> 1.3.204.1 +- waffle: update 1.6.1 -> 1.7.0 +- wayland-protocols: upgrade 1.21 -> 1.25 +- wayland: upgrade 1.19.0 -> 1.20.0 +- webkitgtk: upgrade 2.34.0 -> 2.36.0 +- weston: upgrade 9.0.0 -> 10.0.0 +- wget: update 1.21.1 -> 1.21.3 +- wireless-regdb: upgrade 2021.07.14 -> 2022.02.18 +- wpa-supplicant: update 2.9 -> 2.10 +- wpebackend-fdo: upgrade 1.10.0 -> 1.12.0 +- xauth: upgrade 1.1 -> 1.1.1 +- xf86-input-libinput: update to 1.2.1 +- xf86-video-intel: update to latest commit +- xkeyboard-config: update to 2.35.1 +- xorgproto: update to 2021.5 +- xserver-xorg: update 1.20.13 -> 21.1.3 +- xwayland: update 21.1.2 -> 22.1.0 +- xxhash: upgrade 0.8.0 -> 0.8.1 +- zstd: update 1.5.0 -> 1.5.2 + + + +Contributors to 4.0 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +- Abongwa Amahnui Bonalais +- Adriaan Schmidt +- Adrian Freihofer +- Ahmad Fatoum +- Ahmed Hossam +- Ahsan Hussain +- Alejandro Hernandez Samaniego +- Alessio Igor Bogani +- Alexander Kanavin +- Alexandre Belloni +- Alexandru Ardelean +- Alexey Brodkin +- Alex Stewart +- Andreas Müller +- Andrei Gherzan +- Andrej Valek +- Andres Beltran +- Andrew Jeffery +- Andrey Zhizhikin +- Anton Mikanovich +- Anuj Mittal +- Bill Pittman +- Bruce Ashfield +- Caner Altinbasak +- Carlos Rafael Giani +- Chaitanya Vadrevu +- Changhyeok Bae +- Changqing Li +- Chen Qi +- Christian Eggers +- Claudius Heine +- Claus Stovgaard +- Daiane Angolini +- Daniel Ammann +- Daniel Gomez +- Daniel McGregor +- Daniel Müller +- Daniel Wagenknecht +- David Joyner +- David Reyna +- Denys Dmytriyenko +- Dhruva Gole +- Diego Sueiro +- Dmitry Baryshkov +- Ferry Toth +- Florian Amstutz +- Henry Kleynhans +- He Zhe +- Hongxu Jia +- Hsia-Jun(Randy) Li +- Ian Ray +- Jacob Kroon +- Jagadeesh Krishnanjanappa +- Jasper Orschulko +- Jim Wilson +- Joel Winarske +- Joe Slater +- Jon Mason +- Jose Quaresma +- Joshua Watt +- Justin Bronder +- Kai Kang +- Kamil Dziezyk +- Kevin Hao +- Khairul Rohaizzat Jamaluddin +- Khem Raj +- Kiran Surendran +- Konrad Weihmann +- Kory Maincent +- Lee Chee Yang +- Leif Middelschulte +- Lei Maohui +- Li Wang +- Liwei Song +- Luca Boccassi +- Lukasz Majewski +- Luna Gräfje +- Manuel Leonhardt +- Marek Vasut +- Mark Hatle +- Markus Niebel +- Markus Volk +- Marta Rybczynska +- Martin Beeger +- Martin Jansa +- Matthias Klein +- Matt Madison +- Maximilian Blenk +- Max Krummenacher +- Michael Halstead +- Michael Olbrich +- Michael Opdenacker +- Mike Crowe +- Ming Liu +- Mingli Yu +- Minjae Kim +- Nicholas Sielicki +- Olaf Mandel +- Oleh Matiusha +- Oleksandr Kravchuk +- Oleksandr Ocheretnyi +- Oleksandr Suvorov +- Oleksiy Obitotskyy +- Otavio Salvador +- Pablo Saavedra +- Paul Barker +- Paul Eggleton +- Pavel Zhukov +- Peter Hoyes +- Peter Kjellerstedt +- Petr Vorel +- Pgowda +- Quentin Schulz +- Ralph Siemsen +- Randy Li +- Randy MacLeod +- Rasmus Villemoes +- Ricardo Salveti +- Richard Neill +- Richard Purdie +- Robert Joslyn +- Robert P. J. Day +- Robert Yang +- Ross Burton +- Rudolf J Streif +- Sakib Sajal +- Samuli Piippo +- Saul Wold +- Scott Murray +- Sean Anderson +- Simone Weiss +- Simon Kuhnle +- S. Lockwood-Childs +- Stefan Herbrechtsmeier +- Steve Sakoman +- Sundeep KOKKONDA +- Tamizharasan Kumar +- Tean Cunningham +- Teoh Jay Shen +- Thomas Perrot +- Tim Orling +- Tobias Kaufmann +- Tom Hochstein +- Tony McDowell +- Trevor Gamblin +- Ulrich Ölmann +- Valerii Chernous +- Vivien Didelot +- Vyacheslav Yurkov +- Wang Mingyu +- Xavier Berger +- Yi Zhao +- Yongxin Liu +- Yureka +- Zev Weiss +- Zheng Ruoqin +- Zoltán Böszörményi +- Zygmunt Krynicki + + + +Repositories / Downloads for 4.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0 </poky/tag/?h=yocto-4.0>` +- Git Revision: :yocto_git:`00cfdde791a0176c134f31e5a09eff725e75b905 </poky/commit/?id=00cfdde791a0176c134f31e5a09eff725e75b905>` +- Release Artefact: poky-00cfdde791a0176c134f31e5a09eff725e75b905 +- sha: 4cedb491b7bf0d015768c61690f30d7d73f4266252d6fba907bba97eac83648c +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0/poky-00cfdde791a0176c134f31e5a09eff725e75b905.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0/poky-00cfdde791a0176c134f31e5a09eff725e75b905.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0 </openembedded-core/tag/?h=yocto-4.0>` +- Git Revision: :oe_git:`92fcb6570bddd0c5717d8cfdf38ecf3e44942b0f </openembedded-core/commit/?id=92fcb6570bddd0c5717d8cfdf38ecf3e44942b0f>` +- Release Artefact: oecore-92fcb6570bddd0c5717d8cfdf38ecf3e44942b0f +- sha: c042629752543a10b0384b2076b1ee8742fa5e8112aef7b00b3621f8387a51c6 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0/oecore-92fcb6570bddd0c5717d8cfdf38ecf3e44942b0f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0/oecore-92fcb6570bddd0c5717d8cfdf38ecf3e44942b0f.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0 </meta-mingw/tag/?h=yocto-4.0>` +- Git Revision: :yocto_git:`a90614a6498c3345704e9611f2842eb933dc51c1 </meta-mingw/commit/?id=a90614a6498c3345704e9611f2842eb933dc51c1>` +- Release Artefact: meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1 +- sha: 49f9900bfbbc1c68136f8115b314e95d0b7f6be75edf36a75d9bcd1cca7c6302 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0/meta-mingw-a90614a6498c3345704e9611f2842eb933dc51c1.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0 </meta-gplv2/tag/?h=yocto-4.0>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-mingw/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0 </bitbake/tag/?h=yocto-4.0>` +- Git Revision: :oe_git:`c212b0f3b542efa19f15782421196b7f4b64b0b9 </bitbake/commit/?id=c212b0f3b542efa19f15782421196b7f4b64b0b9>` +- Release Artefact: bitbake-c212b0f3b542efa19f15782421196b7f4b64b0b9 +- sha: 6872095c7d7be5d791ef3e18b6bab2d1e0e237962f003d2b00dc7bd6fb6d2ef7 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0/bitbake-c212b0f3b542efa19f15782421196b7f4b64b0b9.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0/bitbake-c212b0f3b542efa19f15782421196b7f4b64b0b9.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0 </yocto-docs/tag/?h=yocto-4.0>` +- Git Revision: :yocto_git:`a6f571ad5b087385cad8765ed455c4b4eaeebca6 </yocto-docs/commit/?id=a6f571ad5b087385cad8765ed455c4b4eaeebca6>` + diff --git a/documentation/migration-guides/release-notes-4.1.1.rst b/documentation/migration-guides/release-notes-4.1.1.rst new file mode 100644 index 0000000000..4f31fbf1c7 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.1.1.rst @@ -0,0 +1,319 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.1.1 (Langdale) +---------------------------------------- + +Security Fixes in Yocto-4.1.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- curl: Fix :cve:`2022-32221`, :cve:`2022-35260`, :cve:`2022-42915` and :cve:`2022-42916` +- libx11: Fix :cve:`2022-3554` +- lighttpd: Fix :cve:`2022-41556` +- openssl: Fix :cve:`2022-3358`, :cve:`2022-3602` and :cve:`2022-3786` +- pixman: Fix :cve:`2022-44638` +- qemu: Fix :cve:`2022-3165` +- sudo: Fix :cve:`2022-43995` +- tiff: Fix :cve:`2022-3599`, :cve:`2022-3597`, :cve:`2022-3626`, :cve:`2022-3627`, :cve:`2022-3570` and :cve:`2022-3598` +- xserver-xorg: Fix :cve:`2022-3550` and :cve:`2022-3551` +- xserver-xorg: Ignore :cve:`2022-3553` + + +Fixes in Yocto-4.1.1 +~~~~~~~~~~~~~~~~~~~~ + +- Add 4.1 migration guide & release notes +- bitbake: asyncrpc: serv: correct closed client socket detection +- bitbake: bitbake-user-manual: details about variable flags starting with underscore +- bitbake: bitbake: bitbake-layers: checkout layer(s) branch when clone exists +- bitbake: bitbake: user-manual: inform about spaces in :remove +- bitbake: doc: bitbake-user-manual: expand description of BB_PRESSURE_MAX variables +- bitbake: fetch2/git: don't set core.fsyncobjectfiles=0 +- bitbake: tests/fetch: Allow handling of a file:// url within a submodule +- bitbake: tests: bb.tests.fetch.URLHandle: add 2 new tests +- bitbake: utils/ply: Update md5 to better report errors with hashlib +- bluez5: add dbus to :term:`RDEPENDS` +- build-appliance-image: Update to langdale head revision +- buildconf: compare abspath +- buildtools-tarball: export certificates to python and curl +- cmake-native: Fix host tool contamination +- create-spdx.bbclass: remove unused SPDX_INCLUDE_PACKAGED +- create-spdx: Remove ";name=..." for downloadLocation +- cve-update-db-native: add timeout to urlopen() calls +- dev-manual: common-tasks.rst: add reference to "do_clean" task +- dev-manual: common-tasks.rst: add reference to "do_listtasks" task +- docs: add support for langdale (4.1) release +- dropbear: add pam to :term:`PACKAGECONFIG` +- externalsrc.bbclass: fix git repo detection +- externalsrc.bbclass: Remove a trailing slash from ${B} +- externalsrc: move back to classes +- gcc: Allow -Wno-error=poison-system-directories to take effect +- glib-2.0: fix rare GFileInfo test case failure +- gnutls: Unified package names to lower-case +- gnutls: upgrade 3.7.7 -> 3.7.8 +- grub: disable build on armv7ve/a with hardfp +- gstreamer1.0-libav: fix errors with ffmpeg 5.x +- ifupdown: upgrade 0.8.37 -> 0.8.39 +- insane.bbclass: Allow hashlib version that only accepts on parameter +- install-buildtools: support buildtools-make-tarball and update to 4.1 +- kern-tools: fix relative path processing +- kernel-fitimage: Use KERNEL_OUTPUT_DIR where appropriate +- kernel-yocto: improve fatal error messages of symbol_why.py +- kernel: Clear :term:`SYSROOT_DIRS` instead of replacing sysroot_stage_all +- libcap: upgrade 2.65 -> 2.66 +- libical: upgrade 3.0.14 -> 3.0.15 +- libksba: upgrade 1.6.0 -> 1.6.2 +- libsdl2: upgrade 2.24.0 -> 2.24.1 +- lighttpd: upgrade 1.4.66 -> 1.4.67 +- linux-firmware: package amdgpu firmware +- linux-firmware: split rtl8761 firmware +- linux-yocto/5.15: update to v5.15.72 +- linux-yocto/5.19: update to v5.19.14 +- linux-yocto: add efi entry for machine features +- lttng-modules: upgrade 2.13.4 -> 2.13.5 +- lttng-ust: upgrade 2.13.4 -> 2.13.5 +- manuals: add reference to "do_configure" task +- manuals: add reference to the "do_compile" task +- manuals: add reference to the "do_install" task +- manuals: add reference to the "do_kernel_configcheck" task +- manuals: add reference to the "do_populate_sdk" task +- manuals: add references to "do_package_write_*" tasks +- manuals: add references to "do_populate_sysroot" task +- manuals: add references to the "do_build" task +- manuals: add references to the "do_bundle_initramfs" task +- manuals: add references to the "do_cleanall" task +- manuals: add references to the "do_deploy" task +- manuals: add references to the "do_devshell" task +- manuals: add references to the "do_fetch" task +- manuals: add references to the "do_image" task +- manuals: add references to the "do_kernel_configme" task +- manuals: add references to the "do_package" task +- manuals: add references to the "do_package_qa" task +- manuals: add references to the "do_patch" task +- manuals: add references to the "do_rootfs" task +- manuals: add references to the "do_unpack" task +- manuals: fix misc typos +- manuals: improve initramfs details +- manuals: updates for building on Windows (WSL 2) +- mesa: only apply patch to fix ALWAYS_INLINE for native +- mesa: update 22.2.0 -> 22.2.2 +- meson: make wrapper options sub-command specific +- meson: upgrade 0.63.2 -> 0.63.3 +- migration guides: 3.4: remove spurious space in example +- migration guides: add release notes for 4.0.4 +- migration-general: add section on using buildhistory +- migration-guides/release-notes-4.1.rst: add more known issues +- migration-guides/release-notes-4.1.rst: update Repositories / Downloads +- migration-guides: add known issues for 4.1 +- migration-guides: add reference to the "do_shared_workdir" task +- migration-guides: use contributor real name +- migration-guides: use contributor real name +- mirrors.bbclass: use shallow tarball for binutils-native +- mtools: upgrade 4.0.40 -> 4.0.41 +- numactl: upgrade 2.0.15 -> 2.0.16 +- oe/packagemanager/rpm: don't leak file objects +- openssl: export necessary env vars in SDK +- openssl: Fix SSL_CERT_FILE to match ca-certs location +- openssl: Upgrade 3.0.5 -> 3.0.7 +- opkg-utils: use a git clone, not a dynamic snapshot +- overlayfs: Allow not used mount points +- overview-manual: concepts.rst: add reference to "do_packagedata" task +- overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task +- overview-manual: concepts.rst: fix formating and add references +- own-mirrors: add crate +- pango: upgrade 1.50.9 -> 1.50.10 +- perf: Depend on native setuptools3 +- poky.conf: bump version for 4.1.1 +- poky.conf: remove Ubuntu 21.10 +- populate_sdk_base: ensure ptest-pkgs pulls in ptest-runner +- psplash: add psplash-default in rdepends +- qemu-native: Add :term:`PACKAGECONFIG` option for jack +- quilt: backport a patch to address grep 3.8 failures +- ref-manual/faq.rst: update references to products built with OE / Yocto Project +- ref-manual/variables.rst: clarify sentence +- ref-manual: add a note to ssh-server-dropbear feature +- ref-manual: add :term:`CVE_CHECK_SHOW_WARNINGS` +- ref-manual: add :term:`CVE_DB_UPDATE_INTERVAL` +- ref-manual: add :term:`DEV_PKG_DEPENDENCY` +- ref-manual: add :term:`DISABLE_STATIC` +- ref-manual: add :term:`FIT_PAD_ALG` +- ref-manual: add :term:`KERNEL_DEPLOY_DEPEND` +- ref-manual: add missing features +- ref-manual: add :term:`MOUNT_BASE` variable +- ref-manual: add overlayfs class variables +- ref-manual: add :term:`OVERLAYFS_ETC_EXPOSE_LOWER` +- ref-manual: add :term:`OVERLAYFS_QA_SKIP` +- ref-manual: add previous overlayfs-etc variables +- ref-manual: add pypi class +- ref-manual: add :term:`SDK_TOOLCHAIN_LANGS` +- ref-manual: add section for create-spdx class +- ref-manual: add serial-autologin-root to :term:`IMAGE_FEATURES` documentation +- ref-manual: add :term:`UBOOT_MKIMAGE_KERNEL_TYPE` +- ref-manual: add :term:`WATCHDOG_TIMEOUT` to variable glossary +- ref-manual: add :term:`WIRELESS_DAEMON` +- ref-manual: classes.rst: add links to all references to a class +- ref-manual: complementary package installation recommends +- ref-manual: correct default for :term:`BUILDHISTORY_COMMIT` +- ref-manual: document new github-releases class +- ref-manual: expand documentation on image-buildinfo class +- ref-manual: faq.rst: reorganize into subsections, contents at top +- ref-manual: remove reference to largefile in :term:`DISTRO_FEATURES` +- ref-manual: remove reference to testimage-auto class +- ref-manual: system-requirements: Ubuntu 22.04 now supported +- ref-manual: tasks.rst: add reference to the "do_image_complete" task +- ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task +- ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task +- ref-manual: tasks.rst: add reference to the "do_validate_branches" task +- ref-manual: tasks.rst: add references to the "do_cleansstate" task +- ref-manual: update buildpaths QA check documentation +- ref-manual: update pypi documentation for :term:`CVE_PRODUCT` default in 4.1 +- ref-manual: variables.rst: add reference to "do_populate_lic" task +- release-notes-4.1.rst remove bitbake-layers subcommand argument +- runqemu: Do not perturb script environment +- runqemu: Fix gl-es argument from causing other arguments to be ignored +- rust-target-config: match riscv target names with what rust expects +- rust: install rustfmt for riscv32 as well +- sanity: check for GNU tar specifically +- scripts/oe-check-sstate: cleanup +- scripts/oe-check-sstate: force build to run for all targets, specifically populate_sysroot +- sdk-manual: correct the bitbake target for a unified sysroot build +- shadow: update 4.12.1 -> 4.12.3 +- systemd: add systemd-creds and systemd-cryptenroll to systemd-extra-utils +- test-manual: fix typo in machine name +- tiff: fix a typo for :cve:`2022-2953`.patch +- u-boot: Add savedefconfig task +- u-boot: Remove duplicate inherit of cml1 +- uboot-sign: Fix using wrong KEY_REQ_ARGS +- Update documentation for classes split +- vim: upgrade to 9.0.0820 +- vulkan-samples: add lfs=0 to :term:`SRC_URI` to avoid git smudge errors in do_unpack +- wic: honor the :term:`SOURCE_DATE_EPOCH` in case of updated fstab +- wic: swap partitions are not added to fstab +- wpebackend-fdo: upgrade 1.12.1 -> 1.14.0 +- xserver-xorg: move some recommended dependencies in required +- zlib: do out-of-tree builds +- zlib: upgrade 1.2.12 -> 1.2.13 +- zlib: use .gz archive and set a PREMIRROR + + +Known Issues in Yocto-4.1.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + + +Contributors to Yocto-4.1.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Adrian Freihofer +- Alex Kiernan +- Alexander Kanavin +- Bartosz Golaszewski +- Bernhard Rosenkränzer +- Bruce Ashfield +- Chen Qi +- Christian Eggers +- Claus Stovgaard +- Ed Tanous +- Etienne Cordonnier +- Frank de Brabander +- Hitendra Prajapati +- Jan-Simon Moeller +- Jeremy Puhlman +- Johan Korsnes +- Jon Mason +- Jose Quaresma +- Joshua Watt +- Justin Bronder +- Kai Kang +- Keiya Nobuta +- Khem Raj +- Lee Chee Yang +- Liam Beguin +- Luca Boccassi +- Mark Asselstine +- Mark Hatle +- Markus Volk +- Martin Jansa +- Michael Opdenacker +- Ming Liu +- Mingli Yu +- Paul Eggleton +- Peter Kjellerstedt +- Qiu, Zheng +- Quentin Schulz +- Richard Purdie +- Robert Joslyn +- Ross Burton +- Sean Anderson +- Sergei Zhmylev +- Steve Sakoman +- Takayasu Ito +- Teoh Jay Shen +- Thomas Perrot +- Tim Orling +- Vincent Davis Jr +- Vyacheslav Yurkov +- Ciaran Courtney +- Wang Mingyu + + +Repositories / Downloads for Yocto-4.1.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`langdale </poky/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.1 </poky/log/?h=yocto-4.1.1>` +- Git Revision: :yocto_git:`d3cda9a3e0837eb2ac5482f5f2bd8e55e874feff </poky/commit/?id=d3cda9a3e0837eb2ac5482f5f2bd8e55e874feff>` +- Release Artefact: poky-d3cda9a3e0837eb2ac5482f5f2bd8e55e874feff +- sha: e92b694fbb74a26c7a875936dfeef4a13902f24b06127ee52f4d1c1e4b03ec24 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.1/poky-d3cda9a3e0837eb2ac5482f5f2bd8e55e874feff.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.1/poky-d3cda9a3e0837eb2ac5482f5f2bd8e55e874feff.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`langdale </openembedded-core/log/?h=langdale>` +- Tag: :oe_git:`yocto-4.1.1 </openembedded-core/log/?h=yocto-4.1.1>` +- Git Revision: :oe_git:`9237ffc4feee2dd6ff5bdd672072509ef9e82f6d </openembedded-core/commit/?id=9237ffc4feee2dd6ff5bdd672072509ef9e82f6d>` +- Release Artefact: oecore-9237ffc4feee2dd6ff5bdd672072509ef9e82f6d +- sha: d73198aef576f0fca0d746f9d805b1762c19c31786bc3f7d7326dfb2ed6fc1be +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.1/oecore-9237ffc4feee2dd6ff5bdd672072509ef9e82f6d.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.1/oecore-9237ffc4feee2dd6ff5bdd672072509ef9e82f6d.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`langdale </meta-mingw/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.1 </meta-mingw/log/?h=yocto-4.1.1>` +- Git Revision: :yocto_git:`b0067202db8573df3d23d199f82987cebe1bee2c </meta-mingw/commit/?id=b0067202db8573df3d23d199f82987cebe1bee2c>` +- Release Artefact: meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c +- sha: 704f2940322b81ce774e9cbd27c3cfa843111d497dc7b1eeaa39cd694d9a2366 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.1/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.1/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.2 </bitbake/log/?h=2.2>` +- Tag: :oe_git:`yocto-4.1.1 </bitbake/log/?h=yocto-4.1.1>` +- Git Revision: :oe_git:`138dd7883ee2c521900b29985b6d24a23d96563c </bitbake/commit/?id=138dd7883ee2c521900b29985b6d24a23d96563c>` +- Release Artefact: bitbake-138dd7883ee2c521900b29985b6d24a23d96563c +- sha: 5dc5aff4b4a801253c627cdaab6b1a0ceee2c531f1a6b166d85d1265a35d4be5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.1/bitbake-138dd7883ee2c521900b29985b6d24a23d96563c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.1/bitbake-138dd7883ee2c521900b29985b6d24a23d96563c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`langdale </yocto-docs/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.1 </yocto-docs/log/?h=yocto-4.1.1>` +- Git Revision: :yocto_git:`8e0841c3418caa227c66a60327db09dfbe72054a </yocto-docs/commit/?id=8e0841c3418caa227c66a60327db09dfbe72054a>` + + diff --git a/documentation/migration-guides/release-notes-4.1.2.rst b/documentation/migration-guides/release-notes-4.1.2.rst new file mode 100644 index 0000000000..ee5d4ccc51 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.1.2.rst @@ -0,0 +1,286 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.1.2 (Langdale) +---------------------------------------- + +Security Fixes in Yocto-4.1.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- sudo: Fix :cve:`2022-43995` +- binutils: Fix :cve:`2022-4285` +- cairo: update patch for :cve:`2019-6461` with upstream solution +- expat: Fix :cve:`2022-43680` +- ffmpeg: Fix :cve:`2022-3964` and :cve:`2022-3965` +- grub: Fix :cve:`2022-28736` +- libarchive: Fix :cve:`2022-36227` +- libpam: Fix :cve:`2022-28321` +- libpng: Fix :cve:`2019-6129` +- ruby: Fix :cve:`2022-28738` and :cve:`2022-28739` +- tiff: Fix :cve:`2022-3970` +- vim: Fix :cve:`2022-4141` + + +Fixes in Yocto-4.1.2 +~~~~~~~~~~~~~~~~~~~~ + +- Expand create-spdx class documentation +- Expand cve-check class documentation +- archiver: avoid using machine variable as it breaks multiconfig +- babeltrace: Upgrade to 1.5.11 +- backport SPDX documentation and vulnerability improvements +- baremetal-image: Avoid overriding qemu variables from IMAGE_CLASSES +- bc: extend to nativesdk +- bind: Upgrade to 9.18.9 +- bitbake.conf: Drop export of SOURCE_DATE_EPOCH_FALLBACK +- bitbake: gitsm: Fix regression in gitsm submodule path parsing +- bitbake: runqueue: Fix race issues around hash equivalence and sstate reuse +- bluez5: Point hciattach bcm43xx firmware search path to /lib/firmware +- build-appliance-image: Update to langdale head revision +- cargo_common.bbclass: Fix typos +- classes: make TOOLCHAIN more permissive for kernel +- cmake: Upgrade to 3.24.2 +- combo-layer: add sync-revs command +- combo-layer: dont use bb.utils.rename +- combo-layer: remove unused import +- common-tasks.rst: fix oeqa runtime test path +- create-spdx: default share_src for shared sources +- curl: Correct LICENSE from MIT-open-group to curl +- dbus: Add missing CVE product name +- devtool/upgrade: correctly handle recipes where S is a subdir of upstream tree +- dhcpcd: fix to work with systemd +- docs: kernel-dev: faq: update tip on how to not include kernel in image +- docs: migration-4.0: specify variable name change for kernel inclusion in image recipe +- expat: upgrade to 2.5.0 +- externalsrc: fix lookup for .gitmodules +- ffmpeg: Upgrade to 5.1.2 +- gcc-shared-source: Fix source date epoch handling +- gcc-source: Drop gengtype manipulation +- gcc-source: Ensure deploy_source_date_epoch sstate hash doesn't change +- gcc-source: Fix gengtypes race +- gdk-pixbuf: Upgrade to 2.42.10 +- get_module_deps3.py: Check attribute '__file__' +- glibc-tests: correctly pull in the actual tests when installing -ptest package +- gnomebase.bbclass: return the whole version for tarball directory if it is a number +- go-crosssdk: avoid host contamination by GOCACHE +- go: Update reproducibility patch to fix panic errors +- go: submit patch upstream +- go: Upgrade to 1.19.3 +- gptfdisk: remove warning message from target system +- groff: submit patches upstream +- gstreamer1.0: Upgrade to 1.20.5 +- help2man: Upgrade to 1.49.3 +- insane: add codeload.github.com to src-uri-bad checkz +- inetutils: Upgrade to 2.4 +- iso-codes: Upgrade to 4.12.0 +- kbd: Don't build tests +- kea: submit patch upstream +- kern-tools: integrate ZFS speedup patch +- kernel.bbclass: Include randstruct seed assets in STAGING_KERNEL_BUILDDIR +- kernel.bbclass: make KERNEL_DEBUG_TIMESTAMPS work at rebuild +- kernel.bbclass: remove empty module directories to prevent QA issues +- lib/buildstats: fix parsing of trees with reduced_proc_pressure directories +- libdrm: Remove libdrm-kms package +- libepoxy: convert to git +- libepoxy: remove upstreamed patch +- libepoxy: Upgrade to 1.5.10 +- libffi: submit patch upstream +- libffi: Upgrade to 3.4.4 +- libical: Upgrade to 3.0.16 +- libnewt: Upgrade to 0.52.23 +- libsdl2: Upgrade to 2.24.2 +- libpng: Upgrade to 1.6.39 +- libuv: fixup SRC_URI +- libxcrypt-compat: Upgrade to 4.4.33 +- libxcrypt: Upgrade to 4.4.30 +- libxml2: fix test data checksums +- linux-firmware: add new fw file to ${PN}-qcom-adreno-a530 +- linux-firmware: don't put the firmware into the sysroot +- linux-firmware: Upgrade to 20221109 +- linux-yocto/5.15: fix CONFIG_CRYPTO_CCM mismatch warnings +- linux-yocto/5.15: update genericx86* machines to v5.15.72 +- linux-yocto/5.15: Upgrade to v5.15.78 +- linux-yocto/5.19: cfg: intel and vesa updates +- linux-yocto/5.19: fix CONFIG_CRYPTO_CCM mismatch warnings +- linux-yocto/5.19: fix elfutils run-backtrace-native-core ptest failure +- linux-yocto/5.19: security.cfg: remove configs which have been dropped +- linux-yocto/5.19: update genericx86* machines to v5.19.14 +- linux-yocto/5.19: Upgrade to v5.19.17 +- lsof: add update-alternatives logic +- lttng-modules: Upgrade to 2.13.7 +- lttng-tools: submit determinism.patch upstream +- manuals: add 4.0.5 and 4.0.6 release notes +- mesa: do not rely on native llvm-config in target sysroot +- mesa: Upgrade to 22.2.3 +- meta-selftest/staticids: add render group for systemd +- mirrors.bbclass: update CPAN_MIRROR +- mobile-broadband-provider-info: Upgrade to 20221107 +- mpfr: Upgrade to 4.1.1 +- mtd-utils: Upgrade to 2.1.5 +- oeqa/concurrencytest: Add number of failures to summary output +- oeqa/runtime/dnf: rewrite test_dnf_installroot_usrmerge +- oeqa/selftest/externalsrc: add test for srctree_hash_files +- oeqa/selftest/lic_checksum: Cleanup changes to emptytest include +- openssh: remove RRECOMMENDS to rng-tools for sshd package +- opkg: Set correct info_dir and status_file in opkg.conf +- opkg: Upgrade to 0.6.1 +- ovmf: correct patches status +- package: Fix handling of minidebuginfo with newer binutils +- pango: Make it build with ptest disabled +- pango: replace a recipe fix with an upstream submitted patch +- pango: Upgrade to 1.50.11 +- poky.conf: bump version for 4.1.2 +- psplash: consider the situation of psplash not exist for systemd +- python3-mako: Upgrade to 1.2.3 +- qemu-helper-native: Correctly pass program name as argv[0] +- qemu-helper-native: Re-write bridge helper as C program +- qemu: Ensure libpng dependency is deterministic +- qemuboot.bbclass: make sure runqemu boots bundled initramfs kernel image +- resolvconf: make it work +- rm_work: adjust dependency to make do_rm_work_all depend on do_rm_work +- rm_work: exclude the SSTATETASKS from the rm_work tasks sinature +- ruby: merge .inc into .bb +- ruby: Upgrade to 3.1.3 +- rust: submit a rewritten version of crossbeam_atomic.patch upstream +- sanity: Drop data finalize call +- scripts: convert-overrides: Allow command-line customizations +- selftest: add a copy of previous mtd-utils version to meta-selftest +- socat: Upgrade to 1.7.4.4 +- sstate: Allow optimisation of do_deploy_archives task dependencies +- sstatesig: emit more helpful error message when not finding sstate manifest +- sstatesig: skip the rm_work task signature +- sudo: Upgrade to 1.9.12p1 +- sysstat: Upgrade to 12.6.1 +- systemd: Consider PACKAGECONFIG in RRECOMMENDS +- systemd: Make importd depend on glib-2.0 again +- systemd: add group render to udev package +- systemd: Upgrade to 251.8 +- tcl: correct patch status +- tzdata: Upgrade to 2022g +- vala: install vapigen-wrapper into /usr/bin/crosscripts and stage only that +- valgrind: skip the boost_thread test on arm +- vim: Upgrade to 9.0.0947 +- wic: make ext2/3/4 images reproducible +- xwayland: libxshmfence is needed when dri3 is enabled +- xwayland: Upgrade to 22.1.5 +- yocto-check-layer: Allow OE-Core to be tested + + +Known Issues in Yocto-4.1.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.1.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alejandro Hernandez Samaniego +- Alex Kiernan +- Alex Stewart +- Alexander Kanavin +- Alexey Smirnov +- Bruce Ashfield +- Carlos Alberto Lopez Perez +- Chen Qi +- Diego Sueiro +- Dmitry Baryshkov +- Enrico Jörns +- Harald Seiler +- Hitendra Prajapati +- Jagadeesh Krishnanjanappa +- Jose Quaresma +- Joshua Watt +- Kai Kang +- Konrad Weihmann +- Leon Anavi +- Marek Vasut +- Martin Jansa +- Mathieu Dubois-Briand +- Michael Opdenacker +- Mikko Rapeli +- Narpat Mali +- Nathan Rossi +- Niko Mauno +- Ola x Nilsson +- Ovidiu Panait +- Pavel Zhukov +- Peter Bergin +- Peter Kjellerstedt +- Peter Marko +- Polampalli, Archana +- Qiu, Zheng +- Quentin Schulz +- Randy MacLeod +- Ranjitsinh Rathod +- Ravula Adhitya Siddartha +- Richard Purdie +- Robert Andersson +- Ross Burton +- Ryan Eatmon +- Sakib Sajal +- Sandeep Gundlupet Raju +- Sergei Zhmylev +- Steve Sakoman +- Tim Orling +- Wang Mingyu +- Xiangyu Chen +- pgowda + +Repositories / Downloads for Yocto-4.1.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`langdale </poky/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.2 </poky/log/?h=yocto-4.1.2>` +- Git Revision: :yocto_git:`74c92e38c701e268406bb656b45ccd68471c217e </poky/commit/?id=74c92e38c701e268406bb656b45ccd68471c217e>` +- Release Artefact: poky-74c92e38c701e268406bb656b45ccd68471c217e +- sha: 06a2b304d0e928b62d81087797ae86115efe925c506bcb40c7d4747e14790bb0 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.2/poky-74c92e38c701e268406bb656b45ccd68471c217e.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.2/poky-74c92e38c701e268406bb656b45ccd68471c217e.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`langdale </openembedded-core/log/?h=langdale>` +- Tag: :oe_git:`yocto-4.1.2 </openembedded-core/log/?h=yocto-4.1.2>` +- Git Revision: :oe_git:`670f4f103b25897524d115c1f290ecae441fe4bd </openembedded-core/commit/?id=670f4f103b25897524d115c1f290ecae441fe4bd>` +- Release Artefact: oecore-670f4f103b25897524d115c1f290ecae441fe4bd +- sha: 09d77700e84efc738aef5713c5e86f19fa092f876d44b870789155cc1625ef04 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.2/oecore-670f4f103b25897524d115c1f290ecae441fe4bd.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.2/oecore-670f4f103b25897524d115c1f290ecae441fe4bd.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`langdale </meta-mingw/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.2 </meta-mingw/log/?h=yocto-4.1.2>` +- Git Revision: :yocto_git:`b0067202db8573df3d23d199f82987cebe1bee2c </meta-mingw/commit/?id=b0067202db8573df3d23d199f82987cebe1bee2c>` +- Release Artefact: meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c +- sha: 704f2940322b81ce774e9cbd27c3cfa843111d497dc7b1eeaa39cd694d9a2366 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.2/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.2/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.2 </bitbake/log/?h=2.2>` +- Tag: :oe_git:`yocto-4.1.2 </bitbake/log/?h=yocto-4.1.2>` +- Git Revision: :oe_git:`f0f166aee766b4bb1f8cf8b35dfc7d406c75e6a4 </bitbake/commit/?id=f0f166aee766b4bb1f8cf8b35dfc7d406c75e6a4>` +- Release Artefact: bitbake-f0f166aee766b4bb1f8cf8b35dfc7d406c75e6a4 +- sha: 7faf97eca78afd3994e4e126e5f5908617408c340c6eff8cd7047e0b961e2d10 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.2/bitbake-f0f166aee766b4bb1f8cf8b35dfc7d406c75e6a4.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.2/bitbake-f0f166aee766b4bb1f8cf8b35dfc7d406c75e6a4.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`langdale </yocto-docs/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.2 </yocto-docs/log/?h=yocto-4.1.2>` +- Git Revision: :yocto_git:`30f5f9ece260fd600f0c0fa32fc2f1fc61cf7d1b </yocto-docs/commit/?id=30f5f9ece260fd600f0c0fa32fc2f1fc61cf7d1b>` + diff --git a/documentation/migration-guides/release-notes-4.1.3.rst b/documentation/migration-guides/release-notes-4.1.3.rst new file mode 100644 index 0000000000..d8474cda68 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.1.3.rst @@ -0,0 +1,317 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.1.3 (Langdale) +---------------------------------------- + +Security Fixes in Yocto-4.1.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- apr-util: Fix :cve:`2022-25147` +- apr: Fix :cve:`2022-24963` and :cve:`2022-28331` +- bind: Fix :cve:`2022-3094`, :cve:`2022-3736` and :cve:`2022-3924` +- curl: Fix :cve:`2022-43551` and :cve:`2022-43552` +- dbus: Fix :cve:`2022-42010`, :cve:`2022-42011` and :cve:`2022-42012` +- git: Fix :cve:`2022-23521`, :cve:`2022-39253`, :cve:`2022-39260` and :cve:`2022-41903` +- git: Ignore :cve:`2022-41953` +- go: Fix :cve:`2022-41717` and :cve:`2022-41720` +- grub2: Fix :cve:`2022-2601` and :cve:`2022-3775` +- less: Fix :cve:`2022-46663` +- libarchive: Fix :cve:`2022-36227` +- libksba: Fix :cve:`2022-47629` +- openssl: Fix :cve:`2022-3996` +- pkgconf: Fix :cve:`2023-24056` +- ppp: Fix :cve:`2022-4603` +- sudo: Fix :cve:`2023-22809` +- tar: Fix :cve:`2022-48303` +- vim: Fix :cve:`2023-0049`, :cve:`2023-0051`, :cve:`2023-0054`, :cve:`2023-0288`, :cve:`2023-0433` and :cve:`2023-0512` +- xserver-xorg: Fix :cve_mitre:`2023-0494` +- xwayland: Fix :cve_mitre:`2023-0494` + + +Fixes in Yocto-4.1.3 +~~~~~~~~~~~~~~~~~~~~ + +- apr-util: Upgrade to 1.6.3 +- apr: Upgrade to 1.7.2 +- apt: fix do_package_qa failure +- at: Change when files are copied +- base.bbclass: Fix way to check ccache path +- bblayers/makesetup: skip git repos that are submodules +- bblayers/setupwriters/oe-setup-layers: create dir if not exists +- bind: Upgrade to 9.18.11 +- bitbake-layers: fix a typo +- bitbake: bb/utils: include SSL certificate paths in export_proxies +- bitbake: fetch2/git: Clarify the meaning of namespace +- bitbake: fetch2/git: Prevent git fetcher from fetching gitlab repository metadata +- bitbake: process: log odd unlink events with bitbake.sock +- bitbake: server/process: Add bitbake.sock race handling +- bitbake: siggen: Fix inefficient string concatenation +- bootchart2: Fix usrmerge support +- bsp-guide: fix broken git URLs and missing word +- build-appliance-image: Update to langdale head revision +- buildtools-tarball: set pkg-config search path +- busybox: Fix depmod patch +- busybox: always start do_compile with orig config files +- busybox: rm temporary files if do_compile was interrupted +- cairo: fix CVE patches assigned wrong CVE number +- classes/fs-uuid: Fix command output decoding issue +- classes/populate_sdk_base: Append cleandirs +- classes: image: Set empty weak default IMAGE_LINGUAS +- cml1: remove redundant addtask +- core-image.bbclass: Fix missing leading whitespace with ':append' +- createrepo-c: Include missing rpm/rpmstring.h +- curl: don't enable debug builds +- curl: fix dependencies when building with ldap/ldaps +- cve-check: write the cve manifest to IMGDEPLOYDIR +- cve-update-db-native: avoid incomplete updates +- cve-update-db-native: show IP on failure +- dbus: Upgrade to 1.14.6 +- dev-manual: common-tasks.rst: add link to FOSDEM 2023 video +- dev-manual: fix old override syntax +- devshell: Do not add scripts/git-intercept to PATH +- devtool: fix devtool finish when gitmodules file is empty +- devtool: process local files only for the main branch +- dhcpcd: backport two patches to fix runtime error +- dhcpcd: fix dhcpcd start failure on qemuppc64 +- diffutils: Upgrade to 3.9 +- ffmpeg: fix configure failure on noexec /tmp host +- gdk-pixbuf: do not use tools from gdk-pixbuf-native when building tests +- git: Upgrade to 2.37.6 +- glslang: branch rename master -> main +- go: Upgrade to 1.19.4 +- gstreamer1.0 : Revert "disable flaky gstbin:test_watch_for_state_change test" and Fix race conditions in gstbin tests with upstream solution +- harfbuzz: remove bindir only if it exists +- httpserver: add error handler that write to the logger +- image.bbclass: print all QA functions exceptions +- kernel-fitimage: Adjust order of dtb/dtbo files +- kernel-fitimage: Allow user to select dtb when multiple dtb exists +- kernel-yocto: fix kernel-meta data detection +- kernel/linux-kernel-base: Fix kernel build artefact determinism issues +- lib/buildstats: handle tasks that never finished +- lib/oe/reproducible: Use git log without gpg signature +- libarchive: Upgrade to 3.6.2 +- libc-locale: Fix on target locale generation +- libgit2: Upgrade to 1.5.1 +- libjpeg-turbo: Upgrade to 2.1.5.1 +- libksba: Upgrade to 1.6.3 +- libpng: Enable NEON for aarch64 to enensure consistency with arm32. +- librsvg: Only enable the Vala bindings if GObject Introspection is enabled +- librsvg: enable vapi build +- libseccomp: fix for the ptest result format +- libseccomp: fix typo in DESCRIPTION +- libssh2: Clean up ptest patch/coverage +- libtirpc: Check if file exists before operating on it +- libusb1: Link with latomic only if compiler has no atomic builtins +- libusb1: Strip trailing whitespaces +- linux-firmware: add yamato fw files to qcom-adreno-a2xx package +- linux-firmware: properly set license for all Qualcomm firmware +- linux-firmware: Upgrade to 20230210 +- linux-yocto/5.15: fix perf build with clang +- linux-yocto/5.15: libbpf: Fix build warning on ref_ctr_off +- linux-yocto/5.15: ltp and squashfs fixes +- linux-yocto/5.15: powerpc: Fix reschedule bug in KUAP-unlocked user copy +- linux-yocto/5.15: Upgrade to v5.15.91 +- linux-yocto/5.19: fix perf build with clang +- linux-yocto/5.19: powerpc: Fix reschedule bug in KUAP-unlocked user copy +- lsof: fix old override syntax +- lttng-modules: Fix for 5.10.163 kernel version +- lttng-modules: fix for kernel 6.2+ +- lttng-modules: Upgrade to 2.13.8 +- lttng-tools: Upgrade to 2.13.9 +- make-mod-scripts: Ensure kernel build output is deterministic +- manuals: update patchwork instance URL +- mesa-gl: gallium is required when enabling x11 +- meta: remove True option to getVar and getVarFlag calls (again) +- migration-guides: add release-notes for 4.0.7 +- native: Drop special variable handling +- numactl: skip test case when target platform doesn't have 2 CPU node +- oeqa context.py: fix --target-ip comment to include ssh port number +- oeqa dump.py: add error counter and stop after 5 failures +- oeqa qemurunner.py: add timeout to QMP calls +- oeqa qemurunner.py: try to avoid reading one character at a time +- oeqa qemurunner: read more data at a time from serial +- oeqa ssh.py: add connection keep alive options to ssh client +- oeqa ssh.py: fix hangs in run() +- oeqa ssh.py: move output prints to new line +- oeqa/qemurunner: do not use Popen.poll() when terminating runqemu with a signal +- oeqa/rpm.py: Increase timeout and add debug output +- oeqa/selftest/debuginfod: improve testcase +- oeqa/selftest/locales: Add selftest for locale generation/presence +- oeqa/selftest/resulttooltests: fix minor typo +- openssl: Upgrade to 3.0.8 +- opkg: ensure opkg uses private gpg.conf when applying keys. +- pango: Upgrade to 1.50.12 +- perf: Enable debug/source packaging +- pkgconf: Upgrade to 1.9.4 +- poky.conf: Update SANITY_TESTED_DISTROS to match autobuilder +- poky.conf: bump version for 4.1.3 +- populate_sdk_ext.bbclass: Fix missing leading whitespace with ':append' +- profile-manual: update WireShark hyperlinks +- ptest-packagelists.inc: Fix missing leading whitespace with ':append' +- python3-pytest: depend on python3-tomli instead of python3-toml +- quilt: fix intermittent failure in faildiff.test +- quilt: use upstreamed faildiff.test fix +- recipe_sanity: fix old override syntax +- ref-manual: Fix invalid feature name +- ref-manual: update DEV_PKG_DEPENDENCY in variables +- ref-manual: variables.rst: fix broken hyperlink +- rm_work.bbclass: use HOSTTOOLS 'rm' binary exclusively +- runqemu: kill qemu if it hangs +- rust: Do not use default compiler flags defined in CC crate +- scons.bbclass: Make MAXLINELENGTH overridable +- scons: Pass MAXLINELENGTH to scons invocation +- sdkext/cases/devtool: pass a logger to HTTPService +- selftest/virgl: use pkg-config from the host +- spirv-headers/spirv-tools: set correct branch name +- sstate.bbclass: Fetch non-existing local .sig files if needed +- sstatesig: Improve output hash calculation +- sudo: Upgrade to 1.9.12p2 +- system-requirements.rst: Add Fedora 36, AlmaLinux 8.7 & 9.1, and OpenSUSE 15.4 to list of supported distros +- testimage: Fix error message to reflect new syntax +- tiff: Add packageconfig knob for webp +- toolchain-scripts: compatibility with unbound variable protection +- uninative: Upgrade to 3.8.1 to include libgcc +- update-alternatives: fix typos +- vim: Upgrade to 9.0.1293 +- vulkan-samples: branch rename master -> main +- wic: Fix usage of fstype=none in wic +- wireless-regdb: Upgrade to 2023.02.13 +- xserver-xorg: Upgrade to 21.1.7 +- xwayland: Upgrade to 22.1.8 + + +Known Issues in Yocto-4.1.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.1.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Adrian Freihofer +- Alejandro Hernandez Samaniego +- Alex Kiernan +- Alexander Kanavin +- Alexis Lothoré +- Anton Antonov +- Antonin Godard +- Armin Kuster +- Arnout Vandecappelle +- Benoît Mauduit +- Bruce Ashfield +- Carlos Alberto Lopez Perez +- Changqing Li +- Charlie Johnston +- Chee Yang Lee +- Chen Qi +- Dmitry Baryshkov +- Enguerrand de Ribaucourt +- Etienne Cordonnier +- Fawzi KHABER +- Federico Pellegrin +- Frank de Brabander +- Harald Seiler +- He Zhe +- Jan Kircher +- Jermain Horsman +- Jose Quaresma +- Joshua Watt +- Kai Kang +- Khem Raj +- Lei Maohui +- Louis Rannou +- Luis +- Marek Vasut +- Markus Volk +- Marta Rybczynska +- Martin Jansa +- Mateusz Marciniec +- Mauro Queiros +- Michael Halstead +- Michael Opdenacker +- Mikko Rapeli +- Mingli Yu +- Narpat Mali +- Niko Mauno +- Pavel Zhukov +- Pawel Zalewski +- Peter Kjellerstedt +- Petr Kubizňák +- Quentin Schulz +- Randy MacLeod +- Richard Purdie +- Robert Joslyn +- Rodolfo Quesada Zumbado +- Ross Burton +- Sakib Sajal +- Sandeep Gundlupet Raju +- Saul Wold +- Siddharth Doshi +- Steve Sakoman +- Thomas Roos +- Tobias Hagelborn +- Ulrich Ölmann +- Vivek Kumbhar +- Wang Mingyu +- Xiangyu Chen + + +Repositories / Downloads for Yocto-4.1.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`langdale </poky/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.3 </poky/log/?h=yocto-4.1.3>` +- Git Revision: :yocto_git:`91d0157d6daf4ea61d6b4e090c0b682d3f3ca60f </poky/commit/?id=91d0157d6daf4ea61d6b4e090c0b682d3f3ca60f>` +- Release Artefact: poky-91d0157d6daf4ea61d6b4e090c0b682d3f3ca60f +- sha: 94e4615eba651fe705436b29b854458be050cc39db936295f9d5eb7e85d3eff1 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.3/poky-91d0157d6daf4ea61d6b4e090c0b682d3f3ca60f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.3/poky-91d0157d6daf4ea61d6b4e090c0b682d3f3ca60f.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`langdale </openembedded-core/log/?h=langdale>` +- Tag: :oe_git:`yocto-4.1.3 </openembedded-core/log/?h=yocto-4.1.3>` +- Git Revision: :oe_git:`b995ea45773211bd7bdd60eabcc9bbffda6beb5c </openembedded-core/commit/?id=b995ea45773211bd7bdd60eabcc9bbffda6beb5c>` +- Release Artefact: oecore-b995ea45773211bd7bdd60eabcc9bbffda6beb5c +- sha: 952e19361f205ee91b74e5caaa835d58fa6dd0d92ddaed50d4cd3f3fa56fab63 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.3/oecore-b995ea45773211bd7bdd60eabcc9bbffda6beb5c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.3/oecore-b995ea45773211bd7bdd60eabcc9bbffda6beb5c.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`langdale </meta-mingw/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.3 </meta-mingw/log/?h=yocto-4.1.3>` +- Git Revision: :yocto_git:`b0067202db8573df3d23d199f82987cebe1bee2c </meta-mingw/commit/?id=b0067202db8573df3d23d199f82987cebe1bee2c>` +- Release Artefact: meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c +- sha: 704f2940322b81ce774e9cbd27c3cfa843111d497dc7b1eeaa39cd694d9a2366 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.3/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.3/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.2 </bitbake/log/?h=2.2>` +- Tag: :oe_git:`yocto-4.1.3 </bitbake/log/?h=yocto-4.1.3>` +- Git Revision: :oe_git:`592ee222a1c6da42925fb56801f226884b6724ec </bitbake/commit/?id=592ee222a1c6da42925fb56801f226884b6724ec>` +- Release Artefact: bitbake-592ee222a1c6da42925fb56801f226884b6724ec +- sha: 79c32f2ca66596132e32a45654ce0e9dd42b6b39186eff3540a9d6b499fe952c +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.3/bitbake-592ee222a1c6da42925fb56801f226884b6724ec.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.3/bitbake-592ee222a1c6da42925fb56801f226884b6724ec.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`langdale </yocto-docs/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.3 </yocto-docs/log/?h=yocto-4.1.3>` +- Git Revision: :yocto_git:`3de2ad1f8ff87aeec30088779267880306a0f31a </yocto-docs/commit/?id=3de2ad1f8ff87aeec30088779267880306a0f31a>` + diff --git a/documentation/migration-guides/release-notes-4.1.4.rst b/documentation/migration-guides/release-notes-4.1.4.rst new file mode 100644 index 0000000000..de469f4bee --- /dev/null +++ b/documentation/migration-guides/release-notes-4.1.4.rst @@ -0,0 +1,254 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.1.4 (Langdale) +---------------------------------------- + +Security Fixes in Yocto-4.1.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- cve-extra-exclusions/linux-yocto: Ignore :cve:`2020-27784`, :cve:`2021-3669`, :cve:`2021-3759`, :cve:`2021-4218`, :cve:`2022-0480`, :cve:`2022-1184`, :cve:`2022-1462`, :cve:`2022-2308`, :cve:`2022-2327`, :cve:`2022-26365`, :cve:`2022-2663`, :cve:`2022-2785`, :cve:`2022-3176`, :cve:`2022-33740`, :cve:`2022-33741`, :cve:`2022-33742`, :cve:`2022-3526`, :cve:`2022-3563`, :cve:`2022-3621`, :cve:`2022-3623`, :cve:`2022-3624`, :cve:`2022-3625`, :cve:`2022-3629`, :cve:`2022-3630`, :cve:`2022-3633`, :cve:`2022-3635`, :cve:`2022-3636`, :cve:`2022-3637`, :cve:`2022-3646` and :cve:`2022-3649` +- cve-extra-exclusions/linux-yocto 5.15: Ignore :cve:`2022-3435`, :cve:`2022-3534`, :cve:`2022-3564`, :cve:`2022-3564`, :cve:`2022-3619`, :cve:`2022-3640`, :cve:`2022-42895`, :cve:`2022-42896`, :cve:`2022-4382`, :cve:`2023-0266` and :cve:`2023-0394` +- epiphany: Fix :cve:`2023-26081` +- git: Ignore :cve:`2023-22743` +- go: Fix :cve:`2022-41722`, :cve:`2022-41723`, :cve:`2022-41724`, :cve:`2022-41725` and :cve:`2023-24532` +- harfbuzz: Fix :cve:`2023-25193` +- libmicrohttpd: Fix :cve:`2023-27371` +- libxml2: Fix :cve:`2022-40303` and :cve:`2022-40304` +- openssl: Fix :cve:`2023-0464`, :cve:`2023-0465` and :cve:`2023-0466` +- python3-setuptools: Fix :cve:`2022-40897` +- qemu: Fix :cve:`2022-4144` +- screen: Fix :cve:`2023-24626` +- shadow: Ignore :cve:`2016-15024` +- tiff: Fix :cve:`2022-48281`, :cve:`2023-0795`, :cve:`2023-0796`, :cve:`2023-0797`, :cve:`2023-0798`, :cve:`2023-0799`, :cve:`2023-0800`, :cve:`2023-0801`, :cve:`2023-0802`, :cve:`2023-0803` and :cve:`2023-0804` +- vim: Fix :cve:`2023-1127`, :cve:`2023-1170`, :cve:`2023-1175`, :cve:`2023-1264` and :cve:`2023-1355` +- xdg-utils: Fix :cve:`2022-4055` +- xserver-xorg: Fix for :cve:`2023-1393` + + +Fixes in Yocto-4.1.4 +~~~~~~~~~~~~~~~~~~~~ + +- apt: re-enable version check +- base-files: Drop localhost.localdomain from hosts file +- binutils: Fix nativesdk ld.so search +- bitbake: bin/utils: Ensure locale en_US.UTF-8 is available on the system +- bitbake: cookerdata: Drop dubious exception handling code +- bitbake: cookerdata: Improve early exception handling +- bitbake: cookerdata: Remove incorrect SystemExit usage +- bitbake: fetch/git: Fix local clone url to make it work with repo +- bitbake: toaster: Add refreshed oe-core and poky fixtures +- bitbake: toaster: fixtures/README: django 1.8 -> 3.2 +- bitbake: toaster: fixtures/gen_fixtures.py: update branches +- bitbake: utils: Allow to_boolean to support int values +- bmap-tools: switch to main branch +- build-appliance-image: Update to langdale head revision +- buildtools-tarball: Handle spaces within user $PATH +- busybox: move hwclock init earlier in startup +- cargo.bbclass: use offline mode for building +- cpio: Fix wrong CRC with ASCII CRC for large files +- cracklib: update github branch to 'main' +- cups: add/fix web interface packaging +- cups: check :term:`PACKAGECONFIG` for pam feature +- cups: use BUILDROOT instead of DESTDIR +- cve-check: Fix false negative version issue +- devtool/upgrade: do not delete the workspace/recipes directory +- dhcpcd: Fix install conflict when enable multilib. +- ffmpeg: fix build failure when vulkan is enabled +- filemap.py: enforce maximum of 4kb block size +- gcc-shared-source: do not use ${S}/.. in deploy_source_date_epoch +- glibc: Add missing binutils dependency +- go: upgrade to 1.19.7 +- image_types: fix multiubi var init +- image_types: fix vname var init in multiubi_mkfs() function +- iso-codes: upgrade to 4.13.0 +- kernel-devsrc: fix mismatched compiler warning +- lib/oe/gpg_sign.py: Avoid race when creating .sig files in detach_sign +- lib/resulttool: fix typo breaking resulttool log --ptest +- libcomps: Fix callback function prototype for PyCOMPS_hash +- libdnf: upgrade to 0.70.0 +- libgit2: update license information +- libmicrohttpd: upgrade to 0.9.76 +- linux-yocto-rt/5.15: upgrade to -rt59 +- linux-yocto/5.15: upgrade to v5.15.108 +- linux: inherit pkgconfig in kernel.bbclass +- lttng-modules: upgrade to v2.13.9 +- lua: Fix install conflict when enable multilib. +- mdadm: Fix raid0, 06wrmostly and 02lineargrow tests +- mesa-demos: packageconfig weston should have a dependency on wayland-protocols +- meson: Fix wrapper handling of implicit setup command +- meson: remove obsolete RPATH stripping patch +- migration-guides: update release notes +- oeqa ping.py: avoid busylooping failing ping command +- oeqa ping.py: fail test if target IP address has not been set +- oeqa rtc.py: skip if read-only-rootfs +- oeqa/runtime: clean up deprecated backslash expansion +- oeqa/sdk: Improve Meson test +- oeqa/selftest/cases/package.py: adding unittest for package rename conflicts +- oeqa/selftest/cases/runqemu: update imports +- oeqa/selftest/prservice: Improve debug output for failure +- oeqa/selftest/reproducible: Split different packages from missing packages output +- oeqa/selftest: OESelftestTestContext: convert relative to full path when newbuilddir is provided +- oeqa/targetcontrol: do not set dump_host_cmds redundantly +- oeqa/targetcontrol: fix misspelled RuntimeError +- oeqa/targetcontrol: remove unused imports +- oeqa/utils/commands: fix usage of undefined EPIPE +- oeqa/utils/commands: remove unused imports +- oeqa/utils/qemurunner: replace hard-coded user 'root' in debug output +- oeqs/selftest: OESelftestTestContext: replace the os.environ after subprocess.check_output +- package.bbclass: check packages name conflict in do_package +- pango: upgrade to 1.50.13 +- piglit: Fix build time dependency +- poky.conf: bump version for 4.1.4 +- populate_sdk_base: add zip options +- populate_sdk_ext: Handle spaces within user $PATH +- pybootchart: Fix extents handling to account for cpu/io/mem pressure changes +- pybootchartui: Fix python syntax issue +- report-error: catch Nothing :term:`PROVIDES` error +- rpm: Fix hdr_hash function prototype +- run-postinsts: Set dependency for ldconfig to avoid boot issues +- runqemu: respect :term:`IMAGE_LINK_NAME` +- runqemu: Revert "workaround for APIC hang on pre 4.15 kernels on qemux86q" +- scripts/lib/buildstats: handle top-level build_stats not being complete +- selftest/recipetool: Stop test corrupting tinfoil class +- selftest/runtime_test/virgl: Disable for all Rocky Linux +- selftest: devtool: set :term:`BB_HASHSERVE_UPSTREAM` when setting :term:`SSTATE_MIRRORS` +- selftest: runqemu: better check for ROOTFS: in the log +- selftest: runqemu: use better error message when asserts fail +- shadow: Fix can not print full login timeout message +- staging/multilib: Fix manifest corruption +- staging: Separate out different multiconfig manifests +- sudo: upgrade to 1.9.13p3 +- systemd.bbclass: Add /usr/lib/systemd to searchpaths as well +- systemd: add group sgx to udev package +- systemd: fix wrong nobody-group assignment +- timezone: use 'tz' subdir instead of ${WORKDIR} directly +- toolchain-scripts: Handle spaces within user $PATH +- tzcode-native: fix build with gcc-13 on host +- tzdata: upgrade to 2023c +- tzdata: use separate :term:`B` instead of :term:`WORKDIR` for zic output +- u-boot: Map arm64 into map for u-boot dts installation +- uninative: Upgrade to 3.9 to include glibc 2.37 +- vala: Fix install conflict when enable multilib. +- vim: add missing pkgconfig inherit +- vim: set modified-by to the recipe :term:`MAINTAINER` +- vim: upgrade to 9.0.1429 +- xcb-proto: Fix install conflict when enable multilib. + + +Known Issues in Yocto-4.1.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.1.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Andrew Geissler +- Arturo Buzarra +- Bhabu Bindu +- Bruce Ashfield +- Carlos Alberto Lopez Perez +- Chee Yang Lee +- Chris Elledge +- Christoph Lauer +- Dmitry Baryshkov +- Enrico Jörns +- Fawzi KHABER +- Frank de Brabander +- Frederic Martinsons +- Geoffrey GIRY +- Hitendra Prajapati +- Jose Quaresma +- Kenfe-Mickael Laventure +- Khem Raj +- Marek Vasut +- Martin Jansa +- Michael Halstead +- Michael Opdenacker +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Narpat Mali +- Pavel Zhukov +- Peter Marko +- Piotr Łobacz +- Randy MacLeod +- Richard Purdie +- Robert Yang +- Romuald JEANNE +- Romuald Jeanne +- Ross Burton +- Siddharth +- Siddharth Doshi +- Soumya +- Steve Sakoman +- Sudip Mukherjee +- Tim Orling +- Tobias Hagelborn +- Tom Hochstein +- Trevor Woerner +- Wang Mingyu +- Xiangyu Chen +- Zoltan Boszormenyi + + +Repositories / Downloads for Yocto-4.1.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`langdale </poky/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.4 </poky/log/?h=yocto-4.1.4>` +- Git Revision: :yocto_git:`3e95f268ce04b49ba6731fd4bbc53b1693c21963 </poky/commit/?id=3e95f268ce04b49ba6731fd4bbc53b1693c21963>` +- Release Artefact: poky-3e95f268ce04b49ba6731fd4bbc53b1693c21963 +- sha: 54798c4b519f5e11f409e1fd074bea1bc0a1b80672aa60dddbac772c8e4d838b +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.4/poky-3e95f268ce04b49ba6731fd4bbc53b1693c21963.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.4/poky-3e95f268ce04b49ba6731fd4bbc53b1693c21963.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`langdale </openembedded-core/log/?h=langdale>` +- Tag: :oe_git:`yocto-4.1.4 </openembedded-core/log/?h=yocto-4.1.4>` +- Git Revision: :oe_git:`78211cda40eb018a3aa535c75b61e87337236628 </openembedded-core/commit/?id=78211cda40eb018a3aa535c75b61e87337236628>` +- Release Artefact: oecore-78211cda40eb018a3aa535c75b61e87337236628 +- sha: 1303d836bae54c438c64d6b9f068eb91c32be4cc1779e89d0f2d915a55d59b15 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.4/oecore-78211cda40eb018a3aa535c75b61e87337236628.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.4/oecore-78211cda40eb018a3aa535c75b61e87337236628.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`langdale </meta-mingw/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.4 </meta-mingw/log/?h=yocto-4.1.4>` +- Git Revision: :yocto_git:`b0067202db8573df3d23d199f82987cebe1bee2c </meta-mingw/commit/?id=b0067202db8573df3d23d199f82987cebe1bee2c>` +- Release Artefact: meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c +- sha: 704f2940322b81ce774e9cbd27c3cfa843111d497dc7b1eeaa39cd694d9a2366 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.4/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.4/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.2 </bitbake/log/?h=2.2>` +- Tag: :oe_git:`yocto-4.1.4 </bitbake/log/?h=yocto-4.1.4>` +- Git Revision: :oe_git:`5b105e76dd7de3b9a25b17b397f2c12c80048894 </bitbake/commit/?id=5b105e76dd7de3b9a25b17b397f2c12c80048894>` +- Release Artefact: bitbake-5b105e76dd7de3b9a25b17b397f2c12c80048894 +- sha: 2cd6448138816f5a906f9927c6b6fdc5cf24981ef32b6402312f52ca490edb4f +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1.4/bitbake-5b105e76dd7de3b9a25b17b397f2c12c80048894.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1.4/bitbake-5b105e76dd7de3b9a25b17b397f2c12c80048894.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`langdale </yocto-docs/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1.4 </yocto-docs/log/?h=yocto-4.1.4>` +- Git Revision: :yocto_git:`da685fc5e69d49728e3ffd6c4d623e7e1745059d </yocto-docs/commit/?id=da685fc5e69d49728e3ffd6c4d623e7e1745059d>` + diff --git a/documentation/migration-guides/release-notes-4.1.rst b/documentation/migration-guides/release-notes-4.1.rst new file mode 100644 index 0000000000..a0d5196128 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.1.rst @@ -0,0 +1,761 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 4.1 (langdale) +--------------------------------- + + +New Features / Enhancements in 4.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 5.19, glibc 2.36 and ~260 other recipe upgrades + +- ``make`` 4.0 is now the minimum make version required on the build host. + For host distros that do not provide it, this is included as part of the + :term:`buildtools` tarball, and additionally a new :term:`buildtools-make` tarball + has been introduced to provide this in particular for host distros with + a broken make 4.x version. For more details see + :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`. + +- New layer setup tooling: + + - New ``scripts/oe-setup-layers`` standalone script to restore the layer + configuration from a json file + - New ``bitbake-layers create-layers-setup`` command to save the + layer configuration to a json file + - New ``bitbake-layers save-build-conf`` command to save the active build + configuration as a template into a layer + +- Rust-related enhancements: + + - Support for building rust for the target + - Significant SDK toolchain build optimisation + - Support for building native components in the SDK + - Support ``crate://`` fetcher with :ref:`ref-classes-externalsrc` + +- New core recipes: + + - ``buildtools-make-tarball`` + - ``icon-naming-utils`` (previously removed) + - ``musl-locales`` + - ``python3-editables`` (originally in meta-python) + - ``python3-hatch-vcs`` + - ``python3-hatchling`` (originally in meta-oe) + - ``python3-lxml`` (originally in meta-python) + - ``python3-pathspec`` (originally in meta-python) + - ``python3-picobuild`` + - ``sato-icon-theme`` (previously removed) + +- CVE checking enhancements: + + - New :term:`CVE_DB_UPDATE_INTERVAL` variable to allow specifying the CVE database minimum update interval (and default to once per day) + - Added JSON format to summary output + - Added support for Ignored CVEs + - Enable recursive CVE checking also for ``do_populate_sdk`` + - New :term:`CVE_CHECK_SHOW_WARNINGS` variable to disable unpatched CVE warning messages + - The :ref:`ref-classes-pypi` class now defaults :term:`CVE_PRODUCT` from :term:`PYPI_PACKAGE` + - Added current kernel CVEs to ignore list since we stay as close to the kernel stable releases as we can + - Optimisations to avoid dependencies on fetching + +- Complementary package installation (as used in SDKs and images) no longer installs recommended packages, in order to avoid conflicts +- Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable + +- Support for CPU, I/O and memory pressure regulation in BitBake +- Pressure data gathering in :ref:`ref-classes-buildstats` and rendering in ``pybootchartgui`` + +- New Picobuild system for lightweight Python PEP-517 build support in the :ref:`ref-classes-python_pep517` class + +- Many classes are now split into global and recipe contexts for better + validation. For more information, see + :ref:`Classes now split by usage context <migration-4.1-classes-split>`. + +- Architecture-specific enhancements: + + - arch-armv8-4a.inc: add tune include for armv8.4a + - tune-neoversen2: support tune-neoversen2 base on armv9a + - riscv: Add tunes for rv64 without compressed instructions + - gnu-efi: enable for riscv64 + - shadow-securetty: allow ttyS4 for amd-snowyowl-64 + +- Kernel-related enhancements: + + - linux-yocto/5.15: cfg/xen: Move x86 configs to separate file + - linux-yocto/5.15: Enabled MDIO bus config + - linux-yocto: Enable mdio for qemu + - linux-yocto/5.15: base: enable kernel crypto userspace API + - kern-tools: allow 'y' or 'm' to avoid config audit warnings + - kernel-yocto.bbclass: say what :term:`SRC_URI` entry is being dropped + - kernel.bbclass: Do not overwrite recipe's custom postinst + - kmod: Enable xz support by default + - Run depmod(wrapper) against each compiled kernel when multiple kernels are enabled + - linux-yocto-tiny: enable qemuarmv5/qemuarm64 + +- wic Image Creator enhancements: + + - Added dependencies to support erofs + - Added ``fspassno`` parameter to partition to allow specifying the value of the last column (``fs_passno``) in ``/etc/fstab``. + - bootimg-efi: added support for loading devicetree files + - Added ``none`` fstype for custom image (for use in conjunction with ``rawcopy``) + +- SDK-related enhancements: + + - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` + - :ref:`ref-classes-image-buildinfo` class now also writes build information to SDKs + - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK + - rust-llvm: enabled :ref:`ref-classes-nativesdk` variant + - python3-pluggy: enabled for :ref:`ref-classes-native` / :ref:`ref-classes-nativesdk` + +- QEMU/runqemu enhancements: + + - qemux86-64: Allow higher tunes + - runqemu: display host uptime when starting + - runqemu: add ``QB_KERNEL_CMDLINE`` that can be set to "none" to avoid overriding kernel command line specified in dtb + +- Image-related enhancements: + + - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` + - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm + - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel + - :ref:`ref-classes-image_types`: isolate the write of UBI + configuration to a ``write_ubi_config`` function that can be easily overridden + +- openssh: add support for config snippet includes to ssh and sshd +- :ref:`ref-classes-create-spdx`: Add :term:`SPDX_PRETTY` option +- wpa-supplicant: build static library if not disabled via :term:`DISABLE_STATIC` +- wpa-supplicant: package dynamic modules +- openssl: extract legacy provider module to a separate package +- linux-firmware: split out ath3k firmware +- linux-firmware: add support for building snapshots +- eudev: create static-nodes in init script +- udev-extraconf: new :term:`MOUNT_BASE` variable allows configuring automount base directory +- udev-extraconf/mount.sh: use partition labels in mountpoint paths +- systemd: Set RebootWatchdogSec to 60s by default +- systemd: systemd-systemctl: Support instance conf files during enable +- weston.init: enable ``xwayland`` in weston.ini if ``x11`` is in :term:`DISTRO_FEATURES` +- New ``npm_registry`` Python module to enable caching with nodejs 16+ +- :ref:`ref-classes-npm`: replaced ``npm pack`` call with ``tar czf`` for nodejs 16+ compatibility and improved ``do_configure`` performance +- Enabled :ref:`ref-classes-bin-package` class to work properly in the native case +- Enabled :ref:`buildpaths <qa-check-buildpaths>` QA check as a warning by default +- New :term:`OVERLAYFS_ETC_EXPOSE_LOWER` to provide read-only access to the original ``/etc`` content with :ref:`ref-classes-overlayfs-etc` +- New :term:`OVERLAYFS_QA_SKIP` variable to allow skipping check on :ref:`ref-classes-overlayfs` mounts +- New :term:`PACKAGECONFIG` options for individual recipes: + + - apr: xsi-strerror + - btrfs-tools: lzo + - connman: iwd + - coreutils: openssl + - dropbear: enable-x11-forwarding + - eudev: blkid, kmod, rule-generator + - eudev: manpages, selinux + - flac: avx, ogg + - gnutls: fips + - gstreamer1.0-plugins-bad: avtp + - libsdl2: libusb + - llvm: optviewer + - mesa: vulkan, vulkan-beta, zink + - perf: bfd + - piglit: glx, opencl + - python3: editline + - qemu: bpf, brlapi, capstone, rdma, slirp, uring, vde + - rpm: readline + - ruby: capstone + - systemd: no-dns-fallback, sysext + - tiff: jbig + +- ptest enhancements in ``curl``, ``json-c``, ``libgcrypt``, ``libgpg-error``, ``libxml2`` +- ptest compile/install functions now use :term:`PARALLEL_MAKE` and :term:`PARALLEL_MAKEINST` in ptest for significant speedup +- New :term:`TC_CXX_RUNTIME` variable to enable other layers to more easily control C++ runtime +- Set :term:`BB_DEFAULT_UMASK` using ??= to make it easier to override +- Set :term:`TCLIBC` and :term:`TCMODE` using ??= to make them easier to override +- squashfs-tools: build with lzo support by default +- insane.bbclass: make ``do_qa_staging`` check shebang length for native scripts in all :term:`SYSROOT_DIRS` +- utils: Add ``create_cmdline_shebang_wrapper`` function to allow recipes to easily create a wrapper to fix long shebang lines +- meson: provide relocation script and native/cross wrappers also for meson-native +- meson.bbclass: add cython binary to cross/native toolchain config +- New ``musl-locales`` recipe to provide a limited set of locale data for musl based systems +- gobject-introspection: use :term:`OBJDUMP` environment variable so that objdump tool can be picked up from the environment +- The Python ``zoneinfo`` module is now split out to its own ``python3-zoneinfo`` package. +- busybox: added devmem 128-bit support +- vim: split xxd out into its own package +- New :ref:`ref-classes-github-releases` class to consolidate version checks for github-based packages +- ``devtool reset`` now preserves ``workspace/sources`` source trees in ``workspace/attic/sources/`` instead of leaving them in-place +- scripts/patchreview: Add commit to stored json data +- scripts/patchreview: Make json output human parsable +- ``wpa-supplicant`` recipe now uses the upstream ``defconfig`` modified based upon :term:`PACKAGECONFIG` instead of a stale ``defconfig`` file +- bitbake: build: prefix the tasks with a timestamp in the log.task_order +- bitbake: fetch2/osc: Add support to query latest revision +- bitbake: utils: Pass lock argument in fileslocked +- bitbake: utils: Add enable_loopback_networking() + + +Known Issues in 4.1 +~~~~~~~~~~~~~~~~~~~ + +- The change to :ref:`migration-4.1-complementary-deps` means that images + built with the ``ptest-pkgs`` :term:`IMAGE_FEATURES` don’t automatically + install ``ptest-runner``, as that package is a recommendation of the + individual ``-ptest`` packages. This will be resolved in the next point + release, and can be worked around by explicitly installing ``ptest-runner`` + into the image. Filed as :yocto_bugs:`bug 14928 </show_bug.cgi?id=14928>`. + +- There is a known issue with eSDKs where sstate objects may be missing, + resulting in packages being unavailable to install in the sysroot. This is due + to image generation optimisations having unintended consequences in eSDK + generation. This will be resolved in the next point release. Filed as + :yocto_bugs:`bug 14626 </show_bug.cgi?id=14626>`, which also details the fix. + +- The change to :ref:`migration-4.1-classes-split` inadvertently moved the + :ref:`ref-classes-externalsrc` class to ``meta/classes-recipe``, + when it is not recipe-specific and can also be used in a global context. The + class will be moved back to ``meta/classes`` in the next point release. Filed + as :yocto_bugs:`bug 14940 </show_bug.cgi?id=14940>`. + + +Recipe License changes in 4.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +- alsa-state: add GPL-2.0-or-later because of alsa-state-init file +- git: add GPL-2.0-or-later & BSD-3-Clause & MIT & BSL-1.0 & LGPL-2.1-or-later due to embedded code +- libgcrypt: dropped GPLv3 license after upstream changes +- linux-firmware: correct license for ar3k firmware (specific "ar3k" license) + + + +Security Fixes in 4.1 +~~~~~~~~~~~~~~~~~~~~~ + +- bind: :cve:`2022-1183`, :cve:`2022-2795`, :cve:`2022-2881`, :cve:`2022-2906`, :cve:`2022-3080`, :cve:`2022-38178` +- binutils: :cve:`2019-1010204`, :cve:`2022-38126`, :cve:`2022-38127`, :cve:`2022-38128`, :cve:`2022-38533` +- busybox: :cve:`2022-30065` +- connman: :cve:`2022-32292`, :cve:`2022-32293` +- cups: :cve:`2022-26691` +- e2fsprogs: :cve:`2022-1304` +- expat: :cve:`2022-40674` +- freetype: :cve:`2022-27404` +- glibc: :cve:`2022-39046` +- gnupg: :cve:`2022-34903` +- grub2: :cve:`2021-3695`, :cve:`2021-3696`, :cve:`2021-3697`, :cve:`2022-28733`, :cve:`2022-28734`, :cve:`2022-28735` +- inetutils: :cve:`2022-39028` +- libtirpc: :cve:`2021-46828` +- libxml2: :cve:`2016-3709` (ignored) +- libxslt: :cve:`2022-29824` (not applicable) +- linux-yocto/5.15: :cve:`2022-28796` +- logrotate: :cve:`2022-1348` +- lua: :cve:`2022-33099` +- nasm: :cve:`2020-18974` (ignored) +- ncurses: :cve:`2022-29458` +- openssl: :cve:`2022-1292`, :cve:`2022-1343`, :cve:`2022-1434`, :cve:`2022-1473`, :cve:`2022-2068`, :cve:`2022-2274`, :cve:`2022-2097` +- python3: :cve:`2015-20107` (ignored) +- qemu: :cve:`2021-20255` (ignored), :cve:`2019-12067` (ignored), :cve:`2021-3507`, :cve:`2022-0216`, :cve:`2022-2962`, :cve:`2022-35414` +- rpm: :cve:`2021-35937`, :cve:`2021-35938`, :cve:`2021-35939` +- rsync: :cve:`2022-29154` +- subversion: :cve:`2021-28544`, :cve:`2022-24070` +- tiff: :cve:`2022-1210` (not applicable), :cve:`2022-1622`, :cve:`2022-1623` (invalid), :cve:`2022-2056`, :cve:`2022-2057`, :cve:`2022-2058`, :cve:`2022-2953`, :cve:`2022-34526` +- unzip: :cve:`2022-0529`, :cve:`2022-0530` +- vim: :cve:`2022-1381`, :cve:`2022-1420`, :cve:`2022-1621`, :cve:`2022-1629`, :cve:`2022-1674`, :cve:`2022-1733`, :cve:`2022-1735`, :cve:`2022-1769`, :cve:`2022-1771`, :cve:`2022-1785`, :cve:`2022-1796`, :cve:`2022-1927`, :cve:`2022-1942`, :cve:`2022-2257`, :cve:`2022-2264`, :cve:`2022-2284`, :cve:`2022-2285`, :cve:`2022-2286`, :cve:`2022-2287`, :cve:`2022-2816`, :cve:`2022-2817`, :cve:`2022-2819`, :cve:`2022-2845`, :cve:`2022-2849`, :cve:`2022-2862`, :cve:`2022-2874`, :cve:`2022-2889`, :cve:`2022-2980`, :cve:`2022-2946`, :cve:`2022-2982`, :cve:`2022-3099`, :cve:`2022-3134`, :cve:`2022-3234`, :cve:`2022-3278` +- zlib: :cve:`2022-37434` + + + + + +Recipe Upgrades in 4.1 +~~~~~~~~~~~~~~~~~~~~~~ + +- acpica 20211217 -> 20220331 +- adwaita-icon-theme 41.0 -> 42.0 +- alsa-lib 1.2.6.1 -> 1.2.7.2 +- alsa-plugins 1.2.6 -> 1.2.7.1 +- alsa-ucm-conf 1.2.6.3 -> 1.2.7.2 +- alsa-utils 1.2.6 -> 1.2.7 +- asciidoc 10.1.4 -> 10.2.0 +- at-spi2-core 2.42.0 -> 2.44.1 +- autoconf-archive 2022.02.11 -> 2022.09.03 +- base-passwd 3.5.29 -> 3.5.52 +- bind 9.18.5 -> 9.18.7 +- binutils 2.38 -> 2.39 +- boost 1.78.0 -> 1.80.0 +- boost-build-native 4.4.1 -> 1.80.0 +- btrfs-tools 5.16.2 -> 5.19.1 +- cargo 1.59.0 -> 1.63.0 +- ccache 4.6 -> 4.6.3 +- cmake 3.22.3 -> 3.24.0 +- cmake-native 3.22.3 -> 3.24.0 +- coreutils 9.0 -> 9.1 +- createrepo-c 0.19.0 -> 0.20.1 +- cross-localedef-native 2.35 -> 2.36 +- curl 7.82.0 -> 7.85.0 +- diffoscope 208 -> 221 +- dmidecode 3.3 -> 3.4 +- dnf 4.11.1 -> 4.14.0 +- dos2unix 7.4.2 -> 7.4.3 +- dpkg 1.21.4 -> 1.21.9 +- dropbear 2020.81 -> 2022.82 +- efibootmgr 17 -> 18 +- elfutils 0.186 -> 0.187 +- ell 0.50 -> 0.53 +- enchant2 2.3.2 -> 2.3.3 +- erofs-utils 1.4 -> 1.5 +- ethtool 5.16 -> 5.19 +- eudev 3.2.10 -> 3.2.11 +- ffmpeg 5.0.1 -> 5.1.1 +- file 5.41 -> 5.43 +- flac 1.3.4 -> 1.4.0 +- fontconfig 2.13.1 -> 2.14.0 +- freetype 2.11.1 -> 2.12.1 +- gcc 11.3.0 -> 12.2.0 +- gcompat 1.0.0+1.1+gitX (4d6a5156a6eb…) -> 1.0.0+1.1+gitX (c6921a1aa454…) +- gdb 11.2 -> 12.1 +- ghostscript 9.55.0 -> 9.56.1 +- git 2.35.4 -> 2.37.3 +- glibc 2.35 -> 2.36 +- glslang 1.3.204.1 -> 1.3.216.0 +- gnu-config 20211108+gitX -> 20220525+gitX +- gnu-efi 3.0.14 -> 3.0.15 +- gnutls 3.7.4 -> 3.7.7 +- go 1.17.13 -> 1.19 +- go-helloworld 0.1 (787a929d5a0d…) -> 0.1 (2e68773dfca0…) +- gpgme 1.17.1 -> 1.18.0 +- gptfdisk 1.0.8 -> 1.0.9 +- harfbuzz 4.0.1 -> 5.1.0 +- hdparm 9.63 -> 9.64 +- help2man 1.49.1 -> 1.49.2 +- hwlatdetect 2.3 -> 2.4 +- icu 70.1 -> 71.1 +- inetutils 2.2 -> 2.3 +- init-system-helpers 1.62 -> 1.64 +- iproute2 5.17.0 -> 5.19.0 +- iptables 1.8.7 -> 1.8.8 +- iw 5.16 -> 5.19 +- json-c 0.15 -> 0.16 +- kbd 2.4.0 -> 2.5.1 +- kea 2.0.2 -> 2.2.0 +- kexec-tools 2.0.23 -> 2.0.25 +- kmod 29 -> 30 +- kmscube git (9f63f359fab1…) -> git (3bf6ee1a0233…) +- less 600 -> 608 +- libaio 0.3.112 -> 0.3.113 +- libbsd 0.11.5 -> 0.11.6 +- libcap-ng 0.8.2 -> 0.8.3 +- libcap-ng-python 0.8.2 -> 0.8.3 +- libcgroup 2.0.2 -> 3.0.0 +- libcomps 0.1.18 -> 0.1.19 +- libdnf 0.66.0 -> 0.69.0 +- libdrm 2.4.110 -> 2.4.113 +- libevdev 1.12.1 -> 1.13.0 +- libfontenc 1.1.4 -> 1.1.6 +- libgcc 11.3.0 -> 12.2.0 +- libgcc-initial 11.3.0 -> 12.2.0 +- libgcrypt 1.9.4 -> 1.10.1 +- libgfortran 11.3.0 -> 12.2.0 +- libgit2 1.4.3 -> 1.5.0 +- libgpg-error 1.44 -> 1.45 +- libhandy 1.5.0 -> 1.6.3 +- libidn2 2.3.2 -> 2.3.3 +- libjitterentropy 3.4.0 -> 3.4.1 +- libmnl 1.0.4 -> 1.0.5 +- libnl 3.5.0 -> 3.7.0 +- libnotify 0.7.9 -> 0.8.1 +- libpipeline 1.5.5 -> 1.5.6 +- libproxy 0.4.17 -> 0.4.18 +- librepo 1.14.3 -> 1.14.5 +- librsvg 2.52.7 -> 2.54.5 +- libsdl2 2.0.20 -> 2.24.0 +- libseccomp 2.5.3 -> 2.5.4 +- libsndfile1 1.0.31 -> 1.1.0 +- libstd-rs 1.59.0 -> 1.63.0 +- libtirpc 1.3.2 -> 1.3.3 +- libubootenv 0.3.2 -> 0.3.3 +- libva 2.14.0 -> 2.15.0 +- libva-utils 2.14.0 -> 2.15.0 +- libx11 1.7.3.1 -> 1.8.1 +- libxau 1.0.9 -> 1.0.10 +- libxcb 1.14 -> 1.15 +- libxcursor 1.2.0 -> 1.2.1 +- libxcvt 0.1.1 -> 0.1.2 +- libxfont2 2.0.5 -> 2.0.6 +- libxvmc 1.0.12 -> 1.0.13 +- linux-libc-headers 5.16 -> 5.19 +- linux-yocto 5.10.143+gitX, 5.15.68+gitX -> 5.15.68+gitX, 5.19.9+gitX +- linux-yocto-dev 5.18++gitX -> 5.19++gitX +- linux-yocto-rt 5.10.143+gitX, 5.15.68+gitX -> 5.15.68+gitX, 5.19.9+gitX +- linux-yocto-tiny 5.10.143+gitX, 5.15.68+gitX -> 5.15.68+gitX, 5.19.9+gitX +- llvm 13.0.1 -> 14.0.6 +- lsof 4.94.0 -> 4.95.0 +- ltp 20220121 -> 20220527 +- lttng-tools 2.13.4 -> 2.13.8 +- lttng-ust 2.13.3 -> 2.13.4 +- mc 4.8.27 -> 4.8.28 +- mesa 22.0.3 -> 22.2.0 +- mesa-demos 8.4.0 -> 8.5.0 +- mesa-gl 22.0.3 -> 22.2.0 +- meson 0.61.3 -> 0.63.2 +- mmc-utils 0.1+gitX (b7e4d5a6ae99…) -> 0.1+gitX (d7b343fd2628…) +- mpg123 1.29.3 -> 1.30.2 +- msmtp 1.8.20 -> 1.8.22 +- mtools 4.0.38 -> 4.0.40 +- musl 1.2.3+gitX (7a43f6fea908…) -> 1.2.3+gitX (37e18b7bf307…) +- musl-obstack 1.1 -> 1.2 +- ncurses 6.3+20220423 (a0bc708bc695…) -> 6.3+20220423 (20db1fb41ec9…) +- neard 0.16 -> 0.18 +- nettle 3.7.3 -> 3.8.1 +- nfs-utils 2.6.1 -> 2.6.2 +- nghttp2 1.47.0 -> 1.49.0 +- ninja 1.10.2 -> 1.11.1 +- numactl 2.0.14 -> 2.0.15 +- ofono 1.34 -> 2.0 +- opensbi 1.0 -> 1.1 +- openssh 8.9p1 -> 9.0p1 +- opkg 0.5.0 -> 0.6.0 +- ovmf edk2-stable202202 -> edk2-stable202205 +- pango 1.50.4 -> 1.50.9 +- parted 3.4 -> 3.5 +- patchelf 0.14.5 -> 0.15.0 +- pciutils 3.7.0 -> 3.8.0 +- perl 5.34.1 -> 5.36.0 +- perlcross 1.3.7 -> 1.4 +- piglit 1.0+gitrX (2f80c7cc9c02…) -> 1.0+gitrX (265896c86f90…) +- pkgconf 1.8.0 -> 1.9.3 +- psmisc 23.4 -> 23.5 +- pulseaudio 15.0 -> 16.1 +- puzzles 0.0+gitX (c43a34fbfe43…) -> 0.0+gitX (8399cff6a3b9…) +- python3 3.10.4 -> 3.10.6 +- python3-atomicwrites 1.4.0 -> 1.4.1 +- python3-attrs 21.4.0 -> 22.1.0 +- python3-babel 2.9.1 -> 2.10.3 +- python3-bcrypt 3.2.0 -> 3.2.2 +- python3-certifi 2021.10.8 -> 2022.9.14 +- python3-cffi 1.15.0 -> 1.15.1 +- python3-chardet 4.0.0 -> 5.0.0 +- python3-cryptography 36.0.2 -> 37.0.4 +- python3-cryptography-vectors 36.0.2 -> 37.0.4 +- python3-cython 0.29.28 -> 0.29.32 +- python3-dbusmock 0.27.3 -> 0.28.4 +- python3-docutils 0.18.1 -> 0.19 +- python3-dtschema 2022.1 -> 2022.8.3 +- python3-hypothesis 6.39.5 -> 6.54.5 +- python3-idna 3.3 -> 3.4 +- python3-imagesize 1.3.0 -> 1.4.1 +- python3-importlib-metadata 4.11.3 -> 4.12.0 +- python3-jinja2 3.1.1 -> 3.1.2 +- python3-jsonpointer 2.2 -> 2.3 +- python3-jsonschema 4.4.0 -> 4.9.1 +- python3-magic 0.4.25 -> 0.4.27 +- python3-mako 1.1.6 -> 1.2.2 +- python3-markdown 3.3.6 -> 3.4.1 +- python3-more-itertools 8.12.0 -> 8.14.0 +- python3-numpy 1.22.3 -> 1.23.3 +- python3-pbr 5.8.1 -> 5.10.0 +- python3-pip 22.0.3 -> 22.2.2 +- python3-psutil 5.9.0 -> 5.9.2 +- python3-pycryptodome 3.14.1 -> 3.15.0 +- python3-pycryptodomex 3.14.1 -> 3.15.0 +- python3-pyelftools 0.28 -> 0.29 +- python3-pygments 2.11.2 -> 2.13.0 +- python3-pygobject 3.42.0 -> 3.42.2 +- python3-pyparsing 3.0.7 -> 3.0.9 +- python3-pytest 7.1.1 -> 7.1.3 +- python3-pytest-subtests 0.7.0 -> 0.8.0 +- python3-pytz 2022.1 -> 2022.2.1 +- python3-requests 2.27.1 -> 2.28.1 +- python3-scons 4.3.0 -> 4.4.0 +- python3-semantic-version 2.9.0 -> 2.10.0 +- python3-setuptools 59.5.0 -> 65.0.2 +- python3-setuptools-scm 6.4.2 -> 7.0.5 +- python3-sphinx 4.4.0 -> 5.1.1 +- python3-sphinx-rtd-theme 0.5.0 -> 1.0.0 +- python3-typing-extensions 3.10.0.0 -> 4.3.0 +- python3-urllib3 1.26.9 -> 1.26.12 +- python3-webcolors 1.11.1 -> 1.12 +- python3-zipp 3.7.0 -> 3.8.1 +- qemu 6.2.0 -> 7.1.0 +- repo 2.22 -> 2.29.2 +- rpm 4.17.0 -> 4.18.0 +- rsync 3.2.3 -> 3.2.5 +- rt-tests 2.3 -> 2.4 +- rust 1.59.0 -> 1.63.0 +- rust-llvm 1.59.0 -> 1.63.0 +- sbc 1.5 -> 2.0 +- seatd 0.6.4 -> 0.7.0 +- shaderc 2022.1 -> 2022.2 +- shadow 4.11.1 -> 4.12.1 +- shared-mime-info 2.1 -> 2.2 +- slang 2.3.2 -> 2.3.3 +- speex 1.2.0 -> 1.2.1 +- speexdsp 1.2.0 -> 1.2.1 +- spirv-headers 1.3.204.1 -> 1.3.216.0 +- spirv-tools 1.3.204.1 -> 1.3.216.0 +- sqlite3 3.38.5 -> 3.39.3 +- squashfs-tools 4.5 -> 4.5.1 +- strace 5.16 -> 5.19 +- stress-ng 0.13.12 -> 0.14.03 +- sudo 1.9.10 -> 1.9.11p3 +- sysklogd 2.3.0 -> 2.4.4 +- sysstat 12.4.5 -> 12.6.0 +- systemd 250.5 -> 251.4 +- systemd-boot 250.5 -> 251.4 +- systemtap 4.6 -> 4.7 +- systemtap-native 4.6 -> 4.7 +- systemtap-uprobes 4.6 -> 4.7 +- sysvinit 3.01 -> 3.04 +- tiff 4.3.0 -> 4.4.0 +- tzcode-native 2022c -> 2022d +- tzdata 2022c -> 2022d +- u-boot 2022.01 -> 2022.07 +- u-boot-tools 2022.01 -> 2022.07 +- util-linux 2.37.4 -> 2.38.1 +- util-linux-libuuid 2.37.4 -> 2.38.1 +- valgrind 3.18.1 -> 3.19.0 +- vim 9.0.0541 -> 9.0.0598 +- vim-tiny 9.0.0541 -> 9.0.0598 +- virglrenderer 0.9.1 -> 0.10.3 +- vte 0.66.2 -> 0.68.0 +- vulkan-headers 1.3.204.1 -> 1.3.216.0 +- vulkan-loader 1.3.204.1 -> 1.3.216.0 +- vulkan-samples git (28ca2dad83ce…) -> git (74d45aace02d…) +- vulkan-tools 1.3.204.1 -> 1.3.216.0 +- wayland 1.20.0 -> 1.21.0 +- wayland-protocols 1.25 -> 1.26 +- webkitgtk 2.36.5 -> 2.36.7 +- x264 r3039+gitX (5db6aa6cab1b…) -> r3039+gitX (baee400fa9ce…) +- xauth 1.1.1 -> 1.1.2 +- xcb-proto 1.14.1 -> 1.15.2 +- xf86-video-cirrus 1.5.3 -> 1.6.0 +- xkeyboard-config 2.35.1 -> 2.36 +- xmlto 0.0.28 -> 0.0.28+0.0.29+gitX +- xorgproto 2021.5 -> 2022.2 +- zlib 1.2.11 -> 1.2.12 + + + +Contributors to 4.1 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +- Aatir Manzur +- Ahmed Hossam +- Alejandro Hernandez Samaniego +- Alexander Kanavin +- Alexandre Belloni +- Alex Kiernan +- Alex Stewart +- Andrei Gherzan +- Andrej Valek +- Andrey Konovalov +- Aníbal Limón +- Anuj Mittal +- Arkadiusz Drabczyk +- Armin Kuster +- Aryaman Gupta +- Awais Belal +- Beniamin Sandu +- Bertrand Marquis +- Bob Henz +- Bruce Ashfield +- Carlos Rafael Giani +- Changhyeok Bae +- Changqing Li +- Chanho Park +- Chen Qi +- Christoph Lauer +- Claudius Heine +- Daiane Angolini +- Daniel Gomez +- Daniel McGregor +- David Bagonyi +- Davide Gardenal +- Denys Dmytriyenko +- Dmitry Baryshkov +- Drew Moseley +- Enrico Scholz +- Ernst Sjöstrand +- Etienne Cordonnier +- Fabio Estevam +- Federico Pellegrin +- Felix Moessbauer +- Ferry Toth +- Florin Diaconescu +- Gennaro Iorio +- Grygorii Tertychnyi +- Gunjan Gupta +- Henning Schild +- He Zhe +- Hitendra Prajapati +- Jack Mitchell +- Jacob Kroon +- Jan Kiszka +- Jan Luebbe +- Jan Vermaete +- Jasper Orschulko +- JeongBong Seo +- Jeremy Puhlman +- Jiaqing Zhao +- Joerg Vehlow +- Johan Korsnes +- Johannes Schneider +- John Edward Broadbent +- Jon Mason +- Jose Quaresma +- Joshua Watt +- Justin Bronder +- Kai Kang +- Kevin Hao +- Khem Raj +- Konrad Weihmann +- Kory Maincent +- Kristian Amlie +- Lee Chee Yang +- Lei Maohui +- Leon Anavi +- Luca Ceresoli +- Lucas Stach +- LUIS ENRIQUEZ +- Marcel Ziswiler +- Marius Kriegerowski +- Mark Hatle +- Markus Volk +- Marta Rybczynska +- Martin Beeger +- Martin Jansa +- Mateusz Marciniec +- Mattias Jernberg +- Matt Madison +- Maxime Roussin-Bélanger +- Michael Halstead +- Michael Opdenacker +- Mihai Lindner +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Muhammad Hamza +- Naveen Saini +- Neil Horman +- Nick Potenski +- Nicolas Dechesne +- Niko Mauno +- Ola x Nilsson +- Otavio Salvador +- Pascal Bach +- Paul Eggleton +- Paul Gortmaker +- Paulo Neves +- Pavel Zhukov +- Peter Bergin +- Peter Kjellerstedt +- Peter Marko +- Petr Vorel +- Pgowda +- Portia Stephens +- Quentin Schulz +- Rahul Kumar +- Raju Kumar Pothuraju +- Randy MacLeod +- Raphael Teller +- Rasmus Villemoes +- Ricardo Salveti +- Richard Purdie +- Robert Joslyn +- Robert Yang +- Roland Hieber +- Ross Burton +- Rouven Czerwinski +- Ruiqiang Hao +- Russ Dill +- Rusty Howell +- Sakib Sajal +- Samuli Piippo +- Schmidt, Adriaan +- Sean Anderson +- Shruthi Ravichandran +- Shubham Kulkarni +- Simone Weiss +- Sebastian Suesens +- Stefan Herbrechtsmeier +- Stefano Babic +- Stefan Wiehler +- Steve Sakoman +- Sundeep KOKKONDA +- Teoh Jay Shen +- Thomas Epperson +- Thomas Perrot +- Thomas Roos +- Tobias Schmidl +- Tomasz Dziendzielski +- Tom Hochstein +- Tom Rini +- Trevor Woerner +- Ulrich Ölmann +- Vyacheslav Yurkov +- Wang Mingyu +- William A. Kennington III +- Xiaobing Luo +- Xu Huan +- Yang Xu +- Yi Zhao +- Yogesh Tyagi +- Yongxin Liu +- Yue Tao +- Yulong (Kevin) Liu +- Zach Welch +- Zheng Ruoqin +- Zoltán Böszörményi + +Repositories / Downloads for 4.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`langdale </poky/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1 </poky/log/?h=yocto-4.1>` +- Git Revision: :yocto_git:`5200799866b92259e855051112520006e1aaaac0 </poky/commit/?id=5200799866b92259e855051112520006e1aaaac0>` +- Release Artefact: poky-5200799866b92259e855051112520006e1aaaac0 +- sha: 9d9a2f7ecf2502f89f43bf45d63e6b61cdcb95ed1d75c8281372f550d809c823 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1/poky-5200799866b92259e855051112520006e1aaaac0.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1/poky-5200799866b92259e855051112520006e1aaaac0.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`langdale </openembedded-core/log/?h=langdale>` +- Tag: :oe_git:`yocto-4.1 </openembedded-core/log/?h=yocto-4.1>` +- Git Revision: :oe_git:`744a2277844ec9a384a9ca7dae2a634d5a0d3590 </openembedded-core/commit/?id=744a2277844ec9a384a9ca7dae2a634d5a0d3590>` +- Release Artefact: oecore-744a2277844ec9a384a9ca7dae2a634d5a0d3590 +- sha: 34f1fd5bb83514bf0ec8ad7f8cce088a8e28677e1338db94c188283da704c663 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1/oecore-744a2277844ec9a384a9ca7dae2a634d5a0d3590.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1/oecore-744a2277844ec9a384a9ca7dae2a634d5a0d3590.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`langdale </meta-mingw/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1 </meta-mingw/log/?h=yocto-4.1>` +- Git Revision: :yocto_git:`b0067202db8573df3d23d199f82987cebe1bee2c </meta-mingw/commit/?id=b0067202db8573df3d23d199f82987cebe1bee2c>` +- Release Artefact: meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c +- sha: 704f2940322b81ce774e9cbd27c3cfa843111d497dc7b1eeaa39cd694d9a2366 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1/meta-mingw-b0067202db8573df3d23d199f82987cebe1bee2c.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.2 </bitbake/log/?h=2.2>` +- Tag: :oe_git:`yocto-4.1 </bitbake/log/?h=yocto-4.1>` +- Git Revision: :oe_git:`074da4c469d1f4177a1c5be72b9f3ccdfd379d67 </bitbake/commit/?id=074da4c469d1f4177a1c5be72b9f3ccdfd379d67>` +- Release Artefact: bitbake-074da4c469d1f4177a1c5be72b9f3ccdfd379d67 +- sha: e32c300e0c8522d8d49ef10aae473bd5f293202672eb9d38e90ed92594ed1fe8 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.1/bitbake-074da4c469d1f4177a1c5be72b9f3ccdfd379d67.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.1/bitbake-074da4c469d1f4177a1c5be72b9f3ccdfd379d67.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`langdale </yocto-docs/log/?h=langdale>` +- Tag: :yocto_git:`yocto-4.1 </yocto-docs/log/?h=yocto-4.1>` +- Git Revision: :yocto_git:`42d3e26a0d04bc5951e640b471686f347dc9b74a </yocto-docs/commit/?id=42d3e26a0d04bc5951e640b471686f347dc9b74a>` diff --git a/documentation/migration-guides/release-notes-4.2.1.rst b/documentation/migration-guides/release-notes-4.2.1.rst new file mode 100644 index 0000000000..948c35fd67 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.2.1.rst @@ -0,0 +1,206 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.2.1 (Mickledore) +------------------------------------------ + +Security Fixes in Yocto-4.2.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- connman: Fix :cve:`2023-28488` +- linux-yocto: Ignore :cve:`2023-1652` and :cve:`2023-1829` +- ghostscript: Fix :cve:`2023-28879` +- qemu: Ignore :cve:`2023-0664` +- ruby: Fix :cve:`2022-28738` and :cve:`2022-28739` +- tiff: Fix :cve:`2022-4645` +- xwayland: Fix :cve:`2023-1393` + + +Fixes in Yocto-4.2.1 +~~~~~~~~~~~~~~~~~~~~ + +- apr: upgrade to 1.7.3 +- bind: upgrade to 9.18.13 +- build-appliance-image: Update to mickledore head revision +- cargo: Fix build on musl/riscv +- cpio: fix appending to archives larger than 2GB +- cracklib: upgrade to 2.9.11 +- cve-update-nvd2-native: added the missing http import +- dev-manual: init-manager.rst: add summary +- dhcpcd: use git instead of tarballs +- docs: add support for mickledore (4.2) release +- gawk: Add skipped.txt to emit test to ignore +- gawk: Disable known ptest fails on musl +- gawk: Remove redundant patch +- glib-networking: Add test retry to avoid failures +- glib-networking: Correct glib error handling in test patch +- gtk4: upgrade to 4.10.3 +- kernel-devsrc: depend on python3-core instead of python3 +- kernel-fitimage: Fix the default dtb config check +- kernel: improve initramfs bundle processing time +- libarchive: Enable acls, xattr for native as well as target +- libhandy: upgrade to 1.8.2 +- libnotify: remove dependency dbus +- libpam: Fix the xtests/tst-pam_motd[1|3] failures +- libpcap: upgrade to 1.10.4 +- libsdl2: upgrade to 2.26.5 +- libxml2: Disable icu tests on musl +- license.bbclass: Include :term:`LICENSE` in the output when it fails to parse +- linux-firmware: upgrade to 20230404 +- machine/qemuarm*: don't explicitly set vmalloc +- maintainers.inc: Fix email address typo +- maintainers.inc: Move repo to unassigned +- man-pages: upgrade to 6.04 +- manuals: document :term:`SPDX_CUSTOM_ANNOTATION_VARS` +- manuals: expand init manager documentation +- mesa: upgrade to 23.0.3 +- migration-guides: add release-notes for 4.1.4 +- migration-guides: fixes and improvements to 4.2 release notes +- migration-guides: release-notes-4.0.9.rst: add missing :term:`SPDX` info +- migration-guides: release-notes-4.2: add doc improvement highlights +- mpg123: upgrade to 1.31.3 +- mtools: upgrade to 4.0.43 +- oeqa/utils/metadata.py: Fix running oe-selftest running with no distro set +- overview-manual: development-environment: update text and screenshots +- overview-manual: update section about source archives +- package_manager/ipk: fix config path generation in _create_custom_config() +- pango: upgrade to 1.50.14 +- perl: patch out build paths from native binaries +- poky.conf: bump version for 4.2.1 release +- populate_sdk_ext.bbclass: redirect stderr to stdout so that both end in LOGFILE +- populate_sdk_ext.bbclass: set :term:`METADATA_REVISION` with an :term:`DISTRO` override +- python3targetconfig.bbclass: Extend PYTHONPATH instead of overwriting +- qemu: Add fix for powerpc instruction fallback issue +- qemu: Update ppc instruction fix to match revised upstream version +- quilt: Fix merge.test race condition +- recipes: Default to https git protocol where possible +- ref-manual: add "Mixin" term +- ref-manual: classes.rst: document devicetree.bbclass +- ref-manual: classes: kernel: document automatic defconfig usage +- ref-manual: classes: kernel: remove incorrect sentence opening +- ref-manual: remove unused and obsolete file +- ref-manual: system-requirements.rst: fix AlmaLinux variable name +- ref-manual: variables.rst: add wikipedia shortcut for "getty" +- ref-manual: variables.rst: document :term:`KERNEL_DANGLING_FEATURES_WARN_ONLY` +- ref-manual: variables.rst: don't mention the :term:`INIT_MANAGER` "none" option +- release-notes-4.2: remove/merge duplicates entries +- release-notes-4.2: update RC3 changes +- release-notes-4.2: update known issues and Repositories/Downloads +- releases.svg: fix and explain duration of Hardknott 3.3 +- ruby: upgrade to 3.2.2 +- rust: upgrade to 1.68.2 +- selftest/distrodata: clean up exception lists in recipe maintainers test +- systemd-systemctl: fix instance template WantedBy symlink construction +- texinfo: upgrade to 7.0.3 +- unfs3: fix symlink time setting issue +- update-alternatives.bbclass: fix old override syntax +- vala: upgrade to 0.56.6 +- waffle: upgrade to 1.7.2 +- weston: add xwayland to :term:`DEPENDS` for :term:`PACKAGECONFIG` xwayland +- wpebackend-fdo: upgrade to 1.14.2 +- xserver-xorg: upgrade to 21.1.8 +- xwayland: upgrade to 23.1.1 + + +Known Issues in Yocto-4.2.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.2.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alex Kiernan +- Alexander Kanavin +- Arslan Ahmad +- Bruce Ashfield +- Chen Qi +- Dmitry Baryshkov +- Enrico Jörns +- Jan Vermaete +- Joe Slater +- Johannes Schrimpf +- Kai Kang +- Khem Raj +- Kyle Russell +- Lee Chee Yang +- Luca Ceresoli +- Markus Volk +- Martin Jansa +- Martin Siegumfeldt +- Michael Halstead +- Michael Opdenacker +- Ming Liu +- Otavio Salvador +- Pawan Badganchi +- Peter Bergin +- Peter Kjellerstedt +- Piotr Łobacz +- Richard Purdie +- Ross Burton +- Steve Sakoman +- Thomas Roos +- Virendra Thakur +- Wang Mingyu +- Yoann Congal +- Zhixiong Chi + + +Repositories / Downloads for Yocto-4.2.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`mickledore </poky/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.1 </poky/log/?h=yocto-4.2.1>` +- Git Revision: :yocto_git:`c5c69f78fc7ce4ba361363c14352e4264ce7813f </poky/commit/?id=c5c69f78fc7ce4ba361363c14352e4264ce7813f>` +- Release Artefact: poky-c5c69f78fc7ce4ba361363c14352e4264ce7813f +- sha: 057d7771dceebb949a79359d7d028a733a29ae7ecd98b60fefcff83fecb22eb7 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.1/poky-c5c69f78fc7ce4ba361363c14352e4264ce7813f.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.1/poky-c5c69f78fc7ce4ba361363c14352e4264ce7813f.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`mickledore </openembedded-core/log/?h=mickledore>` +- Tag: :oe_git:`yocto-4.2.1 </openembedded-core/log/?h=yocto-4.2.1>` +- Git Revision: :oe_git:`20cd64812d286c920bd766145ab1cd968e72667e </openembedded-core/commit/?id=20cd64812d286c920bd766145ab1cd968e72667e>` +- Release Artefact: oecore-20cd64812d286c920bd766145ab1cd968e72667e +- sha: 877fb909af7aa51e1c962d33cfe91ba3e075c384716006aa1345b4bcb15a48ef +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.1/oecore-20cd64812d286c920bd766145ab1cd968e72667e.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.1/oecore-20cd64812d286c920bd766145ab1cd968e72667e.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`mickledore </meta-mingw/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.1 </meta-mingw/log/?h=yocto-4.2.1>` +- Git Revision: :yocto_git:`cc9fd0a988dc1041035a6a6cafb2d1237ef38d8e </meta-mingw/commit/?id=cc9fd0a988dc1041035a6a6cafb2d1237ef38d8e>` +- Release Artefact: meta-mingw-cc9fd0a988dc1041035a6a6cafb2d1237ef38d8e +- sha: 69ccc3ee503b5c35602889e85d28df64a5422ad0f1e55c96c94135b837bb4a1c +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.1/meta-mingw-cc9fd0a988dc1041035a6a6cafb2d1237ef38d8e.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.1/meta-mingw-cc9fd0a988dc1041035a6a6cafb2d1237ef38d8e.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.4 </bitbake/log/?h=2.4>` +- Tag: :oe_git:`yocto-4.2.1 </bitbake/log/?h=yocto-4.2.1>` +- Git Revision: :oe_git:`d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c </bitbake/commit/?id=d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c>` +- Release Artefact: bitbake-d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c +- sha: 5edcb97cb545011226b778355bb840ebcc790552d4a885a0d83178153697ba7a +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.1/bitbake-d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.1/bitbake-d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`mickledore </yocto-docs/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.1 </yocto-docs/log/?h=yocto-4.2.1>` +- Git Revision: :yocto_git:`6b04269bba72311e83139cc88b7a3539a5d832e8 </yocto-docs/commit/?id=6b04269bba72311e83139cc88b7a3539a5d832e8>` + diff --git a/documentation/migration-guides/release-notes-4.2.2.rst b/documentation/migration-guides/release-notes-4.2.2.rst new file mode 100644 index 0000000000..74f2d0e82a --- /dev/null +++ b/documentation/migration-guides/release-notes-4.2.2.rst @@ -0,0 +1,330 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.2.2 (Mickledore) +------------------------------------------ + +Security Fixes in Yocto-4.2.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- binutils: Fix :cve:`2023-1972` +- cups: Fix :cve:`2023-32324` +- curl: Fix :cve:`2023-28319`, :cve:`2023-28320`, :cve:`2023-28321` and :cve:`2023-28322` +- dbus: Fix :cve:`2023-34969` +- git: Fix :cve:`2023-25652` and :cve:`2023-29007` +- git: Ignore :cve:`2023-25815` +- libwebp: Fix :cve:`2023-1999` +- libxml2: Fix :cve:`2023-28484` and :cve:`2023-29469` +- libxpm: Fix :cve:`2022-44617` +- ninja: Ignore :cve:`2021-4336` +- openssl: Fix :cve:`2023-0464`, :cve:`2023-0465`, :cve:`2023-0466`, :cve:`2023-1255` and :cve:`2023-2650` +- perl: Fix :cve:`2023-31484` and :cve:`2023-31486` +- sysstat: Fix :cve:`2023-33204` +- tiff: Fix :cve_mitre:`2023-25434`, :cve:`2023-26965` and :cve:`2023-2731` +- vim: Fix :cve:`2023-2426` + + +Fixes in Yocto-4.2.2 +~~~~~~~~~~~~~~~~~~~~ + +- apr: Upgrade to 1.7.4 +- avahi: fix D-Bus introspection +- babeltrace2: Always use BFD linker when building tests with ld-is-lld distro feature +- babeltrace2: Upgrade to 2.0.5 +- baremetal-helloworld: Update :term:`SRCREV` to fix entry addresses for ARM architectures +- bind: Upgrade to 9.18.15 +- binutils: move packaging of gprofng static lib into common .inc +- binutils: package static libs from gprofng +- binutils: stable 2.40 branch updates (7343182dd1) +- bitbake.conf: add unzstd in :term:`HOSTTOOLS` +- bitbake: runqueue: Fix deferred task/multiconfig race issue +- bno_plot.py, btt_plot.py: Ask for python3 specifically +- build-appliance-image: Update to mickledore head revision +- busybox: Upgrade to 1.36.1 +- cmake.bbclass: do not search host paths for find_program() +- conf: add nice level to the hash config ignred variables +- connman: fix warning by specifying runstatedir at configure time +- cpio: Run ptests under ptest user +- dbus: Upgrade to 1.14.8 +- devtool: Fix the wrong variable in srcuri_entry +- dnf: only write the log lock to root for native dnf +- docs: bsp-guide: bsp: fix typo +- dpkg: Upgrade to v1.21.22 +- e2fsprogs: Fix error SRCDIR when using usrmerge :term:`DISTRO_FEATURES` +- e2fsprogs: fix ptest bug for second running +- ell: Upgrade to 0.57 +- expect: Add ptest support +- fribidi: Upgrade to 1.0.13 +- gawk: Upgrade to 5.2.2 +- gcc : upgrade to v12.3 +- gdb: fix crashes when debugging threads with Arm Pointer Authentication enabled +- gdb: Upgrade to 13.2 +- git: Upgrade to 2.39.3 +- glib-networking: use correct error code in ptest +- glibc: Pass linker choice via compiler flags +- glibc: stable 2.37 branch updates. +- gnupg: Upgrade to 2.4.2 +- go.bbclass: don't use test to check output from ls +- go: Upgrade to 1.20.5 +- go: Use -no-pie to build target cgo +- gobject-introspection: remove obsolete :term:`DEPENDS` +- grub: submit determinism.patch upstream +- gstreamer1.0: Upgrade to 1.22.3 +- gtk4: Upgrade to 4.10.4 +- image-live.bbclass: respect :term:`IMAGE_MACHINE_SUFFIX` +- image_types: Fix reproducible builds for initramfs and UKI img +- inetutils: remove unused patch files +- ipk: Revert Decode byte data to string in manifest handling +- iso-codes: Upgrade to 4.15.0 +- kernel: don't force PAHOLE=false +- kmod: remove unused ptest.patch +- kmscube: Correct :term:`DEPENDS` to avoid overwrite +- layer.conf: Add missing dependency exclusion +- lib/terminal.py: Add urxvt terminal +- libbsd: Add correct license for all packages +- libdnf: Upgrade to 0.70.1 +- libgcrypt: Upgrade to 1.10.2 +- libgloss: remove unused patch file +- libmicrohttpd: Upgrade to 0.9.77 +- libmodule-build-perl: Upgrade to 0.4234 +- libx11: remove unused patch and :term:`FILESEXTRAPATHS` +- libx11: Upgrade to 1.8.5 +- libxfixes: Upgrade to v6.0.1 +- libxft: Upgrade to 2.3.8 +- libxi: Upgrade to v1.8.1 +- libxml2: Do not use lld linker when building with tests on rv64 +- libxml2: Upgrade to 2.10.4 +- libxpm: Upgrade to 3.5.16 +- linux-firmware: Upgrade to 20230515 +- linux-yocto/5.15: cfg: fix DECNET configuration warning +- linux-yocto/5.15: Upgrade to v5.15.118 +- linux-yocto/6.1: fix intermittent x86 boot hangs +- linux-yocto/6.1: Upgrade to v6.1.35 +- linux-yocto: move build / debug dependencies to .inc +- logrotate: Do not create logrotate.status file +- maintainers.inc: correct Carlos Rafael Giani's email address +- maintainers.inc: correct unassigned entries +- maintainers.inc: unassign Adrian Bunk from wireless-regdb +- maintainers.inc: unassign Alistair Francis from opensbi +- maintainers.inc: unassign Andreas Müller from itstool entry +- maintainers.inc: unassign Chase Qi from libc-test +- maintainers.inc: unassign Oleksandr Kravchuk from python3 and all other items +- maintainers.inc: unassign Pascal Bach from cmake entry +- maintainers.inc: unassign Ricardo Neri from ovmf +- maintainers.inc: update version for gcc-source +- maintainers.inc: unassign Richard Weinberger from erofs-utils entry +- meta: depend on autoconf-archive-native, not autoconf-archive +- meta: lib: oe: npm_registry: Add more safe caracters +- migration-guides: add release notes for 4.2.1 +- minicom: remove unused patch files +- mobile-broadband-provider-info: Upgrade to 20230416 +- musl: Correct :term:`SRC_URI` +- oeqa/selftest/bbtests: add non-existent prefile/postfile tests +- oeqa/selftest/cases/devtool.py: skip all tests require folder a git repo +- oeqa: adding selftest-hello and use it to speed up tests +- openssh: Remove BSD-4-clause contents completely from codebase +- openssl: fix building on riscv32 +- openssl: Upgrade to 3.1.1 +- overview-manual: concepts.rst: Fix a typo +- parted: Add missing libuuid to linker cmdline for libparted-fs-resize.so +- perf: Make built-in libtraceevent plugins cohabit with external libtraceevent +- piglit: Add missing glslang dependencies +- piglit: Fix c++11-narrowing warnings in tests +- pkgconf: Upgrade to 1.9.5 +- pm-utils: fix multilib conflictions +- poky.conf: bump version for 4.2.2 release +- populate_sdk_base.bbclass: respect :term:`MLPREFIX` for ptest-pkgs's ptest-runner +- profile-manual: fix blktrace remote usage instructions +- psmisc: Set :term:`ALTERNATIVE` for pstree to resolve conflict with busybox +- ptest-runner: Ensure data writes don't race +- ptest-runner: Pull in "runner: Remove threads and mutexes" fix +- ptest-runner: Pull in sync fix to improve log warnings +- python3-bcrypt: Use BFD linker when building tests +- python3-numpy: remove NPY_INLINE, use inline instead +- qemu: a pending patch was submitted and accepted upstream +- qemu: remove unused qemu-7.0.0-glibc-2.36.patch +- qemurunner.py: fix error message about qmp +- qemurunner: avoid leaking server_socket +- ref-manual: add clarification for :term:`SRCREV` +- ref-manual: classes.rst: fix typo +- rootfs-postcommands.bbclass: add post func remove_unused_dnf_log_lock +- rpcsvc-proto: Upgrade to 1.4.4 +- rpm: drop unused 0001-Rip-out-partial-support-for-unused-MD2-and-RIPEMD160.patch +- rpm: Upgrade to 4.18.1 +- rpm: write macros under libdir +- runqemu-gen-tapdevs: Refactoring +- runqemu-ifupdown/get-tapdevs: Add support for ip tuntap +- scripts/runqemu: allocate unfsd ports in a way that doesn't race or clash with unrelated processes +- scripts/runqemu: split lock dir creation into a reusable function +- scripts: fix buildstats diff/summary hard bound to host python3 +- sdk.py: error out when moving file fails +- sdk.py: fix moving dnf contents +- selftest/license: Exclude from world +- selftest/reproducible: Allow native/cross reuse in test +- serf: Upgrade to 1.3.10 +- staging.bbclass: do not add extend_recipe_sysroot to prefuncs of prepare_recipe_sysroot +- strace: Disable failing test +- strace: Merge two similar patches +- strace: Update patches/tests with upstream fixes +- sysfsutils: fetch a supported fork from github +- systemd-systemctl: support instance expansion in WantedBy +- systemd: Drop a backport +- tiff: Remove unused patch from tiff +- uninative: Upgrade to 3.10 to support gcc 13 +- uninative: Upgrade to 4.0 to include latest gcc 13.1.1 +- unzip: fix configure check for cross compilation +- unzip: remove hardcoded LARGE_FILE_SUPPORT +- useradd-example: package typo correction +- useradd-staticids.bbclass: improve error message +- v86d: Improve kernel dependency +- vim: Upgrade to 9.0.1527 +- weston-init: add profile to point users to global socket +- weston-init: add the weston user to the wayland group +- weston-init: add weston user to the render group +- weston-init: fix the mixed indentation +- weston-init: guard against systemd configs +- weston-init: make sure the render group exists +- wget: Upgrade to 1.21.4 +- wireless-regdb: Upgrade to 2023.05.03 +- xdpyinfo: Upgrade to 1.3.4 +- xf86-video-intel: Use the HTTPS protocol to fetch the Git repositories +- xinput: upgrade to v1.6.4 +- xwininfo: upgrade to v1.1.6 +- xz: Upgrade to 5.4.3 +- yocto-bsps: update to v5.15.106 +- zip: fix configure check by using _Static_assert +- zip: remove unnecessary LARGE_FILE_SUPPORT CLFAGS + + +Known Issues in Yocto-4.2.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.2.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alberto Planas +- Alejandro Hernandez Samaniego +- Alexander Kanavin +- Andrej Valek +- Andrew Jeffery +- Anuj Mittal +- Archana Polampalli +- BELOUARGA Mohamed +- Bruce Ashfield +- Changqing Li +- Charlie Wu +- Chen Qi +- Chi Xu +- Daniel Ammann +- Deepthi Hemraj +- Denys Dmytriyenko +- Dmitry Baryshkov +- Ed Beroset +- Eero Aaltonen +- Fabien Mahot +- Frieder Paape +- Frieder Schrempf +- Hannu Lounento +- Ian Ray +- Jermain Horsman +- Jörg Sommer +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Lorenzo Arena +- Marc Ferland +- Markus Volk +- Martin Jansa +- Michael Halstead +- Mikko Rapeli +- Mingli Yu +- Natasha Bailey +- Nikhil R +- Pablo Saavedra +- Paul Gortmaker +- Pavel Zhukov +- Peter Kjellerstedt +- Qiu Tingting +- Quentin Schulz +- Randolph Sapp +- Randy MacLeod +- Ranjitsinh Rathod +- Richard Purdie +- Riyaz Khan +- Ross Burton +- Sakib Sajal +- Sanjay Chitroda +- Siddharth Doshi +- Soumya Sambu +- Steve Sakoman +- Sudip Mukherjee +- Sundeep KOKKONDA +- Thomas Roos +- Tim Orling +- Tom Hochstein +- Trevor Gamblin +- Ulrich Ölmann +- Wang Mingyu +- Xiangyu Chen + + +Repositories / Downloads for Yocto-4.2.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`mickledore </poky/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.2 </poky/log/?h=yocto-4.2.2>` +- Git Revision: :yocto_git:`6e17b3e644ca15b8b4afd071ccaa6f172a0e681a </poky/commit/?id=6e17b3e644ca15b8b4afd071ccaa6f172a0e681a>` +- Release Artefact: poky-6e17b3e644ca15b8b4afd071ccaa6f172a0e681a +- sha: c0b4dadcf00b97d866dd4cc2f162474da2c3e3289badaa42a978bff1d479af99 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.2/poky-6e17b3e644ca15b8b4afd071ccaa6f172a0e681a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.2/poky-6e17b3e644ca15b8b4afd071ccaa6f172a0e681a.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`mickledore </openembedded-core/log/?h=mickledore>` +- Tag: :oe_git:`yocto-4.2.2 </openembedded-core/log/?h=yocto-4.2.2>` +- Git Revision: :oe_git:`3ef283e02b0b91daf64c3a589e1f6bb68d4f5aa1 </openembedded-core/commit/?id=3ef283e02b0b91daf64c3a589e1f6bb68d4f5aa1>` +- Release Artefact: oecore-3ef283e02b0b91daf64c3a589e1f6bb68d4f5aa1 +- sha: d2fd127f46e626fa4456c193af3dbd25d4b2565db59bc23be69a3b2dd4febed5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.2/oecore-3ef283e02b0b91daf64c3a589e1f6bb68d4f5aa1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.2/oecore-3ef283e02b0b91daf64c3a589e1f6bb68d4f5aa1.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`mickledore </meta-mingw/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.2 </meta-mingw/log/?h=yocto-4.2.2>` +- Git Revision: :yocto_git:`4608d0bb7e47c52b8f6e9be259bfb1716fda9fd6 </meta-mingw/commit/?id=4608d0bb7e47c52b8f6e9be259bfb1716fda9fd6>` +- Release Artefact: meta-mingw-4608d0bb7e47c52b8f6e9be259bfb1716fda9fd6 +- sha: fcbae0dedb363477492b86b8f997e06f995793285535b24dc66038845483eeef +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.2/meta-mingw-4608d0bb7e47c52b8f6e9be259bfb1716fda9fd6.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.2/meta-mingw-4608d0bb7e47c52b8f6e9be259bfb1716fda9fd6.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.4 </bitbake/log/?h=2.4>` +- Tag: :oe_git:`yocto-4.2.2 </bitbake/log/?h=yocto-4.2.2>` +- Git Revision: :oe_git:`08033b63ae442c774bd3fce62844eac23e6882d7 </bitbake/commit/?id=08033b63ae442c774bd3fce62844eac23e6882d7>` +- Release Artefact: bitbake-08033b63ae442c774bd3fce62844eac23e6882d7 +- sha: 1d070c133bfb6502ac04befbf082cbfda7582c8b1c48296a788384352e5061fd +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.2/bitbake-08033b63ae442c774bd3fce62844eac23e6882d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.2/bitbake-08033b63ae442c774bd3fce62844eac23e6882d7.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`mickledore </yocto-docs/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.2 </yocto-docs/log/?h=yocto-4.2.2>` +- Git Revision: :yocto_git:`54d849d259a332389beea159d789f8fa92871475 </yocto-docs/commit/?id=54d849d259a332389beea159d789f8fa92871475>` + diff --git a/documentation/migration-guides/release-notes-4.2.3.rst b/documentation/migration-guides/release-notes-4.2.3.rst new file mode 100644 index 0000000000..3b568a1c29 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.2.3.rst @@ -0,0 +1,263 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.2.3 (Mickledore) +------------------------------------------ + +Security Fixes in Yocto-4.2.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-2828` and :cve:`2023-2911` +- cups: Fix :cve:`2023-34241` +- dmidecode: Fix :cve:`2023-30630` +- erofs-utils: Fix :cve:`2023-33551` and :cve:`2023-33552` +- ghostscript: Fix :cve:`2023-36664` +- go: Fix :cve_mitre:`2023-24531` +- libarchive: ignore :cve:`2023-30571` +- libjpeg-turbo: Fix :cve:`2023-2804` +- libx11: Fix :cve:`2023-3138` +- ncurses: Fix :cve:`2023-29491` +- openssh: Fix :cve:`2023-38408` +- python3-certifi: Fix :cve:`2023-37920` +- python3-requests: Fix :cve:`2023-32681` +- python3: Ignore :cve:`2023-36632` +- qemu: fix :cve:`2023-0330`, :cve_mitre:`2023-2861`, :cve_mitre:`2023-3255` and :cve_mitre:`2023-3301` +- ruby: Fix :cve:`2023-36617` +- vim: Fix :cve:`2023-2609` and :cve:`2023-2610` +- webkitgtk: Fix :cve:`2023-27932` and :cve:`2023-27954` + + +Fixes in Yocto-4.2.3 +~~~~~~~~~~~~~~~~~~~~ + +- acpica: Update :term:`SRC_URI` +- automake: fix buildtest patch +- baremetal-helloworld: Fix race condition +- bind: upgrade to v9.18.17 +- binutils: stable 2.40 branch updates +- build-appliance-image: Update to mickledore head revision +- cargo.bbclass: set up cargo environment in common do_compile +- conf.py: add macro for Mitre CVE links +- curl: ensure all ptest failures are caught +- cve-update-nvd2-native: actually use API keys +- cve-update-nvd2-native: fix cvssV3 metrics +- cve-update-nvd2-native: handle all configuration nodes, not just first +- cve-update-nvd2-native: increase retry count +- cve-update-nvd2-native: log a little more +- cve-update-nvd2-native: retry all errors and sleep between retries +- cve-update-nvd2-native: use exact times, don't truncate +- dev-manual: wic.rst: Update native tools build command +- devtool/upgrade: raise an error if extracting source produces more than one directory +- diffutils: upgrade to 3.10 +- docs: ref-manual: terms: fix typos in :term:`SPDX` term +- file: fix the way path is written to environment-setup.d +- file: return wrapper to fix builds when file is in buildtools-tarball +- freetype: upgrade to 2.13.1 +- gcc-testsuite: Fix ppc cpu specification +- gcc: don't pass --enable-standard-branch-protection +- glibc-locale: use stricter matching for metapackages' runtime dependencies +- glibc-testsuite: Fix network restrictions causing test failures +- glibc/check-test-wrapper: don't emit warnings from ssh +- go: upgrade to 1.20.6 +- gstreamer1.0: upgrade to 1.22.4 +- ifupdown: install missing directories +- kernel-module-split add systemd modulesloaddir and modprobedir config +- kernel-module-split: install config modules directories only when they are needed +- kernel-module-split: make autoload and probeconf distribution specific +- kernel-module-split: use context manager to open files +- kernel: Fix path comparison in kernel staging dir symlinking +- kernel: config modules directories are handled by kernel-module-split +- kernel: don't fail if Modules.symvers doesn't exist +- libassuan: upgrade to 2.5.6 +- libksba: upgrade to 1.6.4 +- libnss-nis: upgrade to 3.2 +- libproxy: fetch from git +- libwebp: upgrade to 1.3.1 +- libx11: upgrade to 1.8.6 +- libxcrypt: fix hard-coded ".so" extension +- linux-firmware : Add firmware of RTL8822 serie +- linux-firmware: Fix mediatek mt7601u firmware path +- linux-firmware: package firmare for Dragonboard 410c +- linux-firmware: split platform-specific Adreno shaders to separate packages +- linux-firmware: upgrade to 20230625 +- linux-yocto/5.15: update to v5.15.124 +- linux-yocto/6.1: cfg: update ima.cfg to match current meta-integrity +- linux-yocto/6.1: upgrade to v6.1.38 +- ltp: Add kernel loopback module dependency +- ltp: add :term:`RDEPENDS` on findutils +- lttng-ust: upgrade to 2.13.6 +- machine/arch-arm64: add -mbranch-protection=standard +- maintainers.inc: Modify email address +- mdadm: add util-linux-blockdev ptest dependency +- mdadm: fix 07revert-inplace ptest +- mdadm: fix segfaults when running ptests +- mdadm: fix util-linux ptest dependency +- mdadm: re-add mdadm-ptest to PTESTS_SLOW +- mdadm: skip running known broken ptests +- meson.bbclass: Point to llvm-config from native sysroot +- migration-guides: add release notes for 4.0.10 +- migration-guides: add release notes for 4.0.11 +- migration-guides: add release notes for 4.2.2 +- oeqa/runtime/cases/rpm: fix wait_for_no_process_for_user failure case +- oeqa/runtime/ltp: Increase ltp test output timeout +- oeqa/selftest/devtool: add unit test for "devtool add -b" +- oeqa/ssh: Further improve process exit handling +- oeqa/target/ssh: Ensure EAGAIN doesn't truncate output +- oeqa/utils/nfs: allow requesting non-udp ports +- openssh: upgrade to 9.3p2 +- openssl: add PERLEXTERNAL path to test its existence +- openssl: use a glob on the PERLEXTERNAL to track updates on the path +- opkg-utils: upgrade to 0.6.2 +- opkg: upgrade to 0.6.2 +- pkgconf: update :term:`SRC_URI` +- poky.conf: bump version for 4.2.3 release +- poky.conf: update :term:`SANITY_TESTED_DISTROS` to match autobuilder +- ptest-runner: Pull in parallel test fixes and output handling +- python3-certifi: upgrade to 2023.7.22 +- python3: fix missing comma in get_module_deps3.py +- recipetool: Fix inherit in created -native* recipes +- ref-manual: LTS releases now supported for 4 years +- ref-manual: document image-specific variant of :term:`INCOMPATIBLE_LICENSE` +- ref-manual: releases.svg: updates +- resulttool/resultutils: allow index generation despite corrupt json +- rootfs-postcommands.bbclass: Revert "add post func remove_unused_dnf_log_lock" +- rootfs: Add debugfs package db file copy and cleanup +- rootfs_rpm: don't depend on opkg-native for update-alternatives +- rpm: Pick debugfs package db files/dirs explicitly +- rust-common.bbclass: move musl-specific linking fix from rust-source.inc +- scripts/oe-setup-builddir: copy conf-notes.txt to build dir +- scripts/resulttool: add mention about new detected tests +- selftest/cases/glibc.py: fix the override syntax +- selftest/cases/glibc.py: increase the memory for testing +- selftest/cases/glibc.py: switch to using NFS over TCP +- shadow-sysroot: add license information +- systemd-systemctl: fix errors in instance name expansion +- taglib: upgrade to 1.13.1 +- target/ssh: Ensure exit code set for commands +- tcf-agent: upgrade to 1.8.0 +- testimage/oeqa: Drop testimage_dump_host functionality +- tiff: upgrade to 4.5.1 +- uboot-extlinux-config.bbclass: fix old override syntax in comment +- util-linux: add alternative links for ipcs,ipcrm +- vim: upgrade to 9.0.1592 +- webkitgtk: upgrade to 2.38.6 +- weston: Cleanup and fix x11 and xwayland dependencies + + +Known Issues in Yocto-4.2.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.2.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alejandro Hernandez Samaniego +- Alex Kiernan +- Alexander Kanavin +- Alexis Lothoré +- Andrej Valek +- Anuj Mittal +- Archana Polampalli +- BELOUARGA Mohamed +- Benjamin Bouvier +- Bruce Ashfield +- Changqing Li +- Chen Qi +- Daniel Semkowicz +- Dmitry Baryshkov +- Enrico Scholz +- Etienne Cordonnier +- Joe Slater +- Joel Stanley +- Jose Quaresma +- Julien Stephan +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Marek Vasut +- Mark Hatle +- Michael Halstead +- Michael Opdenacker +- Mingli Yu +- Narpat Mali +- Oleksandr Hnatiuk +- Ovidiu Panait +- Peter Marko +- Quentin Schulz +- Richard Purdie +- Ross Burton +- Sanjana +- Sakib Sajal +- Staffan Rydén +- Steve Sakoman +- Stéphane Veyret +- Sudip Mukherjee +- Thomas Roos +- Tom Hochstein +- Trevor Gamblin +- Wang Mingyu +- Yi Zhao +- Yoann Congal +- Yogita Urade +- Yuta Hayama + + +Repositories / Downloads for Yocto-4.2.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`mickledore </poky/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.3 </poky/log/?h=yocto-4.2.3>` +- Git Revision: :yocto_git:`aa63b25cbe25d89ab07ca11ee72c17cab68df8de </poky/commit/?id=aa63b25cbe25d89ab07ca11ee72c17cab68df8de>` +- Release Artefact: poky-aa63b25cbe25d89ab07ca11ee72c17cab68df8de +- sha: 9e2b40fc25f7984b3227126ec9b8aa68d3747c8821fb7bf8cb635fc143f894c3 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.3/poky-aa63b25cbe25d89ab07ca11ee72c17cab68df8de.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.3/poky-aa63b25cbe25d89ab07ca11ee72c17cab68df8de.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`mickledore </openembedded-core/log/?h=mickledore>` +- Tag: :oe_git:`yocto-4.2.3 </openembedded-core/log/?h=yocto-4.2.3>` +- Git Revision: :oe_git:`7e3489c0c5970389c8a239dc7b367bcadf554eb5 </openembedded-core/commit/?id=7e3489c0c5970389c8a239dc7b367bcadf554eb5>` +- Release Artefact: oecore-7e3489c0c5970389c8a239dc7b367bcadf554eb5 +- sha: 68620aca7c9db6b9a65d9853cacff4e60578f0df39e3e37114e062e1667ba724 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.3/oecore-7e3489c0c5970389c8a239dc7b367bcadf554eb5.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.3/oecore-7e3489c0c5970389c8a239dc7b367bcadf554eb5.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`mickledore </meta-mingw/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.3 </meta-mingw/log/?h=yocto-4.2.3>` +- Git Revision: :yocto_git:`92258028e1b5664a9f832541d5c4f6de0bd05e07 </meta-mingw/commit/?id=92258028e1b5664a9f832541d5c4f6de0bd05e07>` +- Release Artefact: meta-mingw-92258028e1b5664a9f832541d5c4f6de0bd05e07 +- sha: ee081460b5dff4fb8dd4869ce5631718dbaaffbede9532b879b854c18f1b3f5d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.3/meta-mingw-92258028e1b5664a9f832541d5c4f6de0bd05e07.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.3/meta-mingw-92258028e1b5664a9f832541d5c4f6de0bd05e07.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.4 </bitbake/log/?h=2.4>` +- Tag: :oe_git:`yocto-4.2.3 </bitbake/log/?h=yocto-4.2.3>` +- Git Revision: :oe_git:`08033b63ae442c774bd3fce62844eac23e6882d7 </bitbake/commit/?id=08033b63ae442c774bd3fce62844eac23e6882d7>` +- Release Artefact: bitbake-08033b63ae442c774bd3fce62844eac23e6882d7 +- sha: 1d070c133bfb6502ac04befbf082cbfda7582c8b1c48296a788384352e5061fd +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.3/bitbake-08033b63ae442c774bd3fce62844eac23e6882d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.3/bitbake-08033b63ae442c774bd3fce62844eac23e6882d7.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`mickledore </yocto-docs/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.3 </yocto-docs/log/?h=yocto-4.2.3>` +- Git Revision: :yocto_git:`8e6752a9e55d16f3713e248b37f9d4d2745a2375 </yocto-docs/commit/?id=8e6752a9e55d16f3713e248b37f9d4d2745a2375>` + diff --git a/documentation/migration-guides/release-notes-4.2.4.rst b/documentation/migration-guides/release-notes-4.2.4.rst new file mode 100644 index 0000000000..3c20140e29 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.2.4.rst @@ -0,0 +1,364 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.2.4 (Mickledore) +------------------------------------------ + +Security Fixes in Yocto-4.2.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-3341` and :cve:`2023-4236` +- binutils: Fix :cve:`2023-39128` +- cups: fix :cve:`2023-4504` +- curl: Fix :cve:`2023-28320`, :cve:`2023-32001`, :cve:`2023-38039`, :cve:`2023-38545` and :cve:`2023-38546` +- dmidecode: fix for :cve:`2023-30630` +- dropbear: fix :cve:`2023-36328` +- ffmpeg: Ignore :cve:`2023-39018` +- gcc: Fix :cve:`2023-4039` +- gdb: Fix :cve:`2023-39128` +- ghostscript: Fix :cve:`2023-38559` and :cve:`2023-43115` +- glibc: Fix :cve:`2023-4527` and :cve:`2023-4806` +- go: Fix :cve:`2023-29409` and :cve:`2023-39533` +- grub: Fix :cve:`2023-4692` and :cve:`2023-4693` +- gstreamer: Fix :cve_mitre:`2023-40474`, :cve_mitre:`2023-40475` and :cve_mitre:`2023-40476` +- inetutils: fix :cve:`2023-40303` +- librsvg: Fix :cve:`2023-38633` +- libssh2: Fix :cve:`2020-22218` +- libwebp: Fix :cve:`2023-4863` and :cve:`2023-5129` +- libx11: Fix :cve:`2023-43785`, :cve:`2023-43786` and :cve:`2023-43787` +- libxpm: Fix :cve:`2023-43788` and :cve:`2023-43789` +- linux-yocto/6.1: Ignore :cve:`2003-1604`, :cve:`2004-0230`, :cve:`2006-3635`, :cve:`2006-5331`, :cve:`2006-6128`, :cve:`2007-4774`, :cve:`2007-6761`, :cve:`2007-6762`, :cve:`2008-7316`, :cve:`2009-2692`, :cve:`2010-0008`, :cve:`2010-3432`, :cve:`2010-4648`, :cve:`2010-5313`, :cve:`2010-5328`, :cve:`2010-5329`, :cve:`2010-5331`, :cve:`2010-5332`, :cve:`2011-4098`, :cve:`2011-4131`, :cve:`2011-4915`, :cve:`2011-5321`, :cve:`2011-5327`, :cve:`2012-0957`, :cve:`2012-2119`, :cve:`2012-2136`, :cve:`2012-2137`, :cve:`2012-2313`, :cve:`2012-2319`, :cve:`2012-2372`, :cve:`2012-2375`, :cve:`2012-2390`, :cve:`2012-2669`, :cve:`2012-2744`, :cve:`2012-2745`, :cve:`2012-3364`, :cve:`2012-3375`, :cve:`2012-3400`, :cve:`2012-3412`, :cve:`2012-3430`, :cve:`2012-3510`, :cve:`2012-3511`, :cve:`2012-3520`, :cve:`2012-3552`, :cve:`2012-4398`, :cve:`2012-4444`, :cve:`2012-4461`, :cve:`2012-4467`, :cve:`2012-4508`, :cve:`2012-4530`, :cve:`2012-4565`, :cve:`2012-5374`, :cve:`2012-5375`, :cve:`2012-5517`, :cve:`2012-6536`, :cve:`2012-6537`, :cve:`2012-6538`, :cve:`2012-6539`, :cve:`2012-6540`, :cve:`2012-6541`, :cve:`2012-6542`, :cve:`2012-6543`, :cve:`2012-6544`, :cve:`2012-6545`, :cve:`2012-6546`, :cve:`2012-6547`, :cve:`2012-6548`, :cve:`2012-6549`, :cve:`2012-6638`, :cve:`2012-6647`, :cve:`2012-6657`, :cve:`2012-6689`, :cve:`2012-6701`, :cve:`2012-6703`, :cve:`2012-6704`, :cve:`2012-6712`, :cve:`2013-0160`, :cve:`2013-0190`, :cve:`2013-0216`, :cve:`2013-0217`, :cve:`2013-0228`, :cve:`2013-0231`, :cve:`2013-0268`, :cve:`2013-0290`, :cve:`2013-0309`, :cve:`2013-0310`, :cve:`2013-0311`, :cve:`2013-0313`, :cve:`2013-0343`, :cve:`2013-0349`, :cve:`2013-0871`, :cve:`2013-0913`, :cve:`2013-0914`, :cve:`2013-1059`, :cve:`2013-1763`, :cve:`2013-1767`, :cve:`2013-1772`, :cve:`2013-1773`, :cve:`2013-1774`, :cve:`2013-1792`, :cve:`2013-1796`, :cve:`2013-1797`, :cve:`2013-1798`, :cve:`2013-1819`, :cve:`2013-1826`, :cve:`2013-1827`, :cve:`2013-1828`, :cve:`2013-1848`, :cve:`2013-1858`, :cve:`2013-1860`, :cve:`2013-1928`, :cve:`2013-1929`, :cve:`2013-1943`, :cve:`2013-1956`, :cve:`2013-1957`, :cve:`2013-1958`, :cve:`2013-1959`, :cve:`2013-1979`, :cve:`2013-2015`, :cve:`2013-2017`, :cve:`2013-2058`, :cve:`2013-2094`, :cve:`2013-2128`, :cve:`2013-2140`, :cve:`2013-2141`, :cve:`2013-2146`, :cve:`2013-2147`, :cve:`2013-2148`, :cve:`2013-2164`, :cve:`2013-2206`, :cve:`2013-2232`, :cve:`2013-2234`, :cve:`2013-2237`, :cve:`2013-2546`, :cve:`2013-2547`, :cve:`2013-2548`, :cve:`2013-2596`, :cve:`2013-2634`, :cve:`2013-2635`, :cve:`2013-2636`, :cve:`2013-2850`, :cve:`2013-2851`, :cve:`2013-2852`, :cve:`2013-2888`, :cve:`2013-2889`, :cve:`2013-2890`, :cve:`2013-2891`, :cve:`2013-2892`, :cve:`2013-2893`, :cve:`2013-2894`, :cve:`2013-2895`, :cve:`2013-2896`, :cve:`2013-2897`, :cve:`2013-2898`, :cve:`2013-2899`, :cve:`2013-2929`, :cve:`2013-2930`, :cve:`2013-3076`, :cve:`2013-3222`, :cve:`2013-3223`, :cve:`2013-3224`, :cve:`2013-3225`, :cve:`2013-3226`, :cve:`2013-3227`, :cve:`2013-3228`, :cve:`2013-3229`, :cve:`2013-3230`, :cve:`2013-3231`, :cve:`2013-3232`, :cve:`2013-3233`, :cve:`2013-3234`, :cve:`2013-3235`, :cve:`2013-3236`, :cve:`2013-3237`, :cve:`2013-3301`, :cve:`2013-3302`, :cve:`2013-4125`, :cve:`2013-4127`, :cve:`2013-4129`, :cve:`2013-4162`, :cve:`2013-4163`, :cve:`2013-4205`, :cve:`2013-4220`, :cve:`2013-4247`, :cve:`2013-4254`, :cve:`2013-4270`, :cve:`2013-4299`, :cve:`2013-4300`, :cve:`2013-4312`, :cve:`2013-4343`, :cve:`2013-4345`, :cve:`2013-4348`, :cve:`2013-4350`, :cve:`2013-4387`, :cve:`2013-4470`, :cve:`2013-4483`, :cve:`2013-4511`, :cve:`2013-4512`, :cve:`2013-4513`, :cve:`2013-4514`, :cve:`2013-4515`, :cve:`2013-4516`, :cve:`2013-4563`, :cve:`2013-4579`, :cve:`2013-4587`, :cve:`2013-4588`, :cve:`2013-4591`, :cve:`2013-4592`, :cve:`2013-5634`, :cve:`2013-6282`, :cve:`2013-6367`, :cve:`2013-6368`, :cve:`2013-6376`, :cve:`2013-6378`, :cve:`2013-6380`, :cve:`2013-6381`, :cve:`2013-6382`, :cve:`2013-6383`, :cve:`2013-6431`, :cve:`2013-6432`, :cve:`2013-6885`, :cve:`2013-7026`, :cve:`2013-7027`, :cve:`2013-7263`, :cve:`2013-7264`, :cve:`2013-7265`, :cve:`2013-7266`, :cve:`2013-7267`, :cve:`2013-7268`, :cve:`2013-7269`, :cve:`2013-7270`, :cve:`2013-7271`, :cve:`2013-7281`, :cve:`2013-7339`, :cve:`2013-7348`, :cve:`2013-7421`, :cve:`2013-7446`, :cve:`2013-7470`, :cve:`2014-0038`, :cve:`2014-0049`, :cve:`2014-0055`, :cve:`2014-0069`, :cve:`2014-0077`, :cve:`2014-0100`, :cve:`2014-0101`, :cve:`2014-0102`, :cve:`2014-0131`, :cve:`2014-0155`, :cve:`2014-0181`, :cve:`2014-0196`, :cve:`2014-0203`, :cve:`2014-0205`, :cve:`2014-0206`, :cve:`2014-1438`, :cve:`2014-1444`, :cve:`2014-1445`, :cve:`2014-1446`, :cve:`2014-1690`, :cve:`2014-1737`, :cve:`2014-1738`, :cve:`2014-1739`, :cve:`2014-1874`, :cve:`2014-2038`, :cve:`2014-2039`, :cve:`2014-2309`, :cve:`2014-2523`, :cve:`2014-2568`, :cve:`2014-2580`, :cve:`2014-2672`, :cve:`2014-2673`, :cve:`2014-2678`, :cve:`2014-2706`, :cve:`2014-2739`, :cve:`2014-2851`, :cve:`2014-2889`, :cve:`2014-3122`, :cve:`2014-3144`, :cve:`2014-3145`, :cve:`2014-3153`, :cve:`2014-3180`, :cve:`2014-3181`, :cve:`2014-3182`, :cve:`2014-3183`, :cve:`2014-3184`, :cve:`2014-3185`, :cve:`2014-3186`, :cve:`2014-3534`, :cve:`2014-3535`, :cve:`2014-3601`, :cve:`2014-3610`, :cve:`2014-3611`, :cve:`2014-3631`, :cve:`2014-3645`, :cve:`2014-3646`, :cve:`2014-3647`, :cve:`2014-3673`, :cve:`2014-3687`, :cve:`2014-3688`, :cve:`2014-3690`, :cve:`2014-3917`, :cve:`2014-3940`, :cve:`2014-4014`, :cve:`2014-4027`, :cve:`2014-4157`, :cve:`2014-4171`, :cve:`2014-4508`, :cve:`2014-4608`, :cve:`2014-4611`, :cve:`2014-4652`, :cve:`2014-4653`, :cve:`2014-4654`, :cve:`2014-4655`, :cve:`2014-4656`, :cve:`2014-4667`, :cve:`2014-4699`, :cve:`2014-4943`, :cve:`2014-5045`, :cve:`2014-5077`, :cve:`2014-5206`, :cve:`2014-5207`, :cve:`2014-5471`, :cve:`2014-5472`, :cve:`2014-6410`, :cve:`2014-6416`, :cve:`2014-6417`, :cve:`2014-6418`, :cve:`2014-7145`, :cve:`2014-7283`, :cve:`2014-7284`, :cve:`2014-7822`, :cve:`2014-7825`, :cve:`2014-7826`, :cve:`2014-7841`, :cve:`2014-7842`, :cve:`2014-7843`, :cve:`2014-7970`, :cve:`2014-7975`, :cve:`2014-8086`, :cve:`2014-8133`, :cve:`2014-8134`, :cve:`2014-8159`, :cve:`2014-8160`, :cve:`2014-8171`, :cve:`2014-8172`, :cve:`2014-8173`, :cve:`2014-8369`, :cve:`2014-8480`, :cve:`2014-8481`, :cve:`2014-8559`, :cve:`2014-8709`, :cve:`2014-8884`, :cve:`2014-8989`, :cve:`2014-9090`, :cve:`2014-9322`, :cve:`2014-9419`, :cve:`2014-9420`, :cve:`2014-9428`, :cve:`2014-9529`, :cve:`2014-9584`, :cve:`2014-9585`, :cve:`2014-9644`, :cve:`2014-9683`, :cve:`2014-9710`, :cve:`2014-9715`, :cve:`2014-9717`, :cve:`2014-9728`, :cve:`2014-9729`, :cve:`2014-9730`, :cve:`2014-9731`, :cve:`2014-9803`, :cve:`2014-9870`, :cve:`2014-9888`, :cve:`2014-9895`, :cve:`2014-9903`, :cve:`2014-9904`, :cve:`2014-9914`, :cve:`2014-9922`, :cve:`2014-9940`, :cve:`2015-0239`, :cve:`2015-0274`, :cve:`2015-0275`, :cve:`2015-1333`, :cve:`2015-1339`, :cve:`2015-1350`, :cve:`2015-1420`, :cve:`2015-1421`, :cve:`2015-1465`, :cve:`2015-1573`, :cve:`2015-1593`, :cve:`2015-1805`, :cve:`2015-2041`, :cve:`2015-2042`, :cve:`2015-2150`, :cve:`2015-2666`, :cve:`2015-2672`, :cve:`2015-2686`, :cve:`2015-2830`, :cve:`2015-2922`, :cve:`2015-2925`, :cve:`2015-3212`, :cve:`2015-3214`, :cve:`2015-3288`, :cve:`2015-3290`, :cve:`2015-3291`, :cve:`2015-3331`, :cve:`2015-3339`, :cve:`2015-3636`, :cve:`2015-4001`, :cve:`2015-4002`, :cve:`2015-4003`, :cve:`2015-4004`, :cve:`2015-4036`, :cve:`2015-4167`, :cve:`2015-4170`, :cve:`2015-4176`, :cve:`2015-4177`, :cve:`2015-4178`, :cve:`2015-4692`, :cve:`2015-4700`, :cve:`2015-5156`, :cve:`2015-5157`, :cve:`2015-5257`, :cve:`2015-5283`, :cve:`2015-5307`, :cve:`2015-5327`, :cve:`2015-5364`, :cve:`2015-5366`, :cve:`2015-5697`, :cve:`2015-5706`, :cve:`2015-5707`, :cve:`2015-6252`, :cve:`2015-6526`, :cve:`2015-6937`, :cve:`2015-7509`, :cve:`2015-7513`, :cve:`2015-7515`, :cve:`2015-7550`, :cve:`2015-7566`, :cve:`2015-7613`, :cve:`2015-7799`, :cve:`2015-7833`, :cve:`2015-7872`, :cve:`2015-7884`, :cve:`2015-7885`, :cve:`2015-7990`, :cve:`2015-8104`, :cve:`2015-8215`, :cve:`2015-8324`, :cve:`2015-8374`, :cve:`2015-8539`, :cve:`2015-8543`, :cve:`2015-8550`, :cve:`2015-8551`, :cve:`2015-8552`, :cve:`2015-8553`, :cve:`2015-8569`, :cve:`2015-8575`, :cve:`2015-8660`, :cve:`2015-8709`, :cve:`2015-8746`, :cve:`2015-8767`, :cve:`2015-8785`, :cve:`2015-8787`, :cve:`2015-8812`, :cve:`2015-8816`, :cve:`2015-8830`, :cve:`2015-8839`, :cve:`2015-8844`, :cve:`2015-8845`, :cve:`2015-8950`, :cve:`2015-8952`, :cve:`2015-8953`, :cve:`2015-8955`, :cve:`2015-8956`, :cve:`2015-8961`, :cve:`2015-8962`, :cve:`2015-8963`, :cve:`2015-8964`, :cve:`2015-8966`, :cve:`2015-8967`, :cve:`2015-8970`, :cve:`2015-9004`, :cve:`2015-9016`, :cve:`2015-9289`, :cve:`2016-0617`, :cve:`2016-0723`, :cve:`2016-0728`, :cve:`2016-0758`, :cve:`2016-0821`, :cve:`2016-0823`, :cve:`2016-10044`, :cve:`2016-10088`, :cve:`2016-10147`, :cve:`2016-10150`, :cve:`2016-10153`, :cve:`2016-10154`, :cve:`2016-10200`, :cve:`2016-10208`, :cve:`2016-10229`, :cve:`2016-10318`, :cve:`2016-10723`, :cve:`2016-10741`, :cve:`2016-10764`, :cve:`2016-10905`, :cve:`2016-10906`, :cve:`2016-10907`, :cve:`2016-1237`, :cve:`2016-1575`, :cve:`2016-1576`, :cve:`2016-1583`, :cve:`2016-2053`, :cve:`2016-2069`, :cve:`2016-2070`, :cve:`2016-2085`, :cve:`2016-2117`, :cve:`2016-2143`, :cve:`2016-2184`, :cve:`2016-2185`, :cve:`2016-2186`, :cve:`2016-2187`, :cve:`2016-2188`, :cve:`2016-2383`, :cve:`2016-2384`, :cve:`2016-2543`, :cve:`2016-2544`, :cve:`2016-2545`, :cve:`2016-2546`, :cve:`2016-2547`, :cve:`2016-2548`, :cve:`2016-2549`, :cve:`2016-2550`, :cve:`2016-2782`, :cve:`2016-2847`, :cve:`2016-3044`, :cve:`2016-3070`, :cve:`2016-3134`, :cve:`2016-3135`, :cve:`2016-3136`, :cve:`2016-3137`, :cve:`2016-3138`, :cve:`2016-3139`, :cve:`2016-3140`, :cve:`2016-3156`, :cve:`2016-3157`, :cve:`2016-3672`, :cve:`2016-3689`, :cve:`2016-3713`, :cve:`2016-3841`, :cve:`2016-3857`, :cve:`2016-3951`, :cve:`2016-3955`, :cve:`2016-3961`, :cve:`2016-4440`, :cve:`2016-4470`, :cve:`2016-4482`, :cve:`2016-4485`, :cve:`2016-4486`, :cve:`2016-4557`, :cve:`2016-4558`, :cve:`2016-4565`, :cve:`2016-4568`, :cve:`2016-4569`, :cve:`2016-4578`, :cve:`2016-4580`, :cve:`2016-4581`, :cve:`2016-4794`, :cve:`2016-4805`, :cve:`2016-4913`, :cve:`2016-4951`, :cve:`2016-4997`, :cve:`2016-4998`, :cve:`2016-5195`, :cve:`2016-5243`, :cve:`2016-5244`, :cve:`2016-5400`, :cve:`2016-5412`, :cve:`2016-5696`, :cve:`2016-5728`, :cve:`2016-5828`, :cve:`2016-5829`, :cve:`2016-6130`, :cve:`2016-6136`, :cve:`2016-6156`, :cve:`2016-6162`, :cve:`2016-6187`, :cve:`2016-6197`, :cve:`2016-6198`, :cve:`2016-6213`, :cve:`2016-6327`, :cve:`2016-6480`, :cve:`2016-6516`, :cve:`2016-6786`, :cve:`2016-6787`, :cve:`2016-6828`, :cve:`2016-7039`, :cve:`2016-7042`, :cve:`2016-7097`, :cve:`2016-7117`, :cve:`2016-7425`, :cve:`2016-7910`, :cve:`2016-7911`, :cve:`2016-7912`, :cve:`2016-7913`, :cve:`2016-7914`, :cve:`2016-7915`, :cve:`2016-7916`, :cve:`2016-7917`, :cve:`2016-8399`, :cve:`2016-8405`, :cve:`2016-8630`, :cve:`2016-8632`, :cve:`2016-8633`, :cve:`2016-8636`, :cve:`2016-8645`, :cve:`2016-8646`, :cve:`2016-8650`, :cve:`2016-8655`, :cve:`2016-8658`, :cve:`2016-8666`, :cve:`2016-9083`, :cve:`2016-9084`, :cve:`2016-9120`, :cve:`2016-9178`, :cve:`2016-9191`, :cve:`2016-9313`, :cve:`2016-9555`, :cve:`2016-9576`, :cve:`2016-9588`, :cve:`2016-9604`, :cve:`2016-9685`, :cve:`2016-9754`, :cve:`2016-9755`, :cve:`2016-9756`, :cve:`2016-9777`, :cve:`2016-9793`, :cve:`2016-9794`, :cve:`2016-9806`, :cve:`2016-9919`, :cve:`2017-0605`, :cve:`2017-0627`, :cve:`2017-0750`, :cve:`2017-0786`, :cve:`2017-0861`, :cve:`2017-1000`, :cve:`2017-1000111`, :cve:`2017-1000112`, :cve:`2017-1000251`, :cve:`2017-1000252`, :cve:`2017-1000253`, :cve:`2017-1000255`, :cve:`2017-1000363`, :cve:`2017-1000364`, :cve:`2017-1000365`, :cve:`2017-1000370`, :cve:`2017-1000371`, :cve:`2017-1000379`, :cve:`2017-1000380`, :cve:`2017-1000405`, :cve:`2017-1000407`, :cve:`2017-1000410`, :cve:`2017-10661`, :cve:`2017-10662`, :cve:`2017-10663`, :cve:`2017-10810`, :cve:`2017-10911`, :cve:`2017-11089`, :cve:`2017-11176`, :cve:`2017-11472`, :cve:`2017-11473`, :cve:`2017-11600`, :cve:`2017-12134`, :cve:`2017-12146`, :cve:`2017-12153`, :cve:`2017-12154`, :cve:`2017-12168`, :cve:`2017-12188`, :cve:`2017-12190`, :cve:`2017-12192`, :cve:`2017-12193`, :cve:`2017-12762`, :cve:`2017-13080`, :cve:`2017-13166`, :cve:`2017-13167`, :cve:`2017-13168`, :cve:`2017-13215`, :cve:`2017-13216`, :cve:`2017-13220`, :cve:`2017-13305`, :cve:`2017-13686`, :cve:`2017-13695`, :cve:`2017-13715`, :cve:`2017-14051`, :cve:`2017-14106`, :cve:`2017-14140`, :cve:`2017-14156`, :cve:`2017-14340`, :cve:`2017-14489`, :cve:`2017-14497`, :cve:`2017-14954`, :cve:`2017-14991`, :cve:`2017-15102`, :cve:`2017-15115`, :cve:`2017-15116`, :cve:`2017-15121`, :cve:`2017-15126`, :cve:`2017-15127`, :cve:`2017-15128`, :cve:`2017-15129`, :cve:`2017-15265`, :cve:`2017-15274`, :cve:`2017-15299`, :cve:`2017-15306`, :cve:`2017-15537`, :cve:`2017-15649`, :cve:`2017-15868`, :cve:`2017-15951`, :cve:`2017-16525`, :cve:`2017-16526`, :cve:`2017-16527`, :cve:`2017-16528`, :cve:`2017-16529`, :cve:`2017-16530`, :cve:`2017-16531`, :cve:`2017-16532`, :cve:`2017-16533`, :cve:`2017-16534`, :cve:`2017-16535`, :cve:`2017-16536`, :cve:`2017-16537`, :cve:`2017-16538`, :cve:`2017-16643`, :cve:`2017-16644`, :cve:`2017-16645`, :cve:`2017-16646`, :cve:`2017-16647`, :cve:`2017-16648`, :cve:`2017-16649`, :cve:`2017-16650`, :cve:`2017-16911`, :cve:`2017-16912`, :cve:`2017-16913`, :cve:`2017-16914`, :cve:`2017-16939`, :cve:`2017-16994`, :cve:`2017-16995`, :cve:`2017-16996`, :cve:`2017-17052`, :cve:`2017-17053`, :cve:`2017-17448`, :cve:`2017-17449`, :cve:`2017-17450`, :cve:`2017-17558`, :cve:`2017-17712`, :cve:`2017-17741`, :cve:`2017-17805`, :cve:`2017-17806`, :cve:`2017-17807`, :cve:`2017-17852`, :cve:`2017-17853`, :cve:`2017-17854`, :cve:`2017-17855`, :cve:`2017-17856`, :cve:`2017-17857`, :cve:`2017-17862`, :cve:`2017-17863`, :cve:`2017-17864`, :cve:`2017-17975`, :cve:`2017-18017`, :cve:`2017-18075`, :cve:`2017-18079`, :cve:`2017-18174`, :cve:`2017-18193`, :cve:`2017-18200`, :cve:`2017-18202`, :cve:`2017-18203`, :cve:`2017-18204`, :cve:`2017-18208`, :cve:`2017-18216`, :cve:`2017-18218`, :cve:`2017-18221`, :cve:`2017-18222`, :cve:`2017-18224`, :cve:`2017-18232`, :cve:`2017-18241`, :cve:`2017-18249`, :cve:`2017-18255`, :cve:`2017-18257`, :cve:`2017-18261`, :cve:`2017-18270`, :cve:`2017-18344`, :cve:`2017-18360`, :cve:`2017-18379`, :cve:`2017-18509`, :cve:`2017-18549`, :cve:`2017-18550`, :cve:`2017-18551`, :cve:`2017-18552`, :cve:`2017-18595`, :cve:`2017-2583`, :cve:`2017-2584`, :cve:`2017-2596`, :cve:`2017-2618`, :cve:`2017-2634`, :cve:`2017-2636`, :cve:`2017-2647`, :cve:`2017-2671`, :cve:`2017-5123`, :cve:`2017-5546`, :cve:`2017-5547`, :cve:`2017-5548`, :cve:`2017-5549`, :cve:`2017-5550`, :cve:`2017-5551`, :cve:`2017-5576`, :cve:`2017-5577`, :cve:`2017-5669`, :cve:`2017-5715`, :cve:`2017-5753`, :cve:`2017-5754`, :cve:`2017-5897`, :cve:`2017-5967`, :cve:`2017-5970`, :cve:`2017-5972`, :cve:`2017-5986`, :cve:`2017-6001`, :cve:`2017-6074`, :cve:`2017-6214`, :cve:`2017-6345`, :cve:`2017-6346`, :cve:`2017-6347`, :cve:`2017-6348`, :cve:`2017-6353`, :cve:`2017-6874`, :cve:`2017-6951`, :cve:`2017-7184`, :cve:`2017-7187`, :cve:`2017-7261`, :cve:`2017-7273`, :cve:`2017-7277`, :cve:`2017-7294`, :cve:`2017-7308`, :cve:`2017-7346`, :cve:`2017-7374`, :cve:`2017-7472`, :cve:`2017-7477`, :cve:`2017-7482`, :cve:`2017-7487`, :cve:`2017-7495`, :cve:`2017-7518`, :cve:`2017-7533`, :cve:`2017-7541`, :cve:`2017-7542`, :cve:`2017-7558`, :cve:`2017-7616`, :cve:`2017-7618`, :cve:`2017-7645`, :cve:`2017-7889`, :cve:`2017-7895`, :cve:`2017-7979`, :cve:`2017-8061`, :cve:`2017-8062`, :cve:`2017-8063`, :cve:`2017-8064`, :cve:`2017-8065`, :cve:`2017-8066`, :cve:`2017-8067`, :cve:`2017-8068`, :cve:`2017-8069`, :cve:`2017-8070`, :cve:`2017-8071`, :cve:`2017-8072`, :cve:`2017-8106`, :cve:`2017-8240`, :cve:`2017-8797`, :cve:`2017-8824`, :cve:`2017-8831`, :cve:`2017-8890`, :cve:`2017-8924`, :cve:`2017-8925`, :cve:`2017-9059`, :cve:`2017-9074`, :cve:`2017-9075`, :cve:`2017-9076`, :cve:`2017-9077`, :cve:`2017-9150`, :cve:`2017-9211`, :cve:`2017-9242`, :cve:`2017-9605`, :cve:`2017-9725`, :cve:`2017-9984`, :cve:`2017-9985`, :cve:`2017-9986`, :cve:`2018-1000004`, :cve:`2018-1000026`, :cve:`2018-1000028`, :cve:`2018-1000199`, :cve:`2018-1000200`, :cve:`2018-1000204`, :cve:`2018-10021`, :cve:`2018-10074`, :cve:`2018-10087`, :cve:`2018-10124`, :cve:`2018-10322`, :cve:`2018-10323`, :cve:`2018-1065`, :cve:`2018-1066`, :cve:`2018-10675`, :cve:`2018-1068`, :cve:`2018-10840`, :cve:`2018-10853`, :cve:`2018-1087`, :cve:`2018-10876`, :cve:`2018-10877`, :cve:`2018-10878`, :cve:`2018-10879`, :cve:`2018-10880`, :cve:`2018-10881`, :cve:`2018-10882`, :cve:`2018-10883`, :cve:`2018-10901`, :cve:`2018-10902`, :cve:`2018-1091`, :cve:`2018-1092`, :cve:`2018-1093`, :cve:`2018-10938`, :cve:`2018-1094`, :cve:`2018-10940`, :cve:`2018-1095`, :cve:`2018-1108`, :cve:`2018-1118`, :cve:`2018-1120`, :cve:`2018-11232`, :cve:`2018-1128`, :cve:`2018-1129`, :cve:`2018-1130`, :cve:`2018-11412`, :cve:`2018-11506`, :cve:`2018-11508`, :cve:`2018-12126`, :cve:`2018-12127`, :cve:`2018-12130`, :cve:`2018-12207`, :cve:`2018-12232`, :cve:`2018-12233`, :cve:`2018-12633`, :cve:`2018-12714`, :cve:`2018-12896`, :cve:`2018-12904`, :cve:`2018-13053`, :cve:`2018-13093`, :cve:`2018-13094`, :cve:`2018-13095`, :cve:`2018-13096`, :cve:`2018-13097`, :cve:`2018-13098`, :cve:`2018-13099`, :cve:`2018-13100`, :cve:`2018-13405`, :cve:`2018-13406`, :cve:`2018-14609`, :cve:`2018-14610`, :cve:`2018-14611`, :cve:`2018-14612`, :cve:`2018-14613`, :cve:`2018-14614`, :cve:`2018-14615`, :cve:`2018-14616`, :cve:`2018-14617`, :cve:`2018-14619`, :cve:`2018-14625`, :cve:`2018-14633`, :cve:`2018-14634`, :cve:`2018-14641`, :cve:`2018-14646`, :cve:`2018-14656`, :cve:`2018-14678`, :cve:`2018-14734`, :cve:`2018-15471`, :cve:`2018-15572`, :cve:`2018-15594`, :cve:`2018-16276`, :cve:`2018-16597`, :cve:`2018-16658`, :cve:`2018-16862`, :cve:`2018-16871`, :cve:`2018-16880`, :cve:`2018-16882`, :cve:`2018-16884`, :cve:`2018-17182`, :cve:`2018-17972`, :cve:`2018-18021`, :cve:`2018-18281`, :cve:`2018-18386`, :cve:`2018-18397`, :cve:`2018-18445`, :cve:`2018-18559`, :cve:`2018-18690`, :cve:`2018-18710`, :cve:`2018-18955`, :cve:`2018-19406`, :cve:`2018-19407`, :cve:`2018-19824`, :cve:`2018-19854`, :cve:`2018-19985`, :cve:`2018-20169`, :cve:`2018-20449`, :cve:`2018-20509`, :cve:`2018-20510`, :cve:`2018-20511`, :cve:`2018-20669`, :cve:`2018-20784`, :cve:`2018-20836`, :cve:`2018-20854`, :cve:`2018-20855`, :cve:`2018-20856`, :cve:`2018-20961`, :cve:`2018-20976`, :cve:`2018-21008`, :cve:`2018-25015`, :cve:`2018-25020`, :cve:`2018-3620`, :cve:`2018-3639`, :cve:`2018-3646`, :cve:`2018-3665`, :cve:`2018-3693`, :cve:`2018-5332`, :cve:`2018-5333`, :cve:`2018-5344`, :cve:`2018-5390`, :cve:`2018-5391`, :cve:`2018-5703`, :cve:`2018-5750`, :cve:`2018-5803`, :cve:`2018-5814`, :cve:`2018-5848`, :cve:`2018-5873`, :cve:`2018-5953`, :cve:`2018-5995`, :cve:`2018-6412`, :cve:`2018-6554`, :cve:`2018-6555`, :cve:`2018-6927`, :cve:`2018-7191`, :cve:`2018-7273`, :cve:`2018-7480`, :cve:`2018-7492`, :cve:`2018-7566`, :cve:`2018-7740`, :cve:`2018-7754`, :cve:`2018-7755`, :cve:`2018-7757`, :cve:`2018-7995`, :cve:`2018-8043`, :cve_mitre:`2018-8087`, :cve_mitre:`2018-8781`, :cve_mitre:`2018-8822`, :cve_mitre:`2018-8897`, :cve_mitre:`2018-9363`, :cve_mitre:`2018-9385`, :cve_mitre:`2018-9415`, :cve_mitre:`2018-9422`, :cve_mitre:`2018-9465`, :cve_mitre:`2018-9516`, :cve_mitre:`2018-9517`, :cve_mitre:`2018-9518` and :cve_mitre:`2018-9568` +- linux-yocto/6.1 (Continued): Ignore :cve:`2019-0136`, :cve:`2019-0145`, :cve:`2019-0146`, :cve:`2019-0147`, :cve:`2019-0148`, :cve:`2019-0149`, :cve:`2019-0154`, :cve:`2019-0155`, :cve:`2019-10124`, :cve:`2019-10125`, :cve:`2019-10126`, :cve:`2019-10142`, :cve:`2019-10207`, :cve:`2019-10220`, :cve:`2019-10638`, :cve:`2019-10639`, :cve:`2019-11085`, :cve:`2019-11091`, :cve:`2019-11135`, :cve:`2019-11190`, :cve:`2019-11191`, :cve:`2019-1125`, :cve:`2019-11477`, :cve:`2019-11478`, :cve:`2019-11479`, :cve:`2019-11486`, :cve:`2019-11487`, :cve:`2019-11599`, :cve:`2019-11683`, :cve:`2019-11810`, :cve:`2019-11811`, :cve:`2019-11815`, :cve:`2019-11833`, :cve:`2019-11884`, :cve:`2019-12378`, :cve:`2019-12379`, :cve:`2019-12380`, :cve:`2019-12381`, :cve:`2019-12382`, :cve:`2019-12454`, :cve:`2019-12455`, :cve:`2019-12614`, :cve:`2019-12615`, :cve:`2019-12817`, :cve:`2019-12818`, :cve:`2019-12819`, :cve:`2019-12881`, :cve:`2019-12984`, :cve:`2019-13233`, :cve:`2019-13272`, :cve:`2019-13631`, :cve:`2019-13648`, :cve:`2019-14283`, :cve:`2019-14284`, :cve:`2019-14615`, :cve:`2019-14763`, :cve:`2019-14814`, :cve:`2019-14815`, :cve:`2019-14816`, :cve:`2019-14821`, :cve:`2019-14835`, :cve:`2019-14895`, :cve:`2019-14896`, :cve:`2019-14897`, :cve:`2019-14901`, :cve:`2019-15030`, :cve:`2019-15031`, :cve:`2019-15090`, :cve:`2019-15098`, :cve:`2019-15099`, :cve:`2019-15117`, :cve:`2019-15118`, :cve:`2019-15211`, :cve:`2019-15212`, :cve:`2019-15213`, :cve:`2019-15214`, :cve:`2019-15215`, :cve:`2019-15216`, :cve:`2019-15217`, :cve:`2019-15218`, :cve:`2019-15219`, :cve:`2019-15220`, :cve:`2019-15221`, :cve:`2019-15222`, :cve:`2019-15223`, :cve:`2019-15291`, :cve:`2019-15292`, :cve:`2019-15504`, :cve:`2019-15505`, :cve:`2019-15538`, :cve:`2019-15666`, :cve:`2019-15794`, :cve:`2019-15807`, :cve:`2019-15916`, :cve:`2019-15917`, :cve:`2019-15918`, :cve:`2019-15919`, :cve:`2019-15920`, :cve:`2019-15921`, :cve:`2019-15922`, :cve:`2019-15923`, :cve:`2019-15924`, :cve:`2019-15925`, :cve:`2019-15926`, :cve:`2019-15927`, :cve:`2019-16229`, :cve:`2019-16230`, :cve:`2019-16231`, :cve:`2019-16232`, :cve:`2019-16233`, :cve:`2019-16234`, :cve:`2019-16413`, :cve:`2019-16714`, :cve:`2019-16746`, :cve:`2019-16921`, :cve:`2019-16994`, :cve:`2019-16995`, :cve:`2019-17052`, :cve:`2019-17053`, :cve:`2019-17054`, :cve:`2019-17055`, :cve:`2019-17056`, :cve:`2019-17075`, :cve:`2019-17133`, :cve:`2019-17351`, :cve:`2019-17666`, :cve:`2019-18198`, :cve:`2019-18282`, :cve:`2019-18660`, :cve:`2019-18675`, :cve:`2019-18683`, :cve:`2019-18786`, :cve:`2019-18805`, :cve:`2019-18806`, :cve:`2019-18807`, :cve:`2019-18808`, :cve:`2019-18809`, :cve:`2019-18810`, :cve:`2019-18811`, :cve:`2019-18812`, :cve:`2019-18813`, :cve:`2019-18814`, :cve:`2019-18885`, :cve:`2019-19036`, :cve:`2019-19037`, :cve:`2019-19039`, :cve:`2019-19043`, :cve:`2019-19044`, :cve:`2019-19045`, :cve:`2019-19046`, :cve:`2019-19047`, :cve:`2019-19048`, :cve:`2019-19049`, :cve:`2019-19050`, :cve:`2019-19051`, :cve:`2019-19052`, :cve:`2019-19053`, :cve:`2019-19054`, :cve:`2019-19055`, :cve:`2019-19056`, :cve:`2019-19057`, :cve:`2019-19058`, :cve:`2019-19059`, :cve:`2019-19060`, :cve:`2019-19061`, :cve:`2019-19062`, :cve:`2019-19063`, :cve:`2019-19064`, :cve:`2019-19065`, :cve:`2019-19066`, :cve:`2019-19067`, :cve:`2019-19068`, :cve:`2019-19069`, :cve:`2019-19070`, :cve:`2019-19071`, :cve:`2019-19072`, :cve:`2019-19073`, :cve:`2019-19074`, :cve:`2019-19075`, :cve:`2019-19076`, :cve:`2019-19077`, :cve:`2019-19078`, :cve:`2019-19079`, :cve:`2019-19080`, :cve:`2019-19081`, :cve:`2019-19082`, :cve:`2019-19083`, :cve:`2019-19227`, :cve:`2019-19241`, :cve:`2019-19252`, :cve:`2019-19318`, :cve:`2019-19319`, :cve:`2019-19332`, :cve:`2019-19338`, :cve:`2019-19377`, :cve:`2019-19447`, :cve:`2019-19448`, :cve:`2019-19449`, :cve:`2019-19462`, :cve:`2019-19523`, :cve:`2019-19524`, :cve:`2019-19525`, :cve:`2019-19526`, :cve:`2019-19527`, :cve:`2019-19528`, :cve:`2019-19529`, :cve:`2019-19530`, :cve:`2019-19531`, :cve:`2019-19532`, :cve:`2019-19533`, :cve:`2019-19534`, :cve:`2019-19535`, :cve:`2019-19536`, :cve:`2019-19537`, :cve:`2019-19543`, :cve:`2019-19602`, :cve:`2019-19767`, :cve:`2019-19768`, :cve:`2019-19769`, :cve:`2019-19770`, :cve:`2019-19807`, :cve:`2019-19813`, :cve:`2019-19815`, :cve:`2019-19816`, :cve:`2019-19922`, :cve:`2019-19927`, :cve:`2019-19947`, :cve:`2019-19965`, :cve:`2019-19966`, :cve:`2019-1999`, :cve:`2019-20054`, :cve:`2019-20095`, :cve:`2019-20096`, :cve:`2019-2024`, :cve:`2019-2025`, :cve:`2019-20422`, :cve:`2019-2054`, :cve:`2019-20636`, :cve:`2019-20806`, :cve:`2019-20810`, :cve:`2019-20811`, :cve:`2019-20812`, :cve:`2019-20908`, :cve:`2019-20934`, :cve:`2019-2101`, :cve:`2019-2181`, :cve:`2019-2182`, :cve:`2019-2213`, :cve:`2019-2214`, :cve:`2019-2215`, :cve:`2019-25044`, :cve:`2019-25045`, :cve:`2019-3016`, :cve:`2019-3459`, :cve:`2019-3460`, :cve:`2019-3701`, :cve:`2019-3819`, :cve:`2019-3837`, :cve:`2019-3846`, :cve:`2019-3874`, :cve:`2019-3882`, :cve:`2019-3887`, :cve:`2019-3892`, :cve:`2019-3896`, :cve:`2019-3900`, :cve:`2019-3901`, :cve:`2019-5108`, :cve:`2019-6133`, :cve:`2019-6974`, :cve:`2019-7221`, :cve:`2019-7222`, :cve:`2019-7308`, :cve:`2019-8912`, :cve:`2019-8956`, :cve:`2019-8980`, :cve:`2019-9003`, :cve:`2019-9162`, :cve:`2019-9213`, :cve:`2019-9245`, :cve:`2019-9444`, :cve:`2019-9445`, :cve:`2019-9453`, :cve:`2019-9454`, :cve:`2019-9455`, :cve:`2019-9456`, :cve:`2019-9457`, :cve:`2019-9458`, :cve:`2019-9466`, :cve:`2019-9500`, :cve:`2019-9503`, :cve:`2019-9506`, :cve:`2019-9857`, :cve:`2020-0009`, :cve:`2020-0030`, :cve:`2020-0041`, :cve:`2020-0066`, :cve:`2020-0067`, :cve:`2020-0110`, :cve:`2020-0255`, :cve:`2020-0305`, :cve:`2020-0404`, :cve:`2020-0423`, :cve:`2020-0427`, :cve:`2020-0429`, :cve:`2020-0430`, :cve:`2020-0431`, :cve:`2020-0432`, :cve:`2020-0433`, :cve:`2020-0435`, :cve:`2020-0444`, :cve:`2020-0465`, :cve:`2020-0466`, :cve:`2020-0543`, :cve:`2020-10135`, :cve:`2020-10690`, :cve:`2020-10711`, :cve:`2020-10720`, :cve:`2020-10732`, :cve:`2020-10742`, :cve:`2020-10751`, :cve:`2020-10757`, :cve:`2020-10766`, :cve:`2020-10767`, :cve:`2020-10768`, :cve:`2020-10769`, :cve:`2020-10773`, :cve:`2020-10781`, :cve:`2020-10942`, :cve:`2020-11494`, :cve:`2020-11565`, :cve:`2020-11608`, :cve:`2020-11609`, :cve:`2020-11668`, :cve:`2020-11669`, :cve:`2020-11884`, :cve:`2020-12114`, :cve:`2020-12351`, :cve:`2020-12352`, :cve:`2020-12362`, :cve:`2020-12363`, :cve:`2020-12364`, :cve:`2020-12464`, :cve:`2020-12465`, :cve:`2020-12652`, :cve:`2020-12653`, :cve:`2020-12654`, :cve:`2020-12655`, :cve:`2020-12656`, :cve:`2020-12657`, :cve:`2020-12659`, :cve:`2020-12768`, :cve:`2020-12769`, :cve:`2020-12770`, :cve:`2020-12771`, :cve:`2020-12826`, :cve:`2020-12888`, :cve:`2020-12912`, :cve:`2020-13143`, :cve:`2020-13974`, :cve:`2020-14305`, :cve:`2020-14314`, :cve:`2020-14331`, :cve:`2020-14351`, :cve:`2020-14353`, :cve:`2020-14356`, :cve:`2020-14381`, :cve:`2020-14385`, :cve:`2020-14386`, :cve:`2020-14390`, :cve:`2020-14416`, :cve:`2020-15393`, :cve:`2020-15436`, :cve:`2020-15437`, :cve:`2020-15780`, :cve:`2020-15852`, :cve:`2020-16119`, :cve:`2020-16120`, :cve:`2020-16166`, :cve:`2020-1749`, :cve:`2020-24394`, :cve:`2020-24490`, :cve:`2020-24504`, :cve:`2020-24586`, :cve:`2020-24587`, :cve:`2020-24588`, :cve:`2020-25211`, :cve:`2020-25212`, :cve:`2020-25221`, :cve:`2020-25284`, :cve:`2020-25285`, :cve:`2020-25639`, :cve:`2020-25641`, :cve:`2020-25643`, :cve:`2020-25645`, :cve:`2020-25656`, :cve:`2020-25668`, :cve:`2020-25669`, :cve:`2020-25670`, :cve:`2020-25671`, :cve:`2020-25672`, :cve:`2020-25673`, :cve:`2020-25704`, :cve:`2020-25705`, :cve:`2020-26088`, :cve:`2020-26139`, :cve:`2020-26141`, :cve:`2020-26145`, :cve:`2020-26147`, :cve:`2020-26541`, :cve:`2020-26555`, :cve:`2020-26558`, :cve:`2020-27066`, :cve:`2020-27067`, :cve:`2020-27068`, :cve:`2020-27152`, :cve:`2020-27170`, :cve:`2020-27171`, :cve:`2020-27194`, :cve:`2020-2732`, :cve:`2020-27673`, :cve:`2020-27675`, :cve:`2020-27777`, :cve:`2020-27784`, :cve:`2020-27786`, :cve:`2020-27815`, :cve:`2020-27820`, :cve:`2020-27825`, :cve:`2020-27830`, :cve:`2020-27835`, :cve:`2020-28097`, :cve:`2020-28374`, :cve:`2020-28588`, :cve:`2020-28915`, :cve:`2020-28941`, :cve:`2020-28974`, :cve:`2020-29368`, :cve:`2020-29369`, :cve:`2020-29370`, :cve:`2020-29371`, :cve:`2020-29372`, :cve:`2020-29373`, :cve:`2020-29374`, :cve:`2020-29534`, :cve:`2020-29568`, :cve:`2020-29569`, :cve:`2020-29660`, :cve:`2020-29661`, :cve:`2020-35499`, :cve:`2020-35508`, :cve:`2020-35513`, :cve:`2020-35519`, :cve:`2020-36158`, :cve:`2020-36310`, :cve:`2020-36311`, :cve:`2020-36312`, :cve:`2020-36313`, :cve:`2020-36322`, :cve:`2020-36385`, :cve:`2020-36386`, :cve:`2020-36387`, :cve:`2020-36516`, :cve:`2020-36557`, :cve:`2020-36558`, :cve:`2020-36691`, :cve:`2020-36694`, :cve:`2020-36766`, :cve:`2020-3702`, :cve:`2020-4788`, :cve:`2020-7053`, :cve:`2020-8428`, :cve:`2020-8647`, :cve:`2020-8648`, :cve:`2020-8649`, :cve:`2020-8694`, :cve:`2020-8834`, :cve:`2020-8835`, :cve:`2020-8992`, :cve:`2020-9383`, :cve:`2020-9391`, :cve:`2021-0129`, :cve:`2021-0342`, :cve_mitre:`2021-0447`, :cve_mitre:`2021-0448`, :cve:`2021-0512`, :cve:`2021-0605`, :cve:`2021-0707`, :cve:`2021-0920`, :cve:`2021-0929`, :cve:`2021-0935`, :cve_mitre:`2021-0937`, :cve:`2021-0938`, :cve:`2021-0941`, :cve:`2021-1048`, :cve:`2021-20177`, :cve:`2021-20194`, :cve:`2021-20226`, :cve:`2021-20239`, :cve:`2021-20261`, :cve:`2021-20265`, :cve:`2021-20268`, :cve:`2021-20292`, :cve:`2021-20317`, :cve:`2021-20320`, :cve:`2021-20321`, :cve:`2021-20322`, :cve:`2021-21781`, :cve:`2021-22543`, :cve:`2021-22555`, :cve:`2021-22600`, :cve:`2021-23133`, :cve:`2021-23134`, :cve:`2021-26401`, :cve:`2021-26708`, :cve:`2021-26930`, :cve:`2021-26931`, :cve:`2021-26932`, :cve:`2021-27363`, :cve:`2021-27364`, :cve:`2021-27365`, :cve:`2021-28038`, :cve:`2021-28039`, :cve:`2021-28375`, :cve:`2021-28660`, :cve:`2021-28688`, :cve:`2021-28691`, :cve:`2021-28711`, :cve:`2021-28712`, :cve:`2021-28713`, :cve:`2021-28714`, :cve:`2021-28715`, :cve:`2021-28950`, :cve:`2021-28951`, :cve:`2021-28952`, :cve:`2021-28964`, :cve:`2021-28971`, :cve:`2021-28972`, :cve:`2021-29154`, :cve:`2021-29155`, :cve:`2021-29264`, :cve:`2021-29265`, :cve:`2021-29266`, :cve:`2021-29646`, :cve:`2021-29647`, :cve:`2021-29648`, :cve:`2021-29649`, :cve:`2021-29650`, :cve:`2021-29657`, :cve:`2021-30002`, :cve:`2021-30178`, :cve:`2021-31440`, :cve:`2021-3178`, :cve:`2021-31829`, :cve:`2021-31916`, :cve:`2021-32078`, :cve:`2021-32399`, :cve:`2021-32606`, :cve:`2021-33033`, :cve:`2021-33034`, :cve:`2021-33061`, :cve:`2021-33098`, :cve:`2021-33135`, :cve:`2021-33200`, :cve:`2021-3347`, :cve:`2021-3348`, :cve:`2021-33624`, :cve:`2021-33655`, :cve:`2021-33656`, :cve:`2021-33909`, :cve:`2021-3411`, :cve:`2021-3428`, :cve:`2021-3444`, :cve:`2021-34556`, :cve:`2021-34693`, :cve:`2021-3483`, :cve:`2021-34866`, :cve:`2021-3489`, :cve:`2021-3490`, :cve:`2021-3491`, :cve:`2021-3493`, :cve_mitre:`2021-34981`, :cve:`2021-3501`, :cve:`2021-35039`, :cve:`2021-3506`, :cve:`2021-3543`, :cve:`2021-35477`, :cve:`2021-3564`, :cve:`2021-3573`, :cve:`2021-3587`, :cve_mitre:`2021-3600`, :cve:`2021-3609`, :cve:`2021-3612`, :cve:`2021-3635`, :cve:`2021-3640`, :cve:`2021-3653`, :cve:`2021-3655`, :cve:`2021-3656`, :cve:`2021-3659`, :cve:`2021-3669`, :cve:`2021-3679`, :cve:`2021-3715`, :cve:`2021-37159`, :cve:`2021-3732`, :cve:`2021-3736`, :cve:`2021-3739`, :cve:`2021-3743`, :cve:`2021-3744`, :cve:`2021-3752`, :cve:`2021-3753`, :cve:`2021-37576`, :cve:`2021-3759`, :cve:`2021-3760`, :cve:`2021-3764`, :cve:`2021-3772`, :cve:`2021-38160`, :cve:`2021-38166`, :cve:`2021-38198`, :cve:`2021-38199`, :cve:`2021-38200`, :cve:`2021-38201`, :cve:`2021-38202`, :cve:`2021-38203`, :cve:`2021-38204`, :cve:`2021-38205`, :cve:`2021-38206`, :cve:`2021-38207`, :cve:`2021-38208`, :cve:`2021-38209`, :cve:`2021-38300`, :cve:`2021-3894`, :cve:`2021-3896`, :cve:`2021-3923`, :cve:`2021-39633`, :cve:`2021-39634`, :cve:`2021-39636`, :cve:`2021-39648`, :cve:`2021-39656`, :cve:`2021-39657`, :cve:`2021-39685`, :cve:`2021-39686`, :cve:`2021-39698`, :cve:`2021-39711`, :cve:`2021-39713`, :cve:`2021-39714`, :cve:`2021-4001`, :cve:`2021-4002`, :cve:`2021-4023`, :cve:`2021-4028`, :cve:`2021-4032`, :cve:`2021-4037`, :cve:`2021-40490`, :cve:`2021-4083`, :cve:`2021-4090`, :cve:`2021-4093`, :cve:`2021-4095`, :cve:`2021-41073`, :cve:`2021-4135`, :cve:`2021-4148`, :cve:`2021-4149`, :cve:`2021-4150`, :cve:`2021-4154`, :cve:`2021-4155`, :cve:`2021-4157`, :cve:`2021-4159`, :cve:`2021-41864`, :cve:`2021-4197`, :cve:`2021-42008`, :cve:`2021-4202`, :cve:`2021-4203`, :cve:`2021-4204`, :cve:`2021-4218`, :cve:`2021-42252`, :cve:`2021-42327`, :cve:`2021-42739`, :cve:`2021-43056`, :cve:`2021-43057`, :cve:`2021-43267`, :cve:`2021-43389`, :cve:`2021-43975`, :cve:`2021-43976`, :cve:`2021-44733`, :cve:`2021-44879`, :cve:`2021-45095`, :cve:`2021-45100`, :cve:`2021-45402`, :cve:`2021-45469`, :cve:`2021-45480`, :cve:`2021-45485`, :cve:`2021-45486`, :cve:`2021-45868`, :cve:`2021-46283`, :cve:`2022-0001`, :cve:`2022-0002`, :cve:`2022-0168`, :cve:`2022-0171`, :cve:`2022-0185`, :cve:`2022-0264`, :cve:`2022-0286`, :cve:`2022-0322`, :cve:`2022-0330`, :cve:`2022-0382`, :cve:`2022-0433`, :cve:`2022-0435`, :cve:`2022-0480`, :cve:`2022-0487`, :cve:`2022-0492`, :cve:`2022-0494`, :cve:`2022-0500`, :cve:`2022-0516`, :cve:`2022-0617`, :cve:`2022-0644`, :cve:`2022-0646`, :cve:`2022-0742`, :cve:`2022-0812`, :cve:`2022-0847`, :cve:`2022-0850`, :cve:`2022-0854`, :cve:`2022-0995`, :cve:`2022-0998`, :cve:`2022-1011`, :cve:`2022-1012`, :cve:`2022-1015`, :cve:`2022-1016`, :cve:`2022-1043`, :cve:`2022-1048`, :cve:`2022-1055`, :cve:`2022-1158`, :cve:`2022-1184`, :cve:`2022-1195`, :cve:`2022-1198`, :cve:`2022-1199`, :cve:`2022-1204`, :cve:`2022-1205`, :cve:`2022-1263`, :cve:`2022-1280`, :cve:`2022-1353`, :cve:`2022-1419`, :cve:`2022-1462`, :cve:`2022-1508`, :cve:`2022-1516`, :cve:`2022-1651`, :cve:`2022-1652`, :cve:`2022-1671`, :cve:`2022-1678`, :cve:`2022-1679`, :cve:`2022-1729`, :cve:`2022-1734`, :cve:`2022-1786`, :cve:`2022-1789`, :cve:`2022-1836`, :cve:`2022-1852`, :cve:`2022-1882`, :cve:`2022-1943`, :cve:`2022-1966`, :cve:`2022-1972`, :cve:`2022-1973`, :cve:`2022-1974`, :cve:`2022-1975`, :cve:`2022-1976`, :cve:`2022-1998`, :cve:`2022-20008`, :cve:`2022-20132`, :cve:`2022-20141`, :cve:`2022-20148`, :cve:`2022-20153`, :cve:`2022-20154`, :cve:`2022-20158`, :cve:`2022-20166`, :cve:`2022-20368`, :cve:`2022-20369`, :cve:`2022-20409`, :cve:`2022-20421`, :cve:`2022-20422`, :cve:`2022-20423`, :cve:`2022-20424`, :cve_mitre:`2022-20565`, :cve:`2022-20566`, :cve:`2022-20567`, :cve:`2022-20568`, :cve:`2022-20572`, :cve:`2022-2078`, :cve:`2022-21123`, :cve:`2022-21125`, :cve:`2022-21166`, :cve:`2022-21385`, :cve:`2022-21499`, :cve_mitre:`2022-21505`, :cve:`2022-2153`, :cve:`2022-2196`, :cve_mitre:`2022-22942`, :cve:`2022-23036`, :cve:`2022-23037`, :cve:`2022-23038`, :cve:`2022-23039`, :cve:`2022-23040`, :cve:`2022-23041`, :cve:`2022-23042`, :cve:`2022-2308`, :cve:`2022-2318`, :cve:`2022-23222`, :cve:`2022-2327`, :cve:`2022-2380`, :cve:`2022-23816`, :cve:`2022-23960`, :cve:`2022-24122`, :cve:`2022-24448`, :cve:`2022-24958`, :cve:`2022-24959`, :cve:`2022-2503`, :cve:`2022-25258`, :cve:`2022-25375`, :cve:`2022-25636`, :cve_mitre:`2022-2585`, :cve_mitre:`2022-2586`, :cve_mitre:`2022-2588`, :cve:`2022-2590`, :cve_mitre:`2022-2602`, :cve:`2022-26365`, :cve:`2022-26373`, :cve:`2022-2639`, :cve:`2022-26490`, :cve:`2022-2663`, :cve:`2022-26966`, :cve:`2022-27223`, :cve:`2022-27666`, :cve:`2022-27672`, :cve:`2022-2785`, :cve:`2022-27950`, :cve:`2022-28356`, :cve:`2022-28388`, :cve:`2022-28389`, :cve:`2022-28390`, :cve:`2022-2873`, :cve:`2022-28796`, :cve:`2022-28893`, :cve:`2022-2905`, :cve:`2022-29156`, :cve:`2022-2938`, :cve:`2022-29581`, :cve:`2022-29582`, :cve:`2022-2959`, :cve:`2022-2964`, :cve:`2022-2977`, :cve:`2022-2978`, :cve:`2022-29900`, :cve:`2022-29901`, :cve:`2022-2991`, :cve:`2022-29968`, :cve:`2022-3028`, :cve:`2022-30594`, :cve:`2022-3061`, :cve:`2022-3077`, :cve:`2022-3078`, :cve:`2022-3103`, :cve:`2022-3104`, :cve:`2022-3105`, :cve:`2022-3106`, :cve:`2022-3107`, :cve:`2022-3108`, :cve:`2022-3110`, :cve:`2022-3111`, :cve:`2022-3112`, :cve:`2022-3113`, :cve:`2022-3114`, :cve:`2022-3115`, :cve:`2022-3169`, :cve:`2022-3170`, :cve:`2022-3176`, :cve:`2022-3202`, :cve:`2022-32250`, :cve:`2022-32296`, :cve:`2022-3239`, :cve:`2022-32981`, :cve:`2022-3303`, :cve:`2022-3344`, :cve:`2022-33740`, :cve:`2022-33741`, :cve:`2022-33742`, :cve:`2022-33743`, :cve:`2022-33744`, :cve:`2022-33981`, :cve:`2022-3424`, :cve:`2022-3435`, :cve:`2022-34494`, :cve:`2022-34495`, :cve:`2022-34918`, :cve:`2022-3521`, :cve:`2022-3522`, :cve:`2022-3524`, :cve:`2022-3526`, :cve:`2022-3531`, :cve:`2022-3532`, :cve:`2022-3534`, :cve:`2022-3535`, :cve:`2022-3541`, :cve:`2022-3542`, :cve:`2022-3543`, :cve:`2022-3545`, :cve:`2022-3564`, :cve:`2022-3565`, :cve:`2022-3577`, :cve:`2022-3586`, :cve:`2022-3594`, :cve:`2022-3595`, :cve:`2022-36123`, :cve:`2022-3619`, :cve:`2022-3621`, :cve:`2022-3623`, :cve:`2022-3624`, :cve:`2022-3625`, :cve:`2022-3628`, :cve:`2022-36280`, :cve:`2022-3629`, :cve:`2022-3630`, :cve:`2022-3633`, :cve:`2022-3635`, :cve:`2022-3636`, :cve:`2022-3640`, :cve:`2022-3643`, :cve:`2022-3646`, :cve:`2022-3649`, :cve:`2022-36879`, :cve:`2022-36946`, :cve:`2022-3707`, :cve:`2022-38457`, :cve:`2022-3903`, :cve:`2022-3910`, :cve:`2022-39188`, :cve:`2022-39189`, :cve:`2022-39190`, :cve:`2022-3977`, :cve:`2022-39842`, :cve:`2022-40133`, :cve:`2022-40307`, :cve:`2022-40476`, :cve:`2022-40768`, :cve:`2022-4095`, :cve:`2022-40982`, :cve:`2022-41218`, :cve:`2022-41222`, :cve:`2022-4127`, :cve:`2022-4128`, :cve:`2022-4129`, :cve:`2022-4139`, :cve:`2022-41674`, :cve:`2022-41849`, :cve:`2022-41850`, :cve:`2022-41858`, :cve:`2022-42328`, :cve:`2022-42329`, :cve:`2022-42432`, :cve:`2022-4269`, :cve:`2022-42703`, :cve:`2022-42719`, :cve:`2022-42720`, :cve:`2022-42721`, :cve:`2022-42722`, :cve:`2022-42895`, :cve:`2022-42896`, :cve:`2022-43750`, :cve:`2022-4378`, :cve:`2022-4379`, :cve:`2022-4382`, :cve:`2022-43945`, :cve:`2022-45869`, :cve:`2022-45886`, :cve:`2022-45887`, :cve:`2022-45919`, :cve:`2022-45934`, :cve:`2022-4662`, :cve:`2022-4696`, :cve:`2022-4744`, :cve:`2022-47518`, :cve:`2022-47519`, :cve:`2022-47520`, :cve:`2022-47521`, :cve:`2022-47929`, :cve:`2022-47938`, :cve:`2022-47939`, :cve:`2022-47940`, :cve:`2022-47941`, :cve:`2022-47942`, :cve:`2022-47943`, :cve:`2022-47946`, :cve:`2022-4842`, :cve:`2022-48423`, :cve:`2022-48424`, :cve:`2022-48425`, :cve:`2022-48502`, :cve:`2023-0030`, :cve:`2023-0045`, :cve:`2023-0047`, :cve:`2023-0122`, :cve:`2023-0160`, :cve:`2023-0179`, :cve:`2023-0210`, :cve:`2023-0240`, :cve:`2023-0266`, :cve:`2023-0386`, :cve:`2023-0394`, :cve:`2023-0458`, :cve:`2023-0459`, :cve:`2023-0461`, :cve:`2023-0468`, :cve:`2023-0469`, :cve:`2023-0590`, :cve:`2023-0615`, :cve_mitre:`2023-1032`, :cve:`2023-1073`, :cve:`2023-1074`, :cve:`2023-1076`, :cve:`2023-1077`, :cve:`2023-1078`, :cve:`2023-1079`, :cve:`2023-1095`, :cve:`2023-1118`, :cve:`2023-1192`, :cve:`2023-1194`, :cve:`2023-1195`, :cve:`2023-1206`, :cve:`2023-1249`, :cve:`2023-1252`, :cve:`2023-1281`, :cve:`2023-1295`, :cve:`2023-1380`, :cve:`2023-1382`, :cve:`2023-1390`, :cve:`2023-1513`, :cve:`2023-1582`, :cve:`2023-1583`, :cve:`2023-1611`, :cve:`2023-1637`, :cve:`2023-1652`, :cve:`2023-1670`, :cve:`2023-1829`, :cve:`2023-1838`, :cve:`2023-1855`, :cve:`2023-1859`, :cve:`2023-1872`, :cve:`2023-1989`, :cve:`2023-1990`, :cve:`2023-1998`, :cve:`2023-2002`, :cve:`2023-2006`, :cve:`2023-2007`, :cve:`2023-2008`, :cve:`2023-2019`, :cve:`2023-20569`, :cve:`2023-20588`, :cve:`2023-20593`, :cve:`2023-20928`, :cve:`2023-20938`, :cve:`2023-21102`, :cve:`2023-21106`, :cve:`2023-2124`, :cve:`2023-21255`, :cve:`2023-2156`, :cve:`2023-2162`, :cve:`2023-2163`, :cve:`2023-2166`, :cve:`2023-2177`, :cve:`2023-2194`, :cve:`2023-2235`, :cve:`2023-2236`, :cve:`2023-2248`, :cve:`2023-2269`, :cve:`2023-22995`, :cve:`2023-22996`, :cve:`2023-22997`, :cve:`2023-22998`, :cve:`2023-22999`, :cve:`2023-23000`, :cve:`2023-23001`, :cve:`2023-23002`, :cve:`2023-23003`, :cve:`2023-23004`, :cve:`2023-23006`, :cve:`2023-23454`, :cve:`2023-23455`, :cve:`2023-23559`, :cve:`2023-23586`, :cve:`2023-2430`, :cve:`2023-2483`, :cve:`2023-25012`, :cve:`2023-2513`, :cve:`2023-25775`, :cve:`2023-2598`, :cve:`2023-26544`, :cve:`2023-26545`, :cve:`2023-26605`, :cve:`2023-26606`, :cve:`2023-26607`, :cve:`2023-28327`, :cve:`2023-28328`, :cve:`2023-28410`, :cve:`2023-28464`, :cve:`2023-28466`, :cve:`2023-2860`, :cve:`2023-28772`, :cve:`2023-28866`, :cve:`2023-2898`, :cve:`2023-2985`, :cve:`2023-3006`, :cve:`2023-30456`, :cve:`2023-30772`, :cve:`2023-3090`, :cve:`2023-3106`, :cve:`2023-3111`, :cve:`2023-3117`, :cve:`2023-31248`, :cve:`2023-3141`, :cve:`2023-31436`, :cve:`2023-3159`, :cve:`2023-3161`, :cve:`2023-3212`, :cve:`2023-3220`, :cve:`2023-32233`, :cve:`2023-32247`, :cve:`2023-32248`, :cve:`2023-32250`, :cve:`2023-32252`, :cve:`2023-32254`, :cve:`2023-32257`, :cve:`2023-32258`, :cve:`2023-32269`, :cve:`2023-3268`, :cve:`2023-3269`, :cve:`2023-3312`, :cve:`2023-3317`, :cve:`2023-33203`, :cve:`2023-33250`, :cve:`2023-33288`, :cve:`2023-3338`, :cve:`2023-3355`, :cve:`2023-3357`, :cve:`2023-3358`, :cve:`2023-3359`, :cve:`2023-3389`, :cve:`2023-3390`, :cve:`2023-33951`, :cve:`2023-33952`, :cve:`2023-34255`, :cve:`2023-34256`, :cve:`2023-34319`, :cve:`2023-3439`, :cve:`2023-35001`, :cve:`2023-3567`, :cve:`2023-35788`, :cve:`2023-35823`, :cve:`2023-35824`, :cve:`2023-35826`, :cve:`2023-35828`, :cve:`2023-35829`, :cve:`2023-3609`, :cve:`2023-3610`, :cve:`2023-3611`, :cve:`2023-37453`, :cve:`2023-3772`, :cve:`2023-3773`, :cve:`2023-3776`, :cve:`2023-3777`, :cve:`2023-3812`, :cve:`2023-38409`, :cve:`2023-38426`, :cve:`2023-38427`, :cve:`2023-38428`, :cve:`2023-38429`, :cve:`2023-38430`, :cve:`2023-38431`, :cve:`2023-38432`, :cve:`2023-3863`, :cve_mitre:`2023-3865`, :cve_mitre:`2023-3866`, :cve_mitre:`2023-3867`, :cve:`2023-4004`, :cve:`2023-4015`, :cve:`2023-40283`, :cve:`2023-4128`, :cve:`2023-4132`, :cve:`2023-4147`, :cve:`2023-4155`, :cve:`2023-4194`, :cve:`2023-4206`, :cve:`2023-4207`, :cve:`2023-4208`, :cve:`2023-4273`, :cve:`2023-42752`, :cve:`2023-42753`, :cve:`2023-4385`, :cve:`2023-4387`, :cve:`2023-4389`, :cve:`2023-4394`, :cve:`2023-4459`, :cve:`2023-4569`, :cve:`2023-4611` and :cve:`2023-4623` +- nghttp2: Fix :cve:`2023-35945` +- openssl: Fix :cve:`2023-2975`, :cve:`2023-3446`, :cve:`2023-3817`, :cve:`2023-4807` and :cve:`2023-5363` +- pixman: Ignore :cve:`2023-37769` +- procps: Fix :cve:`2023-4016` +- python3-git: Fix :cve:`2023-40267`, :cve:`2023-40590` and :cve:`2023-41040` +- python3-pygments: Fix :cve:`2022-40896` +- python3-urllib3: Fix :cve:`2023-43804` and :cve:`2023-45803` +- python3: Fix :cve:`2023-24329` and :cve:`2023-40217` +- qemu: Fix :cve:`2023-3180`, :cve:`2023-3354` and :cve:`2023-42467` +- qemu: Ignore :cve:`2023-2680` +- screen: Fix :cve:`2023-24626` +- shadow: Fix :cve_mitre:`2023-4641` +- tiff: Fix :cve:`2023-40745` and :cve:`2023-41175` +- vim: Fix :cve:`2023-3896`, :cve:`2023-4733`, :cve:`2023-4734`, :cve:`2023-4735`, :cve:`2023-4736`, :cve:`2023-4738`, :cve:`2023-4750`, :cve:`2023-4752`, :cve:`2023-4781`, :cve:`2023-5441` and :cve:`2023-5535` +- webkitgtk: Fix :cve:`2023-32435` and :cve:`2023-32439` +- xserver-xorg: Fix :cve:`2023-5367` and :cve:`2023-5380` + + +Fixes in Yocto-4.2.4 +~~~~~~~~~~~~~~~~~~~~ + +- README: Update to point to new contributor guide +- README: fix mail address in git example command +- SECURITY.md: Add file +- avahi: handle invalid service types gracefully +- bind: upgrade to 9.18.19 +- bitbake.conf: add bunzip2 in :term:`HOSTTOOLS` +- bitbake: Fix disk space monitoring on cephfs +- bitbake: SECURITY.md: add file +- brief-yoctoprojectqs: use new CDN mirror for sstate +- bsp-guide: bsp.rst: replace reference to wiki +- bsp-guide: bsp: skip Intel machines no longer supported in Poky +- build-appliance-image: Update to mickledore head revision +- build-sysroots: Add :term:`SUMMARY` field +- build-sysroots: Ensure dependency chains are minimal +- build-sysroots: target or native sysroot population need to be selected explicitly +- buildtools-tarball: Add libacl +- busybox: Set PATH in syslog initscript +- busybox: remove coreutils dependency in busybox-ptest +- cmake.bbclass: fix allarch override syntax +- cml1: Fix KCONFIG_CONFIG_COMMAND not conveyed fully in do_menuconfig +- contributor-guide/style-guide: Add a note about task idempotence +- contributor-guide/style-guide: Refer to recipes, not packages +- contributor-guide: deprecate "Accepted" patch status +- contributor-guide: discourage marking patches as Inappropriate +- contributor-guide: recipe-style-guide: add Upstream-Status +- contributor-guide: recipe-style-guide: add more patch tagging examples +- contributor-guide: recipe-style-guide: add section about CVE patches +- contributor-guide: style-guide: discourage using Pending patch status +- core-image-ptest: Define a fallback for :term:`SUMMARY` field +- cve-check: add CVSS vector string to CVE database and reports +- cve-check: don't warn if a patch is remote +- cve-check: slightly more verbose warning when adding the same package twice +- cve-check: sort the package list in the JSON report +- cve-exclusion_6.1.inc: update for 6.1.57 +- dbus: add additional entries to :term:`CVE_PRODUCT` +- dbus: upgrade to 1.14.10 +- dev-manual: add security team processes +- dev-manual: disk-space: improve wording for obsolete sstate cache files +- dev-manual: disk-space: mention faster "find" command to trim sstate cache +- dev-manual: fix testimage usage instructions +- dev-manual: layers: Add notes about layer.conf +- dev-manual: licenses: mention :term:`SPDX` for license compliance +- dev-manual: new-recipe.rst fix inconsistency with contributor guide +- dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" section +- dev-manual: new-recipe.rst: replace reference to wiki +- dev-manual: remove unsupported :term: markup inside markup +- dev-manual: start.rst: remove obsolete reference +- ell: upgrade to 0.58 +- externalsrc: fix dependency chain issues +- ffmpeg: upgrade to 5.1.3 +- ffmpeg: avoid neon on unsupported machines +- file: fix call to localtime_r() +- file: upgrade to 5.45 +- fontcache.bbclass: avoid native recipes depending on target fontconfig +- gcc-crosssdk: ignore MULTILIB_VARIANTS in signature computation +- gcc-runtime: remove bashism +- gcc: backport a fix for ICE caused by CVE-2023-4039.patch +- gcc: depend on zstd +- gdb: fix :term:`RDEPENDS` for PACKAGECONFIG[tui] +- glib-2.0: libelf has a configure option now, specify it +- glibc: stable 2.37 branch updates +- gnupg: Fix reproducibility failure +- gnupg: upgrade to 2.4.3 +- go: upgrade to 1.20.7 +- graphene: fix runtime detection of IEEE754 behaviour +- gstreamer: upgrade to 1.22.6 +- gtk4: upgrade to 4.10.5 +- gzip: upgrade to 1.13 +- igt-gpu-tools: do not write shortened git commit hash into binaries +- inetutils: don't guess target paths +- inetutils: remove obsolete cruft from do_configure +- insane.bbclass: Count raw bytes in shebang-size +- kernel.bbclass: Add force flag to rm calls +- lib/package_manager: Improve repo artefact filtering +- libc-test: Run as non-root user +- libconvert-asn1-perl: upgrade to 0.34 +- libevent: fix patch Upstream-Status +- libgudev: explicitly disable tests and vapi +- librepo: upgrade to 1.15.2 +- librsvg: upgrade to 2.54.6 +- libsndfile1: upgrade to 1.2.2 +- libsoup-2.4: Only specify --cross-file when building for target +- libsoup-2.4: update :term:`PACKAGECONFIG` +- libx11: upgrade to 1.8.7 +- libxkbcommon: add :term:`CVE_PRODUCT` +- libxpm: upgrade to 3.5.17 +- linux-firmware: add firmware files for NXP BT chipsets +- linux-firmware: package Dragonboard 845c sensors DSP firmware +- linux-firmware: package audio topology for Lenovo X13s +- linux-firmware: upgrade to 20230804 +- linux-yocto/5.15: update to v5.15.133 +- linux-yocto/6.1: fix CONFIG_F2FS_IO_TRACE configuration warning +- linux-yocto/6.1: fix IRQ-80 warnings +- linux-yocto/6.1: fix uninitialized read in nohz_full/isolcpus setup +- linux-yocto/6.1: tiny: fix arm 32 boot +- linux-yocto/6.1: update to v6.1.57 +- linux-yocto: add script to generate kernel :term:`CVE_CHECK_IGNORE` entries +- linux-yocto: make sure the pahole-native available before do_kernel_configme +- linux/cve-exclusion: add generated CVE_CHECK_IGNOREs +- linux/generate-cve-exclusions: fix mishandling of boundary values +- linux/generate-cve-exclusions: print the generated time in UTC +- manuals: add new contributor guide +- manuals: correct "yocto-linux" by "linux-yocto" +- mdadm: Disable further tests due to intermittent failures +- mdadm: skip running 04update-uuid and 07revert-inplace testcases +- migration-guides: add release notes for 4.0.12 +- migration-guides: add release notes for 4.0.13 +- migration-guides: add release notes for 4.2.3 +- mpfr: upgrade to 4.2.1 +- multilib.conf: explicitly make MULTILIB_VARIANTS vardeps on MULTILIBS +- nativesdk-intercept: Fix bad intercept chgrp/chown logic +- nettle: avoid neon on unsupported machines +- oe-depends-dot: improve '-w' behavior +- oeqa dnf_runtime.py: fix HTTP server IP address and port +- oeqa selftest context.py: remove warning from missing meta-selftest +- oeqa selftest context.py: whitespace fix +- oeqa/concurrencytest: Remove invalid buffering option +- oeqa/selftest/context.py: check git command return values +- oeqa/selftest/wic: Improve assertTrue calls +- oeqa/selftest: Fix broken symlink removal handling +- oeqa/utils/gitarchive: Handle broken commit counts in results repo +- openssl: upgrade to 3.1.4 +- openssl: build and install manpages only if they are enabled +- openssl: ensure all ptest fails are caught +- openssl: parallelize tests +- overview: Add note about non-reproducibility side effects +- packages.bbclass: Correct the check for conflicts with renamed packages +- pango: explictly enable/disable libthai +- patch.py: use --absolute-git-dir instead of --show-toplevel to retrieve gitdir +- pixman: Remove duplication of license MIT +- pixman: avoid neon on unsupported machines +- poky.conf: bump version for 4.2.4 release +- profile-manual: aesthetic cleanups +- pseudo: Fix to work with glibc 2.38 +- ptest: report tests that were killed on timeout +- python3-git: upgrade to 3.1.37 +- python3-urllib3: update to v1.26.18 +- python3: upgrade to 3.11.5 +- qemu: fix "Bad FPU state detected" fault on qemu-system-i386 +- ref-manual: Fix :term:`PACKAGECONFIG` term and add an example +- ref-manual: Warn about :term:`COMPATIBLE_MACHINE` skipping native recipes +- ref-manual: point outdated link to the new location +- ref-manual: releases.svg: Scarthgap is now version 5.0 +- ref-manual: system-requirements: update supported distros +- ref-manual: variables: add :term:`RECIPE_SYSROOT` and :term:`RECIPE_SYSROOT_NATIVE` +- ref-manual: variables: add :term:`TOOLCHAIN_OPTIONS` variable +- ref-manual: variables: add example for :term:`SYSROOT_DIRS` variable +- ref-manual: variables: provide no-match example for :term:`COMPATIBLE_MACHINE` +- resulttool/report: Avoid divide by zero +- runqemu: check permissions of available render nodes as well as their presence +- screen: upgrade to 4.9.1 +- scripts/create-pull-request: update URLs to git repositories +- sdk-manual: appendix-obtain: improve and update descriptions +- sdk-manual: extensible.rst: fix multiple formatting issues +- shadow: fix patch Upstream-Status +- strace: parallelize ptest +- sudo: upgrade to 1.9.15p2 +- systemd-bootchart: musl fixes have been rejected upstream +- systemd: backport patch to fix warning in systemd-vconsole-setup +- tar: upgrade to 1.35 +- tcl: Add a way to skip ptests +- tcl: prevent installing another copy of tzdata +- template: fix typo in section header +- test-manual: reproducible-builds: stop mentioning LTO bug +- uboot-extlinux-config.bbclass: fix missed override syntax migration +- vim: upgrade to 9.0.2048 +- vim: update obsolete comment +- wayland-utils: add libdrm :term:`PACKAGECONFIG` +- weston-init: fix init code indentation +- weston-init: remove misleading comment about udev rule +- wic: bootimg-partition: Fix file name in debug message +- wic: fix wrong attempt to create file system in upartitioned regions +- wireless-regdb: upgrade to 2023.09.01 +- xz: upgrade to 5.4.4 +- yocto-uninative: Update to 4.2 for glibc 2.38 +- yocto-uninative: Update to 4.3 + + +Known Issues in Yocto-4.2.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.2.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alberto Planas +- Alexander Kanavin +- Alexis Lothoré +- Antoine Lubineau +- Anuj Mittal +- Archana Polampalli +- Arne Schwerdt +- BELHADJ SALEM Talel +- Benjamin Bara +- Bruce Ashfield +- Chen Qi +- Colin McAllister +- Daniel Semkowicz +- Dmitry Baryshkov +- Eilís 'pidge' Ní Fhlannagáin +- Emil Kronborg Andersen +- Etienne Cordonnier +- Jaeyoon Jung +- Jan Garcia +- Joe Slater +- Joshua Watt +- Julien Stephan +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Markus Niebel +- Markus Volk +- Marta Rybczynska +- Martijn de Gouw +- Martin Jansa +- Michael Halstead +- Michael Opdenacker +- Mikko Rapeli +- Mingli Yu +- Narpat Mali +- Otavio Salvador +- Ovidiu Panait +- Peter Kjellerstedt +- Peter Marko +- Peter Suti +- Poonam Jadhav +- Quentin Schulz +- Richard Purdie +- Robert P. J. Day +- Roland Hieber +- Ross Burton +- Ryan Eatmon +- Sakib Sajal +- Samantha Jalabert +- Sanjana +- Sanjay Chitroda +- Sean Nyekjaer +- Siddharth Doshi +- Soumya Sambu +- Stefan Tauner +- Steve Sakoman +- Tan Wen Yan +- Tom Hochstein +- Trevor Gamblin +- Vijay Anusuri +- Wang Mingyu +- Xiangyu Chen +- Yash Shinde +- Yoann Congal +- Yogita Urade +- Yuta Hayama + + +Repositories / Downloads for Yocto-4.2.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`mickledore </poky/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.4 </poky/log/?h=yocto-4.2.4>` +- Git Revision: :yocto_git:`7235399a86b134e57d5eb783d7f1f57ca0439ae5 </poky/commit/?id=7235399a86b134e57d5eb783d7f1f57ca0439ae5>` +- Release Artefact: poky-7235399a86b134e57d5eb783d7f1f57ca0439ae5 +- sha: 3d56bb4232ab29ae18249529856f0e638c50c764fc495d6beb1ecd295fa5e5e3 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.4/poky-7235399a86b134e57d5eb783d7f1f57ca0439ae5.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.4/poky-7235399a86b134e57d5eb783d7f1f57ca0439ae5.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`mickledore </openembedded-core/log/?h=mickledore>` +- Tag: :oe_git:`yocto-4.2.4 </openembedded-core/log/?h=yocto-4.2.4>` +- Git Revision: :oe_git:`23b5141400b2c676c806df3308f023f7c04e34e0 </openembedded-core/commit/?id=23b5141400b2c676c806df3308f023f7c04e34e0>` +- Release Artefact: oecore-23b5141400b2c676c806df3308f023f7c04e34e0 +- sha: 152f4ee3cdd2e159f6bd34b01d517de44dfe670d35a5e3c84cc32ee7842d9741 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.4/oecore-23b5141400b2c676c806df3308f023f7c04e34e0.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.4/oecore-23b5141400b2c676c806df3308f023f7c04e34e0.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`mickledore </meta-mingw/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.4 </meta-mingw/log/?h=yocto-4.2.4>` +- Git Revision: :yocto_git:`d87d4f00b9c6068fff03929a4b0f231a942d3873 </meta-mingw/commit/?id=d87d4f00b9c6068fff03929a4b0f231a942d3873>` +- Release Artefact: meta-mingw-d87d4f00b9c6068fff03929a4b0f231a942d3873 +- sha: 8036847cf5bf3da9db4bad13aac9080d559848679f0ae03694d55a576bcaf75f +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.4/meta-mingw-d87d4f00b9c6068fff03929a4b0f231a942d3873.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.4/meta-mingw-d87d4f00b9c6068fff03929a4b0f231a942d3873.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.4 </bitbake/log/?h=2.4>` +- Tag: :oe_git:`yocto-4.2.4 </bitbake/log/?h=yocto-4.2.4>` +- Git Revision: :oe_git:`c7e094ec3beccef0bbbf67c100147c449d9c6836 </bitbake/commit/?id=c7e094ec3beccef0bbbf67c100147c449d9c6836>` +- Release Artefact: bitbake-c7e094ec3beccef0bbbf67c100147c449d9c6836 +- sha: 6a35a62bee3446cd0f9e0ec1de9b8f60fc396109075b37d7c4a1f2e6d63271c6 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2.4/bitbake-c7e094ec3beccef0bbbf67c100147c449d9c6836.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2.4/bitbake-c7e094ec3beccef0bbbf67c100147c449d9c6836.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`mickledore </yocto-docs/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2.4 </yocto-docs/log/?h=yocto-4.2.4>` +- Git Revision: :yocto_git:`91a29ca94314c87fd3dc68601cd4932bdfffde35 </yocto-docs/commit/?id=91a29ca94314c87fd3dc68601cd4932bdfffde35>` + diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst new file mode 100644 index 0000000000..30049b89f6 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.2.rst @@ -0,0 +1,984 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 4.2 (mickledore) +---------------------------------- + +New Features / Enhancements in 4.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 6.1, glibc 2.37 and ~350 other recipe upgrades + +- Python 3.8+ and GCC 8.0+ are now the minimum required versions on the build host. + For host distributions that do not provide it, this is included as part of the + :term:`buildtools` tarball. + +- BitBake in this release now supports a new ``addpylib`` directive to enable + Python libraries within layers. For more information, + see :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`. + + This directive should be added to your layer configuration + as in the below example from ``meta/conf/layer.conf``:: + + addpylib ${LAYERDIR}/lib oe + +- BitBake has seen multiple internal changes that may improve + memory and disk usage as well as parsing time, in particular: + + - BitBake's Cooker server is now multithreaded. + + - Ctrl+C can now be used to interrupt some long-running operations + that previously ignored it. + + - BitBake's cache has been extended to include more hash + debugging data, but has also been optimized to :yocto_git:`compress + cache data <https://git.yoctoproject.org/poky/commit/?h=mickledore&id=7d010055e2af3294e17db862f42664ca689a9356>`. + + - BitBake's UI will now ping the server regularly to ensure + it is still alive. + +- New variables: + + - :term:`VOLATILE_TMP_DIR` allows to specify + whether ``/tmp`` should be on persistent storage + or in RAM. + + - :term:`SPDX_CUSTOM_ANNOTATION_VARS` allows to add + specific comments to the :term:`SPDX` description of a recipe. + +- Rust improvements: + + - This release adds Cargo support on the target, and includes + automated QA tests for this functionality. + + - It also supports checksums for Rust crates and makes + them mandatory for each crate in a recipe. + + - New :ref:`ref-classes-cargo-update-recipe-crates` class to + enable updating :term:`SRC_URI` crate lists from ``Cargo.lock`` + + - Enabled building Rust for baremetal targets + + - You can now also easily select to build beta or nightly + versions of Rust with a new :term:`RUST_CHANNEL` variable + (use at own risk) + + - Support for local GitHub repos in :term:`SRC_URI` as + replacements for Cargo dependencies + + - Use built-in Rust targets for ``-native`` builds to save several + minutes building the Rust toolchain + +- Architecture-specific enhancements: + + - This release adds initial support for the + :wikipedia:`LoongArch <Loongson#LoongArch>` + (``loongarch64``) architecture, though there is no testing for it yet. + + - New ``x86-64-v3`` tunes (AVX, AVX2, BMI1, BMI2, F16C, FMA, LZCNT, MOVBE, XSAVE) + + - go: add support to build on ppc64le + - rust: rustfmt now working and installed for riscv32 + - libpng: enable NEON for aarch64 to ensure consistency with arm32. + - baremetal-helloworld: Enable x86 and x86-64 ports + +- Kernel-related enhancements: + + - Added some support for building 6.2/6.3-rc kernels + - linux-yocto-dev: mark as compatible with qemuarm64 and qemuarmv5 + - Add kernel specific OBJCOPY to help switching toolchains cleanly for kernel build between gcc and clang + +- New core recipes: + + - ``debugedit`` + - ``gtk4`` (import from meta-gnome) + - ``gcr``: add recipe for gcr-4 + - ``graphene`` (import from meta-oe) + - ``libc-test`` + - ``libportal`` (import from meta-gnome) + - ``libslirp`` + - ``libtest-fatal-perl`` + - ``libtest-warnings-perl`` (import from meta-perl) + - ``libtry-tiny-perl`` + - ``python3-build`` + - ``python3-pyproject-hooks`` + - ``python3-hatch-fancy-pypi-readme`` + - ``python3-unittest-automake`` + +- QEMU/runqemu enhancements: + + - Set ``QB_SMP`` with ?= to make it easier to modify + - Set ``QB_CPU`` with ?= to make it easier to modify (x86 configuration only) + - New ``QB_NFSROOTFS_EXTRA_OPT`` to allow extra options to be appended to the NFS rootfs options in kernel boot args, e.g. ``"wsize=4096,rsize=4096"`` + - New ``QB_SETUP_CMD`` and ``QB_CLEANUP_CMD`` to enable running custom shell setup and cleanup commands before and after QEMU. + - ``QB_DEFAULT_KERNEL`` now defaults to pick the bundled initramfs kernel image if the Linux kernel image is generated with :term:`INITRAMFS_IMAGE_BUNDLE` set to "1" + - Split out the QEMU guest agent to its own ``qemu-guest-agent`` package + - runqemu: new ``guestagent`` option to enable communication with the guest agent + - runqemu: respect :term:`IMAGE_LINK_NAME` when searching for image + +- Image-related enhancements: + + - Add 7-Zip support in image conversion types (``7zip``) + - New :term:`IMAGE_MACHINE_SUFFIX` variable to allow easily removing machine name suffix from image file names + +- wic Image Creator enhancements: + + - ``bootimg-efi.py``: add support for directly loading Linux kernel UEFI stub + - ``bootimg-efi.py``: implement ``--include-path`` + - Allow usage of ``fstype=none`` to specify an unformatted partition + - Implement repeatable disk identifiers based on :term:`SOURCE_DATE_EPOCH` + +- FIT image related improvements: + + - FIT image signing support has been reworked to remove interdependencies and make it more easily extensible + - Skip FDT section creation for applicable symlinks to avoid the same dtb being duplicated + - New :term:`FIT_CONF_DEFAULT_DTB` variable to enable selecting default dtb when multiple dtbs exist + +- SDK-related improvements: + + - Extended the following recipes to nativesdk: + + - ``bc`` + - ``gi-docgen`` + - ``gperf`` + - ``python3-iniconfig`` + - ``python3-atomicwrites`` + - ``python3-markdown`` + - ``python3-smartypants`` + - ``python3-typogrify`` + - ``ruby`` + - ``unifdef`` + + - New :term:`SDK_ZIP_OPTIONS` variable to enable passing additional options to the zip command when preparing the SDK zip archive + - New Rust SDK target packagegroup (``packagegroup-rust-sdk-target``) + +- Testing: + + - The ptest images have changed structure in this release. The + underlying ``core-image-ptest`` recipe now uses :term:`BBCLASSEXTEND` to + create a variant for each ptest enabled recipe in OE-Core. + + For example, this means that ``core-image-ptest-bzip2``, + ``core-image-ptest-lttng-tools`` and many more image targets now exist + and can be built/tested individually. + + The ``core-image-ptest-all`` and ``core-image-ptest-fast`` targets are now + wrappers that target groups of individual images and means that the tests + can be executed in parallel during our automated testing. This also means + the dependencies are more accurately tested. + + - It is now possible to track regression changes between releases using + :oe_git:`yocto_testresults_query.py </openembedded-core/tree/scripts/yocto_testresults_query.py>`, + which is a thin wrapper over :oe_git:`resulttool + </openembedded-core/tree/scripts/resulttool>`. Here is an example + command, which allowed to spot and fix a regression in the + ``quilt`` ptest:: + + yocto_testresults_query.py regression-report 4.2_M1 4.2_M2 + + See this `blog post about regression detection + <https://bootlin.com/blog/continuous-integration-in-yocto-improving-the-regressions-detection/>`__. + + - This release adds support for parallel ptest execution with a ptest per image. + This takes ptest execution time from 3.5 hours to around 45 minutes on the autobuilder. + + - Basic Rust compile/run and cargo tests + + - New ``python3-unittest-automake`` recipe which provides modules for pytest + and unittest to adjust their output to automake-style for easier integration + with the ptest system. + + - ptest support added to ``bc``, ``cpio`` and ``gnutls``, and fixes made to + ptests in numerous other recipes. + + - ``ptest-runner`` now adds a non-root "ptest" user to run tests. + + - ``resulttool``: add a ``--list-ptest`` option to the log subcommand to list ptest names + in a results file + + - ``resulttool``: regression: add metadata filtering for oeselftest + +- New :term:`PACKAGECONFIG` options in the following recipes: + + - ``at-spi2-core`` + - ``base-passwd`` + - ``cronie`` + - ``cups`` + - ``curl`` + - ``file`` + - ``gstreamer1.0-plugins-good`` + - ``gtk+3`` + - ``iproute2`` + - ``libsdl2`` + - ``libtiff`` + - ``llvm`` + - ``mesa`` + - ``psmisc`` + - ``qemu`` + - ``sudo`` + - ``systemd`` + - ``tiff`` + - ``util-linux`` + +- Extended the following recipes to native: + + - ``iso-codes`` + - ``libxkbcommon`` + - ``p11-kit`` + - ``python3-atomicwrites`` + - ``python3-dbusmock`` + - ``python3-iniconfig`` + - ``xkeyboard-config`` + +- Utility script changes: + + - ``devtool``: ignore patch-fuzz errors when extracting source in order to enable fixing fuzz issues + - ``oe-setup-layers``: make efficiently idempotent + - ``oe-setup-layers``: print a note about submodules if present + - New ``buildstats-summary`` script to show a summary of the buildstats data + - :ref:`ref-classes-report-error` class: catch ``Nothing PROVIDES`` error + - ``combo-layer``: add ``sync-revs`` command + - ``convert-overrides``: allow command-line customizations + +- bitbake-layers improvements: + + - ``layerindex-fetch``: checkout layer(s) branch when clone exists + - ``create``: add ``-a``/``--add-layer option`` to add layer to ``bblayers.conf`` after creating layer + - ``show-layers``: improve output layout + +- Other BitBake improvements: + + - Inline Python snippets can now include dictionary expressions + - Evaluate the value of export/unexport/network flags so that they can be reset to "0" + - Make :term:`EXCLUDE_FROM_WORLD` boolean so that it can be reset to "0" + - Support int values in ``bb.utils.to_boolean()`` in addition to strings + - ``bitbake-getvar``: Add a ``quiet`` command line argument + - Allow the ``@`` character in variable flag names + - Python library code will now be included when calculating task hashes + - ``fetch2/npmsw``: add more short forms for git operations + - Display a warning when ``SRCREV = "${AUTOREV}"`` is set too late to be effective + - Display all missing :term:`SRC_URI` checksums at once + - Improve error message for a missing multiconfig + - Switch to a new :term:`BB_CACHEDIR` variable for codeparser cache location + - Mechanism introduced to reduce the codeparser cache unnecessarily growing in size + +- Packaging changes: + + - ``rng-tools`` is no longer recommended by ``openssh``, and the ``rng-tools`` + service files have been split out to their own package + - ``linux-firmware``: split ``rtl8761`` and ``amdgpu`` firmware + - ``linux-firmware``: add new firmware file to ``${PN}-qcom-adreno-a530`` + - ``iproute2``: separate ``routel`` and add Python dependency + - ``xinetd``: move ``xconv.pl`` script to separate package + - ``perf``: enable debug/source packaging + +- Prominent documentation updates: + + - Substantially expanded the ":doc:`/dev-manual/vulnerabilities`" section. + - Added a new ":doc:`/dev-manual/sbom`" section about SPDX SBoM generation. + - Expanded ":ref:`init-manager`" documentation. + - New section about :ref:`ref-long-term-support-releases`. + - System Requirements: details about :ref:`system-requirements-minimum-ram`. + - Details about :ref:`ref-building-meson-package` and the + :ref:`ref-classes-meson` class. + - Documentation about how to write recipes for Rust programs. See the + :ref:`ref-classes-cargo` class. + - Documentation about how to write recipes for Go programs. See the + :ref:`ref-classes-go` class. + - Variable index: added references to variables only documented in the + BitBake manual. All variables should be easy to access through the Yocto + Manual variable index. + - Expanded the description of the :term:`BB_NUMBER_THREADS` variable. + +- Miscellaneous changes: + + - Supporting 64 bit dates on 32 bit platforms: several packages have been + updated to pass year 2038 tests, and a QA check for 32 bit time and file + offset functions has been added (default off) + + - Patch fuzz/Upstream-Status checking has been reworked: + + - Upstream-Status checking is now configurable from :term:`WARN_QA`/:term:`ERROR_QA` (``patch-status-core``) + - Can now be enabled for non-core layers (``patch-status-noncore``) + - ``patch-fuzz`` is now in :term:`ERROR_QA` by default, and actually stops the build + + - Many packages were updated to add large file support. + + - ``vulkan-loader``: allow headless targets to build the loader + - ``dhcpcd``: fix to work with systemd + - ``u-boot``: add /boot to :term:`SYSROOT_DIRS` to allow boot files to be used by other recipes + - ``linux-firmware``: don't put the firmware into the sysroot + - ``cups``: add :term:`PACKAGECONFIG` to control web interface and default to off + - ``buildtools-tarball``: export certificates to python and curl + - ``yocto-check-layer``: allow OE-Core to be tested + - ``yocto-check-layer``: check for patch file upstream status + - ``boost``: enable building ``Boost.URL`` library + - ``native``: drop special variable handling + - Poky: make it easier to set :term:`INIT_MANAGER` from local.conf + - :ref:`ref-classes-create-spdx`: add support for custom annotations (:term:`SPDX_CUSTOM_ANNOTATION_VARS`) + - :ref:`ref-classes-create-spdx`: report downloads as separate packages + - :ref:`ref-classes-create-spdx`: remove the top-level image SPDX file and the JSON index file from :term:`DEPLOYDIR` to avoid confusion + - ``os-release``: replace ``DISTRO_CODENAME`` with ``VERSION_CODENAME`` (still set from :term:`DISTRO_CODENAME`) + - ``weston``: add kiosk shell + - :ref:`ref-classes-overlayfs`: Allow unused mount points + - ``sstatesig``: emit more helpful error message when not finding sstate manifest + - :ref:`ref-classes-pypi`.bbclass: Set :term:`SRC_URI` downloadfilename with an optional prefix + - ``poky-bleeding`` distro: update and rework + - :ref:`package.bbclass <ref-classes-package>`: check if package names conflict via ``PKG:${PN}`` override in :ref:`do_package <ref-tasks-package>` + - ``cve-update-nvd2-native``: new NVD CVE database fetcher using the 2.0 API + - :ref:`ref-classes-mirrors` class: use shallow tarball for ``binutils-native``/``nativesdk-binutils`` + - ``meta/conf``: move default configuration templates into ``meta/conf/templates/default`` + - ``binutils``: enable ``--enable-new-dtags`` as per many Linux distributions + - ``base-files``: drop ``localhost.localdomain`` from hosts file as per many Linux distributions + - ``packagegroup-core-boot``: make ``init-ifupdown`` package a recommendation + +Known Issues in 4.2 +~~~~~~~~~~~~~~~~~~~ + +- N/A + +Recipe License changes in 4.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +- ``curl``: set :term:`LICENSE` appropriately to ``curl`` as it is a special derivative of the MIT/X license, not exactly that license. +- ``libgit2``: added ``Zlib``, ``ISC``, ``LGPL-2.1-or-later`` and ``CC0-1.0`` to :term:`LICENSE` covering portions of the included code. +- ``linux-firmware``: set package :term:`LICENSE` appropriately for all qcom packages + +Security Fixes in 4.2 +~~~~~~~~~~~~~~~~~~~~~ + +- binutils: :cve:`2022-4285`, :cve_mitre:`2023-25586` +- curl: :cve:`2022-32221`, :cve:`2022-35260`, :cve:`2022-42915`, :cve:`2022-42916` +- epiphany: :cve:`2023-26081` +- expat: :cve:`2022-43680` +- ffmpeg: :cve:`2022-3964`, :cve:`2022-3965` +- git: :cve:`2022-39260`, :cve:`2022-41903`, :cve:`2022-23521`, :cve:`2022-41953` (ignored) +- glibc: :cve:`2023-25139` (ignored) +- go: :cve:`2023-24532`, :cve:`2023-24537` +- grub2: :cve:`2022-2601`, :cve:`2022-3775`, :cve_mitre:`2022-28736` +- inetutils: :cve:`2019-0053` +- less: :cve:`2022-46663` +- libarchive: :cve:`2022-36227` +- libinput: :cve:`2022-1215` +- libpam: :cve:`2022-28321` +- libpng: :cve:`2019-6129` +- libx11: :cve:`2022-3554` +- openssh: :cve:`2023-28531` +- openssl: :cve:`2022-3358`, :cve:`2022-3786`, :cve:`2022-3602`, :cve:`2022-3996`, :cve:`2023-0286`, :cve:`2022-4304`, :cve:`2022-4203`, :cve:`2023-0215`, :cve:`2022-4450`, :cve:`2023-0216`, :cve:`2023-0217`, :cve:`2023-0401`, :cve:`2023-0464` +- ppp: :cve:`2022-4603` +- python3-cryptography{-vectors}: :cve:`2022-3602`, :cve:`2022-3786`, :cve:`2023-23931` +- python3: :cve_mitre:`2022-37460` +- qemu: :cve:`2022-3165` +- rust: :cve:`2022-46176` +- rxvt-unicode: :cve:`2022-4170` +- screen: :cve:`2023-24626` +- shadow: :cve:`2023-29383`, :cve:`2016-15024` (ignored) +- sudo: :cve:`2022-43995` +- systemd: :cve:`2022-4415` (ignored) +- tar: :cve:`2022-48303` +- tiff: :cve:`2022-3599`, :cve:`2022-3597`, :cve:`2022-3626`, :cve:`2022-3627`, :cve:`2022-3570`, :cve:`2022-3598`, :cve:`2022-3970`, :cve:`2022-48281` +- vim: :cve:`2022-3352`, :cve:`2022-4141`, :cve:`2023-0049`, :cve:`2023-0051`, :cve:`2023-0054`, :cve:`2023-0288`, :cve:`2023-1127`, :cve:`2023-1170`, :cve:`2023-1175`, :cve:`2023-1127`, :cve:`2023-1170`, :cve:`2023-1175`, :cve:`2023-1264`, :cve:`2023-1355`, :cve:`2023-0433`, :cve:`2022-47024`, :cve:`2022-3705` +- xdg-utils: :cve:`2022-4055` +- xserver-xorg: :cve:`2022-3550`, :cve:`2022-3551`, :cve:`2023-1393`, :cve:`2023-0494`, :cve:`2022-3553` (ignored) + +Recipe Upgrades in 4.2 +~~~~~~~~~~~~~~~~~~~~~~ + +- acpid: upgrade 2.0.33 -> 2.0.34 +- adwaita-icon-theme: update 42.0 -> 43 +- alsa-lib: upgrade 1.2.7.2 -> 1.2.8 +- alsa-ucm-conf: upgrade 1.2.7.2 -> 1.2.8 +- alsa-utils: upgrade 1.2.7 -> 1.2.8 +- apr: update 1.7.0 -> 1.7.2 +- apr-util: update 1.6.1 -> 1.6.3 +- argp-standalone: replace with a maintained fork +- at-spi2-core: upgrade 2.44.1 -> 2.46.0 +- autoconf-archive: upgrade 2022.09.03 -> 2023.02.20 +- babeltrace: upgrade 1.5.8 -> 1.5.11 +- base-passwd: Update to 3.6.1 +- bash: update 5.1.16 -> 5.2.15 +- bind: upgrade 9.18.7 -> 9.18.12 +- binutils: Upgrade to 2.40 release +- bluez: update 5.65 -> 5.66 +- boost-build-native: update 1.80.0 -> 1.81.0 +- boost: upgrade 1.80.0 -> 1.81.0 +- btrfs-tools: upgrade 5.19.1 -> 6.1.3 +- busybox: 1.35.0 -> 1.36.0 +- ccache: upgrade 4.6.3 -> 4.7.4 +- cmake: update 3.24.0 -> 3.25.2 +- cracklib: upgrade to v2.9.10 +- curl: upgrade 7.86.0 -> 8.0.1 +- dbus: upgrade 1.14.0 -> 1.14.6 +- diffoscope: upgrade 221 -> 236 +- diffstat: upgrade 1.64 -> 1.65 +- diffutils: update 3.8 -> 3.9 +- dos2unix: upgrade 7.4.3 -> 7.4.4 +- dpkg: update 1.21.9 -> 1.21.21 +- dropbear: upgrade 2022.82 -> 2022.83 +- dtc: upgrade 1.6.1 -> 1.7.0 +- e2fsprogs: upgrade 1.46.5 -> 1.47.0 +- ed: upgrade 1.18 -> 1.19 +- elfutils: update 0.187 -> 0.188 +- ell: upgrade 0.53 -> 0.56 +- enchant2: upgrade 2.3.3 -> 2.3.4 +- encodings: update 1.0.6 -> 1.0.7 +- epiphany: update 42.4 -> 43.1 +- ethtool: upgrade 5.19 -> 6.2 +- expat: upgrade to 2.5.0 +- ffmpeg: upgrade 5.1.1 -> 5.1.2 +- file: upgrade 5.43 -> 5.44 +- flac: update 1.4.0 -> 1.4.2 +- font-alias: update 1.0.4 -> 1.0.5 +- fontconfig: upgrade 2.14.0 -> 2.14.2 +- font-util: upgrade 1.3.3 -> 1.4.0 +- freetype: update 2.12.1 -> 2.13.0 +- gawk: update 5.1.1 -> 5.2.1 +- gcr3: update 3.40.0 -> 3.41.1 +- gcr: rename gcr -> gcr3 +- gdb: Upgrade to 13.1 +- gdk-pixbuf: upgrade 2.42.9 -> 2.42.10 +- gettext: update 0.21 -> 0.21.1 +- ghostscript: update 9.56.1 -> 10.0.0 +- gi-docgen: upgrade 2022.1 -> 2023.1 +- git: upgrade 2.37.3 -> 2.39.2 +- glib-2.0: update 2.72.3 -> 2.74.6 +- glibc: upgrade to 2.37 release + stable updates +- glib-networking: update 2.72.2 -> 2.74.0 +- glslang: upgrade 1.3.236.0 -> 1.3.239.0 +- gnu-config: upgrade to latest revision +- gnupg: upgrade 2.3.7 -> 2.4.0 +- gnutls: upgrade 3.7.7 -> 3.8.0 +- gobject-introspection: upgrade 1.72.0 -> 1.74.0 +- go: update 1.19 -> 1.20.1 +- grep: update 3.7 -> 3.10 +- gsettings-desktop-schemas: upgrade 42.0 -> 43.0 +- gstreamer1.0: upgrade 1.20.3 -> 1.22.0 +- gtk+3: upgrade 3.24.34 -> 3.24.36 +- gtk4: update 4.8.2 -> 4.10.0 +- harfbuzz: upgrade 5.1.0 -> 7.1.0 +- hdparm: update 9.64 -> 9.65 +- help2man: upgrade 1.49.2 -> 1.49.3 +- icu: update 71.1 -> 72-1 +- ifupdown: upgrade 0.8.37 -> 0.8.41 +- igt-gpu-tools: upgrade 1.26 -> 1.27.1 +- inetutils: upgrade 2.3 -> 2.4 +- init-system-helpers: upgrade 1.64 -> 1.65.2 +- iproute2: upgrade 5.19.0 -> 6.2.0 +- iptables: update 1.8.8 -> 1.8.9 +- iputils: update to 20221126 +- iso-codes: upgrade 4.11.0 -> 4.13.0 +- jquery: upgrade 3.6.0 -> 3.6.3 +- kexec-tools: upgrade 2.0.25 -> 2.0.26 +- kmscube: upgrade to latest revision +- libarchive: upgrade 3.6.1 -> 3.6.2 +- libbsd: upgrade 0.11.6 -> 0.11.7 +- libcap: upgrade 2.65 -> 2.67 +- libdnf: update 0.69.0 -> 0.70.0 +- libdrm: upgrade 2.4.113 -> 2.4.115 +- libedit: upgrade 20210910-3.1 -> 20221030-3.1 +- libepoxy: update 1.5.9 -> 1.5.10 +- libffi: upgrade 3.4.2 -> 3.4.4 +- libfontenc: upgrade 1.1.6 -> 1.1.7 +- libgit2: upgrade 1.5.0 -> 1.6.3 +- libgpg-error: update 1.45 -> 1.46 +- libhandy: update 1.6.3 -> 1.8.1 +- libical: upgrade 3.0.14 -> 3.0.16 +- libice: update 1.0.10 -> 1.1.1 +- libidn2: upgrade 2.3.3 -> 2.3.4 +- libinput: upgrade 1.19.4 -> 1.22.1 +- libjpeg-turbo: upgrade 2.1.4 -> 2.1.5.1 +- libksba: upgrade 1.6.0 -> 1.6.3 +- libmicrohttpd: upgrade 0.9.75 -> 0.9.76 +- libmodule-build-perl: update 0.4231 -> 0.4232 +- libmpc: upgrade 1.2.1 -> 1.3.1 +- libnewt: update 0.52.21 -> 0.52.23 +- libnotify: upgrade 0.8.1 -> 0.8.2 +- libpcap: upgrade 1.10.1 -> 1.10.3 +- libpciaccess: update 0.16 -> 0.17 +- libpcre2: upgrade 10.40 -> 10.42 +- libpipeline: upgrade 1.5.6 -> 1.5.7 +- libpng: upgrade 1.6.38 -> 1.6.39 +- libpsl: upgrade 0.21.1 -> 0.21.2 +- librepo: upgrade 1.14.5 -> 1.15.1 +- libsdl2: upgrade 2.24.1 -> 2.26.3 +- libsm: 1.2.3 > 1.2.4 +- libsndfile1: upgrade 1.1.0 -> 1.2.0 +- libsolv: upgrade 0.7.22 -> 0.7.23 +- libsoup-2.4: upgrade 2.74.2 -> 2.74.3 +- libsoup: upgrade 3.0.7 -> 3.2.2 +- libtest-fatal-perl: upgrade 0.016 -> 0.017 +- libtest-needs-perl: upgrade 0.002009 -> 0.002010 +- libunistring: upgrade 1.0 -> 1.1 +- liburcu: upgrade 0.13.2 -> 0.14.0 +- liburi-perl: upgrade 5.08 -> 5.17 +- libva: upgrade 2.15.0 -> 2.16.0 +- libva-utils: upgrade 2.15.0 -> 2.17.1 +- libwebp: upgrade 1.2.4 -> 1.3.0 +- libwpe: upgrade 1.12.3 -> 1.14.1 +- libx11: 1.8.1 -> 1.8.4 +- libx11-compose-data: 1.6.8 -> 1.8.4 +- libxau: upgrade 1.0.10 -> 1.0.11 +- libxcomposite: update 0.4.5 -> 0.4.6 +- libxcrypt-compat: upgrade 4.4.30 -> 4.4.33 +- libxcrypt: upgrade 4.4.28 -> 4.4.30 +- libxdamage: update 1.1.5 -> 1.1.6 +- libxdmcp: update 1.1.3 -> 1.1.4 +- libxext: update 1.3.4 -> 1.3.5 +- libxft: update 2.3.4 -> 2.3.6 +- libxft: upgrade 2.3.6 -> 2.3.7 +- libxinerama: update 1.1.4 -> 1.1.5 +- libxkbcommon: upgrade 1.4.1 -> 1.5.0 +- libxkbfile: update 1.1.0 -> 1.1.1 +- libxkbfile: upgrade 1.1.1 -> 1.1.2 +- libxml2: upgrade 2.9.14 -> 2.10.3 +- libxmu: update 1.1.3 -> 1.1.4 +- libxpm: update 3.5.13 -> 3.5.15 +- libxrandr: update 1.5.2 -> 1.5.3 +- libxrender: update 0.9.10 -> 0.9.11 +- libxres: update 1.2.1 -> 1.2.2 +- libxscrnsaver: update 1.2.3 -> 1.2.4 +- libxshmfence: update 1.3 -> 1.3.2 +- libxslt: upgrade 1.1.35 -> 1.1.37 +- libxtst: update 1.2.3 -> 1.2.4 +- libxv: update 1.0.11 -> 1.0.12 +- libxxf86vm: update 1.1.4 -> 1.1.5 +- lighttpd: upgrade 1.4.66 -> 1.4.69 +- linux-firmware: upgrade 20220913 -> 20230210 +- linux-libc-headers: bump to 6.1 +- linux-yocto/5.15: update genericx86* machines to v5.15.103 +- linux-yocto/5.15: update to v5.15.108 +- linux-yocto/6.1: update to v6.1.25 +- linux-yocto-dev: bump to v6.3 +- linux-yocto-rt/5.15: update to -rt59 +- linux-yocto-rt/6.1: update to -rt7 +- llvm: update 14.0.6 -> 15.0.7 +- log4cplus: upgrade 2.0.8 -> 2.1.0 +- logrotate: upgrade 3.20.1 -> 3.21.0 +- lsof: upgrade 4.95.0 -> 4.98.0 +- ltp: upgrade 20220527 -> 20230127 +- lttng-modules: upgrade 2.13.4 -> 2.13.9 +- lttng-tools: update 2.13.8 -> 2.13.9 +- lttng-ust: upgrade 2.13.4 -> 2.13.5 +- makedepend: upgrade 1.0.6 -> 1.0.8 +- make: update 4.3 -> 4.4.1 +- man-db: update 2.10.2 -> 2.11.2 +- man-pages: upgrade 5.13 -> 6.03 +- matchbox-config-gtk: Update to latest SRCREV +- matchbox-desktop-2: Update 2.2 -> 2.3 +- matchbox-panel-2: Update 2.11 -> 2.12 +- matchbox-terminal: Update to latest SRCREV +- matchbox-wm: Update 1.2.2 -> 1.2.3 +- mc: update 4.8.28 -> 4.8.29 +- mesa: update 22.2.0 -> 23.0.0 +- meson: upgrade 0.63.2 -> 1.0.1 +- mmc-utils: upgrade to latest revision +- mobile-broadband-provider-info: upgrade 20220725 -> 20221107 +- mpfr: upgrade 4.1.0 -> 4.2.0 +- mpg123: upgrade 1.30.2 -> 1.31.2 +- msmtp: upgrade 1.8.22 -> 1.8.23 +- mtd-utils: upgrade 2.1.4 -> 2.1.5 +- mtools: upgrade 4.0.40 -> 4.0.42 +- musl-obstack: Update to 1.2.3 +- musl: Upgrade to latest master +- nasm: update 2.15.05 -> 2.16.01 +- ncurses: upgrade 6.3+20220423 -> 6.4 +- netbase: upgrade 6.3 -> 6.4 +- newlib: Upgrade 4.2.0 -> 4.3.0 +- nghttp2: upgrade 1.49.0 -> 1.52.0 +- numactl: upgrade 2.0.15 -> 2.0.16 +- opensbi: Upgrade to 1.2 release +- openssh: upgrade 9.0p1 -> 9.3p1 +- openssl: Upgrade 3.0.5 -> 3.1.0 +- opkg: upgrade to version 0.6.1 +- orc: upgrade 0.4.32 -> 0.4.33 +- ovmf: upgrade edk2-stable202205 -> edk2-stable202211 +- pango: upgrade 1.50.9 -> 1.50.13 +- patchelf: upgrade 0.15.0 -> 0.17.2 +- pciutils: upgrade 3.8.0 -> 3.9.0 +- piglit: upgrade to latest revision +- pinentry: update 1.2.0 -> 1.2.1 +- pixman: upgrade 0.40.0 -> 0.42.2 +- pkgconf: upgrade 1.9.3 -> 1.9.4 +- popt: update 1.18 -> 1.19 +- powertop: upgrade 2.14 -> 2.15 +- procps: update 3.3.17 -> 4.0.3 +- psmisc: upgrade 23.5 -> 23.6 +- puzzles: upgrade to latest revision +- python3-alabaster: upgrade 0.7.12 -> 0.7.13 +- python3-attrs: upgrade 22.1.0 -> 22.2.0 +- python3-babel: upgrade 2.10.3 -> 2.12.1 +- python3-bcrypt: upgrade 3.2.2 -> 4.0.1 +- python3-certifi: upgrade 2022.9.14 -> 2022.12.7 +- python3-chardet: upgrade 5.0.0 -> 5.1.0 +- python3-cryptography: upgrade 38.0.3 -> 39.0.4 +- python3-cryptography-vectors: upgrade 37.0.4 -> 39.0.2 +- python3-cython: upgrade 0.29.32 -> 0.29.33 +- python3-dbusmock: update 0.28.4 -> 0.28.7 +- python3-dbus: upgrade 1.2.18 -> 1.3.2 +- python3-dtschema: upgrade 2022.8.3 -> 2023.1 +- python3-flit-core: upgrade 3.7.1 -> 3.8.0 +- python3-gitdb: upgrade 4.0.9 -> 4.0.10 +- python3-git: upgrade 3.1.27 -> 3.1.31 +- python3-hatch-fancy-pypi-readme: upgrade 22.7.0 -> 22.8.0 +- python3-hatchling: upgrade 1.9.0 -> 1.13.0 +- python3-hatch-vcs: upgrade 0.2.0 -> 0.3.0 +- python3-hypothesis: upgrade 6.54.5 -> 6.68.2 +- python3-importlib-metadata: upgrade 4.12.0 -> 6.0.0 +- python3-iniconfig: upgrade 1.1.1 -> 2.0.0 +- python3-installer: update 0.5.1 -> 0.6.0 +- python3-iso8601: upgrade 1.0.2 -> 1.1.0 +- python3-jsonschema: upgrade 4.9.1 -> 4.17.3 +- python3-lxml: upgrade 4.9.1 -> 4.9.2 +- python3-mako: upgrade 1.2.2 -> 1.2.4 +- python3-markupsafe: upgrade 2.1.1 -> 2.1.2 +- python3-more-itertools: upgrade 8.14.0 -> 9.1.0 +- python3-numpy: upgrade 1.23.3 -> 1.24.2 +- python3-packaging: upgrade to 23.0 +- python3-pathspec: upgrade 0.10.1 -> 0.11.0 +- python3-pbr: upgrade 5.10.0 -> 5.11.1 +- python3-pip: upgrade 22.2.2 -> 23.0.1 +- python3-poetry-core: upgrade 1.0.8 -> 1.5.2 +- python3-psutil: upgrade 5.9.2 -> 5.9.4 +- python3-pycairo: upgrade 1.21.0 -> 1.23.0 +- python3-pycryptodome: upgrade 3.15.0 -> 3.17 +- python3-pycryptodomex: upgrade 3.15.0 -> 3.17 +- python3-pygments: upgrade 2.13.0 -> 2.14.0 +- python3-pyopenssl: upgrade 22.0.0 -> 23.0.0 +- python3-pyrsistent: upgrade 0.18.1 -> 0.19.3 +- python3-pytest-subtests: upgrade 0.8.0 -> 0.10.0 +- python3-pytest: upgrade 7.1.3 -> 7.2.2 +- python3-pytz: upgrade 2022.2.1 -> 2022.7.1 +- python3-requests: upgrade 2.28.1 -> 2.28.2 +- python3-scons: upgrade 4.4.0 -> 4.5.2 +- python3-setuptools-rust: upgrade 1.5.1 -> 1.5.2 +- python3-setuptools-scm: upgrade 7.0.5 -> 7.1.0 +- python3-setuptools: upgrade 65.0.2 -> 67.6.0 +- python3-sphinxcontrib-applehelp: update 1.0.2 -> 1.0.4 +- python3-sphinxcontrib-htmlhelp: 2.0.0 -> 2.0.1 +- python3-sphinx-rtd-theme: upgrade 1.0.0 -> 1.2.0 +- python3-sphinx: upgrade 5.1.1 -> 6.1.3 +- python3-subunit: upgrade 1.4.0 -> 1.4.2 +- python3-testtools: upgrade 2.5.0 -> 2.6.0 +- python3-typing-extensions: upgrade 4.3.0 -> 4.5.0 +- python3: update 3.10.6 -> 3.11.2 +- python3-urllib3: upgrade 1.26.12 -> 1.26.15 +- python3-wcwidth: upgrade 0.2.5 -> 0.2.6 +- python3-wheel: upgrade 0.37.1 -> 0.40.0 +- python3-zipp: upgrade 3.8.1 -> 3.15.0 +- qemu: update 7.1.0 -> 7.2.0 +- quota: update 4.06 -> 4.09 +- readline: update 8.1.2 -> 8.2 +- repo: upgrade 2.29.2 -> 2.32 +- rgb: update 1.0.6 -> 1.1.0 +- rng-tools: upgrade 6.15 -> 6.16 +- rsync: update 3.2.5 -> 3.2.7 +- rt-tests: update 2.4 -> 2.5 +- ruby: update 3.1.2 -> 3.2.1 +- rust: update 1.63.0 -> 1.68.1 +- rxvt-unicode: upgrade 9.30 -> 9.31 +- sed: update 4.8 -> 4.9 +- shaderc: upgrade 2022.2 -> 2023.2 +- shadow: update 4.12.1 -> 4.13 +- socat: upgrade 1.7.4.3 -> 1.7.4.4 +- spirv-headers: upgrade 1.3.236.0 -> 1.3.239.0 +- spirv-tools: upgrade 1.3.236.0 -> 1.3.239.0 +- sqlite3: upgrade 3.39.3 -> 3.41.0 +- strace: upgrade 5.19 -> 6.2 +- stress-ng: update 0.14.03 -> 0.15.06 +- sudo: upgrade 1.9.11p3 -> 1.9.13p3 +- swig: update 4.0.2 -> 4.1.1 +- sysstat: upgrade 12.6.0 -> 12.6.2 +- systemd: update 251.4 -> 253.1 +- systemtap: upgrade 4.7 -> 4.8 +- taglib: upgrade 1.12 -> 1.13 +- tcf-agent: Update to current version +- tcl: update 8.6.11 -> 8.6.13 +- texinfo: update 6.8 -> 7.0.2 +- tiff: update 4.4.0 -> 4.5.0 +- tzdata: update 2022d -> 2023c +- u-boot: upgrade 2022.07 -> 2023.01 +- unfs: update 0.9.22 -> 0.10.0 +- usbutils: upgrade 014 -> 015 +- util-macros: upgrade 1.19.3 -> 1.20.0 +- vala: upgrade 0.56.3 -> 0.56.4 +- valgrind: update to 3.20.0 +- vim: Upgrade 9.0.0598 -> 9.0.1429 +- virglrenderer: upgrade 0.10.3 -> 0.10.4 +- vte: update 0.68.0 -> 0.72.0 +- vulkan-headers: upgrade 1.3.236.0 -> 1.3.239.0 +- vulkan-loader: upgrade 1.3.236.0 -> 1.3.239.0 +- vulkan-samples: update to latest revision +- vulkan-tools: upgrade 1.3.236.0 -> 1.3.239.0 +- vulkan: update 1.3.216.0 -> 1.3.236.0 +- wayland-protocols: upgrade 1.26 -> 1.31 +- wayland-utils: update 1.0.0 -> 1.1.0 +- webkitgtk: update 2.36.7 -> 2.38.5 +- weston: update 10.0.2 -> 11.0.1 +- wireless-regdb: upgrade 2022.08.12 -> 2023.02.13 +- wpebackend-fdo: upgrade 1.12.1 -> 1.14.0 +- xcb-util: update 0.4.0 -> 0.4.1 +- xcb-util-keysyms: 0.4.0 -> 0.4.1 +- xcb-util-renderutil: 0.3.9 -> 0.3.10 +- xcb-util-wm: 0.4.1 -> 0.4.2 +- xcb-util-image: 0.4.0 -> 0.4.1 +- xf86-input-mouse: update 1.9.3 -> 1.9.4 +- xf86-input-vmmouse: update 13.1.0 -> 13.2.0 +- xf86-video-vesa: update 2.5.0 -> 2.6.0 +- xf86-video-vmware: update 13.3.0 -> 13.4.0 +- xhost: update 1.0.8 -> 1.0.9 +- xinit: update 1.4.1 -> 1.4.2 +- xkbcomp: update 1.4.5 -> 1.4.6 +- xkeyboard-config: upgrade 2.36 -> 2.38 +- xprop: update 1.2.5 -> 1.2.6 +- xrandr: upgrade 1.5.1 -> 1.5.2 +- xserver-xorg: upgrade 21.1.4 -> 21.1.7 +- xset: update 1.2.4 -> 1.2.5 +- xvinfo: update 1.1.4 -> 1.1.5 +- xwayland: upgrade 22.1.3 -> 22.1.8 +- xz: upgrade 5.2.6 -> 5.4.2 +- zlib: upgrade 1.2.12 -> 1.2.13 +- zstd: upgrade 1.5.2 -> 1.5.4 + +Contributors to 4.2 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +- Adrian Freihofer +- Ahmad Fatoum +- Alejandro Hernandez Samaniego +- Alexander Kanavin +- Alexandre Belloni +- Alexey Smirnov +- Alexis Lothoré +- Alex Kiernan +- Alex Stewart +- Andrej Valek +- Andrew Geissler +- Anton Antonov +- Antonin Godard +- Archana Polampalli +- Armin Kuster +- Arnout Vandecappelle +- Arturo Buzarra +- Atanas Bunchev +- Benjamin Szőke +- Benoît Mauduit +- Bernhard Rosenkränzer +- Bruce Ashfield +- Caner Altinbasak +- Carlos Alberto Lopez Perez +- Changhyeok Bae +- Changqing Li +- Charlie Johnston +- Chase Qi +- Chee Yang Lee +- Chen Qi +- Chris Elledge +- Christian Eggers +- Christoph Lauer +- Chuck Wolber +- Ciaran Courtney +- Claus Stovgaard +- Clément Péron +- Daniel Ammann +- David Bagonyi +- Denys Dmytriyenko +- Denys Zagorui +- Diego Sueiro +- Dmitry Baryshkov +- Ed Tanous +- Enguerrand de Ribaucourt +- Enrico Jörns +- Enrico Scholz +- Etienne Cordonnier +- Fabio Estevam +- Fabre Sébastien +- Fawzi KHABER +- Federico Pellegrin +- Frank de Brabander +- Frederic Martinsons +- Geoffrey GIRY +- George Kelly +- Harald Seiler +- He Zhe +- Hitendra Prajapati +- Jagadeesh Krishnanjanappa +- James Raphael Tiovalen +- Jan Kircher +- Jan Luebbe +- Jan-Simon Moeller +- Javier Tia +- Jeremy Puhlman +- Jermain Horsman +- Jialing Zhang +- Joel Stanley +- Joe Slater +- Johan Korsnes +- Jon Mason +- Jordan Crouse +- Jose Quaresma +- Joshua Watt +- Justin Bronder +- Kai Kang +- Kasper Revsbech +- Keiya Nobuta +- Kenfe-Mickael Laventure +- Kevin Hao +- Khem Raj +- Konrad Weihmann +- Lei Maohui +- Leon Anavi +- Liam Beguin +- Louis Rannou +- Luca Boccassi +- Luca Ceresoli +- Luis Martins +- Maanya Goenka +- Marek Vasut +- Mark Asselstine +- Mark Hatle +- Markus Volk +- Marta Rybczynska +- Martin Jansa +- Martin Larsson +- Mateusz Marciniec +- Mathieu Dubois-Briand +- Mauro Queiros +- Maxim Uvarov +- Michael Halstead +- Michael Opdenacker +- Mike Crowe +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Narpat Mali +- Nathan Rossi +- Niko Mauno +- Ola x Nilsson +- Oliver Lang +- Ovidiu Panait +- Pablo Saavedra +- Patrick Williams +- Paul Eggleton +- Paulo Neves +- Pavel Zhukov +- Pawel Zalewski +- Pedro Baptista +- Peter Bergin +- Peter Kjellerstedt +- Peter Marko +- Petr Kubizňák +- Petr Vorel +- pgowda +- Piotr Łobacz +- Quentin Schulz +- Randy MacLeod +- Ranjitsinh Rathod +- Ravineet Singh +- Ravula Adhitya Siddartha +- Richard Elberger +- Richard Leitner +- Richard Purdie +- Robert Andersson +- Robert Joslyn +- Robert Yang +- Romuald JEANNE +- Ross Burton +- Ryan Eatmon +- Sakib Sajal +- Sandeep Gundlupet Raju +- Saul Wold +- Sean Anderson +- Sergei Zhmylev +- Siddharth Doshi +- Soumya +- Sudip Mukherjee +- Sundeep KOKKONDA +- Teoh Jay Shen +- Thomas De Schampheleire +- Thomas Perrot +- Thomas Roos +- Tim Orling +- Tobias Hagelborn +- Tom Hochstein +- Trevor Woerner +- Ulrich Ölmann +- Vincent Davis Jr +- Vivek Kumbhar +- Vyacheslav Yurkov +- Wang Mingyu +- Wentao Zhang +- Xiangyu Chen +- Xiaotian Wu +- Yan Xinkuan +- Yash Shinde +- Yi Zhao +- Yoann Congal +- Yureka Lilian +- Zang Ruochen +- Zheng Qiu +- Zheng Ruoqin +- Zoltan Boszormenyi +- 张忠山 + + +Repositories / Downloads for Yocto-4.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`mickledore </poky/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2 </poky/log/?h=yocto-4.2>` +- Git Revision: :yocto_git:`21790e71d55f417f27cd51fae9dd47549758d4a0 </poky/commit/?id=21790e71d55f417f27cd51fae9dd47549758d4a0>` +- Release Artefact: poky-21790e71d55f417f27cd51fae9dd47549758d4a0 +- sha: 38606076765d912deec84e523403709ef1249122197e61454ae08818e60f83c2 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2/poky-21790e71d55f417f27cd51fae9dd47549758d4a0.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2/poky-21790e71d55f417f27cd51fae9dd47549758d4a0.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`mickledore </openembedded-core/log/?h=mickledore>` +- Tag: :oe_git:`yocto-4.2 </openembedded-core/log/?h=yocto-4.2>` +- Git Revision: :oe_git:`c57d1a561db563ed2f521bbac5fc12d4ac8e11a7 </openembedded-core/commit/?id=c57d1a561db563ed2f521bbac5fc12d4ac8e11a7>` +- Release Artefact: oecore-c57d1a561db563ed2f521bbac5fc12d4ac8e11a7 +- sha: e8cdd870492017be7e7b74b8c2fb73ae6771b2d2125b2aa1f0e65d0689f96af8 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2/oecore-c57d1a561db563ed2f521bbac5fc12d4ac8e11a7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2/oecore-c57d1a561db563ed2f521bbac5fc12d4ac8e11a7.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`mickledore </meta-mingw/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2 </meta-mingw/log/?h=yocto-4.2>` +- Git Revision: :yocto_git:`250617ffa524c082b848487359b9d045703d59c2 </meta-mingw/commit/?id=250617ffa524c082b848487359b9d045703d59c2>` +- Release Artefact: meta-mingw-250617ffa524c082b848487359b9d045703d59c2 +- sha: 873a97dfd5ed6fb26e1f6a2ddc2c0c9d7a7b3c7f5018588e912294618775c323 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2/meta-mingw-250617ffa524c082b848487359b9d045703d59c2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2/meta-mingw-250617ffa524c082b848487359b9d045703d59c2.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.4 </bitbake/log/?h=2.4>` +- Tag: :oe_git:`yocto-4.2 </bitbake/log/?h=yocto-4.2>` +- Git Revision: :oe_git:`d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c </bitbake/commit/?id=d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c>` +- Release Artefact: bitbake-d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c +- sha: 5edcb97cb545011226b778355bb840ebcc790552d4a885a0d83178153697ba7a +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.2/bitbake-d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.2/bitbake-d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`mickledore </yocto-docs/log/?h=mickledore>` +- Tag: :yocto_git:`yocto-4.2 </yocto-docs/log/?h=yocto-4.2>` +- Git Revision: :yocto_git:`4d6807e34adf5d92d9b6e5852736443a867c78fa </yocto-docs/commit/?id=4d6807e34adf5d92d9b6e5852736443a867c78fa>` + diff --git a/documentation/migration-guides/release-notes-4.3.1.rst b/documentation/migration-guides/release-notes-4.3.1.rst new file mode 100644 index 0000000000..cea9c538a2 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.3.1.rst @@ -0,0 +1,237 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.3.1 (Nanbield) +---------------------------------------- + +Security Fixes in Yocto-4.3.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- libsndfile1: Fix :cve:`2022-33065` +- libxml2: Ignore :cve:`2023-45322` +- linux-yocto/6.1: Ignore :cve:`2020-27418`, :cve:`2023-31085`, :cve_mitre:`2023-34324`, :cve:`2023-39189`, :cve:`2023-39192`, :cve:`2023-39193`, :cve:`2023-39194`, :cve:`2023-4244`, :cve:`2023-42754`, :cve:`2023-42756`, :cve:`2023-44466`, :cve:`2023-4563`, :cve:`2023-45862`, :cve:`2023-45863`, :cve:`2023-45871`, :cve:`2023-45898`, :cve:`2023-4732`, :cve:`2023-5158`, :cve:`2023-5197` and :cve:`2023-5345` +- linux-yocto/6.5: Ignore :cve:`2020-27418`, :cve:`2023-1193`, :cve:`2023-39191`, :cve:`2023-39194`, :cve:`2023-40791`, :cve:`2023-44466`, :cve:`2023-45862`, :cve:`2023-45863`, :cve:`2023-4610` and :cve:`2023-4732` +- openssl: Fix :cve:`2023-5363` +- pixman: Ignore :cve:`2023-37769` +- vim: Fix :cve:`2023-46246` +- zlib: Ignore :cve:`2023-45853` + + +Fixes in Yocto-4.3.1 +~~~~~~~~~~~~~~~~~~~~ + +- baremetal-helloworld: Pull in fix for race condition on x86-64 +- base: Ensure recipes using mercurial-native have certificates +- bb-matrix-plot.sh: Show underscores correctly in labels +- bin_package.bbclass: revert "Inhibit the default dependencies" +- bitbake: SECURITY.md: add file +- brief-yoctoprojectqs: use new CDN mirror for sstate +- bsp-guide: bsp.rst: update beaglebone example +- bsp-guide: bsp: skip Intel machines no longer supported in Poky +- build-appliance-image: Update to nanbield head revision +- contributor-guide: add patchtest section +- contributor-guide: clarify patchtest usage +- cve-check: don't warn if a patch is remote +- cve-check: slightly more verbose warning when adding the same package twice +- cve-check: sort the package list in the JSON report +- dev-manual: add security team processes +- dev-manual: extend the description of CVE patch preparation +- dev-manual: layers: Add notes about layer.conf +- dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" section +- dev-manual: start.rst: remove obsolete reference +- dev-manual: wic: update "wic list images" output +- docs: add support for nanbield (4.3) release +- documentation.conf: drop SERIAL_CONSOLES_CHECK +- ell: Upgrade to 0.59 +- glib-2.0: Remove unnecessary assignement +- goarch: Move Go architecture mapping to a library +- kernel-arch: drop CCACHE from :term:`KERNEL_STRIP` definition +- kernel.bbclass: Use strip utility used for kernel build in do_package +- layer.conf: Switch layer to nanbield series only +- libsdl2: upgrade to 2.28.4 +- linux-yocto: make sure the pahole-native available before do_kernel_configme +- llvm: Upgrade to 17.0.3 +- machine: drop obsolete SERIAL_CONSOLES_CHECK +- manuals: correct "yocto-linux" by "linux-yocto" +- manuals: improve description of :term:`CVE_STATUS` and :term:`CVE_STATUS_GROUPS` +- manuals: Remove references to apm in :term:`MACHINE_FEATURES` +- manuals: update linux-yocto append examples +- manuals: update list of supported machines +- migration-4.3: additional migration items +- migration-4.3: adjustments to existing text +- migration-4.3: remove some unnecessary items +- migration-guides: QEMU_USE_SLIRP variable removed +- migration-guides: add BitBake changes +- migration-guides: add debian 12 to newly supported distros +- migration-guides: add kernel notes +- migration-guides: add testing notes +- migration-guides: add utility notes +- migration-guides: edgerouter machine removed +- migration-guides: enabling :term:`SPDX` only for Poky, not a global default +- migration-guides: fix empty sections +- migration-guides: further updates for 4.3 +- migration-guides: further updates for release 4.3 +- migration-guides: git recipes reword +- migration-guides: mention CDN +- migration-guides: mention LLVM 17 +- migration-guides: mention runqemu change in serial port management +- migration-guides: packaging changes +- migration-guides: remove SERIAL_CONSOLES_CHECK +- migration-guides: remove non-notable change +- migration-guides: updates for 4.3 +- oeqa/selftest/debuginfod: improve selftest +- oeqa/selftest/devtool: abort if a local workspace already exist +- oeqa/ssh: Handle SSHCall timeout error code +- openssl: Upgrade to 3.1.4 +- overview-manual: concepts: Add Bitbake Tasks Map +- patchtest-send-results: add In-Reply-To +- patchtest-send-results: check max line length, simplify responses +- patchtest-send-results: fix sender parsing +- patchtest-send-results: improve subject line +- patchtest-send-results: send results to submitter +- patchtest/selftest: add XSKIP, update test files +- patchtest: disable merge test +- patchtest: fix lic_files_chksum test regex +- patchtest: make pylint tests compatible with 3.x +- patchtest: reduce checksum test output length +- patchtest: remove test for CVE tag in mbox +- patchtest: remove unused imports +- patchtest: rework license checksum tests +- patchtest: shorten test result outputs +- patchtest: simplify test directory structure +- patchtest: skip merge test if not targeting master +- patchtest: test regardless of mergeability +- perl: fix intermittent test failure +- poky.conf: bump version for 4.3.1 release +- profile-manual: aesthetic cleanups +- ref-manual: Add documentation for the unimplemented-ptest QA warning +- ref-manual: Fix :term:`PACKAGECONFIG` term and add an example +- ref-manual: Warn about :term:`COMPATIBLE_MACHINE` skipping native recipes +- ref-manual: add systemd-resolved to distro features +- ref-manual: classes: explain cml1 class name +- ref-manual: document :term:`KERNEL_LOCALVERSION` +- ref-manual: document :term:`KERNEL_STRIP` +- ref-manual: document :term:`MESON_TARGET` +- ref-manual: document cargo_c class +- ref-manual: remove semicolons from ``*PROCESS_COMMAND`` variables +- ref-manual: update :term:`SDK_NAME` variable documentation +- ref-manual: variables: add :term:`RECIPE_MAINTAINER` +- ref-manual: variables: add :term:`RECIPE_SYSROOT` and :term:`RECIPE_SYSROOT_NATIVE` +- ref-manual: variables: add :term:`TOOLCHAIN_OPTIONS` variable +- ref-manual: variables: add example for :term:`SYSROOT_DIRS` variable +- ref-manual: variables: document :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE` +- ref-manual: variables: mention new CDN for :term:`SSTATE_MIRRORS` +- ref-manual: variables: provide no-match example for :term:`COMPATIBLE_MACHINE` +- ref-manual: variables: remove SERIAL_CONSOLES_CHECK +- release-notes-4.3: add CVEs, recipe upgrades, license changes, contributors +- release-notes-4.3: add Repositories / Downloads section +- release-notes-4.3: feature additions +- release-notes-4.3: fix some typos +- release-notes-4.3: move new classes to Rust section +- release-notes-4.3: remove the Distribution section +- release-notes-4.3: tweaks to existing text +- sdk-manual: appendix-obtain: improve and update descriptions +- test-manual: reproducible-builds: stop mentioning LTO bug +- vim: Improve locale handling +- vim: Upgrade to 9.0.2068 +- vim: use upstream generated .po files + + +Known Issues in Yocto-4.3.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.3.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alejandro Hernandez Samaniego +- Alex Stewart +- Archana Polampalli +- Arne Schwerdt +- BELHADJ SALEM Talel +- Dmitry Baryshkov +- Eero Aaltonen +- Joshua Watt +- Julien Stephan +- Jérémy Rosen +- Khem Raj +- Lee Chee Yang +- Marta Rybczynska +- Max Krummenacher +- Michael Halstead +- Michael Opdenacker +- Paul Eggleton +- Peter Kjellerstedt +- Peter Marko +- Quentin Schulz +- Richard Purdie +- Robert P. J. Day +- Ross Burton +- Rouven Czerwinski +- Steve Sakoman +- Trevor Gamblin +- Wang Mingyu +- William Lyu +- Xiangyu Chen +- luca fancellu + + +Repositories / Downloads for Yocto-4.3.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`nanbield </poky/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.1 </poky/log/?h=yocto-4.3.1>` +- Git Revision: :yocto_git:`bf9f2f6f60387b3a7cd570919cef6c4570edcb82 </poky/commit/?id=bf9f2f6f60387b3a7cd570919cef6c4570edcb82>` +- Release Artefact: poky-bf9f2f6f60387b3a7cd570919cef6c4570edcb82 +- sha: 9b4351159d728fec2b63a50f1ac15edc412e2d726e9180a40afc06051fadb922 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.1/poky-bf9f2f6f60387b3a7cd570919cef6c4570edcb82.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.1/poky-bf9f2f6f60387b3a7cd570919cef6c4570edcb82.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`nanbield </openembedded-core/log/?h=nanbield>` +- Tag: :oe_git:`yocto-4.3.1 </openembedded-core/log/?h=yocto-4.3.1>` +- Git Revision: :oe_git:`cce77e8e79c860f4ef0ac4a86b9375bf87507360 </openembedded-core/commit/?id=cce77e8e79c860f4ef0ac4a86b9375bf87507360>` +- Release Artefact: oecore-cce77e8e79c860f4ef0ac4a86b9375bf87507360 +- sha: e6cde08e7c549f57a67d833a36cdb942648fba81558dc8b0e65332d2a2c023cc +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.1/oecore-cce77e8e79c860f4ef0ac4a86b9375bf87507360.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.1/oecore-cce77e8e79c860f4ef0ac4a86b9375bf87507360.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`nanbield </meta-mingw/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.1 </meta-mingw/log/?h=yocto-4.3.1>` +- Git Revision: :yocto_git:`49617a253e09baabbf0355bc736122e9549c8ab2 </meta-mingw/commit/?id=49617a253e09baabbf0355bc736122e9549c8ab2>` +- Release Artefact: meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2 +- sha: 2225115b73589cdbf1e491115221035c6a61679a92a93b2a3cf761ff87bf4ecc +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.1/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.1/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.6 </bitbake/log/?h=2.6>` +- Tag: :oe_git:`yocto-4.3.1 </bitbake/log/?h=yocto-4.3.1>` +- Git Revision: :oe_git:`936fcec41efacc4ce988c81882a9ae6403702bea </bitbake/commit/?id=936fcec41efacc4ce988c81882a9ae6403702bea>` +- Release Artefact: bitbake-936fcec41efacc4ce988c81882a9ae6403702bea +- sha: efbdd5fe7f29227a3fd26d6a08a368bf8215083a588b4d23f3adf35044897520 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.1/bitbake-936fcec41efacc4ce988c81882a9ae6403702bea.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.1/bitbake-936fcec41efacc4ce988c81882a9ae6403702bea.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`nanbield </yocto-docs/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.1 </yocto-docs/log/?h=yocto-4.3.1>` +- Git Revision: :yocto_git:`6b98a6164263298648e89b5a5ae1260a58f1bb35 </yocto-docs/commit/?id=6b98a6164263298648e89b5a5ae1260a58f1bb35>` + diff --git a/documentation/migration-guides/release-notes-4.3.2.rst b/documentation/migration-guides/release-notes-4.3.2.rst new file mode 100644 index 0000000000..3a40d83bc2 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.3.2.rst @@ -0,0 +1,247 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.3.2 (Nanbield) +---------------------------------------- + +Security Fixes in Yocto-4.3.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- avahi: Fix :cve:`2023-1981`, :cve:`2023-38469`, :cve:`2023-38470`, :cve:`2023-38471`, :cve:`2023-38472` and :cve:`2023-38473` +- curl: Fix :cve:`2023-46218` +- ghostscript: Fix :cve:`2023-46751` +- grub: fix :cve:`2023-4692` and :cve:`2023-4693` +- gstreamer1.0: Fix :cve_mitre:`2023-44446` +- linux-yocto/6.1: Ignore :cve_mitre:`2023-39197`, :cve:`2023-39198`, :cve:`2023-5090`, :cve:`2023-5633`, :cve:`2023-6111`, :cve:`2023-6121` and :cve:`2023-6176` +- linux-yocto/6.5: Ignore :cve:`2022-44034`, :cve_mitre:`2023-39197`, :cve:`2023-39198`, :cve:`2023-5972`, :cve:`2023-6039`, :cve:`2023-6111` and :cve:`2023-6176` +- perl: fix :cve:`2023-47100` +- python3-urllib3: Fix :cve:`2023-45803` +- rust: Fix :cve:`2023-40030` +- vim: Fix :cve:`2023-48231`, :cve:`2023-48232`, :cve:`2023-48233`, :cve:`2023-48234`, :cve:`2023-48235`, :cve:`2023-48236` and :cve:`2023-48237` +- xserver-xorg: Fix :cve:`2023-5367` and :cve:`2023-5380` +- xwayland: Fix :cve:`2023-5367` + + +Fixes in Yocto-4.3.2 +~~~~~~~~~~~~~~~~~~~~ + +- base-passwd: Upgrade to 3.6.2 +- bind: Upgrade to 9.18.20 +- binutils: stable 2.41 branch updates +- bitbake: command: Make parseRecipeFile() handle virtual recipes correctly +- bitbake: lib/bb: Add workaround for libgcc issues with python 3.8 and 3.9 +- bitbake: toastergui: verify that an existing layer path is given +- bluez5: fix connection for ps5/dualshock controllers +- build-appliance-image: Update to nanbield head revision +- cmake: Upgrade to 3.27.7 +- contributor-guide: add License-Update tag +- contributor-guide: fix command option +- cups: Add root,sys,wheel to system groups +- cve-update-nvd2-native: faster requests with API keys +- cve-update-nvd2-native: increase the delay between subsequent request failures +- cve-update-nvd2-native: make number of fetch attemtps configurable +- cve-update-nvd2-native: remove unused variable CVE_SOCKET_TIMEOUT +- dev-manual: Discourage the use of SRC_URI[md5sum] +- dev-manual: layers: update link to YP Compatible form +- dev-manual: runtime-testing: fix test module name +- devtool: finish/update-recipe: restrict mode srcrev to recipes fetched from SCM +- devtool: fix update-recipe dry-run mode +- ell: Upgrade to 0.60 +- enchant2: Upgrade to 2.6.2 +- ghostscript: Upgrade to 10.02.1 +- glib-2.0: Upgrade to 2.78.1 +- glibc: stable 2.38 branch updates +- gstreamer1.0: Upgrade to 1.22.7 +- gtk: Add rdepend on printbackend for cups +- harfbuzz: Upgrade to 8.2.2 +- json-c: fix icecc compilation +- kern-tools: bump :term:`SRCREV` for queue processing changes +- kern-tools: make lower context patches reproducible +- kern-tools: update :term:`SRCREV` to include SECURITY.md file +- kernel-arch: use ccache only for compiler +- kernel-yocto: improve metadata patching +- lib/oe/buildcfg.py: Include missing import +- lib/oe/buildcfg.py: Remove unused parameter +- lib/oe/patch: ensure os.chdir restoring always happens +- lib/oe/path: Deploy files can start only with a dot +- libgcrypt: Upgrade to 1.10.3 +- libjpeg-turbo: Upgrade to 3.0.1 +- libnewt: Upgrade to 0.52.24 +- libnsl2: Upgrade to 2.0.1 +- libsolv: Upgrade to 0.7.26 +- libxslt: Upgrade to 1.1.39 +- linux-firmware: add audio topology symlink to the X13's audio package +- linux-firmware: add missing depenencies on license packages +- linux-firmware: add new fw file to ${PN}-rtl8821 +- linux-firmware: add notice file to sdm845 modem firmware +- linux-firmware: create separate packages +- linux-firmware: package Qualcomm Venus 6.0 firmware +- linux-firmware: package Robotics RB5 sensors DSP firmware +- linux-firmware: package firmware for Qualcomm Adreno a702 +- linux-firmware: package firmware for Qualcomm QCM2290 / QRB4210 +- linux-firmware: Upgrade to 20231030 +- linux-yocto-rt/6.1: update to -rt18 +- linux-yocto/6.1: cfg: restore CONFIG_DEVMEM +- linux-yocto/6.1: drop removed IMA option +- linux-yocto/6.1: Upgrade to v6.1.68 +- linux-yocto/6.5: cfg: restore CONFIG_DEVMEM +- linux-yocto/6.5: cfg: split runtime and symbol debug +- linux-yocto/6.5: drop removed IMA option +- linux-yocto/6.5: fix AB-INT: QEMU kernel panic: No irq handler for vector +- linux-yocto/6.5: Upgrade to v6.5.13 +- linux/cve-exclusion6.1: Update to latest kernel point release +- log4cplus: Upgrade to 2.1.1 +- lsb-release: use https for :term:`UPSTREAM_CHECK_URI` +- manuals: brief-yoctoprojectqs: align variable order with default local.conf +- manuals: fix URL +- meson: use correct targets for rust binaries +- migration-guide: add release notes for 4.0.14, 4.0.15, 4.2.4, 4.3.1 +- migration-guides: release 3.5 is actually 4.0 +- migration-guides: reword fix in release-notes-4.3.1 +- msmtp: Upgrade to 1.8.25 +- oeqa/selftest/tinfoil: Add tests that parse virtual recipes +- openssl: improve handshake test error reporting +- package_ipk: Fix Source: field variable dependency +- patchtest: shorten patch signed-off-by test output +- perf: lift :term:`TARGET_CC_ARCH` modification out of security_flags.inc +- perl: Upgrade to 5.38.2 +- perlcross: Upgrade to 1.5.2 +- poky.conf: bump version for 4.3.2 release +- python3-ptest: skip test_storlines +- python3-urllib3: Upgrade to 2.0.7 +- qemu: Upgrade to 8.1.2 +- ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults +- ref-manual: releases.svg: update nanbield release status +- useradd_base: sed -i destroys symlinks +- rootfs-postcommands: sed -i destroys symlinks +- sstate: Ensure sstate searches update file mtime +- strace: backport fix for so_peerpidfd-test +- systemd-boot: Fix build issues on armv7a-linux +- systemd-compat-units.bb: fix postinstall script +- systemd: fix DynamicUser issue +- systemd: update :term:`LICENSE` statement +- tcl: skip async and event tests in run-ptest +- tcl: skip timing-dependent tests in run-ptest +- test-manual: add links to python unittest +- test-manual: add or improve hyperlinks +- test-manual: explicit or fix file paths +- test-manual: resource updates +- test-manual: text and formatting fixes +- test-manual: use working example +- testimage: Drop target_dumper and most of monitor_dumper +- testimage: Exclude wtmp from target-dumper commands +- tzdata: Upgrade to 2023d +- update_gtk_icon_cache: Fix for GTK4-only builds +- useradd_base: Fix sed command line for passwd-expire +- vim: Upgrade to 9.0.2130 +- xserver-xorg: Upgrade to 21.1.9 +- xwayland: Upgrade to 23.2.2 + + +Known Issues in Yocto-4.3.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + +Contributors to Yocto-4.3.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Adam Johnston +- Alexander Kanavin +- Anuj Mittal +- Bastian Krause +- Bruce Ashfield +- Chen Qi +- Deepthi Hemraj +- Dhairya Nagodra +- Dmitry Baryshkov +- Fahad Arslan +- Javier Tia +- Jermain Horsman +- Joakim Tjernlund +- Julien Stephan +- Justin Bronder +- Khem Raj +- Lee Chee Yang +- Marco Felsch +- Markus Volk +- Marta Rybczynska +- Massimiliano Minella +- Michael Opdenacker +- Paul Barker +- Peter Kjellerstedt +- Peter Marko +- Randy MacLeod +- Rasmus Villemoes +- Richard Purdie +- Ross Burton +- Shubham Kulkarni +- Simone Weiß +- Steve Sakoman +- Sundeep KOKKONDA +- Tim Orling +- Trevor Gamblin +- Vijay Anusuri +- Viswanath Kraleti +- Vyacheslav Yurkov +- Wang Mingyu +- William Lyu +- Zoltán Böszörményi + +Repositories / Downloads for Yocto-4.3.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`nanbield </poky/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.2 </poky/log/?h=yocto-4.3.2>` +- Git Revision: :yocto_git:`f768ffb8916feb6542fcbe3e946cbf30e247b151 </poky/commit/?id=f768ffb8916feb6542fcbe3e946cbf30e247b151>` +- Release Artefact: poky-f768ffb8916feb6542fcbe3e946cbf30e247b151 +- sha: 21ca1695d70aba9b4bd8626d160111feab76206883cd14fe41eb024692bdfd7b +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.2/poky-f768ffb8916feb6542fcbe3e946cbf30e247b151.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.2/poky-f768ffb8916feb6542fcbe3e946cbf30e247b151.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`nanbield </openembedded-core/log/?h=nanbield>` +- Tag: :oe_git:`yocto-4.3.2 </openembedded-core/log/?h=yocto-4.3.2>` +- Git Revision: :oe_git:`ff595b937d37d2315386aebf315cea719e2362ea </openembedded-core/commit/?id=ff595b937d37d2315386aebf315cea719e2362ea>` +- Release Artefact: oecore-ff595b937d37d2315386aebf315cea719e2362ea +- sha: a7c6332dc0e09ecc08221e78b11151e8e2a3fd9fa3eaad96a4c03b67012bfb97 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.2/oecore-ff595b937d37d2315386aebf315cea719e2362ea.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.2/oecore-ff595b937d37d2315386aebf315cea719e2362ea.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`nanbield </meta-mingw/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.2 </meta-mingw/log/?h=yocto-4.3.2>` +- Git Revision: :yocto_git:`49617a253e09baabbf0355bc736122e9549c8ab2 </meta-mingw/commit/?id=49617a253e09baabbf0355bc736122e9549c8ab2>` +- Release Artefact: meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2 +- sha: 2225115b73589cdbf1e491115221035c6a61679a92a93b2a3cf761ff87bf4ecc +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.2/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.2/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.6 </bitbake/log/?h=2.6>` +- Tag: :oe_git:`yocto-4.3.2 </bitbake/log/?h=yocto-4.3.2>` +- Git Revision: :oe_git:`72bf75f0b2e7f36930185e18a1de8277ce7045d8 </bitbake/commit/?id=72bf75f0b2e7f36930185e18a1de8277ce7045d8>` +- Release Artefact: bitbake-72bf75f0b2e7f36930185e18a1de8277ce7045d8 +- sha: 0b6ccd4796ccd211605090348a3d4378358c839ae1bb4c35964d0f36f2663187 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.2/bitbake-72bf75f0b2e7f36930185e18a1de8277ce7045d8.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.2/bitbake-72bf75f0b2e7f36930185e18a1de8277ce7045d8.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`nanbield </yocto-docs/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.2 </yocto-docs/log/?h=yocto-4.3.2>` +- Git Revision: :yocto_git:`fac88b9e80646a68b31975c915a718a9b6b2b439 </yocto-docs/commit/?id=fac88b9e80646a68b31975c915a718a9b6b2b439>` + diff --git a/documentation/migration-guides/release-notes-4.3.3.rst b/documentation/migration-guides/release-notes-4.3.3.rst new file mode 100644 index 0000000000..2a0658a9c9 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.3.3.rst @@ -0,0 +1,200 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.3.3 (Nanbield) +---------------------------------------- + +Security Fixes in Yocto-4.3.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- curl: Fix :cve:`2023-46219` +- glibc: Ignore fixed :cve:`2023-0687` and :cve:`2023-5156` +- linux-yocto/6.1: Ignore :cve:`2022-48619`, :cve:`2023-4610`, :cve:`2023-5178`, :cve:`2023-5972`, :cve:`2023-6040`, :cve:`2023-6531`, :cve:`2023-6546`, :cve:`2023-6622`, :cve:`2023-6679`, :cve:`2023-6817`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2023-7192`, :cve:`2024-0193` and :cve:`2024-0443` +- linux-yocto/6.1: Fix :cve:`2023-1193`, :cve_mitre:`2023-51779`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782` and :cve:`2023-6606` +- qemu: Fix :cve:`2023-3019` +- shadow: Fix :cve:`2023-4641` +- sqlite3: Fix :cve:`2024-0232` +- sqlite3: drop obsolete CVE ignore :cve:`2023-36191` +- sudo: Fix :cve:`2023-42456` and :cve:`2023-42465` +- tiff: Fix :cve:`2023-6277` +- xwayland: Fix :cve:`2023-6377` and :cve:`2023-6478` + + +Fixes in Yocto-4.3.3 +~~~~~~~~~~~~~~~~~~~~ + +- aspell: upgrade to 0.60.8.1 +- avahi: update URL for new project location +- base-passwd: upgrade to 3.6.3 +- bitbake: asyncrpc: Add context manager API +- bitbake: toaster/toastergui: Bug-fix verify given layer path only if import/add local layer +- build-appliance-image: Update to nanbield head revision +- classes-global/sstate: Fix variable typo +- cmake: Unset CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES +- contributor-guide: fix lore URL +- contributor-guide: use "apt" instead of "aptitude" +- create-spdx-2.2: combine spdx can try to write before dir creation +- curl: Disable test 1091 due to intermittent failures +- curl: Disable two intermittently failing tests +- dev-manual: gen-tapdevs need iptables installed +- dev-manual: start.rst: Update use of Download page +- dev-manual: update license manifest path +- devtool: deploy: provide max_process to strip_execs +- devtool: modify: Handle recipes with a menuconfig task correctly +- docs: document VSCode extension +- dtc: preserve version also from shallow git clones +- elfutils: Update license information +- glib-2.0: upgrade to 2.78.3 +- glibc-y2038-tests: do not run tests using 32 bit time APIs +- go: upgrade to 1.20.12 +- grub: fs/fat: Don't error when mtime is 0 +- gstreamer1.0: upgrade to 1.22.8 +- icon-naming-utils: take tarball from debian +- kea: upgrade to 2.4.1 +- lib/prservice: Improve lock handling robustness +- libadwaita: upgrade to 1.4.2 +- libatomic-ops: upgrade to 7.8.2 +- libva-utils: upgrade to 2.20.1 +- linux-firmware: Change bnx2 packaging +- linux-firmware: Create bnx2x subpackage +- linux-firmware: Fix the linux-firmware-bcm4373 :term:`FILES` variable +- linux-firmware: Package iwlwifi .pnvm files +- linux-yocto/6.1: security/cfg: add configs to harden protection +- linux-yocto/6.1: update to v6.1.73 +- meta/documentation.conf: fix do_menuconfig description +- migration-guide: add release notes for 4.0.16 +- migration-guide: add release notes for 4.3.2 +- ncurses: Fix - tty is hung after reset +- nfs-utils: Update Upstream-Status +- nfs-utils: upgrade to 2.6.4 +- oeqa/selftest/prservice: Improve test robustness +- package.py: OEHasPackage: Add :term:`MLPREFIX` to packagename +- poky.conf: bump version for 4.3.3 release +- pseudo: Update to pull in syncfs probe fix +- python3-license-expression: Fix the ptest failure +- qemu.bbclass: fix a python TypeError +- qemu: upgrade to 8.1.4 +- ref-manual: Add UBOOT_BINARY, extend :term:`UBOOT_CONFIG` +- ref-manual: classes: remove insserv bbclass +- ref-manual: update tested and supported distros +- release-notes-4.3: fix spacing +- rootfs.py: check depmodwrapper execution result +- rpcbind: Specify state directory under /run +- scripts/runqemu: fix regex escape sequences +- sqlite3: upgrade to 3.43.2 +- sstate: Fix dir ownership issues in :term:`SSTATE_DIR` +- sudo: upgrade to 1.9.15p5 +- tcl: Fix prepending to run-ptest script +- uninative-tarball.xz - reproducibility fix +- xwayland: upgrade to 23.2.3 +- zstd: fix :term:`LICENSE` statement + + +Known Issues in Yocto-4.3.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.3.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alassane Yattara +- Alexander Kanavin +- Anuj Mittal +- Baruch Siach +- Bruce Ashfield +- Chen Qi +- Clay Chang +- Enguerrand de Ribaucourt +- Ilya A. Kriveshko +- Jason Andryuk +- Jeremy A. Puhlman +- Joao Marcos Costa +- Jose Quaresma +- Joshua Watt +- Jörg Sommer +- Khem Raj +- Lee Chee Yang +- Markus Volk +- Massimiliano Minella +- Maxin B. John +- Michael Opdenacker +- Ming Liu +- Mingli Yu +- Peter Kjellerstedt +- Peter Marko +- Richard Purdie +- Robert Berger +- Robert Yang +- Rodrigo M. Duarte +- Ross Burton +- Saul Wold +- Simone Weiß +- Soumya Sambu +- Steve Sakoman +- Trevor Gamblin +- Wang Mingyu +- William Lyu +- Xiangyu Chen +- Yang Xu +- Zahir Hussain + + +Repositories / Downloads for Yocto-4.3.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`nanbield </poky/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.3 </poky/log/?h=yocto-4.3.3>` +- Git Revision: :yocto_git:`d3b27346c3a4a7ef7ec517e9d339d22bda74349d </poky/commit/?id=d3b27346c3a4a7ef7ec517e9d339d22bda74349d>` +- Release Artefact: poky-d3b27346c3a4a7ef7ec517e9d339d22bda74349d +- sha: 2db39f1bf7bbcee039e9970eed1f6f9233bcc95d675159647c9a2a334fc81eb0 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.3/poky-d3b27346c3a4a7ef7ec517e9d339d22bda74349d.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.3/poky-d3b27346c3a4a7ef7ec517e9d339d22bda74349d.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`nanbield </openembedded-core/log/?h=nanbield>` +- Tag: :oe_git:`yocto-4.3.3 </openembedded-core/log/?h=yocto-4.3.3>` +- Git Revision: :oe_git:`0584d01f623e1f9b0fef4dfa95dd66de6cbfb7b3 </openembedded-core/commit/?id=0584d01f623e1f9b0fef4dfa95dd66de6cbfb7b3>` +- Release Artefact: oecore-0584d01f623e1f9b0fef4dfa95dd66de6cbfb7b3 +- sha: 730de0d5744f139322402ff9a6b2483c6ab929f704cec06258ae51de1daebe3d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.3/oecore-0584d01f623e1f9b0fef4dfa95dd66de6cbfb7b3.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.3/oecore-0584d01f623e1f9b0fef4dfa95dd66de6cbfb7b3.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`nanbield </meta-mingw/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.3 </meta-mingw/log/?h=yocto-4.3.3>` +- Git Revision: :yocto_git:`49617a253e09baabbf0355bc736122e9549c8ab2 </meta-mingw/commit/?id=49617a253e09baabbf0355bc736122e9549c8ab2>` +- Release Artefact: meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2 +- sha: 2225115b73589cdbf1e491115221035c6a61679a92a93b2a3cf761ff87bf4ecc +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.3/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.3/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.6 </bitbake/log/?h=2.6>` +- Tag: :oe_git:`yocto-4.3.3 </bitbake/log/?h=yocto-4.3.3>` +- Git Revision: :oe_git:`380a9ac97de5774378ded5e37d40b79b96761a0c </bitbake/commit/?id=380a9ac97de5774378ded5e37d40b79b96761a0c>` +- Release Artefact: bitbake-380a9ac97de5774378ded5e37d40b79b96761a0c +- sha: 78f579b9d29e72d09b6fb10ac62aa925104335e92d2afb3155bc9ab1994e36c1 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.3/bitbake-380a9ac97de5774378ded5e37d40b79b96761a0c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.3/bitbake-380a9ac97de5774378ded5e37d40b79b96761a0c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`nanbield </yocto-docs/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.3 </yocto-docs/log/?h=yocto-4.3.3>` +- Git Revision: :yocto_git:`dde4b815db82196af086847f68ee27d7902b4ffa </yocto-docs/commit/?id=dde4b815db82196af086847f68ee27d7902b4ffa>` + diff --git a/documentation/migration-guides/release-notes-4.3.4.rst b/documentation/migration-guides/release-notes-4.3.4.rst new file mode 100644 index 0000000000..4c9e67f2cb --- /dev/null +++ b/documentation/migration-guides/release-notes-4.3.4.rst @@ -0,0 +1,206 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.3.4 (Nanbield) +---------------------------------------- + +Security Fixes in Yocto-4.3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- bind: Fix :cve:`2023-4408`, :cve:`2023-5517`, :cve:`2023-5679` and :cve:`2023-50387` +- gcc: Update :term:`CVE_STATUS` for :cve:`2023-4039` as fixed +- glibc: Fix :cve:`2023-6246`, :cve:`2023-6779` and :cve:`2023-6780` +- gnutls: Fix :cve:`2024-0553` and :cve:`2024-0567` +- gstreamer: Fix :cve_mitre:`2024-0444` +- libssh2: fix :cve:`2023-48795` +- libxml2: Fix :cve:`2024-25062` +- linux-yocto/6.1: Fix :cve:`2023-6610`, :cve:`2023-6915`, :cve:`2023-46838`, :cve:`2023-50431`, :cve:`2024-1085`, :cve:`2024-1086` and :cve:`2024-23849` +- linux-yocto/6.1: Ignore :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-36402`, :cve:`2023-5717`, :cve:`2023-6200`, :cve:`2023-35827`, :cve:`2023-40791`, :cve:`2023-46343`, :cve:`2023-46813`, :cve:`2023-46862`, :cve:`2023-51042`, :cve:`2023-51043`, :cve_mitre:`2023-52340`, :cve:`2024-0562`, :cve:`2024-0565`, :cve:`2024-0582`, :cve:`2024-0584`, :cve:`2024-0607`, :cve:`2024-0639`, :cve:`2024-0641`, :cve:`2024-0646`, :cve:`2024-0775` and :cve:`2024-22705` +- openssl: fix :cve:`2024-0727` +- python3-jinja2: Fix :cve:`2024-22195` +- tiff: Fix :cve:`2023-6228`, :cve:`2023-52355` and :cve:`2023-52356` +- vim: Fix :cve:`2024-22667` +- wpa-supplicant: Fix :cve:`2023-52160` +- xserver-xorg: Fix :cve:`2023-6377`, :cve:`2023-6478`, :cve:`2023-6816`, :cve:`2024-0229`, :cve:`2024-0408`, :cve:`2024-0409`, :cve:`2024-21885` and :cve:`2024-21886` +- xwayland: Fix :cve:`2023-6816`, :cve:`2024-0408` and :cve:`2024-0409` +- zlib: Ignore :cve:`2023-6992` + + +Fixes in Yocto-4.3.4 +~~~~~~~~~~~~~~~~~~~~ + +- allarch: Fix allarch corner case +- at-spi2-core: Upgrade to 2.50.1 +- bind: Upgrade to 9.18.24 +- build-appliance-image: Update to nanbield head revision +- contributor-guide: add notes for tests +- contributor-guide: be more specific about meta-* trees +- core-image-ptest: Increase disk size to 1.5G for strace ptest image +- cpio: Upgrade to 2.15 +- curl: improve run-ptest +- curl: increase test timeouts +- cve-check: Log if :term:`CVE_STATUS` set but not reported for component +- cve-update-nvd2-native: Add an age threshold for incremental update +- cve-update-nvd2-native: Fix CVE configuration update +- cve-update-nvd2-native: Fix typo in comment +- cve-update-nvd2-native: Remove duplicated CVE_CHECK_DB_FILE definition +- cve-update-nvd2-native: Remove rejected CVE from database +- cve-update-nvd2-native: nvd_request_next: Improve comment +- cve_check: cleanup logging +- cve_check: handle :term:`CVE_STATUS` being set to the empty string +- dev-manual: Rephrase spdx creation +- dev-manual: improve descriptions of 'bitbake -S printdiff' +- dev-manual: packages: clarify shared :term:`PR` service constraint +- dev-manual: packages: fix capitalization +- dev-manual: packages: need enough free space +- docs: add initial stylechecks with Vale +- docs: correct sdk installation default path +- docs: document VIRTUAL-RUNTIME variables +- docs: suppress excess use of "following" word +- docs: use "manual page(s)" +- docs: Makefile: remove releases.rst in "make clean" +- externalsrc: fix task dependency for do_populate_lic +- glibc: Remove duplicate :term:`CVE_STATUS` for :cve:`2023-4527` +- glibc: stable 2.38 branch updates (2.38+gitd37c2b20a4) +- gnutls: Upgrade to 3.8.3 +- gstreamer1.0: skip a test that is known to be flaky +- gstreamer: Upgrade to 1.22.9 +- gtk: Set :term:`CVE_PRODUCT` +- kernel.bbclass: Set pkg-config variables for building modules +- libxml2: Upgrade to 2.11.7 +- linux-firmware: Upgrade to 20240220 +- linux-yocto/6.1: update to v6.1.78 +- mdadm: Disable ptests +- migration-guides: add release notes for 4.3.3 +- migration-guides: add release notes for 4.0.17 +- migration-guides: fix release notes for 4.3.3 linux-yocto/6.1 CVE entries +- multilib_global.bbclass: fix parsing error with no kernel module split +- openssl: fix crash on aarch64 if BTI is enabled but no Crypto instructions +- openssl: Upgrade to 3.1.5 +- overlayfs: add missing closing parenthesis in selftest +- poky.conf: bump version for 4.3.4 release +- profile-manual: usage.rst: fix reference to bug report +- profile-manual: usage.rst: formatting fixes +- profile-manual: usage.rst: further style improvements +- pseudo: Update to pull in gcc14 fix and missing statvfs64 intercept +- python3-jinja2: Upgrade to 3.1.3 +- ref-manual: release-process: grammar fix +- ref-manual: system-requirements: update packages to build docs +- ref-manual: tasks: do_cleanall: recommend using '-f' instead +- ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate +- ref-manual: variables: adding multiple groups in :term:`GROUPADD_PARAM` +- ref-manual: variables: add documentation of the variable :term:`SPDX_NAMESPACE_PREFIX` +- reproducible: Fix race with externalsrc/devtool over lockfile +- sdk-manual: extensible: correctly describe separate build-sysroots tasks in direct sdk workflows +- tzdata : Upgrade to 2024a +- udev-extraconf: fix unmount directories containing octal-escaped chars +- vim: Upgrade to v9.0.2190 +- wireless-regdb: Upgrade to 2024.01.23 +- xserver-xorg: Upgrade to 21.1.11 +- xwayland: Upgrade to 23.2.4 +- yocto-uninative: Update to 4.4 for glibc 2.39 + + +Known Issues in Yocto-4.3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alex Kiernan +- Alexander Kanavin +- Alexander Sverdlin +- Baruch Siach +- BELOUARGA Mohamed +- Benjamin Bara +- Bruce Ashfield +- Chen Qi +- Claus Stovgaard +- Dhairya Nagodra +- Geoff Parker +- Johan Bezem +- Jonathan GUILLOT +- Julien Stephan +- Kai Kang +- Khem Raj +- Lee Chee Yang +- Luca Ceresoli +- Martin Jansa +- Michael Halstead +- Michael Opdenacker +- Munehisa Kamata +- Pavel Zhukov +- Peter Marko +- Priyal Doshi +- Richard Purdie +- Robert Joslyn +- Ross Burton +- Simone Weiß +- Soumya Sambu +- Steve Sakoman +- Tim Orling +- Wang Mingyu +- Yoann Congal +- Yogita Urade + + +Repositories / Downloads for Yocto-4.3.4 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`nanbield </poky/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.4 </poky/log/?h=yocto-4.3.4>` +- Git Revision: :yocto_git:`7b8aa378d069ee31373f22caba3bd7fc7863f447 </poky/commit/?id=7b8aa378d069ee31373f22caba3bd7fc7863f447>` +- Release Artefact: poky-7b8aa378d069ee31373f22caba3bd7fc7863f447 +- sha: 0cb14125f215cc9691cff43982e2c540a5b6018df4ed25c10933135b5bf21d0f +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.4/poky-7b8aa378d069ee31373f22caba3bd7fc7863f447.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.4/poky-7b8aa378d069ee31373f22caba3bd7fc7863f447.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`nanbield </openembedded-core/log/?h=nanbield>` +- Tag: :oe_git:`yocto-4.3.4 </openembedded-core/log/?h=yocto-4.3.4>` +- Git Revision: :oe_git:`d0e68072d138ccc1fb5957fdc46a91871eb6a3e1 </openembedded-core/commit/?id=d0e68072d138ccc1fb5957fdc46a91871eb6a3e1>` +- Release Artefact: oecore-d0e68072d138ccc1fb5957fdc46a91871eb6a3e1 +- sha: d311fe22ff296c466f9bea1cd26343baee5630bc37f3dda42f2d9d8cc99e3add +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.4/oecore-d0e68072d138ccc1fb5957fdc46a91871eb6a3e1.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.4/oecore-d0e68072d138ccc1fb5957fdc46a91871eb6a3e1.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`nanbield </meta-mingw/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.4 </meta-mingw/log/?h=yocto-4.3.4>` +- Git Revision: :yocto_git:`49617a253e09baabbf0355bc736122e9549c8ab2 </meta-mingw/commit/?id=49617a253e09baabbf0355bc736122e9549c8ab2>` +- Release Artefact: meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2 +- sha: 2225115b73589cdbf1e491115221035c6a61679a92a93b2a3cf761ff87bf4ecc +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.4/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.4/meta-mingw-49617a253e09baabbf0355bc736122e9549c8ab2.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.6 </bitbake/log/?h=2.6>` +- Tag: :oe_git:`yocto-4.3.4 </bitbake/log/?h=yocto-4.3.4>` +- Git Revision: :oe_git:`380a9ac97de5774378ded5e37d40b79b96761a0c </bitbake/commit/?id=380a9ac97de5774378ded5e37d40b79b96761a0c>` +- Release Artefact: bitbake-380a9ac97de5774378ded5e37d40b79b96761a0c +- sha: 78f579b9d29e72d09b6fb10ac62aa925104335e92d2afb3155bc9ab1994e36c1 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3.4/bitbake-380a9ac97de5774378ded5e37d40b79b96761a0c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3.4/bitbake-380a9ac97de5774378ded5e37d40b79b96761a0c.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`nanbield </yocto-docs/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3.4 </yocto-docs/log/?h=yocto-4.3.4>` +- Git Revision: :yocto_git:`05d08b0bbaef760157c8d35a78d7405bc5ffce55 </yocto-docs/commit/?id=05d08b0bbaef760157c8d35a78d7405bc5ffce55>` + diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst new file mode 100644 index 0000000000..0e175067da --- /dev/null +++ b/documentation/migration-guides/release-notes-4.3.rst @@ -0,0 +1,965 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 4.3 (nanbield) +-------------------------------- + +New Features / Enhancements in 4.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 6.5 and 6.1, gcc 13, glibc 2.38, LLVM 17, and over 300 other recipe upgrades + +- The autobuilder's shared-state artefacts are now available over the `jsDelivr + <https://jsdelivr.com>`__ Content Delivery Network (CDN). + See :term:`SSTATE_MIRRORS`. + +- New variables: + + - :term:`CVE_CHECK_STATUSMAP`, :term:`CVE_STATUS`, :term:`CVE_STATUS_GROUPS`, + replacing the deprecated :term:`CVE_CHECK_IGNORE`. + + - :term:`FILE_LAYERNAME`: bitbake now sets this to the name of the layer + containing the recipe + + - :term:`FIT_ADDRESS_CELLS` and :term:`UBOOT_FIT_ADDRESS_CELLS`. + See details below. + + - :term:`KERNEL_DTBDEST`: directory where to install DTB files. + + - :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories. + + - :term:`KERNEL_LOCALVERSION`: to add a string to the kernel version + information. + + - :term:`KERNEL_STRIP`: to specify the command to strip the kernel binary. + + - :term:`LICENSE_FLAGS_DETAILS`: add extra details about a recipe license + in case it is not allowed by :term:`LICENSE_FLAGS_ACCEPTED`. + + - :term:`MESON_TARGET`: to compile a specific Meson target instead of the + default ones. + + - :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE`: to restrict package managers used + in reproducibility testing. + +- Layername functionality available through overrides + + Code can now know which layer a recipe is coming from through the newly added :term:`FILE_LAYERNAME` + variable. This has been added as an override of the form ``layer-<layername>``. In particular, + this means QA checks can now be layer specific, for example:: + + ERROR_QA:layer-core:append = " patch-status" + + This will enable the ``patch-status`` QA check for the core layer. + +- Architecture-specific enhancements: + + - RISCV support is now enabled in LLVM 17. + + - Loongarch support in the :ref:`ref-classes-linuxloader` class and + ``core-image-minimal-initramfs`` image. + + - The ``arch-armv8`` and ``arch-armv9`` architectures are now given + `Scalable Vector Extension (SVE) + <https://developer.arm.com/documentation/100891/0612/sve-overview/introducing-sve>`__ + based tune options. Commits: + :yocto_git:`1 </poky/commit/?id=e4be03be5be62e367a40437a389121ef97d6cff3>`, + :yocto_git:`2 </poky/commit/?id=8cd5d264af4c346730531cb98ae945ab862dbd69>`. + + - Many changes to support 64-bit ``time_t`` on 32-bit architectures + +- Kernel-related enhancements: + + - The default kernel is the current stable (6.5), and there is also support + for the latest long-term release (6.1). + + - The list of fixed kernel CVEs is updated regularly using data from + `linuxkernelcves.com <https://linuxkernelcves.com>`__. + + - A ``showconfig`` task was added to the :ref:`ref-classes-cml1` class, to + easily examine the final generated ``.config`` file. + +- New core recipes: + + - `appstream <https://github.com/ximion/appstream>`__: a collaborative effort + for making machine-readable software metadata easily available + (from meta-oe) + + - `cargo-c-native <https://crates.io/crates/cargo-c>`__: cargo applet to build + and install C-ABI compatible dynamic and static libraries + + - `libadwaita <https://gitlab.gnome.org/GNOME/libadwaita>`__: Building blocks + for modern GNOME applications (from meta-gnome) + + - `libtraceevent <https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/>`__: + API to access the kernel tracefs directory (from meta-openembedded) + + - `libxmlb <https://github.com/hughsie/libxmlb>`__: A library to help create + and query binary XML blobs (from meta-oe) + + - ``musl-legacy-error``: glibc ``error()`` API implementation still needed + by a few packages. + + - `python3-beartype <https://beartype.readthedocs.io>`__, unbearably fast + runtime type checking in pure Python. + + - `python3-booleanpy <https://github.com/bastikr/boolean.py>`__: Define boolean + algebras, create and parse boolean expressions and create custom boolean DSL + (from meta-python) + + - `python3-calver <https://github.com/di/calver>`__: Setuptools extension for + CalVer package versions + + - `python3-click <http://click.pocoo.org/>`__: A simple wrapper around optparse + for powerful command line utilities (from meta-python) + + - ``python3-dtc``: Python Library for the Device Tree Compiler (from + meta-virtualization) + + - `python3-isodate <https://github.com/gweis/isodate/>`__: ISO 8601 date/time + parser (from meta-python) + + - `python3-license-expression <https://github.com/nexB/license-expression>`__: + Utility library to parse, compare, simplify and normalize license expressions + (from meta-python) + + - `python3-rdflib <https://github.com/RDFLib/rdflib>`__: a pure Python package + for working with RDF (from meta-python) + + - `python3-spdx-tools <https://github.com/spdx/tools-python>`__, + tools for SPDX validation and conversion. + + - `python3-trove-classifiers <https://github.com/pypa/trove-classifiers>`__: + Canonical source for classifiers on PyPI (pypi.org) + + - `python3-uritools <https://github.com/tkem/uritools/>`__, replacement for + the ``urllib.parse`` module. + + - `python3-xmltodict <https://github.com/martinblech/xmltodict>`__: Makes + working with XML feel like you are working with JSON (from meta-python) + + - `ttyrun <https://github.com/ibm-s390-linux/s390-tools>`__, starts + ``getty`` programs only when a terminal exists, preventing respawns + through the ``init`` program. This enabled removing the + ``SERIAL_CONSOLES_CHECK`` variable. + + - ``vulkan-validation-layers``: Khronos official validation layers to assist in + verifying that applications correctly use the + `Vulkan API <https://www.khronos.org/vulkan>`__. + + - `xcb-util-cursor <http://xcb.freedesktop.org/XcbUtil/>`__: XCB port of + libXcursor (from meta-oe) + +- QEMU / ``runqemu`` enhancements: + + - QEMU has been upgraded to version 8.1 + + - Many updates to the ``runqemu`` command. + + - The ``qemu-system-native`` recipe is now built with PNG support, which could be + useful to grab screenshots for error reporting purposes. + +- Rust improvements: + + - Rust has been upgraded to version 1.70 + + - New ``ptest-cargo`` class was added to allow Cargo based recipes to easily add ptests + + - New :ref:`ref-classes-cargo_c` class was added to allow recipes to make Rust code + available to C and C++ programs. See + ``meta-selftest/recipes-devtools/rust/rust-c-lib-example_git.bb`` for an example. + +- wic Image Creator enhancements: + + - ``bootimg-efi``: if ``fixed-size`` is set then use that for mkdosfs + + - ``bootimg-efi``: stop hardcoding VMA offsets, as required by systemd-boot v254 + (and dracut/ukify) + + - ``bootimg-pcbios``: use kernel name from :term:`KERNEL_IMAGETYPE` instead of + hardcoding ``vmlinuz`` + + - Added new ``gpt-hybrid`` option to ``ptable_format`` (formatting a disk with a hybrid + MBR and GPT partition scheme) + + - Use ``part_name`` in default imager when defined + + - Added ``--hidden`` argument to default imager to avoid MS Windows prompting to + format partition after flashing to a USB stick/SD card + +- FIT image related improvements: + + - New :term:`FIT_ADDRESS_CELLS` and :term:`UBOOT_FIT_ADDRESS_CELLS` variables allowing + to specify 64 bit addresses, typically for loading U-Boot. + + - Added ``compatible`` line to config section (with value from dtb) to allow bootloaders + to select the best matching configuration. + + +- SDK-related improvements: + + - Extended the following recipes to ``nativesdk``: ``libwebp``, ``python3-ply`` + +- Testing: + + - The :ref:`ref-classes-insane` class now adds an :ref:`unimplemented-ptest + <qa-check-unimplemented-ptest>` infrastructure to detect package sources + with unit tests but no implemented ptests in the recipe. + + - A new task to perform recipe-wide QA checks was added: ``do_recipe_qa``. + + - New build-time checks for set :term:`SUMMARY`, :term:`HOMEPAGE`, and + :term:`RECIPE_MAINTAINER` fields was added, and enabled for the core + recipes. + + - The ``parselogs`` runtime test was rewritten. Notably it no longer uses + regular expressions, which may mean custom patterns need updating. + + - A self-test to validate that the :term:`SPDX` manifests generated by + image builds are valid was added. + + - The ``QEMU_USE_SLIRP`` variable has been replaced by adding ``slirp`` to + ``TEST_RUNQEMUPARAMS``. + +- Utility script changes: + + - New ``scripts/patchtest`` utility to check patches to the + OpenEmbedded-Core project. See + :ref:`contributor-guide/submit-changes:validating patches with patchtest` + for details. + + - ``scripts/bblock`` was added, allowing the user to lock/unlock specific + recipes from being built. This makes it possibly to work on the + ``python3`` recipe without causing ``python3-native`` to rebuild. + +- BitBake improvements: + + - A fetcher for the Google Cloud Platform (``gs://``) was added. + + - The BitBake Cooker log now contains notes when the caches are + invalidated which is useful for memory resident BitBake debugging. + + - BitBake no longer watches files with :wikipedia:`inotify <inotify>` for + changes, as under load this can lead to races causing build instability. + + - Toaster's dependencies were upgraded to current releases, specifically + to Django 4.2. + +- Packaging changes: + + - :term:`FILES` now accepts a ``**`` wildcard, which matches zero or more + subdirectories. + + - The X server packagegroup now defaults to using the ``modesetting`` X + driver, which obsoletes the ``fbdev`` driver. + + - If a recipe uses :term:`LICENSE_FLAGS` and the licenses are not accepted, + it can set a custom message with :term:`LICENSE_FLAGS_DETAILS` to be + displayed to the users. + + - Recipes that fetch specific revisions no longer need to explicitly add + :term:`SRCPV` to :term:`PV` as BitBake will now automatically add the + revision information to :term:`PKGV` if needed (as long as "+" is still + present in the :term:`PKGV` value, which is set from :term:`PV` by + default). + + - The default :term:`PR` values in many recipes have been removed. + +- Security improvements: + + - Most repositories now include a :yocto_git:`SECURITY.md + </poky/tree/SECURITY.md>` file with hints for security researchers + and other parties who might report potential security vulnerabilities. + +- Prominent documentation updates: + + - New :doc:`../contributor-guide/index` document. + + - New :doc:`../dev-manual/security-subjects` chapter in the Development + Tasks Manual. + + - Long overdue documentation for the :ref:`ref-classes-devicetree` class. + + - New :ref:`summary about available init systems + <dev-manual/init-manager:summary>`. + + - New documentation for the :ref:`ref-classes-uboot-sign` class and + its variables and for the :ref:`ref-classes-kernel-devicetree` class + variables. + +- Miscellaneous changes: + + - Selecting systemd via :term:`INIT_MANAGER` now adds ``usrmerge`` to + :term:`DISTRO_FEATURES` as current versions of systemd now require + merged ``/usr``. + + - Generation of :term:`SPDX` manifests is now enabled by default. + + - Git based recipes in OE-Core which used the ``git`` protocol have been + changed to use `https`` where possible, as it is typically faster and + more reliable. + + - The ``os-release`` recipe added a ``CPE_NAME`` to the fields provided, with the + default being populated from :term:`DISTRO`. + + - The ``psplash`` recipe now accepts a PNG format image through + :term:`SPLASH_IMAGES`, instead of a harder to generate and modify + ``.h`` file. + + - The ; character is no longer needed to separate functions specified in + :term:`IMAGE_POSTPROCESS_COMMAND`, :term:`IMAGE_PREPROCESS_COMMAND`, + :term:`POPULATE_SDK_POST_HOST_COMMAND`, :term:`ROOTFS_POSTINSTALL_COMMAND` + etc. (If any are present they will be replaced with spaces, so existing + metadata does not yet need to be changed.) + + - In the ``Upstream-Status`` field in a patch header, "Accepted" is no longer + a valid value since it is logically the same as "Backport". Change any + values you have (particularly in patches applied through bbappends for core + recipes, since they will be validated as indicated above). + + +Known Issues in 4.3 +~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Recipe License changes in 4.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +- ``glib-networking``: make :term:`LICENSE` more accurate (``LGPL-2.1`` -> ``LGPL-2.1-or-later``) and add an exception for linking to OpenSSL if it is enabled (``openssl`` is in :term:`PACKAGECONFIG`) +- ``libbsd``: set per-package licensing to clarify that BSD-4-Clause code is only in the ``-doc`` package +- ``openssh``: BSD-4-Clause code has been removed completely from the codebase as part of 9.4p1 update - previously in the kirkstone release, ``BSD-4-Clause`` was removed from the :term:`LICENSE` value in our recipe, however some BSD-4-Clause code actually still remained upstream until 9.4p1. +- ``python3-sphinx``: remove ``BSD-3-Clause`` from :term:`LICENSE` - BSD-3-Clause code was removed as part of the python3-sphinx 7.0.1 release (see `this upstream commit <https://github.com/sphinx-doc/sphinx/commit/a7f5d91c29d6f377b9fe7e926965c6f9d3e7b802>`__) + + +Security Fixes in 4.3 +~~~~~~~~~~~~~~~~~~~~~ + +- bind: :cve:`2023-2911`, :cve:`2023-2828`, :cve:`2023-3341`, :cve:`2023-4236` +- binutils: :cve:`2023-1972` +- connman: :cve:`2023-28488` +- cups: :cve:`2023-32324`, :cve:`2023-34241`, :cve:`2023-4504` +- dbus: :cve:`2023-34969` +- dmidecode: :cve:`2023-30630` +- dropbear: :cve:`2023-36328` +- erofs-utils: :cve:`2023-33551`, :cve:`2023-33552` +- gcc: :cve:`2023-4039` +- ghostscript: :cve:`2023-28879`, :cve:`2023-36664`, :cve:`2023-38559;` ignore :cve:`2023-38560` +- git: :cve:`2023-25652`, :cve:`2023-29007` +- glibc: :cve:`2023-4527`, :cve:`2023-4806` +- go: :cve:`2023-24537`, :cve:`2023-39325` +- gstreamer: :cve:`2023-40475`, :cve:`2023-40476` +- inetutils: :cve:`2023-40303` +- libarchive: ignore :cve:`2023-30571` +- librsvg: :cve:`2023-38633` +- libwebp: :cve:`2023-1999`, :cve:`2023-4863` +- libx11: :cve:`2023-3138`, :cve:`2023-43785`, :cve:`2023-43786`, :cve:`2023-43787` +- libxml2: :cve:`2023-28484`, :cve:`2023-29469;` ignore disputed :cve:`2023-45322` +- libxpm: :cve:`2023-43788`, :cve:`2023-43789`, :cve:`2022-44617` +- linux: update CVE exclusions +- ncurses: :cve:`2023-29491` +- nghttp2: :cve:`2023-44487` +- ninja: ignore :cve:`2021-4336`, wrong ninja +- openssh: :cve:`2023-38408` +- openssl: :cve:`2023-2650`, :cve:`2023-1255`, :cve:`2023-0466`, :cve:`2023-0465`, :cve:`2023-0464`, :cve:`2023-3817`, :cve:`2023-3446`, :cve:`2023-2975`, :cve:`2023-4807` +- perl: :cve:`2023-31484`, :cve:`2023-31486` +- pixman: ignore :cve:`2023-37769` +- procps: :cve:`2023-4016` +- python3-git: :cve:`2023-41040` +- python3: ignore :cve:`2023-36632` +- python3-urllib3: :cve:`2023-43804` +- qemu: :cve:`2023-40360`, :cve:`2023-42467;` ignore :cve:`2023-0664` (Windows-specific), ignore :cve:`2023-2680` (RHEL specific) +- screen: :cve:`2023-24626` +- shadow: :cve:`2023-29383` +- sqlite3: ignore :cve:`2023-36191` +- sysstat: :cve:`2023-33204` +- tiff: :cve:`2022-4645`, :cve:`2023-2731`, :cve:`2023-26965`, :cve:`2023-40745`, :cve:`2023-41175` +- vim: :cve:`2023-2426`, :cve:`2023-2609`, :cve:`2023-2610`, :cve:`2023-3896`, :cve:`2023-5441`, :cve:`2023-5535` +- zlib: ignore :cve:`2023-45853` + + +Recipe Upgrades in 4.3 +~~~~~~~~~~~~~~~~~~~~~~ + +- acpica: upgrade 20220331 -> 20230628 +- adwaita-icon-theme: 43 -> 45.0 +- alsa-lib: upgrade 1.2.8 -> 1.2.10 +- alsa-ucm-conf: upgrade 1.2.8 -> 1.2.10 +- alsa-utils: upgrade 1.2.8 -> 1.2.10 +- apr: upgrade 1.7.2 -> 1.7.4 +- apt: Upgrade to v2.6.0 +- at-spi2-core: update 2.46.0 -> 2.50.0 +- autoconf: Upgrade to 2.72c +- babeltrace2: upgrade 2.0.4 -> 2.0.5 +- bind: upgrade 9.18.12 -> 9.18.19 +- binutils: Upgrade to 2.41 release +- bluez5: upgrade 5.66 -> 5.69 +- boost: upgrade 1.81.0 -> 1.83.0 +- btrfs-tools: upgrade 6.1.3 -> 6.5.1 +- busybox: 1.36.0 -> 1.36.1 +- ccache: upgrade 4.7.4 -> 4.8.3 +- cmake: upgrade to 3.27.5 +- connman: update 1.41 -> 1.42 +- coreutils: upgrade 9.1 -> 9.4 +- cpio: upgrade to 2.14 +- cracklib: upgrade 2.9.10 -> 2.9.11 +- createrepo-c: update 0.20.1 -> 1.0.0 +- cryptodev: update to 1.13 + latest git +- cups: upgrade to 2.4.6 +- curl: upgrade 8.0.1 -> 8.4.0 +- dbus: upgrade 1.14.6 -> 1.14.10 +- debianutils: upgrade 5.8 -> 5.13 +- dhcpcd: upgrade to 10.0.2 +- diffoscope: upgrade 236 -> 249 +- diffutils: update 3.9 -> 3.10 +- dmidecode: upgrade to 3.5 +- dnf: upgrade 4.14.0 -> 4.17.0 +- dos2unix: upgrade 7.4.4 -> 7.5.1 +- dpkg: upgrade to v1.22.0 +- efivar: Upgrade to tip of trunk +- elfutils: upgrade 0.188 -> 0.189 +- ell: upgrade 0.56 -> 0.58 +- enchant2: upgrade 2.3.4 -> 2.6.1 +- epiphany: upgrade 43.1 -> 44.6 +- erofs-utils: update 1.5 -> 1.6 +- ethtool: upgrade 6.2 -> 6.5 +- eudev: Upgrade 3.2.11 -> 3.2.12 +- ffmpeg: update 5.1.2 -> 6.0 +- file: upgrade 5.44 -> 5.45 +- flac: Upgrade 1.4.2 -> 1.4.3 +- font-util: upgrade 1.4.0 -> 1.4.1 +- freetype: upgrade 2.13.0 -> 2.13.2 +- fribidi: upgrade 1.0.12 -> 1.0.13 +- gawk: upgrade 5.2.1 -> 5.2.2 +- gcc: upgrade to 13.2 +- gcompat: Upgrade to 1.1.0 +- gcr: update 4.0.0 -> 4.1.0 +- gdb: upgrade 13.1 -> 13.2 +- gettext: upgrade 0.21.1 -> 0.22 +- ghostscript: upgrade to 10.02.0 +- git: upgrade to 2.42.0 +- glib-2.0: upgrade 2.74.6 -> 2.78.0 +- glibc: upgrade to 2.38 + stable updates +- glib-networking: upgrade 2.74.0 -> 2.76.1 +- glslang: upgrade to 1.3.243 +- gmp: upgrade 6.2.1 -> 6.3.0 +- gnu-efi: upgrade 3.0.15 -> 3.0.17 +- gnupg: upgrade 2.4.0 -> 2.4.3 +- gnutls: update 3.8.0 -> 3.8.1 +- gobject-introspection: upgrade 1.74.0 -> 1.78.1 +- go-helloworld: Upgrade to tip of trunk +- go: update 1.20.1 -> 1.20.10 +- gpgme: update 1.18.0 -> 1.22.0 +- grep: upgrade 3.10 -> 3.11 +- groff: update 1.22.4 -> 1.23.0 +- gsettings-desktop-schemas: upgrade 43.0 -> 44.0 +- gstreamer1.0: upgrade 1.22.0 -> 1.22.5 +- gstreamer: upgrade 1.22.5 -> 1.22.6 +- gtk+3: upgrade 3.24.36 -> 3.24.38 +- gtk4: update 4.10.0 -> 4.12.3 +- gzip: update 1.12 -> 1.13 +- harfbuzz: upgrade 7.1.0 -> 8.2.1 +- icu: upgrade 72-1 -> 73-2 +- igt-gpu-tools: update 1.27.1 -> 1.28 +- iproute2: upgrade 6.2.0 -> 6.5.0 +- iso-codes: upgrade 4.13.0 -> 4.15.0 +- jquery: upgrade 3.6.3 -> 3.7.1 +- json-c: upgrade 0.16 -> 0.17 +- kbd: upgrade 2.5.1 -> 2.6.3 +- kea: upgrade to v2.4.0 +- kexec-tools: upgrade 2.0.26 -> 2.0.27 +- kmscube: upgrade to latest revision +- less: update 608 -> 643 +- libadwaita: upgrade 1.3.3 -> 1.4.0 +- libarchive: upgrade 3.6.2 -> 3.7.2 +- libassuan: upgrade 2.5.5 -> 2.5.6 +- libatomic-ops: update 7.6.14 -> 7.8.0 +- libcap: upgrade 2.67 -> 2.69 +- libcgroup: update 3.0.0 -> 3.1.0 +- libconvert-asn1-perl: upgrade 0.33 -> 0.34 +- libdnf: update 0.70.1 -> 0.70.1 +- libdrm: upgrade 2.4.115 -> 2.4.116 +- libedit: upgrade 20221030-3.1 -> 20230828-3.1 +- libevdev: upgrade 1.13.0 -> 1.13.1 +- libgcrypt: update 1.10.1 -> 1.10.2 +- libgit2: upgrade 1.6.3 -> 1.7.1 +- libglu: update 9.0.2 -> 9.0.3 +- libgpg-error: update 1.46 -> 1.47 +- libgudev: upgrade 237 -> 238 +- libhandy: upgrade 1.8.1 -> 1.8.2 +- libinput: upgrade to 1.24.0 +- libjpeg-turbo: upgrade to 3.0.0 +- libksba: upgrade 1.6.3 -> 1.6.4 +- libmd: upgrade 1.0.4 -> 1.1.0 +- libmicrohttpd: upgrade 0.9.76 -> 0.9.77 +- libmodule-build-perl: upgrade 0.4232 -> 0.4234 +- libmodulemd: upgrade 2.14.0 -> 2.15.0 +- libnl: upgrade 3.7.0 -> 3.8.0 +- libnss-nis: upgrade 3.1 -> 3.2 +- libpam: update 1.5.2 -> 1.5.3 +- libpcap: upgrade 1.10.3 -> 1.10.4 +- libpng: upgrade 1.6.39 -> 1.6.40 +- libportal: upgrade 0.6 -> 0.7.1 +- libproxy: update 0.4.18 -> 0.5.3 +- libpthread-stubs: update 0.4 -> 0.5 +- librepo: upgrade 1.15.1 -> 1.16.0 +- librsvf: update 2.54.5 -> 2.56.0 +- librsvg: update 2.56.0 -> 2.56.3 +- libsdl2: upgrade 2.26.3 -> 2.28.3 +- libsecret: upgrade 0.20.5 -> 0.21.1 +- libsndfile1: upgrade 1.2.0 -> 1.2.2 +- libsolv: upgrade 0.7.23 -> 0.7.25 +- libsoup: upgrade 3.2.2 -> 3.4.2 +- libssh2: update 1.10.0 -> 1.11.0 +- libtraceevent: upgrade 1.7.2 -> 1.7.3 +- libubootenv: upgrade 0.3.3 -> 0.3.4 +- liburi-perl: update 5.17 -> 5.21 +- libuv: upgrade 1.44.2 -> 1.46.0 +- libva: update 2.16 -> 2.19.0 +- libva-utils: update 2.19.0 -> 2.20.0 +- libwebp: upgrade 1.3.0 -> 1.3.2 +- libx11: upgrade 1.8.4 -> 1.8.7 +- libxcb: upgrade 1.15 -> 1.16 +- libxcrypt: upgrade 4.4.33 -> 4.4.36 +- libxfixes: Upgrade to v6.0.1 +- libxft: upgrade 2.3.7 -> 2.3.8 +- libxi: upgrade to v1.8.1 +- libxml2: upgrade 2.10.3 -> 2.11.5 +- libxpm: upgrade 3.5.15 -> 3.5.17 +- libxslt: upgrade 1.1.37 -> 1.1.38 +- libxt: Upgrade to v1.3.0 +- lighttpd: upgrade 1.4.69 -> 1.4.71 +- linux-firmware: upgrade 20230210 -> 20230804 +- linux-libc-headers: uprev to v6.5 +- linux-yocto/6.1: update to v6.1.57 +- linux-yocto-dev: update to v6.6-rcX +- linux-yocto: introduce 6.5 reference kernel recipes +- llvm: Upgrade to 17.0.2 +- ltp: upgrade 20230127 -> 20230516 +- lttng-modules: Upgrade 2.13.9 -> 2.13.10 +- lttng-tools: Upgrade 2.13.9 -> 2.13.11 +- lttng-ust: upgrade 2.13.5 -> 2.13.6 +- lua: update 5.4.4 -> 5.4.6 +- man-pages: upgrade 6.03 -> 6.05.01 +- mc: upgrade 4.8.29 -> 4.8.30 +- mesa: upgrade 23.0.0 -> 23.2.1 +- meson: upgrade 1.0.1 -> 1.2.2 +- mmc-utils: upgrade to latest revision +- mobile-broadband-provider-info: upgrade 20221107 -> 20230416 +- mpfr: upgrade 4.2.0 -> 4.2.1 +- mpg123: upgrade 1.31.2 -> 1.31.3 +- msmtp: upgrade 1.8.23 -> 1.8.24 +- mtd-utils: upgrade 2.1.5 -> 2.1.6 +- mtools: upgrade 4.0.42 -> 4.0.43 +- musl: update to latest master +- neard: upgrade 0.18 -> 0.19 +- nettle: upgrade 3.8.1 -> 3.9.1 +- nfs-utils: upgrade 2.6.2 -> 2.6.3 +- nghttp2: upgrade 1.52.0 -> 1.57.0 +- ofono: upgrade 2.0 -> 2.1 +- openssh: upgrade to 9.5p1 +- openssl: upgrade 3.1.0 -> 3.1.3 +- opkg: upgrade 0.6.1 -> 0.6.2 +- opkg-utils: upgrade 0.5.0 -> 0.6.2 +- orc: upgrade 0.4.33 -> 0.4.34 +- ovmf: update 202211 -> 202305 +- ovmf: update edk2-stable202305 -> edk2-stable202308 +- p11-kit: upgrade 0.24.1 -> 0.25.0 +- pango: upgrade 1.50.13 -> 1.51.0 +- parted: upgrade 3.5 -> 3.6 +- patchelf: Upgrade 0.17.2 -> 0.18.0 +- pciutils: upgrade 3.9.0 -> 3.10.0 +- perlcross: update 1.4 -> 1.5 +- perl: update 5.36.0 -> 5.38.0 +- piglit: upgrade to latest revision +- pigz: upgrade 2.7 -> 2.8 +- pkgconf: upgrade 1.9.4 -> 2.0.3 +- ppp: upgrade 2.4.9 -> 2.5.0 +- procps: update 4.0.3 -> 4.0.4 +- puzzles: upgrade to latest revision +- python3-attrs: upgrade 22.2.0 -> 23.1.0 +- python3-build: upgrade to 1.0.3 +- python3-certifi: upgrade 2022.12.7 -> 2023.7.22 +- python3-chardet: upgrade 5.1.0 -> 5.2.0 +- python3-cryptography{-vectors}: upgrade 39.0.2 -> 41.0.4 +- python3-cython: upgrade 0.29.33 -> 0.29.36 +- python3-dbusmock: upgrade 0.28.7 -> 0.29.1 +- python3-docutils: upgrade 0.19 -> 0.20.1 +- python3-dtc: upgrade 1.6.1 -> 1.7.0 +- python3-dtschema: upgrade 2023.1 -> 2023.7 +- python3-editables: upgrade 0.3 -> 0.5 +- python3-flit-core: upgrade 3.8.0 -> 3.9.0 +- python3-git: upgrade 3.1.31 -> 3.1.36 +- python3-hatch-fancy-pypi-readme: upgrade 22.8.0 -> 23.1.0 +- python3-hatchling: upgrade 1.13.0 -> 1.18.0 +- python3-hypothesis: upgrade 6.68.2 -> 6.86.2 +- python3-importlib-metadata: upgrade 6.0.0 -> 6.8.0 +- python3-installer: upgrade 0.6.0 -> 0.7.0 +- python3-iso8601: upgrade 1.1.0 -> 2.0.0 +- python3-jsonpointer: upgrade to 2.4 +- python3-libarchive-c: upgrade 4.0 -> 5.0 +- python3-lxml: upgrade 4.9.2 -> 4.9.3 +- python3-markdown: upgrade 3.4.1 -> 3.4.4 +- python3-markupsafe: upgrade 2.1.2 -> 2.1.3 +- python3-more-itertools: upgrade 9.1.0 -> 10.1.0 +- python3-numpy: upgrade 1.24.2 -> 1.26.0 +- python3-packaging: upgrade 23.0 -> 23.1 +- python3-pathspec: upgrade 0.11.0 -> 0.11.2 +- python3-pip: upgrade 23.0.1 -> 23.2.1 +- python3-pluggy: upgrade 1.0.0 -> 1.3.0 +- python3-poetry-core: upgrade 1.5.2 -> 1.7.0 +- python3-psutil: upgrade 5.9.4 -> 5.9.5 +- python3-pyasn1: upgrade 0.4.8 -> 0.5.0 +- python3-pycairo: upgrade 1.23.0 -> 1.24.0 +- python3-pycryptodome: upgrade 3.17 -> 3.19.0 +- python3-pycryptodomex: upgrade 3.17 -> 3.19.0 +- python3-pyelftools: upgrade 0.29 -> 0.30 +- python3-pygments: upgrade 2.14.0 -> 2.16.1 +- python3-pygobject: upgrade 3.42.2 -> 3.46.0 +- python3-pyopenssl: upgrade 23.0.0 -> 23.2.0 +- python3-pyparsing: upgrade 3.0.9 -> 3.1.1 +- python3-pytest-subtests: upgrade 0.10.0 -> 0.11.0 +- python3-pytest: upgrade 7.2.2 -> 7.4.2 +- python3-pytz: upgrade 2022.7.1 -> 2023.3 +- python3-pyyaml: upgrade 6.0 -> 6.0.1 +- python3-requests: Upgrade to 2.31.0 +- python3-ruamel-yaml: upgrade 0.17.21 -> 0.17.32 +- python3-setuptools-rust: upgrade 1.5.2 -> 1.7.0 +- python3-setuptools: upgrade 67.6.0 -> 68.2.2 +- python3-smmap: upgrade 5.0.0 -> 6.0.0 +- python3-sphinx-rtd-theme: upgrade 1.2.0 -> 1.3.0 +- python3-sphinx: upgrade 6.1.3 -> 7.2.6 +- python3-trove-classifiers: upgrade 2023.4.29 -> 2023.9.19 +- python3-typing-extensions: upgrade 4.5.0 -> 4.8.0 +- python3: upgrade 3.11.2 -> 3.11.5 +- python3-urllib3: upgrade 1.26.15 -> 2.0.6 +- python3-webcolors: upgrade 1.12 -> 1.13 +- python3-wheel: upgrade 0.40.0 -> 0.41.2 +- python3-zipp: upgrade 3.15.0 -> 3.17.0 +- qemu: Upgrade 7.2.0 -> 8.1.0 +- re2c: upgrade 3.0 -> 3.1 +- repo: upgrade 2.32 -> 2.36.1 +- rpcsvc-proto: Upgrade to 1.4.4 +- rpm2cpio.sh: update to the last 4.x version +- rpm: update 4.18.0 -> 4.18.1 +- ruby: upgrade 3.2.1 -> 3.2.2 +- rust: Upgrade 1.68.1 -> 1.70.0 +- screen: update 4.9.0 -> 4.9.1 +- seatd: upgrade 0.7.0 -> 0.8.0 +- serf: upgrade 1.3.9 -> 1.3.10 +- shaderc: upgrade 2023.2 -> 2023.6 +- spirv-headers: upgrade 1.3.239.0 -> 1.3.243.0 +- spirv-tools: upgrade 1.3.239.0 -> 1.3.243.0 +- sqlite3: upgrade 3.41.0 -> 3.43.1 +- squashfs-tools: upgrade 4.5.1 -> 4.6.1 +- sstatesig: Update to match bitbake changes to runtaskdeps +- strace: upgrade 6.2 -> 6.5 +- stress-ng: upgrade 0.15.06 -> 0.16.05 +- sudo: update 1.9.13p3 -> 1.9.14p3 +- sysfsutils: update 2.1.0 -> 2.1.1 +- sysklogd: upgrade 2.4.4 -> 2.5.2 +- sysstat: update 12.6.2 -> 12.7.4 +- systemd: upgrade 253.1 -> 254.4 +- systemtap: upgrade 4.8 -> 4.9 +- taglib: upgrade 1.13 -> 1.13.1 +- tar: upgrade 1.34 -> 1.35 +- tcf-agent: Update to 1.8.0 release +- texinfo: upgrade 7.0.2 -> 7.0.3 +- tiff: upgrade to 4.6.0 +- u-boot: Upgrade to 2023.10 +- util-linux: upgrade 2.38.1 -> 2.39.2 +- vala: upgrade 0.56.4 -> 0.56.13 +- valgrind: update 3.20.0 -> 3.21.0 +- vim: upgrade 9.0.1429 -> 9.0.2048 +- vte: upgrade 0.72.0 -> 0.72.2 +- vulkan-headers: upgrade to 1.3.243 +- vulkan-loader: upgrade to 1.3.243 +- vulkan-samples: update to latest SHA +- vulkan-tools: upgrade to 1.3.243 +- vulkan: upgrade 1.3.243.0 -> 1.3.261.1 +- waffle: upgrade 1.7.0 -> 1.7.2 +- wayland-protocols: upgrade 1.31 -> 1.32 +- wayland: upgrade 1.21.0 -> 1.22.0 +- wayland-utils: upgrade 1.1.0 -> 1.2.0 +- webkitgtk: update 2.38.5 -> 2.40.5 +- weston: update 11.0.1 -> 12.0.2 +- wget: upgrade 1.21.3 -> 1.21.4 +- wireless-regdb: upgrade 2023.02.13 -> 2023.09.01 +- wpebackend-fdo: upgrade 1.14.0 -> 1.14.2 +- xcb-proto: upgrade 1.15.2 -> 1.16.0 +- xdpyinfo: upgrade 1.3.3 -> 1.3.4 +- xeyes: upgrade 1.2.0 -> 1.3.0 +- xf86-input-libinput: upgrade 1.2.1 -> 1.4.0 +- xf86-input-mouse: upgrade 1.9.4 -> 1.9.5 +- xinput: upgrade to v1.6.4 +- xkeyboard-config: upgrade 2.38 -> 2.39 +- xorgproto: upgrade 2022.2 -> 2023.2 +- xserver-xorg: upgrade 21.1.7 -> 21.1.8 +- xtrans: update 1.4.0 -> 1.5.0 +- xwayland: upgrade 22.1.8 -> 23.2.1 +- xwininfo: upgrade to v1.1.6 +- xxhash: upgrade 0.8.1 -> 0.8.2 +- xz: upgrade 5.4.2 -> 5.4.4 +- zlib: upgrade 1.2.13 -> 1.3 +- zstd: upgrade 1.5.4 -> 1.5.5 + + + + +Contributors to 4.3 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +- Adrian Freihofer +- Alassane Yattara +- Alberto Pianon +- Alberto Planas +- Alejandro Hernandez Samaniego +- Alexander Kanavin +- Alexandre Belloni +- Alexis Lothoré +- Alex Kiernan +- Andreas Cord-Landwehr +- André Draszik +- Andrej Valek +- Andrew Jeffery +- Andrey Zhizhikin +- Angelo Ribeiro +- Antoine Lubineau +- Antonin Godard +- Anuj Mittal +- Archana Polampalli +- Armin Kuster +- Arne Schwerdt +- Arno Baumfalk +- Arslan Ahmad +- Bartosz Golaszewski +- BELHADJ SALEM Talel +- BELOUARGA Mohamed +- Benjamin Bara +- Benjamin Bouvier +- Bergin, Peter +- Bruce Ashfield +- Changhyeok Bae +- Changqing Li +- Charles-Antoine Couret +- Charlie Wu +- Chen Qi +- Chi Xu +- Chris Laplante +- Christopher Larson +- Daniel Ammann +- Daniel McGregor +- Daniel Semkowicz +- David Reyna +- Deepthi Hemraj +- Denis OSTERLAND-HEIM +- Denys Dmytriyenko +- Derek Straka +- Dit Kozmaj +- Dmitry Baryshkov +- Ed Beroset +- Eero Aaltonen +- Eilís 'pidge' Ní Fhlannagáin +- Emil Ekmečić +- Emil Kronborg Andersen +- Enrico Jörns +- Enrico Scholz +- Etienne Cordonnier +- Fabien Mahot +- Fabio Estevam +- Fahad Arslan +- Frank WOLFF +- Frederic Martinsons +- Frieder Paape +- Frieder Schrempf +- Geoff Parker +- Hannu Lounento +- Ian Ray +- Insu Park +- Jaeyoon Jung +- Jamin Lin +- Jan Garcia +- Jan Vermaete +- Jasper Orschulko +- Jean-Marie Lemetayer +- Jérémy Rosen +- Jermain Horsman +- Jialing Zhang +- Joel Stanley +- Joe Slater +- Johannes Schrimpf +- Jon Mason +- Jörg Sommer +- Jose Quaresma +- Joshua Watt +- Julien Stephan +- Kai Kang +- Khem Raj +- Kyle Russell +- Lee Chee Yang +- Lei Maohui +- Leon Anavi +- Lorenzo Arena +- Louis Rannou +- Luan Rafael Carneiro +- Luca Boccassi +- Luca Ceresoli +- Marc Ferland +- Marcus Flyckt +- Marek Vasut +- Mark Asselstine +- Mark Hatle +- Markus Niebel +- Markus Volk +- Marlon Rodriguez Garcia +- Marta Rybczynska +- Martijn de Gouw +- Martin Jansa +- Martin Siegumfeldt +- Matthias Schnelte +- Mauro Queiros +- Max Krummenacher +- Michael Halstead +- Michael Opdenacker +- Mickael RAMILISON +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Narpat Mali +- Natasha Bailey +- Nikhil R +- Ninad Palsule +- Ola x Nilsson +- Oleksandr Hnatiuk +- Otavio Salvador +- Ovidiu Panait +- Pascal Bach +- Patrick Williams +- Paul Eggleton +- Paul Gortmaker +- Paulo Neves +- Pavel Zhukov +- Pawan Badganchi +- Peter Bergin +- Peter Hoyes +- Peter Kjellerstedt +- Peter Marko +- Peter Suti +- Petr Gotthard +- Petr Kubizňák +- Piotr Łobacz +- Poonam Jadhav +- Qiu Tingting +- Quentin Schulz +- Randolph Sapp +- Randy MacLeod +- Ranjitsinh Rathod +- Rasmus Villemoes +- Remi Peuvergne +- Richard Purdie +- Riyaz Khan +- Robert Joslyn +- Robert P. J. Day +- Robert Yang +- Roland Hieber +- Ross Burton +- Ryan Eatmon +- Sakib Sajal +- Samantha Jalabert +- Sanjay Chitroda +- Sean Nyekjaer +- Sergei Zhmylev +- Siddharth Doshi +- Soumya Sambu +- Staffan Rydén +- Stefano Babic +- Stefan Tauner +- Stéphane Veyret +- Stephan Wurm +- Sudip Mukherjee +- Sundeep KOKKONDA +- Svend Meyland Nicolaisen +- Tan Wen Yan +- Thomas Roos +- Tim Orling +- Tom Hochstein +- Tom Isaacson +- Trevor Gamblin +- Ulrich Ölmann +- Victor Kamensky +- Vincent Davis Jr +- Virendra Thakur +- Wang Mingyu +- Xiangyu Chen +- Yang Xu +- Yash Shinde +- Yi Zhao +- Yoann Congal +- Yogita Urade +- Yuta Hayama +- Zang Ruochen +- Zhixiong Chi + + +Repositories / Downloads for Yocto-4.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`nanbield </poky/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3 </poky/log/?h=yocto-4.3>` +- Git Revision: :yocto_git:`15b576c4101231d248fda7ae0824e1780e1a8901 </poky/commit/?id=15b576c4101231d248fda7ae0824e1780e1a8901>` +- Release Artefact: poky-15b576c4101231d248fda7ae0824e1780e1a8901 +- sha: 6b0ef7914d15db057f3efdf091b169a7361c74aac0abcfa717ef55d1a0adf74c +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3/poky-15b576c4101231d248fda7ae0824e1780e1a8901.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3/poky-15b576c4101231d248fda7ae0824e1780e1a8901.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`nanbield </openembedded-core/log/?h=nanbield>` +- Tag: :oe_git:`yocto-4.3 </openembedded-core/log/?h=yocto-4.3>` +- Git Revision: :oe_git:`4c261f8cbdf0c7196a74daad041d04eb093015f3 </openembedded-core/commit/?id=4c261f8cbdf0c7196a74daad041d04eb093015f3>` +- Release Artefact: oecore-4c261f8cbdf0c7196a74daad041d04eb093015f3 +- sha: c9e6ac75d7848ce8844cb29c98659dd8f83b3de13b916124dff76abe034e6a5c +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3/oecore-4c261f8cbdf0c7196a74daad041d04eb093015f3.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3/oecore-4c261f8cbdf0c7196a74daad041d04eb093015f3.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`nanbield </meta-mingw/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3 </meta-mingw/log/?h=yocto-4.3>` +- Git Revision: :yocto_git:`65ef95a74f6ae815f63f636ed53e140a26a014ce </meta-mingw/commit/?id=65ef95a74f6ae815f63f636ed53e140a26a014ce>` +- Release Artefact: meta-mingw-65ef95a74f6ae815f63f636ed53e140a26a014ce +- sha: fb2bf806941a00a1be6349c074379b63a76490bcf0f3b740d96d1aeeefa12286 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3/meta-mingw-65ef95a74f6ae815f63f636ed53e140a26a014ce.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3/meta-mingw-65ef95a74f6ae815f63f636ed53e140a26a014ce.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.6 </bitbake/log/?h=2.6>` +- Tag: :oe_git:`yocto-4.3 </bitbake/log/?h=yocto-4.3>` +- Git Revision: :oe_git:`5419a8473d6d4cd1d01537de68ad8d72cf5be0b2 </bitbake/commit/?id=5419a8473d6d4cd1d01537de68ad8d72cf5be0b2>` +- Release Artefact: bitbake-5419a8473d6d4cd1d01537de68ad8d72cf5be0b2 +- sha: e5dab4b3345d91307860803e2ad73b2fcffa9d17dd3fde0e013ca0ebea0d05ca +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.3/bitbake-5419a8473d6d4cd1d01537de68ad8d72cf5be0b2.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.3/bitbake-5419a8473d6d4cd1d01537de68ad8d72cf5be0b2.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`nanbield </yocto-docs/log/?h=nanbield>` +- Tag: :yocto_git:`yocto-4.3 </yocto-docs/log/?h=yocto-4.3>` +- Git Revision: :yocto_git:`ceb1812e63b9fac062f886c2a1dde23137c0e1ed </yocto-docs/commit/?id=ceb1812e63b9fac062f886c2a1dde23137c0e1ed>` + diff --git a/documentation/migration-guides/release-notes-5.0.rst b/documentation/migration-guides/release-notes-5.0.rst new file mode 100644 index 0000000000..884a66771d --- /dev/null +++ b/documentation/migration-guides/release-notes-5.0.rst @@ -0,0 +1,938 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 5.0 (scarthgap) +--------------------------------- + +New Features / Enhancements in 5.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 6.6, gcc 13.2, glibc 2.39, LLVM 18.1, and over 300 other recipe upgrades + +- New variables: + + - :term:`CVE_DB_INCR_UPDATE_AGE_THRES`: Configure the maximum age of the + internal CVE database for incremental update (instead of a full + redownload). + + - :term:`RPMBUILD_EXTRA_PARAMS`: support extra user-defined fields without + crashing the RPM package creation. + + - :term:`OPKG_MAKE_INDEX_EXTRA_PARAMS`: support extra parameters for + ``opkg-make-index``. + + - :term:`EFI_UKI_PATH`, :term:`EFI_UKI_DIR`: define the location of UKI + image in the EFI System partition. + + - :term:`TARGET_DBGSRC_DIR`: specifies the target path to debug source files + + - :term:`USERADD_DEPENDS`: provides a way to declare dependencies on the users + and/or groups created by other recipes, resolving a long-standing build + ordering issue + +- Architecture-specific enhancements: + + - ``genericarm64``: a new :term:`MACHINE` to represent a 64-bit General Arm + SystemReady platform. + + - Add Power8 tune to PowerPC architecture. + + - ``arch-armv9``: remove CRC and SVE tunes, since FEAT_CRC32 is now mandatory + and SVE/SVE2 are enabled by default in GCC's ``-march=armv9-a``. + + - ``arm/armv*``: add all of the additional Arm tunes in GCC 13.2.0 + +- Kernel-related enhancements: + + - The default kernel is the current LTS (6.6). + + - Add support for ``genericarm64``. + +- New core recipes: + + - `bmaptool <https://github.com/yoctoproject/bmaptool>`__: a tool for + creating block maps for files and flashing images, being now under the + Yocto Project umbrella. + + - ``core-image-initramfs-boot``: a minimal initramfs image, containing just + ``udev`` and ``init``, designed to find the main root filesystem and + pivot to it. + + - `lzlib <https://www.nongnu.org/lzip/lzlib.html>`__: a data compression + library that provides LZMA compression and decompression functions. + + - `lzop <https://www.lzop.org/>`__: a compression utility based on the LZO + library, that was brought back after a (now reverted) removal. + + - `python3-jsonschema-specifications <https://pypi.org/project/jsonschema-specifications/>`__: + support files for JSON Schema Specifications (meta-schemas and + vocabularies), added as a new dependency of ``python3-jsonschema``. + + - `python3-maturin <https://github.com/pyo3/maturin>`__: a project that + allows building and publishing Rust crates as Python packages. + + - `python3-meson-python <https://github.com/mesonbuild/meson-python>`__: a + Python build backend that enables the Meson build-system for Python packages. + + - `python3-pyproject-metadata <https://pypi.org/project/pyproject-metadata/>`__: + a class to handle PEP 621 metadata, and a dependency for + ``python3-meson-python``. + + - `python3-referencing <https://github.com/python-jsonschema/referencing>`__: + another dependency of ``python3-jsonschema``, it provides an + implementation of JSON reference resolution. + + - `python3-rpds-py <https://pypi.org/project/rpds-py/>`__: Python bindings + to the Rust rpds crate, and a runtime dependency for ``python3-referencing``. + + - `python3-sphinxcontrib-jquery <https://pypi.org/project/sphinxcontrib-jquery/>`__: + a Sphinx extension to include jQuery on newer Sphinx releases. Recent + versions of ``python3-sphinx-rtd-theme`` depend on it. + + - `python3-websockets <https://pypi.org/project/websockets/>`__: a + library for building WebSocket servers and clients in Python. + + - `python3-yamllint <https://github.com/adrienverge/yamllint>`__: a linter + for YAML files. In U-Boot, the ``binman`` tool uses this linter to verify the + configurations at compile time. + + - ``systemd-boot-native``: a UEFI boot manager, this time built as native to + provide the ``ukify`` tool. + + - `utfcpp <https://github.com/nemtrif/utfcpp>`__: a C++ library to handle + UTF-8 encoded strings. It was added as a dependency for ``taglib`` after + its upgrade to v2.0. + + - `vulkan-utility-libraries <https://github.com/KhronosGroup/Vulkan-Utility-Libraries>`__: + a set of libraries to share code across various Vulkan repositories. + + - `vulkan-volk <https://github.com/zeux/volk>`__: a meta-loader for Vulkan, + needed to support building the latest ``vulkan-tools``. + +- QEMU / ``runqemu`` enhancements: + + - QEMU has been upgraded to version 8.2.1 + + - ``qemuboot``: support predictable network interface names. + + - ``runqemu``: match ".rootfs." in addition to "-image-" for the root + filesystem. + + - :ref:`ref-classes-cmake-qemu`: a new class allowing to execute cross-compiled + binaries using QEMU user-mode emulation. + +- Rust improvements: + + - Rust has been upgraded to version 1.75 + + - The Rust profiler (i.e., PGO - Profile-Guided Optimization) options were + enabled back. + + - The Rust ``oe-selftest`` were enabled, except for ``mips32`` whose tests + are skipped. + + - ``rust-cross-canadian``: added ``riscv64`` to cross-canadian hosts. + +- wic Image Creator enhancements: + + - Allow the imager's output file extension to match the imager's name, + instead of hardcoding it to ``direct`` (i.e., the default imager) + + - For GPT-based disks, add reproducible Disk GUID generation + + - Allow generating reproducible ext4 images + + - Add feature to fill a specific range of a partition with zeros + + - ``bootimg-efi``: add ``install-kernel-into-boot-dir`` parameter to + configure kernel installation point(s) (i.e., rootfs and/or boot partition) + + - ``rawcopy``: add support for zstd decompression + +- SDK-related improvements: + + - ``nativesdk``: let :term:`MACHINE_FEATURES` be set by ``machine-sdk`` + configuration files. + + - ``nativesdk``: prevent :term:`MACHINE_FEATURES` and :term:`DISTRO_FEATURES` + from being backfilled. + + - Support for ``riscv64`` as an SDK host architecture + + - Extend recipes to ``nativesdk``: ``acpica``, ``libpcap``, ``python3-setuptools-rust`` + +- Testing: + + - Move `patchtest` to the core (as ``scripts/patchtest``, test cases under + ``meta/lib/patchtest/tests``) and make a number of improvements to enable + it to validate patches submitted on the mailing list again. Additionally, + make it work with the original upstream version of + `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__. + + - Add an optional ``unimplemented-ptest`` QA warning to detect upstream + packages with tests, that do not use ptest. + + - ``testimage``: retrieve the ptests directory, especially for the logs, + upon ptest failure. + + - ``oeqa``, ``oe-selftest``: add test cases for Maturin (SDK and runtime). + + - Proof-of-concept of screenshot-based runtime UI test + (``meta/lib/oeqa/runtime/cases/login.py``) + + - Enable ptests for ``python3-attrs``, ``python3-pyyaml``, ``xz`` + +- Utility script changes: + + - ``oe-init-build-env`` can generate a initial configuration (``.vscode``) + for VSCode and its "Yocto Project BitBake" extension. + + - The ``sstate-cache-management`` script has been rewritten in python for better performance and maintainability + + - ``bitbake-layers``: added an option to update the reference of repositories in layer setup + +- BitBake improvements: + + - New ``inherit_defer`` statement which works as + :ref:`inherit <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` directive>` + does, except that it is only evaluated at the end of parsing + --- recommended where a conditional expression is used, e.g.:: + + inherit_defer ${@bb.utils.contains('PACKAGECONFIG', 'python', 'python3targetconfig', '', d)} + + This allows conditional expressions to be evaluated 'late' meaning changes + to the variable after the line is parsed will take effect - with inherit this + is not the case. + + - Add support for :term:`BB_LOADFACTOR_MAX`, so Bitbake can stop running + extra tasks if the system load is too high, especially in distributions + where ``/proc/pressure`` is disabled. + + - ``taskexp_ncurses``: add ncurses version of ``taskexp``, the dependency + explorer originally implemented with GTK. + + - Improve ``runqueue`` performance by adding a cache mechanism in + ``build_taskdepdata``. + + - ``bitbake.conf``: add ``runtimedir`` to represent the path to the runtime + state directory (i.e., ``/run``). + + - Allow to disable colored text output through the + `NO_OUTPUT <https://no-color.org/>`__ environment variable. + + - ``git-make-shallow`` script: add support for Git's ``safe.bareRepository=explicit`` + configuration setting. + + - Hash equivalence gained a number of scalability improvements including: + + - Support for a wide range of database backends through `SQLAlchemy` + + - Support for hash equivalence server and client to communicate over websockets + + - Support for per-user permissions in the hashserver, and on the client side + specifying credentials via the environment or ``.netrc`` + + - Add garbage collection to remove unused unihashes from the database. + +- devtool improvements: + + - Introduce a new ``ide-sdk`` plugin to generate a configuration to use + the eSDK through an IDE. + + - Add ``--no-pypi`` option for Python projects that are not hosted on PyPI. + + - Add support for Git submodules. + + - ``ide``: ``vscode``: generate files from recipe sysroots and debug the + root filesystem in read-only mode to avoid confusion. + + - ``modify``: add support for multiple sources in :term:`SRC_URI`. + + - Support plugins within plugins. + +- recipetool improvements: + + - ``appendsrcfile(s)``: add a mode to update the recipe itself. + + - ``appendsrcfile(s)``: add ``--dry-run`` mode. + + - ``create``: add handler to create Go recipes. + + - ``create``: improve identification of licenses. + + - ``create``: add support for modern Python PEP-517 build systems including + hatchling, maturin, meson-python. + + - ``create``: add PyPi support. + + - ``create``: prefix created Python recipes with ``python3-``. + +- Packaging changes: + + - ``package_rpm``: the RPM package compressor's mode can now be overriden. + + - ipk packaging (using ``opkg``) now uses ``zstd`` compression instead of + ``xz`` for better compression and performance. + +- Security improvements: + + - Improve incremental CVE database download from NVD. Rejected CVEs are + removed, configuration is kept up-to-date. The age threshold for + incremental update can be configured with :term:`CVE_DB_INCR_UPDATE_AGE_THRES` + variable. + +- Toaster Web UI improvements: + + - Numerous bugfixes, and additional input validation + + - Add `pytest` support and add/update test cases + +- Prominent documentation updates: + + - Documentation for using the new ``devtool ide-sdk`` command and features. + See :ref:`using_devtool` for details. + + - New ":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-ref-variables-context`" + section in the BitBake User Manual. + + - New ``make stylecheck`` command to run `Vale <https://vale.sh>`__, + to perform text style checks and comply with text writing standards in + the industry. + + - New ``make sphinx-lint`` command to run `sphinx-lint + <https://github.com/sphinx-contrib/sphinx-lint>`__. After customization, + this will allow us to enforce Sphinx syntax style choices. + +- Miscellaneous changes: + + - Systemd's following :term:`PACKAGECONFIG` options were added: + ``cryptsetup-plugins``, ``no-ntp-fallback``, and ``p11kit``. + + - New PACKAGECONFIG options added to ``libarchive``, ``libinput``, + ``libunwind``, ``mesa``, ``mesa-gl``, ``openssh``, ``perf``, + ``python3-pyyaml``, ``qemu``, ``rpm``, ``shadow``, ``strace``, + ``syslinux``, ``systemd``, ``vte``, ``webkitgtk``, ``xserver-xorg``. + + - ``systemd-boot`` can, from now on, be compiled as ``native``, thus + providing ``ukify`` tool to build UKI images. + + - systemd: split bash completion for ``udevadm`` in a new + ``udev-bash-completion`` package. + + - The :ref:`ref-classes-go-vendor` class was added to support offline builds + (i.e., vendoring). It can also handle modules from the same repository, + taking into account their versions. + + - Disable strace support of bluetooth by default. + + - ``openssh`` now has a systemd service: ``sshd.service``. + + - The :ref:`ref-classes-python_mesonpy` class was added (moved in from + ``meta-python``) to support Python package builds using the meson-python + PEP-517 build backend. + + - Support for unpacking ``.7z`` archives in :term:`SRC_URI` using ``p7zip``. + + - Add minimal VS Code configuration to avoid VS Code's indexer from choking + on build directories. + + +Known Issues in 5.0 +~~~~~~~~~~~~~~~~~~~ + +- ``gpgme`` has had Python binding support disabled since upstream does not yet support Python 3.12. + + +Recipe License changes in 5.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +- ``elfutils``: split license for libraries & backend and utilities. +- ``ghostscript``: correct :term:`LICENSE` to ``AGPL-3.0-or-later``. +- ``kbd``: update license for consolefont and keymaps. +- ``libsystemd``: set its own :term:`LICENSE` value (``LGPL-2.1-or-later``) to add more granularity. +- ``libtest-warnings-perl``: update :term:`LICENSE` ``Artistic-1.0`` to ``Artistic-1.0-Perl``. +- ``linux-firmware``: set package :term:`LICENSE` appropriately for ``carl9170``, ``rockchip`` and ``powerpr``. +- ``newlib``: add license ``Apache-2.0-with-LLVM-exception``. +- ``python3-poetry-core``: add license ``BSD-3-Clause`` for ``fastjsonschema``. +- ``systemd``: make the scope of ``LGPL`` more accurate (``LGPL-2.1`` -> ``LGPL-2.1-or-later``). +- ``util-linux``: add ``GPL-1.0-or-later`` license for fdisk and ``MIT`` license for ``flock``. +- ``zstd``: set to dual-licensed ``BSD-3-Clause`` or ``GPL-2.0-only``. + +Security Fixes in 5.0 +~~~~~~~~~~~~~~~~~~~~~ + +- avahi: :cve:`2023-1981`, :cve:`2023-38469`, :cve:`2023-38470`, :cve:`2023-38471`, :cve:`2023-38469`, :cve:`2023-38470`, :cve:`2023-38471`, :cve:`2023-38472`, :cve:`2023-38473` +- bind: :cve:`2023-4408`, :cve:`2023-5517`, :cve:`2023-5679`, :cve:`2023-50387` +- bluez5: :cve:`2023-45866` +- coreutils: :cve:`2024-0684` +- cups: :cve:`2023-4504` +- curl: :cve:`2023-46218` +- expat: :cve:`2024-28757` +- gcc: :cve:`2023-4039` +- glibc: :cve:`2023-5156`, :cve:`2023-0687` +- gnutls: :cve:`2024-0553`, :cve:`2024-0567`, :cve:`2024-28834`, :cve:`2024-28835` +- go: :cve:`2023-45288` +- grub: :cve:`2023-4692`, :cve:`2023-4693` +- grub2: :cve:`2023-4001` (ignored), :cve:`2024-1048` (ignored) +- libgit2: :cve:`2024-24575`, :cve:`2024-24577` +- libsndfile1: :cve:`2022-33065` +- libssh2: :cve:`2023-48795` +- libuv: :cve:`2024-24806` +- libxml2: :cve:`2023-45322` (ignored) +- linux-yocto/6.6: :cve:`2020-16119` +- openssh: :cve:`2023-48795`, :cve:`2023-51384`, :cve:`2023-51385` +- openssl: :cve:`2023-5363`, :cve:`2023-5678`, :cve:`2023-6129`, :cve_mitre:`2023-6237`, :cve:`2024-0727`, :cve:`2024-2511` +- perl: :cve:`2023-47100` +- pixman: :cve:`2023-37769` (ignored) +- python3-cryptography{-vectors}: :cve:`2023-49083`, :cve:`2024-26130` +- python3-urllib3: :cve:`2023-45803` +- shadow: :cve:`2023-4641` +- sudo: :cve:`2023-42456` +- tiff: :cve:`2023-6228`, :cve:`2023-6277`, :cve:`2023-52355`, :cve:`2023-52356` +- vim: :cve:`2023-46246`, :cve:`2023-48231`, :cve:`2023-48232`, :cve:`2023-48233`, :cve:`2023-48234`, :cve:`2023-48235`, :cve:`2023-48236`, :cve:`2023-48237`, :cve:`2024-22667` +- wpa-supplicant: :cve:`2023-52160` +- xserver-xorg: :cve:`2023-5574`, :cve:`2023-6816`, :cve:`2024-0229`, :cve:`2024-0408`, :cve:`2024-0409`, :cve:`2024-21885`, :cve:`2024-21886` +- xwayland: :cve:`2023-5367`, :cve:`2024-0408`, :cve:`2024-0409`, :cve:`2023-6816`, :cve:`2024-0229`, :cve:`2024-21885`, :cve:`2024-21886` +- zlib: :cve:`2023-45853` (ignored), :cve:`2023-6992` (ignored) + + +Recipe Upgrades in 5.0 +~~~~~~~~~~~~~~~~~~~~~~ + +- acl 2.3.1 -> 2.3.2 +- acpica 20230628 -> 20240322 +- alsa-lib 1.2.10 -> 1.2.11 +- alsa-tools 1.2.5 -> 1.2.11 +- alsa-ucm-conf 1.2.10 -> 1.2.11 +- alsa-utils 1.2.10 -> 1.2.11 +- appstream 0.16.3 -> 1.0.2 +- autoconf 2.72c -> 2.72e +- bash 5.2.15 -> 5.2.21 +- bash-completion 2.11 -> 2.12.0 +- binutils 2.41 -> 2.42 +- bluez5 5.69 -> 5.72 +- boost 1.83.0 -> 1.84.0 +- boost-build-native 1.83.0 -> 1.84.0 +- btrfs-tools 6.5.1 -> 6.7.1 +- cairo 1.16.0 -> 1.18.0 +- cargo 1.70.0 -> 1.75.0 +- cargo-c-native 0.9.18 -> 0.9.30+cargo-0.77.0 +- ccache 4.8.3 -> 4.9.1 +- cmake 3.27.7 -> 3.28.3 +- cmake-native 3.27.7 -> 3.28.3 +- createrepo-c 1.0.0 -> 1.0.4 +- cronie 1.6.1 -> 1.7.1 +- cross-localedef-native 2.38+git -> 2.39+git +- cups 2.4.6 -> 2.4.7 +- curl 8.4.0 -> 8.7.1 +- dbus-wait 0.1+git (6cc6077a36fe…) -> 0.1+git (64bc7c8fae61…) +- debianutils 5.13 -> 5.16 +- desktop-file-utils 0.26 -> 0.27 +- dhcpcd 10.0.2 -> 10.0.6 +- diffoscope 249 -> 259 +- diffstat 1.65 -> 1.66 +- dnf 4.17.0 -> 4.19.0 +- dos2unix 7.5.1 -> 7.5.2 +- ed 1.19 -> 1.20.1 +- efivar 38+39+git -> 39+39+git +- elfutils 0.189 -> 0.191 +- ell 0.60 -> 0.63 +- enchant2 2.6.2 -> 2.6.7 +- epiphany 44.6 -> 46.0 +- erofs-utils 1.6 -> 1.7.1 +- ethtool 6.5 -> 6.7 +- eudev 3.2.12 -> 3.2.14 +- expat 2.5.0 -> 2.6.2 +- ffmpeg 6.0 -> 6.1.1 +- fontconfig 2.14.2 -> 2.15.0 +- gawk 5.2.2 -> 5.3.0 +- gcr 4.1.0 -> 4.2.0 +- gdb 13.2 -> 14.2 +- gettext 0.22 -> 0.22.5 +- gettext-minimal-native 0.22 -> 0.22.5 +- gi-docgen 2023.1 -> 2023.3 +- git 2.42.0 -> 2.44.0 +- glib-2.0 2.78.3 -> 2.78.4 +- glib-networking 2.76.1 -> 2.78.1 +- glibc 2.38+git -> 2.39+git +- glibc-locale 2.38 -> 2.39+git +- glibc-mtrace 2.38 -> 2.39+git +- glibc-scripts 2.38 -> 2.39+git +- glibc-testsuite 2.38+git -> 2.39+git +- glibc-y2038-tests 2.38+git -> 2.39+git +- glslang 1.3.261.1 -> 1.3.275.0 +- gnu-config 20230216+git -> 20240101+git +- gnupg 2.4.3 -> 2.4.4 +- gnutls 3.8.3 -> 3.8.4 +- go 1.20.12 -> 1.22.2 +- go-binary-native 1.20.12 -> 1.22.2 +- go-native 1.20.12 -> 1.22.2 +- go-runtime 1.20.12 -> 1.22.2 +- gpgme 1.22.0 -> 1.23.2 +- grub 2.06 -> 2.12 +- grub-efi 2.06 -> 2.12 +- gsettings-desktop-schemas 44.0 -> 46.0 +- gst-devtools 1.22.9 -> 1.22.11 +- gstreamer1.0 1.22.9 -> 1.22.11 +- gstreamer1.0-libav 1.22.9 -> 1.22.11 +- gstreamer1.0-omx 1.22.9 -> 1.22.11 +- gstreamer1.0-plugins-bad 1.22.9 -> 1.22.11 +- gstreamer1.0-plugins-base 1.22.9 -> 1.22.11 +- gstreamer1.0-plugins-good 1.22.9 -> 1.22.11 +- gstreamer1.0-plugins-ugly 1.22.9 -> 1.22.11 +- gstreamer1.0-python 1.22.9 -> 1.22.11 +- gstreamer1.0-rtsp-server 1.22.9 -> 1.22.11 +- gstreamer1.0-vaapi 1.22.9 -> 1.22.11 +- gtk+3 3.24.38 -> 3.24.41 +- gtk4 4.12.3 -> 4.14.1 +- harfbuzz 8.2.2 -> 8.3.0 +- hwlatdetect 2.5 -> 2.6 +- icu 73-2 -> 74-1 +- inetutils 2.4 -> 2.5 +- init-system-helpers 1.65.2 -> 1.66 +- iproute2 6.5.0 -> 6.7.0 +- iptables 1.8.9 -> 1.8.10 +- iputils 20221126 -> 20240117 +- iso-codes 4.15.0 -> 4.16.0 +- iw 5.19 -> 6.7 +- json-glib 1.6.6 -> 1.8.0 +- kbd 2.6.3 -> 2.6.4 +- kexec-tools 2.0.27 -> 2.0.28 +- kmod 30 -> 31 +- kmscube git -> 0.0.1+git +- libadwaita 1.4.2 -> 1.5.0 +- libbsd 0.11.7 -> 0.12.1 +- libcap-ng 0.8.3 -> 0.8.4 +- libcap-ng-python 0.8.3 -> 0.8.4 +- libcomps 0.1.19 -> 0.1.20 +- libdnf 0.71.0 -> 0.73.0 +- libdrm 2.4.116 -> 2.4.120 +- libffi 3.4.4 -> 3.4.6 +- libgit2 1.7.1 -> 1.7.2 +- libgloss 4.3.0+git -> 4.4.0+git +- libgpg-error 1.47 -> 1.48 +- libhandy 1.8.2 -> 1.8.3 +- libical 3.0.16 -> 3.0.17 +- libidn2 2.3.4 -> 2.3.7 +- libinput 1.24.0 -> 1.25.0 +- libksba 1.6.4 -> 1.6.6 +- libmicrohttpd 0.9.77 -> 1.0.1 +- libnl 3.8.0 -> 3.9.0 +- libnotify 0.8.2 -> 0.8.3 +- libpciaccess 0.17 -> 0.18 +- libpcre2 10.42 -> 10.43 +- libpng 1.6.40 -> 1.6.42 +- libproxy 0.5.3 -> 0.5.4 +- libpsl 0.21.2 -> 0.21.5 +- librepo 1.16.0 -> 1.17.0 +- librsvg 2.56.3 -> 2.57.1 +- libsdl2 2.28.4 -> 2.30.0 +- libseccomp 2.5.4 -> 2.5.5 +- libsecret 0.21.1 -> 0.21.4 +- libsolv 0.7.26 -> 0.7.28 +- libsoup 3.4.2 -> 3.4.4 +- libstd-rs 1.70.0 -> 1.75.0 +- libtest-warnings-perl 0.031 -> 0.033 +- libtirpc 1.3.3 -> 1.3.4 +- libubootenv 0.3.4 -> 0.3.5 +- libunistring 1.1 -> 1.2 +- liburi-perl 5.21 -> 5.27 +- libusb1 1.0.26 -> 1.0.27 +- libuv 1.46.0 -> 1.48.0 +- libva 2.19.0 -> 2.20.0 +- libva-initial 2.19.0 -> 2.20.0 +- libwpe 1.14.1 -> 1.14.2 +- libxext 1.3.5 -> 1.3.6 +- libxkbcommon 1.5.0 -> 1.6.0 +- libxkbfile 1.1.2 -> 1.1.3 +- libxml-parser-perl 2.46 -> 2.47 +- libxml2 2.11.7 -> 2.12.5 +- libxmlb 0.3.14 -> 0.3.15 +- libxrandr 1.5.3 -> 1.5.4 +- libxvmc 1.0.13 -> 1.0.14 +- lighttpd 1.4.71 -> 1.4.74 +- linux-firmware 20240220 -> 20240312 +- linux-libc-headers 6.5 -> 6.6 +- linux-yocto 6.1.78+git, 6.5.13+git -> 6.6.23+git +- linux-yocto-dev 6.6+git -> 6.9+git +- linux-yocto-rt 6.1.78+git, 6.5.13+git -> 6.6.23+git +- linux-yocto-tiny 6.1.78+git, 6.5.13+git -> 6.6.23+git +- llvm 17.0.3 -> 18.1.3 +- lsof 4.98.0 -> 4.99.3 +- ltp 20230516 -> 20240129 +- lttng-modules 2.13.10 -> 2.13.12 +- lttng-ust 2.13.6 -> 2.13.7 +- lzip 1.23 -> 1.24 +- makedepend 1.0.8 -> 1.0.9 +- man-db 2.11.2 -> 2.12.0 +- man-pages 6.05.01 -> 6.06 +- mc 4.8.30 -> 4.8.31 +- mesa 23.2.1 -> 24.0.2 +- mesa-gl 23.2.1 -> 24.0.2 +- meson 1.2.2 -> 1.3.1 +- minicom 2.8 -> 2.9 +- mmc-utils 0.1+git (613495ecaca9…) -> 0.1+git (b5ca140312d2…) +- mpg123 1.31.3 -> 1.32.5 +- newlib 4.3.0+git -> 4.4.0+git +- nghttp2 1.57.0 -> 1.61.0 +- numactl 2.0.16 -> 2.0.18 +- ofono 2.1 -> 2.4 +- opensbi 1.2 -> 1.4 +- openssh 9.5p1 -> 9.6p1 +- openssl 3.1.5 -> 3.2.1 +- opkg 0.6.2 -> 0.6.3 +- opkg-utils 0.6.2 -> 0.6.3 +- orc 0.4.34 -> 0.4.38 +- ovmf edk2-stable202308 -> edk2-stable202402 +- p11-kit 0.25.0 -> 0.25.3 +- pango 1.51.0 -> 1.52.0 +- pciutils 3.10.0 -> 3.11.1 +- piglit 1.0+gitr (71c21b1157c4…) -> 1.0+gitr (22eaf6a91cfd…) +- pkgconf 2.0.3 -> 2.1.1 +- psplash 0.1+git (44afb7506d43…) -> 0.1+git (ecc191375669…) +- ptest-runner 2.4.2+git -> 2.4.3+git +- pulseaudio 16.1 -> 17.0 +- puzzles 0.0+git (2d9e414ee316…) -> 0.0+git (80aac3104096…) +- python3 3.11.5 -> 3.12.3 +- python3-alabaster 0.7.13 -> 0.7.16 +- python3-attrs 23.1.0 -> 23.2.0 +- python3-babel 2.12.1 -> 2.14.0 +- python3-bcrypt 4.0.1 -> 4.1.2 +- python3-beartype 0.15.0 -> 0.17.2 +- python3-build 1.0.3 -> 1.1.1 +- python3-certifi 2023.7.22 -> 2024.2.2 +- python3-cffi 1.15.1 -> 1.16.0 +- python3-cryptography 41.0.4 -> 42.0.5 +- python3-cryptography-vectors 41.0.4 -> 42.0.5 +- python3-cython 0.29.36 -> 3.0.8 +- python3-dbusmock 0.29.1 -> 0.31.1 +- python3-dtschema 2023.7 -> 2024.2 +- python3-git 3.1.36 -> 3.1.42 +- python3-gitdb 4.0.10 -> 4.0.11 +- python3-hatch-fancy-pypi-readme 23.1.0 -> 24.1.0 +- python3-hatch-vcs 0.3.0 -> 0.4.0 +- python3-hatchling 1.18.0 -> 1.21.1 +- python3-hypothesis 6.86.2 -> 6.98.15 +- python3-idna 3.4 -> 3.6 +- python3-importlib-metadata 6.8.0 -> 7.0.1 +- python3-iso8601 2.0.0 -> 2.1.0 +- python3-jsonschema 4.17.3 -> 4.21.1 +- python3-license-expression 30.1.1 -> 30.2.0 +- python3-lxml 4.9.3 -> 5.0.0 +- python3-mako 1.2.4 -> 1.3.2 +- python3-markdown 3.4.4 -> 3.5.2 +- python3-markupsafe 2.1.3 -> 2.1.5 +- python3-more-itertools 10.1.0 -> 10.2.0 +- python3-numpy 1.26.0 -> 1.26.4 +- python3-packaging 23.1 -> 23.2 +- python3-pathspec 0.11.2 -> 0.12.1 +- python3-pbr 5.11.1 -> 6.0.0 +- python3-pip 23.2.1 -> 24.0 +- python3-pluggy 1.3.0 -> 1.4.0 +- python3-poetry-core 1.7.0 -> 1.9.0 +- python3-psutil 5.9.5 -> 5.9.8 +- python3-pyasn1 0.5.0 -> 0.5.1 +- python3-pycairo 1.24.0 -> 1.26.0 +- python3-pycryptodome 3.19.0 -> 3.20.0 +- python3-pycryptodomex 3.19.0 -> 3.20.0 +- python3-pygments 2.16.1 -> 2.17.2 +- python3-pyopenssl 23.2.0 -> 24.0.0 +- python3-pyrsistent 0.19.3 -> 0.20.0 +- python3-pytest 7.4.2 -> 8.0.2 +- python3-pytest-runner 6.0.0 -> 6.0.1 +- python3-pytz 2023.3 -> 2024.1 +- python3-ruamel-yaml 0.17.32 -> 0.18.6 +- python3-scons 4.5.2 -> 4.6.0 +- python3-setuptools 68.2.2 -> 69.1.1 +- python3-setuptools-rust 1.7.0 -> 1.9.0 +- python3-setuptools-scm 7.1.0 -> 8.0.4 +- python3-spdx-tools 0.8.1 -> 0.8.2 +- python3-sphinx-rtd-theme 1.3.0 -> 2.0.0 +- python3-sphinxcontrib-applehelp 1.0.4 -> 1.0.8 +- python3-sphinxcontrib-devhelp 1.0.2 -> 1.0.6 +- python3-sphinxcontrib-htmlhelp 2.0.1 -> 2.0.5 +- python3-sphinxcontrib-qthelp 1.0.3 -> 1.0.7 +- python3-sphinxcontrib-serializinghtml 1.1.5 -> 1.1.10 +- python3-subunit 1.4.2 -> 1.4.4 +- python3-testtools 2.6.0 -> 2.7.1 +- python3-trove-classifiers 2023.9.19 -> 2024.2.23 +- python3-typing-extensions 4.8.0 -> 4.10.0 +- python3-unittest-automake-output 0.1 -> 0.2 +- python3-urllib3 2.0.7 -> 2.2.1 +- python3-wcwidth 0.2.6 -> 0.2.13 +- python3-wheel 0.41.2 -> 0.42.0 +- qemu 8.1.4 -> 8.2.1 +- qemu-native 8.1.4 -> 8.2.1 +- qemu-system-native 8.1.4 -> 8.2.1 +- repo 2.36.1 -> 2.42 +- resolvconf 1.91 -> 1.92 +- rpm 4.18.1 -> 4.19.1 +- rt-tests 2.5 -> 2.6 +- rust 1.70.0 -> 1.75.0 +- rust-cross-canadian 1.70.0 -> 1.75.0 +- rust-llvm 1.70.0 -> 1.75.0 +- shaderc 2023.6 -> 2023.8 +- shadow 4.13 -> 4.14.2 +- shared-mime-info 2.2 -> 2.4 +- socat 1.7.4.4 -> 1.8.0.0 +- spirv-headers 1.3.261.1 -> 1.3.275.0 +- spirv-tools 1.3.261.1 -> 1.3.275.0 +- sqlite3 3.43.2 -> 3.45.1 +- strace 6.5 -> 6.7 +- stress-ng 0.16.05 -> 0.17.05 +- subversion 1.14.2 -> 1.14.3 +- swig 4.1.1 -> 4.2.1 +- sysstat 12.7.4 -> 12.7.5 +- systemd 254.4 -> 255.4 +- systemd-boot 254.4 -> 255.4 +- systemd-bootchart 234 -> 235 +- systemtap 4.9 -> 5.0 +- systemtap-native 4.9 -> 5.0 +- taglib 1.13.1 -> 2.0 +- ttyrun 2.29.0 -> 2.31.0 +- u-boot 2023.10 -> 2024.01 +- u-boot-tools 2023.10 -> 2024.01 +- update-rc.d 0.8 (8636cf478d42…) -> 0.8 (b8f950105010…) +- usbutils 015 -> 017 +- util-linux 2.39.2 -> 2.39.3 +- util-linux-libuuid 2.39.2 -> 2.39.3 +- vala 0.56.13 -> 0.56.15 +- valgrind 3.21.0 -> 3.22.0 +- vim 9.0.2190 -> 9.1.0114 +- vim-tiny 9.0.2190 -> 9.1.0114 +- virglrenderer 0.10.4 -> 1.0.1 +- vte 0.72.2 -> 0.74.2 +- vulkan-headers 1.3.261.1 -> 1.3.275.0 +- vulkan-loader 1.3.261.1 -> 1.3.275.0 +- vulkan-tools 1.3.261.1 -> 1.3.275.0 +- vulkan-validation-layers 1.3.261.1 -> 1.3.275.0 +- wayland-protocols 1.32 -> 1.33 +- webkitgtk 2.40.5 -> 2.44.0 +- weston 12.0.2 -> 13.0.0 +- xkbcomp 1.4.6 -> 1.4.7 +- xkeyboard-config 2.39 -> 2.41 +- xprop 1.2.6 -> 1.2.7 +- xwayland 23.2.4 -> 23.2.5 +- xz 5.4.4 -> 5.4.6 +- zlib 1.3 -> 1.3.1 + + +Contributors to 5.0 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +- Adam Johnston +- Adithya Balakumar +- Adrian Freihofer +- Alassane Yattara +- Alejandro Hernandez Samaniego +- Aleksey Smirnov +- Alexander Kanavin +- Alexander Lussier-Cullen +- Alexander Sverdlin +- Alexandre Belloni +- Alexandre Truong +- Alex Bennée +- Alexis Lothoré +- Alex Kiernan +- Alex Stewart +- André Draszik +- Anibal Limon +- Anuj Mittal +- Archana Polampalli +- Arne Schwerdt +- Bartosz Golaszewski +- Baruch Siach +- Bastian Krause +- BELHADJ SALEM Talel +- BELOUARGA Mohamed +- Bruce Ashfield +- Changhyeok Bae +- Changqing Li +- Charlie Johnston +- Chen Qi +- Chi Xu +- Chris Laplante +- Christian Taedcke +- Christoph Vogtländer +- Claus Stovgaard +- Clay Chang +- Clément Péron +- Colin McAllister +- Corentin Guillevic +- Daniel Ammann +- david d zuhn +- David Reyna +- Deepthi Hemraj +- Denys Dmytriyenko +- Derek Erdmann +- Desone Burns +- Dhairya Nagodra +- Dmitry Baryshkov +- Eero Aaltonen +- Eilís 'pidge' Ní Fhlannagáin +- Emil Kronborg +- Enguerrand de Ribaucourt +- Enrico Jörns +- Enrico Scholz +- Etienne Cordonnier +- Fabien Mahot +- Fabio Estevam +- Fahad Arslan +- Felix Moessbauer +- Florian Wickert +- Geoff Parker +- Glenn Strauss +- Harish Sadineni +- Hongxu Jia +- Ilya A. Kriveshko +- Jamin Lin +- Jan Vermaete +- Jason Andryuk +- Javier Tia +- Jeremy A. Puhlman +- Jérémy Rosen +- Jermain Horsman +- Jiang Kai +- Joakim Tjernlund +- Joao Marcos Costa +- Joe Slater +- Johan Bezem +- Johannes Schneider +- Jonathan GUILLOT +- Jon Mason +- Jörg Sommer +- Jose Quaresma +- Joshua Watt +- Julien Stephan +- Justin Bronder +- Kai Kang +- Kareem Zarka +- Kevin Hao +- Khem Raj +- Konrad Weihmann +- Lee Chee Yang +- Lei Maohui +- lixiaoyong +- Logan Gunthorpe +- Luca Ceresoli +- luca fancellu +- Lucas Stach +- Ludovic Jozeau +- Lukas Funke +- Maanya Goenka +- Malte Schmidt +- Marcel Ziswiler +- Marco Felsch +- Marcus Folkesson +- Marek Vasut +- Mark Asselstine +- Mark Hatle +- Markus Fuchs +- Markus Volk +- Marlon Rodriguez Garcia +- Marta Rybczynska +- Martin Hundebøll +- Martin Jansa +- Massimiliano Minella +- Maxin B. John +- Max Krummenacher +- Meenali Gupta +- Michael Halstead +- Michael Opdenacker +- Michal Sieron +- Mikko Rapeli +- Ming Liu +- Mingli Yu +- Munehisa Kamata +- Nick Owens +- Niko Mauno +- Ola x Nilsson +- Oleh Matiusha +- Patrick Williams +- Paul Barker +- Paul Eggleton +- Paul Gortmaker +- Pavel Zhukov +- Peter A. Bigot +- Peter Kjellerstedt +- Peter Marko +- Petr Vorel +- Philip Balister +- Philip Lorenz +- Philippe Rivest +- Piotr Łobacz +- Priyal Doshi +- Quentin Schulz +- Ragesh Nair +- Randolph Sapp +- Randy MacLeod +- Rasmus Villemoes +- Renat Khalikov +- Richard Haar +- Richard Purdie +- Robert Berger +- Robert Joslyn +- Robert P. J. Day +- Robert Yang +- Rodrigo M. Duarte +- Ross Burton +- Rouven Czerwinski +- Ryan Eatmon +- Sam Van Den Berge +- Saul Wold +- Sava Jakovljev +- Sean Nyekjaer +- Sergei Zhmylev +- Shinji Matsunaga +- Shubham Kulkarni +- Simone Weiß +- Siong W.LIM +- Soumya Sambu +- Sourav Kumar Pramanik +- Stefan Herbrechtsmeier +- Stéphane Veyret +- Steve Sakoman +- Sundeep KOKKONDA +- Thomas Perrot +- Thomas Wolber +- Timon Bergelt +- Tim Orling +- Timotheus Giuliani +- Tobias Hagelborn +- Tom Hochstein +- Tom Rini +- Toni Lammi +- Trevor Gamblin +- Trevor Woerner +- Ulrich Ölmann +- Valek Andrej +- venkata pyla +- Victor Kamensky +- Vijay Anusuri +- Vikas Katariya +- Vincent Davis Jr +- Viswanath Kraleti +- Vyacheslav Yurkov +- Wang Mingyu +- William A. Kennington III +- William Hauser +- William Lyu +- Xiangyu Chen +- Xiaotian Wu +- Yang Xu +- Yannick Rodriguez +- Yash Shinde +- Yi Zhao +- Yoann Congal +- Yogesh Tyagi +- Yogita Urade +- Zahir Hussain +- Zang Ruochen +- Zoltan Boszormenyi + +Repositories / Downloads for Yocto-5.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 5698d93759..62f2327a7e 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -34,10 +34,10 @@ itself is of various types: BitBake knows how to combine multiple data sources together and refers to each data source as a layer. For information on layers, see the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. -Following are some brief details on these core components. For +Here are some brief details on these core components. For additional information on how these components interact during a build, see the ":ref:`overview-manual/concepts:openembedded build system concepts`" @@ -69,12 +69,10 @@ type the following:: $ bitbake matchbox-desktop -Several different -versions of ``matchbox-desktop`` might exist. BitBake chooses the one -selected by the distribution configuration. You can get more details -about how BitBake chooses between different target versions and -providers in the -":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:preferences`" section +Several different versions of ``matchbox-desktop`` might exist. BitBake chooses +the one selected by the distribution configuration. You can get more details +about how BitBake chooses between different target versions and providers in the +":ref:`bitbake-user-manual/bitbake-user-manual-execution:preferences`" section of the BitBake User Manual. BitBake also tries to execute any dependent tasks first. So for example, @@ -107,12 +105,11 @@ Classes ------- Class files (``.bbclass``) contain information that is useful to share -between recipes files. An example is the -:ref:`autotools <ref-classes-autotools>` class, -which contains common settings for any application that Autotools uses. -The ":ref:`ref-manual/classes:Classes`" chapter in the -Yocto Project Reference Manual provides details about classes and how to -use them. +between recipes files. An example is the :ref:`ref-classes-autotools` class, +which contains common settings for any application that is built with +the :wikipedia:`GNU Autotools <GNU_Autotools>`. +The ":ref:`ref-manual/classes:Classes`" chapter in the Yocto Project +Reference Manual provides details about classes and how to use them. Configurations -------------- @@ -140,7 +137,7 @@ using a different layer where that metadata might be common across several pieces of hardware. There are many layers working in the Yocto Project development environment. The -:yocto_home:`Yocto Project Curated Layer Index </software-overview/layers/>` +:yocto_home:`Yocto Project Compatible Layer Index </software-overview/layers/>` and :oe_layerindex:`OpenEmbedded Layer Index <>` both contain layers from which you can use or leverage. @@ -149,7 +146,7 @@ Conforming to a known structure allows BitBake to make assumptions during builds on where to find types of metadata. You can find procedures and learn about tools (i.e. ``bitbake-layers``) for creating layers suitable for the Yocto Project in the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. OpenEmbedded Build System Concepts @@ -166,7 +163,7 @@ remainder of this section expands on the fundamental input, output, process, and metadata logical blocks that make up the workflow. .. image:: figures/YP-flow-diagram.png - :align: center + :width: 100% In general, the build's workflow consists of several functional areas: @@ -209,7 +206,7 @@ Configuration" box of the :ref:`general workflow figure <overview-manual/concepts:openembedded build system concepts>`: .. image:: figures/user-configuration.png - :align: center + :width: 100% BitBake needs some basic configuration files in order to complete a build. These files are ``*.conf`` files. The minimally necessary ones @@ -233,13 +230,12 @@ for creating actual configuration files when you source :ref:`structure-core-script`, which is the build environment script. -Sourcing the build environment script creates a -:term:`Build Directory` if one does not -already exist. BitBake uses the Build Directory for all its work during -builds. The Build Directory has a ``conf`` directory that contains -default versions of your ``local.conf`` and ``bblayers.conf`` +Sourcing the build environment script creates a :term:`Build Directory` +if one does not already exist. BitBake uses the :term:`Build Directory` +for all its work during builds. The Build Directory has a ``conf`` directory +that contains default versions of your ``local.conf`` and ``bblayers.conf`` configuration files. These default configuration files are created only -if versions do not already exist in the Build Directory at the time you +if versions do not already exist in the :term:`Build Directory` at the time you source the build environment setup script. Because the Poky repository is fundamentally an aggregation of existing @@ -251,9 +247,9 @@ assumes the script is executed from within a cloned or unpacked version of Poky. Depending on where the script is sourced, different sub-scripts are -called to set up the Build Directory (Yocto or OpenEmbedded). +called to set up the :term:`Build Directory` (Yocto or OpenEmbedded). Specifically, the script ``scripts/oe-setup-builddir`` inside the poky -directory sets up the Build Directory and seeds the directory (if +directory sets up the :term:`Build Directory` and seeds the directory (if necessary) with configuration files appropriate for the Yocto Project development environment. @@ -269,7 +265,7 @@ The ``local.conf`` file provides many basic variables that define a build environment. Here is a list of a few. To see the default configurations in a ``local.conf`` file created by the build environment script, see the -:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/local.conf.sample>` +:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/templates/default/local.conf.sample>` in the ``meta-poky`` layer: - *Target Machine Selection:* Controlled by the @@ -300,25 +296,20 @@ in the ``meta-poky`` layer: .. note:: - Configurations set in the - conf/local.conf - file can also be set in the - conf/site.conf - and - conf/auto.conf - configuration files. + Configurations set in the ``conf/local.conf`` file can also be set + in the ``conf/site.conf`` and ``conf/auto.conf`` configuration files. The ``bblayers.conf`` file tells BitBake what layers you want considered during the build. By default, the layers listed in this file include layers minimally needed by the build system. However, you must manually add any custom layers you have created. You can find more information on working with the ``bblayers.conf`` file in the -":ref:`dev-manual/common-tasks:enabling your layer`" +":ref:`dev-manual/layers:enabling your layer`" section in the Yocto Project Development Tasks Manual. The files ``site.conf`` and ``auto.conf`` are not created by the environment initialization script. If you want the ``site.conf`` file, -you need to create that yourself. The ``auto.conf`` file is typically +you need to create it yourself. The ``auto.conf`` file is typically created by an autobuilder: - *site.conf:* You can use the ``conf/site.conf`` configuration @@ -326,17 +317,7 @@ created by an autobuilder: you had several build environments and they shared some common features. You can set these default build properties here. A good example is perhaps the packaging format to use through the - :term:`PACKAGE_CLASSES` - variable. - - One useful scenario for using the ``conf/site.conf`` file is to - extend your :term:`BBPATH` variable - to include the path to a ``conf/site.conf``. Then, when BitBake looks - for Metadata using :term:`BBPATH`, it finds the ``conf/site.conf`` file - and applies your common configurations found in the file. To override - configurations in a particular build directory, alter the similar - configurations within that build directory's ``conf/local.conf`` - file. + :term:`PACKAGE_CLASSES` variable. - *auto.conf:* The file is usually created and written to by an autobuilder. The settings put into the file are typically the same as @@ -406,6 +387,7 @@ layers from the :ref:`general workflow figure .. image:: figures/layer-input.png :align: center + :width: 70% In general, all layers have a similar structure. They all contain a licensing file (e.g. ``COPYING.MIT``) if the layer is to be distributed, @@ -413,7 +395,7 @@ a ``README`` file as good practice and especially if the layer is to be distributed, a configuration directory, and recipe directories. You can learn about the general structure for layers used with the Yocto Project in the -":ref:`dev-manual/common-tasks:creating your own layer`" +":ref:`dev-manual/layers:creating your own layer`" section in the Yocto Project Development Tasks Manual. For a general discussion on layers and the many layers from which you can draw, see the @@ -442,7 +424,7 @@ The distribution layer provides policy configurations for your distribution. Best practices dictate that you isolate these types of configurations into their own layer. Settings you provide in ``conf/distro/distro.conf`` override similar settings that BitBake finds -in your ``conf/local.conf`` file in the Build Directory. +in your ``conf/local.conf`` file in the :term:`Build Directory`. The following list provides some explanation and references for what you typically find in the distribution layer: @@ -545,10 +527,11 @@ repositories, which is not the default behavior, and store them in the variable. Judicious use of a :term:`DL_DIR` directory can save the build system a trip -across the Internet when looking for files. A good method for using a -download directory is to have :term:`DL_DIR` point to an area outside of -your Build Directory. Doing so allows you to safely delete the Build -Directory if needed without fear of removing any downloaded source file. +across the Internet when looking for files. A good method for using a download +directory is to have :term:`DL_DIR` point to an area outside of your +:term:`Build Directory`. Doing so allows you to safely delete the +:term:`Build Directory` if needed without fear of removing any downloaded +source file. The remainder of this section provides a deeper look into the source files and the mirrors. Here is a more detailed look at the source file @@ -556,6 +539,7 @@ area of the :ref:`general workflow figure <overview-manual/concepts:openembedded .. image:: figures/source-input.png :align: center + :width: 70% Upstream Project Releases ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -570,33 +554,30 @@ Local Projects ~~~~~~~~~~~~~~ Local projects are custom bits of software the user provides. These bits -reside somewhere local to a project - perhaps a directory into which the +reside somewhere local to a project --- perhaps a directory into which the user checks in items (e.g. a local directory containing a development source tree used by the group). -The canonical method through which to include a local project is to use -the :ref:`externalsrc <ref-classes-externalsrc>` -class to include that local project. You use either the ``local.conf`` -or a recipe's append file to override or set the recipe to point to the -local directory on your disk to pull in the whole source tree. +The canonical method through which to include a local project is to use the +:ref:`ref-classes-externalsrc` class to include that local project. You use +either the ``local.conf`` or a recipe's append file to override or set the +recipe to point to the local directory on your disk to pull in the whole +source tree. Source Control Managers (Optional) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Another place from which the build system can get source files is with -:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers` employing various Source -Control Managers (SCMs) such as Git or Subversion. In such cases, a -repository is cloned or checked out. The -:ref:`ref-tasks-fetch` task inside -BitBake uses the :term:`SRC_URI` -variable and the argument's prefix to determine the correct fetcher -module. +:ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` employing +various Source Control Managers (SCMs) such as Git or Subversion. In such +cases, a repository is cloned or checked out. The :ref:`ref-tasks-fetch` task +inside BitBake uses the :term:`SRC_URI` variable and the argument's prefix to +determine the correct fetcher module. .. note:: For information on how to have the OpenEmbedded build system generate - tarballs for Git repositories and place them in the - DL_DIR + tarballs for Git repositories and place them in the :term:`DL_DIR` directory, see the :term:`BB_GENERATE_MIRROR_TARBALLS` variable in the Yocto Project Reference Manual. @@ -634,7 +615,7 @@ This section looks a little closer into the package feeds area used by the build system. Here is a more detailed look at the area: .. image:: figures/package-feeds.png - :align: center + :width: 100% Package feeds are an intermediary step in the build process. The OpenEmbedded build system provides classes to generate different package @@ -642,26 +623,23 @@ types, and you specify which classes to enable through the :term:`PACKAGE_CLASSES` variable. Before placing the packages into package feeds, the build process validates them with generated output quality assurance checks -through the :ref:`insane <ref-classes-insane>` -class. +through the :ref:`ref-classes-insane` class. -The package feed area resides in the Build Directory. The directory the +The package feed area resides in the :term:`Build Directory`. The directory the build system uses to temporarily store packages is determined by a combination of variables and the particular package manager in use. See the "Package Feeds" box in the illustration and note the information to the right of that area. In particular, the following defines where package files are kept: -- :term:`DEPLOY_DIR`: Defined as - ``tmp/deploy`` in the Build Directory. +- :term:`DEPLOY_DIR`: Defined as ``tmp/deploy`` in the :term:`Build Directory`. - ``DEPLOY_DIR_*``: Depending on the package manager used, the package type sub-folder. Given RPM, IPK, or DEB packaging and tarball creation, the :term:`DEPLOY_DIR_RPM`, - :term:`DEPLOY_DIR_IPK`, - :term:`DEPLOY_DIR_DEB`, or - :term:`DEPLOY_DIR_TAR`, + :term:`DEPLOY_DIR_IPK`, or + :term:`DEPLOY_DIR_DEB` variables are used, respectively. - :term:`PACKAGE_ARCH`: Defines @@ -674,9 +652,8 @@ tasks to generate packages and place them into the package holding area (e.g. ``do_package_write_ipk`` for IPK packages). See the ":ref:`ref-tasks-package_write_deb`", ":ref:`ref-tasks-package_write_ipk`", -":ref:`ref-tasks-package_write_rpm`", and -":ref:`ref-tasks-package_write_tar`" +":ref:`ref-tasks-package_write_rpm`" sections in the Yocto Project Reference Manual for additional information. As an example, consider a scenario where an IPK packaging manager is being used and there is package architecture support for both @@ -697,7 +674,7 @@ closer look at each of those areas. .. note:: Documentation for the BitBake tool is available separately. See the - BitBake User Manual + :doc:`BitBake User Manual <bitbake:index>` for reference material on BitBake. Source Fetching @@ -707,37 +684,30 @@ The first stages of building a recipe are to fetch and unpack the source code: .. image:: figures/source-fetching.png - :align: center + :width: 100% -The :ref:`ref-tasks-fetch` and -:ref:`ref-tasks-unpack` tasks fetch -the source files and unpack them into the -:term:`Build Directory`. +The :ref:`ref-tasks-fetch` and :ref:`ref-tasks-unpack` tasks fetch +the source files and unpack them into the :term:`Build Directory`. .. note:: - For every local file (e.g. - file:// - ) that is part of a recipe's - SRC_URI - statement, the OpenEmbedded build system takes a checksum of the file - for the recipe and inserts the checksum into the signature for the - do_fetch - task. If any local file has been modified, the - do_fetch - task and all tasks that depend on it are re-executed. - -By default, everything is accomplished in the Build Directory, which has -a defined structure. For additional general information on the Build -Directory, see the ":ref:`structure-core-build`" section in + For every local file (e.g. ``file://``) that is part of a recipe's + :term:`SRC_URI` statement, the OpenEmbedded build system takes a + checksum of the file for the recipe and inserts the checksum into + the signature for the :ref:`ref-tasks-fetch` task. If any local + file has been modified, the :ref:`ref-tasks-fetch` task and all + tasks that depend on it are re-executed. + +By default, everything is accomplished in the :term:`Build Directory`, which has +a defined structure. For additional general information on the +:term:`Build Directory`, see the ":ref:`structure-core-build`" section in the Yocto Project Reference Manual. -Each recipe has an area in the Build Directory where the unpacked source -code resides. The :term:`S` variable points -to this area for a recipe's unpacked source code. The name of that -directory for any given recipe is defined from several different -variables. The preceding figure and the following list describe the -Build Directory's hierarchy: +Each recipe has an area in the :term:`Build Directory` where the unpacked +source code resides. The :term:`S` variable points to this area for a recipe's +unpacked source code. The name of that directory for any given recipe is +defined from several different variables. The preceding figure and the +following list describe the :term:`Build Directory`'s hierarchy: - :term:`TMPDIR`: The base directory where the OpenEmbedded build system performs all its work during the @@ -795,7 +765,7 @@ Once source code is fetched and unpacked, BitBake locates patch files and applies them to the source files: .. image:: figures/patching.png - :align: center + :width: 100% The :ref:`ref-tasks-patch` task uses a recipe's :term:`SRC_URI` statements @@ -819,7 +789,7 @@ For more information on how the source directories are created, see the ":ref:`overview-manual/concepts:source fetching`" section. For more information on how to create patches and how the build system processes patches, see the -":ref:`dev-manual/common-tasks:patching code`" +":ref:`dev-manual/new-recipe:patching code`" section in the Yocto Project Development Tasks Manual. You can also see the ":ref:`sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" @@ -836,7 +806,7 @@ compile the source code. Once compilation occurs, the files are copied to a holding area (staged) in preparation for packaging: .. image:: figures/configuration-compile-autoreconf.png - :align: center + :width: 100% This step in the build process consists of the following tasks: @@ -862,15 +832,13 @@ This step in the build process consists of the following tasks: are specific to configurations for the source code being built by the recipe. - If you are using the - :ref:`autotools <ref-classes-autotools>` class, + If you are using the :ref:`ref-classes-autotools` class, you can add additional configuration options by using the :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS` variables. For information on how this variable works within that - class, see the - :ref:`autotools <ref-classes-autotools>` class - :yocto_git:`here </poky/tree/meta/classes/autotools.bbclass>`. + class, see the :ref:`ref-classes-autotools` class + :yocto_git:`here </poky/tree/meta/classes-recipe/autotools.bbclass>`. - *do_compile*: Once a configuration task has been satisfied, BitBake compiles the source using the @@ -894,7 +862,7 @@ After source code is configured, compiled, and staged, the build system analyzes the results and splits the output into packages: .. image:: figures/analysis-for-package-splitting.png - :align: center + :width: 100% The :ref:`ref-tasks-package` and :ref:`ref-tasks-packagedata` @@ -905,7 +873,7 @@ following as well as other items: splitting out debugging symbols, looking at shared library dependencies between packages, and looking at package relationships. -The ``do_packagedata`` task creates package metadata based on the +The :ref:`ref-tasks-packagedata` task creates package metadata based on the analysis such that the build system can generate the final packages. The :ref:`ref-tasks-populate_sysroot` task stages (copies) a subset of the files installed by the @@ -918,7 +886,7 @@ the analysis and package splitting process use several areas: individual packages. - :term:`PKGDESTWORK`: A - temporary work area (i.e. ``pkgdata``) used by the ``do_package`` + temporary work area (i.e. ``pkgdata``) used by the :ref:`ref-tasks-package` task to save package metadata. - :term:`PKGDEST`: The parent @@ -942,13 +910,13 @@ the analysis and package splitting process use several areas: - :term:`STAGING_DIR_TARGET`: The path for the sysroot used when a component that is built to execute on a system and it generates code for yet another machine - (e.g. cross-canadian recipes). + (e.g. :ref:`ref-classes-cross-canadian` recipes). The :term:`FILES` variable defines the files that go into each package in :term:`PACKAGES`. If you want details on how this is accomplished, you can look at -:yocto_git:`package.bbclass </poky/tree/meta/classes/package.bbclass>`. +:yocto_git:`package.bbclass </poky/tree/meta/classes-global/package.bbclass>`. Depending on the type of packages being created (RPM, DEB, or IPK), the :ref:`do_package_write_* <ref-tasks-package_write_deb>` @@ -973,7 +941,7 @@ Once packages are split and stored in the Package Feeds area, the build system uses BitBake to generate the root filesystem image: .. image:: figures/image-generation.png - :align: center + :width: 100% The image generation process consists of several stages and depends on several tasks and variables. The @@ -1019,29 +987,25 @@ data files are deleted from the root filesystem. As part of the final stage of package installation, post installation scripts that are part of the packages are run. Any scripts that fail to run on the build host are run on the target when the target system is first booted. If you are -using a -:ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`, +using a +:ref:`read-only root filesystem <dev-manual/read-only-rootfs:creating a read-only root filesystem>`, all the post installation scripts must succeed on the build host during the package installation phase since the root filesystem on the target is read-only. -The final stages of the ``do_rootfs`` task handle post processing. Post +The final stages of the :ref:`ref-tasks-rootfs` task handle post processing. Post processing includes creation of a manifest file and optimizations. -The manifest file (``.manifest``) resides in the same directory as the -root filesystem image. This file lists out, line-by-line, the installed -packages. The manifest file is useful for the -:ref:`testimage <ref-classes-testimage*>` class, +The manifest file (``.manifest``) resides in the same directory as the root +filesystem image. This file lists out, line-by-line, the installed packages. +The manifest file is useful for the :ref:`ref-classes-testimage` class, for example, to determine whether or not to run specific tests. See the -:term:`IMAGE_MANIFEST` -variable for additional information. +:term:`IMAGE_MANIFEST` variable for additional information. -Optimizing processes that are run across the image include ``mklibs``, -``prelink``, and any other post-processing commands as defined by the +Optimizing processes that are run across the image include ``mklibs`` +and any other post-processing commands as defined by the :term:`ROOTFS_POSTPROCESS_COMMAND` -variable. The ``mklibs`` process optimizes the size of the libraries, -while the ``prelink`` process optimizes the dynamic linking of shared -libraries to reduce start up time of executables. +variable. The ``mklibs`` process optimizes the size of the libraries. After the root filesystem is built, processing begins on the image through the :ref:`ref-tasks-image` @@ -1051,7 +1015,7 @@ the variable. This variable specifies a list of functions to call before the build system creates the final image output files. -The build system dynamically creates ``do_image_*`` tasks as needed, +The build system dynamically creates :ref:`do_image_* <ref-tasks-image>` tasks as needed, based on the image types specified in the :term:`IMAGE_FSTYPES` variable. The process turns everything into an image file or a set of image files @@ -1093,14 +1057,14 @@ Development Kit (SDK) installer scripts for both the standard SDK and the extensible SDK (eSDK): .. image:: figures/sdk-generation.png - :align: center + :width: 100% .. note:: For more information on the cross-development toolchain generation, see the ":ref:`overview-manual/concepts:cross-development toolchain generation`" section. For information on advantages gained when building a - cross-development toolchain using the do_populate_sdk task, see the + cross-development toolchain using the :ref:`ref-tasks-populate_sdk` task, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. @@ -1115,13 +1079,13 @@ actually install. For information on the variables listed in the figure, see the ":ref:`overview-manual/concepts:application development sdk`" section. -The ``do_populate_sdk`` task helps create the standard SDK and handles +The :ref:`ref-tasks-populate_sdk` task helps create the standard SDK and handles two parts: a target part and a host part. The target part is the part built for the target hardware and includes libraries and headers. The host part is the part of the SDK that runs on the :term:`SDKMACHINE`. -The ``do_populate_sdk_ext`` task helps create the extensible SDK and +The :ref:`ref-tasks-populate_sdk_ext` task helps create the extensible SDK and handles host and target parts differently than its counter part does for the standard SDK. For the extensible SDK, the task encapsulates the build system, which includes everything needed (host and target) for the @@ -1145,8 +1109,7 @@ checksum <overview-manual/concepts:checksums (signatures)>`. .. note:: - This naming scheme assumes that - BB_SIGNATURE_HANDLER + This naming scheme assumes that :term:`BB_SIGNATURE_HANDLER` is "OEBasicHash", which is almost always the case in current OpenEmbedded. @@ -1176,12 +1139,12 @@ Since :term:`STAMPS_DIR` is usually a subdirectory of :term:`TMPDIR`, removing properly be rerun to repopulate :term:`TMPDIR`. If you want some task to always be considered "out of date", you can -mark it with the :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>` +mark it with the :ref:`nostamp <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>` varflag. If some other task depends on such a task, then that task will also always be considered out of date, which might not be what you want. For details on how to view information about a task's signature, see the -":ref:`dev-manual/common-tasks:viewing task variable dependencies`" +":ref:`dev-manual/debugging:viewing task variable dependencies`" section in the Yocto Project Development Tasks Manual. Setscene Tasks and Shared State @@ -1213,7 +1176,7 @@ the work involved would be equal to or greater than the underlying task. In the build system, the common tasks that have setscene variants are :ref:`ref-tasks-package`, -``do_package_write_*``, +:ref:`do_package_write_* <ref-tasks-package_write_deb>`, :ref:`ref-tasks-deploy`, :ref:`ref-tasks-packagedata`, and :ref:`ref-tasks-populate_sysroot`. @@ -1223,15 +1186,15 @@ end result. The build system has knowledge of the relationship between these tasks and other preceding tasks. For example, if BitBake runs ``do_populate_sysroot_setscene`` for something, it does not make sense -to run any of the ``do_fetch``, ``do_unpack``, ``do_patch``, -``do_configure``, ``do_compile``, and ``do_install`` tasks. However, if -``do_package`` needs to be run, BitBake needs to run those other tasks. +to run any of the :ref:`ref-tasks-fetch`, :ref:`ref-tasks-unpack`, :ref:`ref-tasks-patch`, +:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if +:ref:`ref-tasks-package` needs to be run, BitBake needs to run those other tasks. It becomes more complicated if everything can come from an sstate cache because some objects are simply not required at all. For example, you do not need a compiler or native tools, such as quilt, if there isn't anything -to compile or patch. If the ``do_package_write_*`` packages are available -from sstate, BitBake does not need the ``do_package`` task data. +to compile or patch. If the :ref:`do_package_write_* <ref-tasks-package_write_deb>` packages are available +from sstate, BitBake does not need the :ref:`ref-tasks-package` task data. To handle all these complexities, BitBake runs in two phases. The first is the "setscene" stage. During this stage, BitBake first checks the @@ -1269,6 +1232,7 @@ this output: .. image:: figures/images.png :align: center + :width: 75% .. note:: @@ -1276,15 +1240,12 @@ this output: ":doc:`/ref-manual/images`" chapter in the Yocto Project Reference Manual. -The build process writes images out to the :term:`Build Directory` -inside the -``tmp/deploy/images/machine/`` folder as shown in the figure. This +The build process writes images out to the :term:`Build Directory` inside +the ``tmp/deploy/images/machine/`` folder as shown in the figure. This folder contains any files expected to be loaded on the target device. -The :term:`DEPLOY_DIR` variable -points to the ``deploy`` directory, while the -:term:`DEPLOY_DIR_IMAGE` -variable points to the appropriate directory containing images for the -current configuration. +The :term:`DEPLOY_DIR` variable points to the ``deploy`` directory, while the +:term:`DEPLOY_DIR_IMAGE` variable points to the appropriate directory +containing images for the current configuration. - kernel-image: A kernel binary file. The :term:`KERNEL_IMAGETYPE` @@ -1328,7 +1289,7 @@ SDK (e.g. ``bitbake -c populate_sdk_ext`` imagename) or a standard SDK closer look at this output: .. image:: figures/sdk.png - :align: center + :width: 100% The specific form of this output is a set of files that includes a self-extracting SDK installer (``*.sh``), host and target manifest @@ -1358,10 +1319,9 @@ can initialize the environment before using the tools. the :doc:`/sdk-manual/index` manual. All the output files for an SDK are written to the ``deploy/sdk`` folder -inside the :term:`Build Directory` as -shown in the previous figure. Depending on the type of SDK, there are -several variables to configure these files. Here are the variables -associated with an extensible SDK: +inside the :term:`Build Directory` as shown in the previous figure. Depending +on the type of SDK, there are several variables to configure these files. +The variables associated with an extensible SDK are: - :term:`DEPLOY_DIR`: Points to the ``deploy`` directory. @@ -1379,15 +1339,15 @@ associated with an extensible SDK: Specifies whether or not the toolchain is included when building the extensible SDK. -- :term:`SDK_LOCAL_CONF_WHITELIST`: +- :term:`ESDK_LOCALCONF_ALLOW`: A list of variables allowed through from the build system configuration into the extensible SDK configuration. -- :term:`SDK_LOCAL_CONF_BLACKLIST`: +- :term:`ESDK_LOCALCONF_REMOVE`: A list of variables not allowed through from the build system configuration into the extensible SDK configuration. -- :term:`SDK_INHERIT_BLACKLIST`: +- :term:`ESDK_CLASS_INHERIT_DISABLE`: A list of classes to remove from the :term:`INHERIT` value globally within the extensible SDK configuration. @@ -1415,7 +1375,7 @@ This next list, shows the variables associated with a standard SDK: Lists packages that make up the target part of the SDK (i.e. the part built for the target hardware). -- :term:`SDKPATH`: Defines the +- :term:`SDKPATHINSTALL`: Defines the default SDK installation path offered by the installation script. - :term:`SDK_HOST_MANIFEST`: @@ -1446,10 +1406,10 @@ The following figure shows a high-level build environment regarding toolchain construction and use. .. image:: figures/cross-development-toolchains.png - :align: center + :width: 100% Most of the work occurs on the Build Host. This is the machine used to -build images and generally work within the the Yocto Project +build images and generally work within the Yocto Project environment. When you run :term:`BitBake` to create an image, the OpenEmbedded build system uses the host ``gcc`` compiler to bootstrap a @@ -1500,12 +1460,11 @@ relocatable SDK used to develop applications. When you run the installer, it installs the toolchain, which contains the development tools (e.g., ``gcc-cross-canadian``, ``binutils-cross-canadian``, and other ``nativesdk-*`` tools), which are tools native to the SDK (i.e. -native to :term:`SDK_ARCH`), you -need to cross-compile and test your software. The figure shows the -commands you use to easily build out this toolchain. This -cross-development toolchain is built to execute on the -:term:`SDKMACHINE`, which might or -might not be the same machine as the Build Host. +native to :term:`SDK_ARCH`), you need to cross-compile and test your +software. The figure shows the commands you use to easily build out +this toolchain. This cross-development toolchain is built to execute on the +:term:`SDKMACHINE`, which might or might not be the same machine as +the Build Host. .. note:: @@ -1610,15 +1569,15 @@ them if they are deemed to be valid. the shared state packages. Consequently, there are considerations that affect maintaining shared state feeds. For information on how the build system works with packages and can track incrementing :term:`PR` - information, see the ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" + information, see the ":ref:`dev-manual/packages:automatically incrementing a package version number`" section in the Yocto Project Development Tasks Manual. - The code in the build system that supports incremental builds is complex. For techniques that help you work around issues related to shared state code, see the - ":ref:`dev-manual/common-tasks:viewing metadata used to create the input signature of a shared state task`" + ":ref:`dev-manual/debugging:viewing metadata used to create the input signature of a shared state task`" and - ":ref:`dev-manual/common-tasks:invalidating shared state to force a task to run`" + ":ref:`dev-manual/debugging:invalidating shared state to force a task to run`" sections both in the Yocto Project Development Tasks Manual. The rest of this section goes into detail about the overall incremental @@ -1655,7 +1614,7 @@ you a good idea of when the task's data changes. To complicate the problem, there are things that should not be included in the checksum. First, there is the actual specific build path of a -given task - the :term:`WORKDIR`. It +given task --- the :term:`WORKDIR`. It does not matter if the work directory changes because it should not affect the output for target packages. Also, the build process has the objective of making native or cross packages relocatable. @@ -1714,7 +1673,7 @@ need to fix this situation. Thus far, this section has limited discussion to the direct inputs into a task. Information based on direct inputs is referred to as the "basehash" in the code. However, the question of a task's indirect -inputs still exits - items already built and present in the +inputs still exits --- items already built and present in the :term:`Build Directory`. The checksum (or signature) for a particular task needs to add the hashes of all the tasks on which the particular task depends. Choosing which dependencies @@ -1729,7 +1688,7 @@ it construct the basehash. The following statement effectively results in a list of global variable dependency excludes (i.e. variables never included in any checksum):: - BB_HASHBASE_WHITELIST ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH DL_DIR \\ + BB_BASEHASH_IGNORE_VARS ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH DL_DIR \\ SSTATE_DIR THISDIR FILESEXTRAPATHS FILE_DIRNAME HOME LOGNAME SHELL TERM \\ USER FILESPATH STAGING_DIR_HOST STAGING_DIR_TARGET COREBASE PRSERV_HOST \\ PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \\ @@ -1780,12 +1739,11 @@ half the problem of supporting a shared state. The other half of the problem is being able to use checksum information during the build and being able to reuse or rebuild specific components. -The :ref:`sstate <ref-classes-sstate>` class is a -relatively generic implementation of how to "capture" a snapshot of a -given task. The idea is that the build process does not care about the -source of a task's output. Output could be freshly built or it could be -downloaded and unpacked from somewhere. In other words, the build -process does not need to worry about its origin. +The :ref:`ref-classes-sstate` class is a relatively generic implementation of +how to "capture" a snapshot of a given task. The idea is that the build process +does not care about the source of a task's output. Output could be freshly +built or it could be downloaded and unpacked from somewhere. In other words, +the build process does not need to worry about its origin. Two types of output exist. One type is just about creating a directory in :term:`WORKDIR`. A good example is @@ -1796,10 +1754,9 @@ type of output occurs when a set of data is merged into a shared directory tree such as the sysroot. The Yocto Project team has tried to keep the details of the -implementation hidden in the :ref:`sstate <ref-classes-sstate>` class. From a user's perspective, +implementation hidden in the :ref:`ref-classes-sstate` class. From a user's perspective, adding shared state wrapping to a task is as simple as this -:ref:`ref-tasks-deploy` example taken -from the :ref:`deploy <ref-classes-deploy>` class:: +:ref:`ref-tasks-deploy` example taken from the :ref:`ref-classes-deploy` class:: DEPLOYDIR = "${WORKDIR}/deploy-${PN}" SSTATETASKS += "do_deploy" @@ -1815,14 +1772,12 @@ from the :ref:`deploy <ref-classes-deploy>` class:: The following list explains the previous example: -- Adding "do_deploy" to ``SSTATETASKS`` adds some required - sstate-related processing, which is implemented in the - :ref:`sstate <ref-classes-sstate>` class, to - before and after the - :ref:`ref-tasks-deploy` task. +- Adding ``do_deploy`` to ``SSTATETASKS`` adds some required sstate-related + processing, which is implemented in the :ref:`ref-classes-sstate` class, to + before and after the :ref:`ref-tasks-deploy` task. - The ``do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"`` declares that - ``do_deploy`` places its output in ``${DEPLOYDIR}`` when run normally + :ref:`ref-tasks-deploy` places its output in ``${DEPLOYDIR}`` when run normally (i.e. when not using the sstate cache). This output becomes the input to the shared state cache. @@ -1832,15 +1787,15 @@ The following list explains the previous example: .. note:: - If ``do_deploy`` is not already in the shared state cache or if its input + If :ref:`ref-tasks-deploy` is not already in the shared state cache or if its input checksum (signature) has changed from when the output was cached, the task runs to populate the shared state cache, after which the contents of the shared state cache is copied to ${:term:`DEPLOY_DIR_IMAGE`}. If - ``do_deploy`` is in the shared state cache and its signature indicates + :ref:`ref-tasks-deploy` is in the shared state cache and its signature indicates that the cached output is still valid (i.e. if no relevant task inputs have changed), then the contents of the shared state cache copies directly to ${:term:`DEPLOY_DIR_IMAGE`} by the ``do_deploy_setscene`` task - instead, skipping the ``do_deploy`` task. + instead, skipping the :ref:`ref-tasks-deploy` task. - The following task definition is glue logic needed to make the previous settings effective:: @@ -1850,36 +1805,33 @@ The following list explains the previous example: } addtask do_deploy_setscene - ``sstate_setscene()`` takes the flags above as input and accelerates the ``do_deploy`` task - through the shared state cache if possible. If the task was - accelerated, ``sstate_setscene()`` returns True. Otherwise, it - returns False, and the normal ``do_deploy`` task runs. For more - information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene`" - section in the BitBake User Manual. + ``sstate_setscene()`` takes the flags above as input and accelerates the + :ref:`ref-tasks-deploy` task through the shared state cache if possible. If + the task was accelerated, ``sstate_setscene()`` returns True. Otherwise, it + returns False, and the normal :ref:`ref-tasks-deploy` task runs. For more + information, see the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:setscene`" + section in the BitBake User Manual. -- The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates - ``${DEPLOYDIR}`` and ``${B}`` before the ``do_deploy`` task runs, and - also sets the current working directory of ``do_deploy`` to ``${B}``. - For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" - section in the BitBake - User Manual. +- The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates ``${DEPLOYDIR}`` + and ``${B}`` before the :ref:`ref-tasks-deploy` task runs, and also sets the + current working directory of :ref:`ref-tasks-deploy` to ``${B}``. For more + information, see the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" + section in the BitBake User Manual. .. note:: In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be the same, you can use ``sstate-plaindirs``. For example, to preserve the - ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the ``do_package`` + ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the :ref:`ref-tasks-package` task, use the following:: do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" -- The ``do_deploy[stamp-extra-info] = "${MACHINE_ARCH}"`` line appends - extra metadata to the :ref:`stamp - file <overview-manual/concepts:stamp files and the rerunning of tasks>`. In - this case, the metadata makes the task specific to a machine's architecture. - See - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:the task list`" +- The ``do_deploy[stamp-extra-info] = "${MACHINE_ARCH}"`` line appends extra + metadata to the :ref:`stamp file <overview-manual/concepts:stamp files and the rerunning of tasks>`. + In this case, the metadata makes the task specific to a machine's architecture. + See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:the task list`" section in the BitBake User Manual for more information on the ``stamp-extra-info`` flag. @@ -1904,7 +1856,7 @@ Behind the scenes, the shared state code works by looking in shared state files. Here is an example:: 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" .. note:: @@ -1989,7 +1941,7 @@ Thanks to this, the depending tasks will keep a previously recorded task hash, and BitBake will be able to retrieve their output from the Shared State cache, instead of re-executing them. Similarly, the output of further downstream tasks can also be retrieved from Shared -Shate. +State. If the output hash is unknown, a new entry will be created on the Hash Equivalence server, matching the task hash to that output. @@ -2011,6 +1963,15 @@ task output from the Shared State cache. the stability of the task's output hash. Therefore, the effectiveness of Hash Equivalence strongly depends on it. + Recipes that are not reproducible may have undesired behavior if hash + equivalence is enabled, since the non-reproducible diverging output maybe be + remapped to an older sstate object in the cache by the server. If a recipe + is non-reproducible in trivial ways, such as different timestamps, this is + likely not a problem. However recipes that have more dramatic changes (such + as completely different file names) will likely outright fail since the + downstream sstate objects are not actually equivalent to what was just + built. + This applies to multiple scenarios: - A "trivial" change to a recipe that doesn't impact its generated output, @@ -2037,7 +1998,7 @@ variables: - :term:`BB_HASHSERVE_UPSTREAM`, when ``BB_HASHSERVE = "auto"``, allowing to connect the local server to an upstream one. -- :term:`bitbake:BB_SIGNATURE_HANDLER`, which must be set to ``OEEquivHash``. +- :term:`bitbake:BB_SIGNATURE_HANDLER`, which must be set to ``OEEquivHash``. Therefore, the default configuration in Poky corresponds to the below settings:: @@ -2088,7 +2049,7 @@ dependencies, you must manually declare the dependencies. located. For each shared library, the package that contains the shared library is registered as providing the shared library. More specifically, the package is registered as providing the - `soname <https://en.wikipedia.org/wiki/Soname>`__ of the library. The + :wikipedia:`soname <Soname>` of the library. The resulting shared-library-to-package mapping is saved globally in :term:`PKGDATA_DIR` by the :ref:`ref-tasks-packagedata` @@ -2115,12 +2076,12 @@ dependencies, you must manually declare the dependencies. :term:`PRIVATE_LIBS` inside the package's recipe. -- ``pcdeps``: During the ``do_package`` task of each recipe, all +- ``pcdeps``: During the :ref:`ref-tasks-package` task of each recipe, all pkg-config modules (``*.pc`` files) installed by the recipe are located. For each module, the package that contains the module is registered as providing the module. The resulting module-to-package mapping is saved globally in :term:`PKGDATA_DIR` by the - ``do_packagedata`` task. + :ref:`ref-tasks-packagedata` task. Simultaneously, all pkg-config modules installed by the recipe are inspected to see what other pkg-config modules they depend on. A @@ -2153,7 +2114,7 @@ dependencies, you must manually declare the dependencies. By default, ``foo-dev`` also has an :term:`RDEPENDS`-style dependency on ``foo``, because the default value of ``RDEPENDS:${PN}-dev`` (set in - bitbake.conf) includes "${PN}". + ``bitbake.conf``) includes "${PN}". To ensure that the dependency chain is never broken, ``-dev`` and ``-dbg`` packages are always generated by default, even if the @@ -2161,12 +2122,12 @@ dependencies, you must manually declare the dependencies. :term:`ALLOW_EMPTY` variable for more information. -The ``do_package`` task depends on the ``do_packagedata`` task of each -recipe in :term:`DEPENDS` through use -of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` -declaration, which guarantees that the required -shared-library/module-to-package mapping information will be available -when needed as long as :term:`DEPENDS` has been correctly set. +The :ref:`ref-tasks-package` task depends on the :ref:`ref-tasks-packagedata` +task of each recipe in :term:`DEPENDS` through use of a +``[``\ :ref:`deptask <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` +declaration, which guarantees that the required shared-library / +module-to-package mapping information will be available when needed as long as +:term:`DEPENDS` has been correctly set. Fakeroot and Pseudo =================== @@ -2176,8 +2137,8 @@ operations that are normally reserved for the root user (e.g. :ref:`ref-tasks-install`, :ref:`do_package_write* <ref-tasks-package_write_deb>`, :ref:`ref-tasks-rootfs`, and -:ref:`do_image* <ref-tasks-image>`). For example, -the ``do_install`` task benefits from being able to set the UID and GID +:ref:`do_image_* <ref-tasks-image>`). For example, +the :ref:`ref-tasks-install` task benefits from being able to set the UID and GID of installed files to arbitrary values. One approach to allowing tasks to perform root-only operations would be @@ -2228,3 +2189,173 @@ For more information, see the BitBake User Manual. You can also reference the "`Why Not Fakeroot? <https://github.com/wrpseudo/pseudo/wiki/WhyNotFakeroot>`__" article for background information on Fakeroot and Pseudo. + +BitBake Tasks Map +================= + +To understand how BitBake operates in the build directory and environment +we can consider the following recipes and diagram, to have full picture +about the tasks that BitBake runs to generate the final package file +for the recipe. + +We will have two recipes as an example: + +- ``libhello``: A recipe that provides a shared library +- ``sayhello``: A recipe that uses ``libhello`` library to do its job + +.. note:: + + ``sayhello`` depends on ``libhello`` at compile time as it needs the shared + library to do the dynamic linking process. It also depends on it at runtime + as the shared library loader needs to find the library. + For more details about dependencies check :ref:`ref-varlocality-recipe-dependencies`. + +``libhello`` sources are as follows: + +- ``LICENSE``: This is the license associated with this library +- ``Makefile``: The file used by ``make`` to build the library +- ``hellolib.c``: The implementation of the library +- ``hellolib.h``: The C header of the library + +``sayhello`` sources are as follows: + +- ``LICENSE``: This is the license associated with this project +- ``Makefile``: The file used by ``make`` to build the project +- ``sayhello.c``: The source file of the project + +Before presenting the contents of each file, here are the steps +that we need to follow to accomplish what we want in the first place, +which is integrating ``sayhello`` in our root file system: + +#. Create a Git repository for each project with the corresponding files + +#. Create a recipe for each project + +#. Make sure that ``sayhello`` recipe :term:`DEPENDS` on ``libhello`` + +#. Make sure that ``sayhello`` recipe :term:`RDEPENDS` on ``libhello`` + +#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into + the root file system + +The contents of ``libhello/Makefile`` are:: + + LIB=libhello.so + + all: $(LIB) + + $(LIB): hellolib.o + $(CC) $< -Wl,-soname,$(LIB).1 -fPIC $(LDFLAGS) -shared -o $(LIB).1.0 + + %.o: %.c + $(CC) -c $< + + clean: + rm -rf *.o *.so* + +.. note:: + + When creating shared libraries, it is strongly recommended to follow the Linux + conventions and guidelines (see `this article + <https://tldp.org/HOWTO/Program-Library-HOWTO/shared-libraries.html>`__ + for some background). + +.. note:: + + When creating ``Makefile`` files, it is strongly recommended to use ``CC``, ``LDFLAGS`` + and ``CFLAGS`` as BitBake will set them as environment variables according + to your build configuration. + +The contents of ``libhello/hellolib.h`` are:: + + #ifndef HELLOLIB_H + #define HELLOLIB_H + + void Hello(); + + #endif + +The contents of ``libhello/hellolib.c`` are:: + + #include <stdio.h> + + void Hello(){ + puts("Hello from a Yocto demo \n"); + } + +The contents of ``sayhello/Makefile`` are:: + + EXEC=sayhello + LDFLAGS += -lhello + + all: $(EXEC) + + $(EXEC): sayhello.c + $(CC) $< $(LDFLAGS) $(CFLAGS) -o $(EXEC) + + clean: + rm -rf $(EXEC) *.o + +The contents of ``sayhello/sayhello.c`` are:: + + #include <hellolib.h> + + int main(){ + Hello(); + return 0; + } + +The contents of ``libhello_0.1.bb`` are:: + + SUMMARY = "Hello demo library" + DESCRIPTION = "Hello shared library used in Yocto demo" + + # NOTE: Set the License according to the LICENSE file of your project + # and then add LIC_FILES_CHKSUM accordingly + LICENSE = "CLOSED" + + # Assuming the branch is main + # Change <username> accordingly + SRC_URI = "git://github.com/<username>/libhello;branch=main;protocol=https" + + S = "${WORKDIR}/git" + + do_install(){ + install -d ${D}${includedir} + install -d ${D}${libdir} + + install hellolib.h ${D}${includedir} + oe_soinstall ${PN}.so.${PV} ${D}${libdir} + } + +The contents of ``sayhello_0.1.bb`` are:: + + SUMMARY = "SayHello demo" + DESCRIPTION = "SayHello project used in Yocto demo" + + # NOTE: Set the License according to the LICENSE file of your project + # and then add LIC_FILES_CHKSUM accordingly + LICENSE = "CLOSED" + + # Assuming the branch is main + # Change <username> accordingly + SRC_URI = "git://github.com/<username>/sayhello;branch=main;protocol=https" + + DEPENDS += "libhello" + RDEPENDS:${PN} += "libhello" + + S = "${WORKDIR}/git" + + do_install(){ + install -d ${D}/usr/bin + install -m 0700 sayhello ${D}/usr/bin + } + +After placing the recipes in a custom layer we can run ``bitbake sayhello`` +to build the recipe. + +The following diagram shows the sequences of tasks that BitBake +executes to accomplish that. + +.. image:: svg/bitbake_tasks_map.* + :width: 100% diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index fc193f3135..d79173ff55 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -39,10 +39,9 @@ Linus Torvalds in 1991. Conversely, a good example of a non-open source project is the Windows family of operating systems developed by Microsoft Corporation. -Wikipedia has a good historical description of the Open Source -Philosophy `here <https://en.wikipedia.org/wiki/Open_source>`__. You can -also find helpful information on how to participate in the Linux -Community +Wikipedia has a good :wikipedia:`historical description of the Open Source +Philosophy <Open_source>`. You can also find helpful information on how +to participate in the Linux Community `here <https://www.kernel.org/doc/html/latest/process/index.html>`__. The Development Host @@ -52,7 +51,7 @@ A development host or :term:`Build Host` is key to using the Yocto Project. Because the goal of the Yocto Project is to develop images or applications that run on embedded hardware, development of those images and applications generally takes place on a -system not intended to run the software - the development host. +system not intended to run the software --- the development host. You need to set up a development host in order to use it with the Yocto Project. Most find that it is best to have a native Linux machine @@ -94,7 +93,7 @@ are several ways of working in the Yocto Project environment: through your Linux distribution and the Yocto Project. For a general flow of the build procedures, see the - ":ref:`dev-manual/common-tasks:building a simple image`" + ":ref:`dev-manual/building:building a simple image`" section in the Yocto Project Development Tasks Manual. - *Board Support Package (BSP) Development:* Development of BSPs @@ -132,6 +131,14 @@ are several ways of working in the Yocto Project environment: Toaster and on how to use Toaster in general, see the :doc:`/toaster-manual/index`. +- *Using the VSCode Extension:* You can use the `Yocto Project BitBake + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + extension for Visual Studio Code to start your BitBake builds through a + graphical user interface. + + Learn more about the VSCode Extension on the `extension's marketplace page + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__. + Yocto Project Source Repositories ================================= @@ -170,42 +177,31 @@ these tarballs gives you a snapshot of the released files. In summary, here is where you can get the project files needed for development: -- :yocto_git:`Source Repositories: <>` This area contains IDE - Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and - Yocto Metadata Layers. You can create local copies of Git - repositories for each of these areas. +- :yocto_git:`Source Repositories: <>` This area contains Poky, Yocto + documentation, metadata layers, and Linux kernel. You can create local + copies of Git repositories for each of these areas. .. image:: figures/source-repos.png - :align: center + :width: 100% For steps on how to view and access these upstream Git repositories, see the ":ref:`dev-manual/start:accessing source repositories`" Section in the Yocto Project Development Tasks Manual. -- :yocto_dl:`Index of /releases: </releases>` This is an index - of releases such as Poky, Pseudo, installers for cross-development - toolchains, miscellaneous support and all released versions of Yocto - Project in the form of images or tarballs. Downloading and extracting - these files does not produce a local copy of the Git repository but - rather a snapshot of a particular release or image. - - .. image:: figures/index-downloads.png - :align: center - - For steps on how to view and access these files, see the - ":ref:`dev-manual/start:accessing index of releases`" - section in the Yocto Project Development Tasks Manual. +- :yocto_dl:`Yocto release archives: </releases/yocto>` This is where you can + download tarballs corresponding to each Yocto Project release. Downloading + and extracting these files does not produce a local copy of a Git repository + but rather a snapshot corresponding to a particular release. -- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* - - The Yocto Project website includes a "DOWNLOADS" page accessible +- :yocto_home:`DOWNLOADS page </software-overview/downloads/>`: + The :yocto_home:`Yocto Project website <>` includes a "DOWNLOADS" page accessible through the "SOFTWARE" menu that allows you to download any Yocto Project release, tool, and Board Support Package (BSP) in tarball - form. The tarballs are similar to those found in the - :yocto_dl:`Index of /releases: </releases>` area. + form. The hyperlinks point to the tarballs under + :yocto_dl:`/releases/yocto/`. .. image:: figures/yp-download.png - :align: center + :width: 100% For steps on how to use the "DOWNLOADS" page, see the ":ref:`dev-manual/start:using the downloads page`" @@ -244,8 +240,8 @@ and so forth. For information on finding out who is responsible for (maintains) a particular area of code in the Yocto Project, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section of the Yocto Project Development Tasks Manual. + ":doc:`../contributor-guide/identify-component`" + section of the Yocto Project and OpenEmbedded Contributor Guide. The Yocto Project ``poky`` Git repository also has an upstream contribution Git repository named ``poky-contrib``. You can see all the @@ -276,8 +272,8 @@ push them into the "contrib" area and subsequently request that the maintainer include them into an upstream branch. This process is called "submitting a patch" or "submitting a change." For information on submitting patches and changes, see the -":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" -section in the Yocto Project Development Tasks Manual. +":doc:`../contributor-guide/submit-changes`" section in the Yocto Project +and OpenEmbedded Contributor Guide. In summary, there is a single point of entry for changes into the development branch of the Git repository, which is controlled by the @@ -340,11 +336,10 @@ Book <https://book.git-scm.com>`__. software on which to develop. The Yocto Project has two scripts named ``create-pull-request`` and ``send-pull-request`` that ship with the release to facilitate this workflow. You can find these scripts in - the ``scripts`` folder of the - :term:`Source Directory`. For information + the ``scripts`` folder of the :term:`Source Directory`. For information on how to use these scripts, see the - ":ref:`dev-manual/common-tasks:using scripts to push a change upstream and request a pull`" - section in the Yocto Project Development Tasks Manual. + ":ref:`contributor-guide/submit-changes:using scripts to push a change upstream and request a pull`" + section in the Yocto Project and OpenEmbedded Contributor Guide. - *Patch Workflow:* This workflow allows you to notify the maintainer through an email that you have a change (or patch) you would like @@ -352,8 +347,8 @@ Book <https://book.git-scm.com>`__. this type of change, you format the patch and then send the email using the Git commands ``git format-patch`` and ``git send-email``. For information on how to use these scripts, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section in the Yocto Project Development Tasks Manual. + ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project + and OpenEmbedded Contributor Guide. Git === @@ -427,7 +422,7 @@ other branches represent offshoots of the "master" branch. When you create a local copy of a Git repository, the copy has the same set of branches as the original. This means you can use Git to create a local working area (also called a branch) that tracks a specific -development branch from the upstream source Git repository. in other +development branch from the upstream source Git repository. In other words, you can define your local Git environment to work on any development branch in the repository. To help illustrate, consider the following example Git commands:: @@ -461,7 +456,7 @@ and clicking on the ``[...]`` link beneath the "Tag" heading. Some key tags for the ``poky`` repository are ``jethro-14.0.3``, ``morty-16.0.1``, ``pyro-17.0.0``, and -``&DISTRO_NAME_NO_CAP;-&POKYVERSION;``. These tags represent Yocto Project +``&DISTRO_NAME_NO_CAP;-&DISTRO;``. These tags represent Yocto Project releases. When you create a local copy of the Git repository, you also have access @@ -550,11 +545,11 @@ descriptions and strategies on how to use these commands: You need to be in a local branch other than the one you are deleting in order to delete branch-name. -- *git pull --rebase:* Retrieves information from an upstream Git +- *git pull \-\-rebase*: Retrieves information from an upstream Git repository and places it in your local Git repository. You use this command to make sure you are synchronized with the repository from which you are basing changes (e.g. the "&DISTRO_NAME_NO_CAP;" - branch). The "--rebase" option ensures that any local commits you + branch). The ``--rebase`` option ensures that any local commits you have in your branch are preserved at the top of your local branch. - *git push repo-name local-branch:upstream-branch:* Sends @@ -607,30 +602,22 @@ licensing structures in place. License evolution for both Open Source and Free Software has an interesting history. If you are interested in this history, you can find basic information here: -- `Open source license - history <https://en.wikipedia.org/wiki/Open-source_license>`__ +- :wikipedia:`Open source license history <Open-source_license>` -- `Free software license - history <https://en.wikipedia.org/wiki/Free_software_license>`__ +- :wikipedia:`Free software license history <Free_software_license>` In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology (MIT) License. MIT licensing permits the reuse of software within proprietary software as long as the -license is distributed with that software. MIT is also compatible with -the GNU General Public License (GPL). Patches to the Yocto Project +license is distributed with that software. Patches to the Yocto Project follow the upstream licensing scheme. You can find information on the -MIT license -`here <https://www.opensource.org/licenses/mit-license.php>`__. You can -find information on the GNU GPL -`here <https://www.opensource.org/licenses/LGPL-3.0>`__. +MIT license :wikipedia:`here <MIT_License>`. When you build an image using the Yocto Project, the build process uses a known list of licenses to ensure compliance. You can find this list in -the :term:`Source Directory` at -``meta/files/common-licenses``. Once the build completes, the list of -all licenses found and used during that build are kept in the -:term:`Build Directory` at -``tmp/deploy/licenses``. +the :term:`Source Directory` at ``meta/files/common-licenses``. Once the +build completes, the list of all licenses found and used during that build +are kept in the :term:`Build Directory` at ``tmp/deploy/licenses``. If a module requires a license that is not in the base list, the build process generates a warning during the build. These tools make it easier @@ -655,5 +642,5 @@ Project uses in the ``meta/files/common-licenses`` directory in your For information that can help you maintain compliance with various open source licensing during the lifecycle of a product created using the Yocto Project, 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. diff --git a/documentation/overview-manual/figures/index-downloads.png b/documentation/overview-manual/figures/index-downloads.png Binary files differdeleted file mode 100755 index d8d4475cee..0000000000 --- a/documentation/overview-manual/figures/index-downloads.png +++ /dev/null diff --git a/documentation/overview-manual/figures/source-repos.png b/documentation/overview-manual/figures/source-repos.png Binary files differindex 603300b6d2..56023d585d 100644 --- a/documentation/overview-manual/figures/source-repos.png +++ b/documentation/overview-manual/figures/source-repos.png diff --git a/documentation/overview-manual/figures/yp-download.png b/documentation/overview-manual/figures/yp-download.png Binary files differindex bfd12b678a..c8b50ec8a7 100644 --- a/documentation/overview-manual/figures/yp-download.png +++ b/documentation/overview-manual/figures/yp-download.png diff --git a/documentation/overview-manual/intro.rst b/documentation/overview-manual/intro.rst index a8091771f4..80446b3810 100644 --- a/documentation/overview-manual/intro.rst +++ b/documentation/overview-manual/intro.rst @@ -38,7 +38,7 @@ This manual does not give you the following: procedures reside in other manuals within the Yocto Project documentation set. For example, the :doc:`/dev-manual/index` provides examples on how to perform - various development tasks. As another example, the + various development tasks. As another example, the :doc:`/sdk-manual/index` manual contains detailed instructions on how to install an SDK, which is used to develop applications for target hardware. diff --git a/documentation/overview-manual/svg/bitbake_tasks_map.svg b/documentation/overview-manual/svg/bitbake_tasks_map.svg new file mode 100644 index 0000000000..09ef36faae --- /dev/null +++ b/documentation/overview-manual/svg/bitbake_tasks_map.svg @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- Do not edit this file with editors other than draw.io --> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="12270px" height="3804px" viewBox="-0.5 -0.5 12270 3804" content="<mxfile host="app.diagrams.net" modified="2023-11-01T08:31:56.536Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36" etag="p-CQVME_iMteI52En1Eq" version="22.0.8" type="device"><diagram name="Page-1" id="c7558073-3199-34d8-9f00-42111426c3f3">7V1bc6M6tv41rprzYAohro9JnO7O2X1JJZk9Z89LCtvEZtox3oA7nfn1R1yEQcjmLmRHPVV7YowxRp++dV9rAm9ef3/27d36m7d0NhNFXv6ewNlEUaCl6uj/oiPvyRFFM2FyZOW7y+QYOBx4dP/rpAfl9OjeXTpB4cTQ8zahuyseXHjbrbMIC8ds3/feiqe9eJvit+7slVM68LiwN+Wj/3KX4To5air64fgXx12t8TcD3UremduLnyvf22/T79t6Wyd559XGl0l/Y7C2l95b7hC8ncAb3/PC5K/X3zfOJnqu+Ikln/t05N3sln1nG9b5gPOn9ja72cPZi/UlfHp//N+7+WoKLTO5zi97s08fRnq74Tt+OvHvc6LLgAm8flu7ofO4sxfRu28IEOjYOnzdpG+/uJvNjbfxfPQ6fhrwemkH6+zjL942/GS/upsIK1/duePboett0Tc+2tsgPeHR2/vx9ddhiCCgaPAK/Qf9tOg/0QmBtPK81caxd24gLbzX+I1FEJ/66SW5PPqz8AWacp1+RfnRpU/zl+OHzu/cofRRfna8Vyf00TVl/K6lpuuaYt7Er98OAFLM9Ng6Dx4tPWinoF1lFz+sHvojXcAmi4l3XW7tnCUCevrS88O1t/K29ub2cPT6cPSr5+3SVfqPE4bv6T6196FXXGP02Pz3/0MvZMnQ8Ou/8m/OosckZ6/es1fLq2i7opeLjR0E7uJp7W6TNz65G3z9AmAWe//XeaAnwN97fIHSpQ9tf+WEJ89Mt2G0fifx6DsbdIe/ikRGg1b8UfT07ffcCTvPRY8jd+X76EAO5oZqFGBu6QTLVH1AT6nyAOzkHg4wz35Me+SrssEI+b/dMA989PKv3FsH2Ecv3vN7IPlUo91SQH4Q+t7PTDpBgmknClzKC8dRsjNz78jxv4+0e7BUG3v3mFZRSABACmniE4psnv7EMPsne7RCDWioBphytRqAl7CgBijqUGoAwoxYzDaLCWuspWIwXUugKsOv5SpSxVKZc4nrip6ijiRvfmmhVXNpARhsaXUGS3uJy5nR6SnKVdluUxmUlq5a/ywubidttLsyelA/K023FFsHm+38dUusMFaqlpbVt2bZzeSHJiPDpyVsihj/ICABUObC/jBBUephAjxmfUyx5kg/fyDbQ1UFhLmDMFThWUIYyOrJDwzlfyqrbgLDY2NYxVrZuWFYHZiH9+EP7fr+38Gnuf63/Cd0vb9n0ykQEOYQwup5ahLoE+xZmBrL1Ddhigb0ztIO7Wn09zTwF/EZ+t/7KAB7nSAkwgdCxxFsxMjIcAFnV/4iMsgX0YO7RkhHhqbjHy6J/lpF/x++7vBtpJfG75Q2XGNzH+/OdJvlPTlZvJl766y+6W+Q3nGzbPrTvDgDGv5tWLO74X/ZxrhV186Se2fHTmjAN84ZAb15/s9hGIgDmDVhwQEYKKOb8RhIZ6S3tXI2nuapS9LpMjKqQVsaV7QFNG0UISa81yNAr3e3Tl3o0Y1Ozn1/GUZzCD3glY7RQtpOIQBXM/3to4BRhSpfPIjvnDP9Dd/D/HBAnRjX3/759enu29XNl+enq4fPt0/PPx4nxiyn6M3JCwjlr6PyB4vKn0qLPLPV/nB6ghDd58qWsLbo7j2psSNbQi7ZcuPO1+j2PUF6/ZAeVHQJOzZS3tOUsY1eHCBh7XYTFHbCnK1BYXxlz2R3zhmFBfa7oLAeKcwyinrb+PyF6wfPjr8u2W6tnd6l633TWKugLMQZxLjUyjwdlDVPnj5MTDYzhwTSzxHp2nkiHRB1V4ygfl6k3sKG/zC4NziL0Fht6lvPys3zcaDFR1JiU0rV9REoVTHalDcI7YEPqCt67/EdJlCfamNoDzKf2YuyBKa+LDwRfTlTie4Y8sieCCifldLKA2S6UGftzEZD4YI6gSwXE7+ruNPST54/UAnZeYUDPgqIFU6KFxqDGEB1BA0AtqrAESgeHMW9B60YoVjDgGKKYv2sHL4fBcVQ46QlVmMU68YoKD4rx8OHQTEnkbfmKDbHcJ9BU6CYRxSbxnmiuNSdkJFnjM+yOuEZGzRHx0yxOVqODq5OONWfTdT6dmVNnFJfo6kSZ6VLbRynPUrTyl7bafAWh2tF6VI7MNIXv3cJ3pGr+KxcQhJiu/HsZSCkZD9SclrqZDp+ATruFHYOuSmXLUprlxLhrsLc0BefpUQrN1QEcw3FXBCOzFzoFsZR6FOFLnuRU81OKHR9TIBooxTyANYurKjXZUVOkp0VIv1INSq8MsT5BoteawCWS6cQXa7382hxJUST9mtEejF37gPH39qvTnY0plDpUOZ0CVya225O/I+2EaEOLbjsiVGBQlKqSkknUiBLToVwnEzlzEgWnMqCU+tWfA6VAkIJExLuQ5lAePKj0k8dQN7YZ15iZ6Ui8jMSPeud6flQSC/ouSd61samZ4BTshvRc8EtKKpK2PGsVlt3xSnuvFj0Wpl/OLHohUHfD78BItPXoBTVa0y5TSvHib/ZPx30XJzLWN2cpHrRov+lX52XYPE/mmzT4389rT1WL9K1z7Jb8o2wcG+/wgimoRZfhWfly2kzCJcHFHaQZXrdQK8KOZNlejm49vXu5vb74+3F0Qob1bhEH5RpfGzpQwFtWuAydFR0bkRak3HEmGGgg9pKNx8zkohmFxasKNEiTtdZ+CPwQ81x6Iv7W9rZ4WJ9cSzKl3JmURRz1uzKPFeqJbtKsqwXGNa0YAOORe/cO76LnprjT/rzMPMA8S6EWjcvQcGoHHvaEcmQ5klCJYfSyBCwYNRyzkTsrt24c2khKHVYSqU4ctlSataDjjMHW+gMNe2KE0wy9LBpxV4RozvYlJGajYuuu6f6SFVLVd667hplW4AH6greA9/zwunSCcKl6wsW64fFshY3J2gMKCx5DMoj56iIrmLHG95U05k1Wh3Q6TvnjM58Z+HunGnKaoLN+mEzC9RgM8A07InbOgs244jNao9EMDirJDP4HIngvtorR5BYPyQGoSzhrkYneAx7mBjR2LgBfEFjJ8ipmsawD5QXGjNZDZYcZxLaKcwVQhIfB4C9t9XuKEcNLuXoPhCOjb6kqCpLSjEHkpYHp0KcBc5Ijo7T84k/HuQBkh2oz6ybLwf6byfVEYF8NqNwt4vNfimMiN6MCE0iGoxalHm4GpQMpvxnnZU7hAfgdCGp2rlyFmf6mclnEGrjzgVB9UNQqmZl1HOCoJjrZ2XDIMvbEamQ/ebtQKUooIAMygAwKd56rNcPsPzlIiVcaCsFnlQeZCAQ0IkEFDI5DxhSubMkNQA9XPKWVdaQCyCQyok2Agb9wkBVasNgMC6waDpIp3XPPfM056lQQmb7i1SD5V73bLC2AFaTPMB9SfIrq2cY6D9XztRbmCEM24P2kZdeSn5P7sP4KANFs8y6MZJWjuSiQ4Losi5rFY1QymVChG8TAPJKya/u3FJFJwqSAGbhujOmyA8Mk3CfLXaOrW8RS72Ha3e7ij4dwRYbb/Njgev5wZ6TX7zNMjIC5XBtR7/PDSIg+k7gxD+XfsHHvx4ffvx4ep7dPTweue6bG/+cOfpeeeHtXLRHI+LzHak/8ZIvFuWuTHnQ6lUyodGkGJV0RWK4zOxW1e+d3PwNSL6tiCqIF1FHpYC6zrYBMr5bMbsmE5pZFbOTQ4YZMXurwWsddTUVFtzEkmVZFdshfkWWF7aJuxUTBBrvIspOPOt9lfVOqlGf2LsTu9W+Ak01JlU1RtlXfLZ1XnrP7jYI7egX1HO1I80gLG5le+OutujvBYJbtBmvI/3BXdibq/SNV3e5TEJLTuD+155vsNWdLi66rnY90WbRtRBRBAlnANrOy5SXY/oX1/uvvmKlGCSsKe1MLYpiRRomPVa8lWfAXLqjjlULGLO41kf8stSiWmM4tw3gM20LUdbC2764q72fGZNz/8BXgsY4oDEcZDRoOGZLW2YJxSLGyKo3gElxB7Btt6LQ4gpckFja70cQGJcEhqPm9H5SVTHz4ehMoU3i4wLP+y0iyp8C0HwDWpHJTty06ZJsLQulss4uXbkD7kAegvIiW6/DQfgS/yucN8rWyEUtcnDHZyV3E/889OUy0Ha/k88QV9Hp8Y16WwstgrsLnGqNxg526PegFy/u70gLIpJBib1BuMFy72i6BowL2jXAqLNraO3rB9w1lV2PxK4xxK4Z0/qjaEuM90ilC0PsEVPskREly5S0MCgeE8Z7ppzbwYmFgT6+iwcYCBODZ0iX8ktlmjubsYlR9gIKQUBcxRKCYExBAGptG7ayAFZ6T8W2AbLYN2NKG7VGpJzxruGzb1QUc/B2+40dOs8NW+EJxYkFlDVAJnNToJyN4GGEZeFlqpYAQEiAMYuezBrbhqkEgBrzEUrN0sk7p8qKFHQFZ23VGPzce1OadqmysKQqVeTKAo3oasIoWRbSrHViP/VaDMo1FBuEqci0UWo9jkqhwkyrGECDsFpwoRizPBKrYXBUsxrepJx0scnunDOrS4xZ7m/MMgSczVlW1LKDTMxZHia3VMFdkU80mGScXKoqpdW/1Gm4vC3+6GNys2YC3A9yzKk8jcbkinJIRVVr23gaHzbesYzloyZe6QOGysDCU8tpzIH9nhSTiYmNA5MnB1Nw1XKIBK//xa0+oyrC0irX1o+GqyGEeG6GaMZxwZ5Qte5kAohHn48tJbXGnlAdT2pk6wlVaQmswhNazYaqBiTLKtoMHDQnUseZSCCmC5xak9qd6/oP5HREE5+pumJAWZ9OT9Xkb0JZ5mUVPMYPj2lKXR7TVL54DN85ZzwmBkT1yGIWjxOi0PMZhcfEhKi+ua+2oxbPxBm6+3A5dybrxV3RNLg341ErO1l5oNV51MxX0GpPymE0eco6/CtAztIo8XHGQ6gUnU8U4t51U1kCAo79wHEKiH7Q1JHwMtMMDX3k4QNV8rnofSu6juf2wlxS40OZ65iuSmTaA1WVKLqslfQm7u0QbZRtfCeKHB0tzjT4EHqEUVuPMBjpEWhPEUlPMhGtqTvFAOgVF+ppiEH5jtOCqGM3VvqArlV54+Gp8wfyxevVzSQqS0jUUgnJONLvEX1x/F1y/j11Ylz/68fDH7O7h4mB3vyUJC8ePluvoAXtiK/23NlMBqsY20SXRyy9dHxMikvnxd7H9xcgkexuV08xcSuHA1+dl5BrljotwEpiOKqt2m7RUqePapLG64+LZ2SCG2Qf+uRVR5LSiU94Ly+BM4xRgzPcOVMn8ba5ZE2yurosjSg2UTuJlJi0MjD9Tek1QA+6KTQhOQKT1sOL5kYfbOqZgoPKnIF5JmDMLYxBCcY0I0vRaX7UAYHMpwf/UQCZVyADrdpVwBzFfA7pqK15CxQzR7ECJQ7ZmE+Xq2BjbnE8zRLheIIxn310ngSMeYWxCrhUjit76IwVAVu6vgAzt2AmRttZBiWay3JIu2LwORHK3S42e4RNAWZ+wQx1naRmGp5pw1QGxDOf+dMPtzd397fP6XRrgWleMW2ZUDKL00QNSsYNALoEWLqVoQZK6OCq/Vgh56FmYkGxNJ0D+B4FUHWWgZmeWV0wh+HES6a2yWfAQngWuCVJAEuzcwy1HHdjbZOZfAYshKuXYyCTEQseYMxnxGImYMwtjDVYjiDzgGQ+YxYir4d3PMtEAyONMkGJbVaPyaebLOr/7zvRw372nYW7E1MAuGxdYahEhiatnblCK6IYbgoALpoT7Zp6a9ek6kXPEeKxekOyBmzXpFg0dbLT+n6MdjMmIYNorWayzGVGrWYstbR0XBU+fUC/n5UGgmtUKXPWXNtiNdCCv8r4DwlAKHPmeLb4zKEQLUJ6Kx42DS47hFhGC+YTHUL4o76643qg3HuTyo4IrJxdO2bWjaC/nuhPjzp5FOjPolgRzNt34JYiotMbN1yWKWc1uIyvTm/ZnXPGZRt3LnisHx6zTKuU6EfhMcZqXCbUc8CL3Zdo5aX1ZSwyNwMHTK0oxw6dz8bK9IRy2YGNG0BJgSeV8+UEAjqRAJEqgRBAG2ZP7749HAeUvdsFEEjlprYCBv3CQFVqw2A4LqBlGgwZ5LD9RaroypygpI+1JcOUNJIH0CivrK4MN29ErrSV24z5HqnOcO0G0UPaBN4k7vUT2u42OuKF6+h8OZoyGL1+8aNvwYd1+zXC53Ye7Ca5Ced+lgbg7JAx5GwXrhNI6GOztHES+pW5d6Iv9pMnQl5gbgdRiD8CmJy9S32y5d+Ez9/jA6vFIqd578nzJoWB6jd9fCNakh16cD6i/qD+V8v2dtnt22udj26qwfM427SNlCWLLFukyUsME2takTN12qB6WszfGEwnAnwa5Gnt0/Ps9vFJpN9xnH6nk6mktAKoQ8oKGw2PotAxjNngv2N/ZRTSqhe0meTdnJXTPcXYMYhn2VV6QQHOrOLFC6qMOnWgiE9D4HN8fOp84RNU5uIvsuU6SG74soj+Vxbmn91wvb9sB3u1DEfvKFBVtZ7yR6cqIMvqoFV2reAyt7zczfKJBwAOn1k6S+/5xQkX67Ite8Y21AWmvkf1bGQOkCpTUM0y+R2C6r7fydodgAcK3iM6WSYa+eheptMejWrfWHKV/AiNxg4KtAjuLnCq2d4Oduj3oBcv7u9IQhA6UW0i1nQNGJe0b6KusDX2DWS6bxQhDIQw6FkYaGMLA0UIg0phoAlhwJswoOwbtsIA8tk4BgmDhbd9cVd73xECgW9gA6AW0wkshZJLANjCWhHioNI2UIQ8GHXbgOptw1gY8Nm1JhYGcXKAEAW8Y1onMK3R8gtpofQBUV3pNReyIOqDKWTBiPsG1tk3bKWBymcKCpIG+y1C2E8hDPgGtULoNzTPJ1tJoFYau0ISCKNgVEFgVu8ZxlKgTZ0pw8rSC2oDAnHqfnX9qMpXZooKTYESDlHSe35d/NGmg8eBrBIZMcrpOeIWME6dPxlkjrgKBdPxh2G1/xw8NhgGwDj5gWFAnD1Yzoy2KJhz0YmGDCv5DxV9KbIUysAeWlPDPqr49+EP7fr+38Gnuf63/Cd0vb9n0ynOKGHHnHnerJpqkvVsmuTzq0+nVxe4ts1YFB5w2YWftTI/05eeDxXDJPzO+AccY2fyfLxfjmokOKBIP38oMi8P2tx4C3sjJXR6CbzJvMEvpZ0dpHX4Vcv82UcHBPom4rwlbIENaxLg+dSJ1mBDSntO+kIqfbNhR+dNOdVzPt/Y744fCA7ptZcSjUOoOS/DtVHRKuM17b3COd/ykfL9/Kivqpr9ZdLaIGpmsHK2aFWTpgVh1E+h+psmiC6NbACIMYvNlejQ9f139HKavLj/M36rWcn+IZR0t6Xdy8oNj/ykZHJD9IsWa3uLdj9arbDTbyp+Vy8dBxrtbu4IvNiHoA9DStFK+1ijzaWGB5WhULClDbeXFS7N+GhUiX0yR9/FB/7x3YvXB53tBP+TQ6h7fNOJ+C1XsSgyr9OkZCtTZdxw7QK1SveWiOCKVB6u0jppzdLZhnA1kQBXuWlUsWnGnK2F53DjpnW02VqMNw23VZLuNgjt6BcI9YlnTAMIVNK6ADIlVMM2B04ThZLV2dBCGoy6c5ClUb1t2IoDXSmvsxi3MK5bXqs9Okbna3RMduecKRdRVr29EqNj+vIv6oQDxaA4F2kjkAf0n1hcAu/+j8+zi0bdWfcSBboFJZzjg6FMGU0Pdcmghc0H6ydqsoqbZ1PfjO5j36rSlQrBdtGuMZPd1VIe106MnSqq48lwmTejKleUTEciPzFQfhF+tDlpcBVbeLvo93qRPUdvWl8MW85ykVaqNyI73/kdzaZzt6vjp+eu/Sl4D3zPC6feNgIXzSLrJBuO+B+4C3wOO/BcB4akF91vtDHZyAajTrgbUFnRK/3W4wVBC4qycMFx6kjQDKS4qAS1UlzLbF1wejmtU7jgSBecaFY27s5RoYRLP/kJypjlgXDCCze2fl57dn3/+nlHHuYzxJcqF8E02G0KOYCX5xZh6Ywz5WpnHHXi3YAKbmUsbjRv3O3j00Uj77wdchaRY0TzxukUKA/nijOMUSRz5phr4pf7EFLZqiuVDciZVOYzRBHY7/FE2otmRabyWDGJQSkmZUYZ2/CYIaL83DEZ5qcaTMbZODF855wx2T7wBYn1RWLQJKuJLcq8ZRXSBi0OyGNtAqMjaWOC+6oZrbLwGAwT+qwRqZShQY4NT+42/SQB5T7Clkal/3wUXp0j/Ale7YtXoQSUIq8atJa4GqRGJYejVjy5jwK+YGdvOwU9PnmbpePHRcS+Y4cIINGv8qNiYjv+7853AidGuEutT8YHsmrh+6ubP64+3zYpzv5l+24cXYzHul+74bX9M/run1vvLbq1t7Ud3UAyd/0tvb24zHm3jyueEQ+vohP3QRzoRwecWvf66e5rhxt1ftuvu036hOt+WXRyXCz+vVGxuIy2Q1zr/ebGiFl5k4aV3g2/sJiG8RLDJH76blSLK7vBkIjIjiX4FrXltRhMkzUJFtsY0mrLoQKoBAZUMzs+AInxKUFFZsXZxIcNtSSgOcisMCsjeiKzIpoFLDIrRtw5AJKCgYPMCrxPheeTH+vfNMrW/5Ezrb7N/448zGdge+nsNt779KiSnLWm2f1c5Qix1LGmDXEKk79iWoiscJefYbXpaytIcVhSrB3YtjgLB+E754wUKWwYeygSP8Hz1cPNl6KvQlDf0NRHbbTFmPqqG221tkAQLcU+zthbOq/nHPR3r0F9l9VNrWsunXmDa8qeX+uq7u5n7atKZT/H09oJ8g5f75e7jB3B8/fyydV3k/pTntHz6/vx4Uujx9jgKSZ+4/pXR4+zwdVjwRe7Zn0nNkARrUdb/Sb2R9eDGma+m69Xj4+NPNIvMUTC1EGeoeCwXgu0QxL/fVRcN+i9pK7peHvZu50TM3Dphmo6re++f7l9uHuq//VtvXfCi0zEwYgOAjQXskprwTio/1gF2iiKcZpfgP+uM8ihbRW2KLzO9OfqGT24e9vIhdeHqSc4ZJw2cTtWd136gCZXFGqrhM+b+MBkmDptqxyuwemoU1kCU1+WqEp7pl5UOzYuQWVn3gceWKpO5LBalNJpBdd5FFy5Cpk206PyXt3jravyHtrBz+jeN0GkQSydSMGIjnuNotDN9ZqbNkpwC/9eo4B8U0tmAENmEDumseo7nD3S3vLp8HD2x3fKW7qVo70y9zZL6l6ptmEKMMqbLHTLcIIHJiS5QVmwvDBGYWu/xu8m+TfRHbbZMS2yVOqBNb30w3CXPuq5qmWbVrY8GZ5cWBhPeYGZlrpxZ08dF969W1qKQkxepvVAgbSpesAYygmnyqOkcfOw8u3NFlWu2y9KlUerfKMPj2rT3KC3KYo5+/ikSYx3YzrDZ/LhZyVSAUdfYL76H2Q3zllAKonSDyP0OEAa61R6aJA2Kst5sUccRuPUJ7UMrPOAmi78VLeAcgA/XkeCOh6EnBd1/tnt/dcffz3P7h6ea+vjx4LagmAaEoyqS7g9Op6GSKnkBorFtlRHlfnssn3Icn9+89H59RErkuJHINgm7mCtKGipeb3Z1EAmib2qXJl1JFLigXHKESNS4gffN0T+E9N8eHo9NXNbvFl4uo2ZXbDTeYBOm3h+LT347kH7z+rd/e/1p6vdf7b6dbiWnWntNiI4esaLFgxoWjDV0S0014aaqwYI01jFzTxGy7xUQXUNW4cCc/8QNgqSsErYIhvz7v6PvmM3D/ff2obpjl90dtsg7CL/o6SIL9bO4mf8xJ1d9FzzekJ2Un64sUhua1IiTXTOgaopYbIr5LfRrEYg4SKjAbYgn+VLByfHRTtHz7s1J5IgZHknpGizJkWmDNadUwV8ekKevt0LMHMMZhMW7TKFAmSmbWZVwGcN1eyrYGUugXyCgXVF0k2W2FWUFj6FHoNek0bR/nbJ9rUcEdyptrWcCp2Da3rfboVjOeqmLKmWnP0jQjOmIammZiBFJfkvoUUnP3mw5n0qHsfDGYOLoMyFBmWQ0lK0Mg2D4uJhG5PBMkbEZE7EZEwRkxlz2wCiNIq2bZiGZMwW2lO3iIzx8UIyHTQhpW63IlXpvVtRu3JBiJU3DPF0LPvRckHyA3qqWw1a/Zc92IK0ECZlQ5OyF04kWxTRhmAz9YcorFiRPgE7swCraq+bUWkbO/I8qZQaqVZrEmnWpIWXSLVS6Z1j2zTm/o/P/3q4e7qd3T00Ci/Wi1jmrt4szlgzeJm7fqN46+C1mEP1hiEN6YY/o1nBarE/DJOSO+78Xv2HdC2rKCGhCSRKSoUKdMmkOF+N0iyJ/sgJKkfJqXPj/q/uwtnG7YXijIGk7/06brvToDV75IPydntE1c7zxl00ALP9ElviNb/DDqOu8Scgf/LrkgZOcwexTNz5P+12hH97sH/Ff5a/I3kkWaOApqW2X+9unuPG/c83X/54/GeThBH3ZZJOIiDvaZOtXSxgtl5Y60HefP3xeDtrT265sz5MX31KzXEPpDNViJk0hkWbFAKVw6imQv2uPFwnDhUe93Z3Jp1UIzqMwUgAvA/i6v+4s1fgoCeL6CSWdwt351B6ks3t5AMxMtAOcf1M95TQX+m3rO0g+xlJ97LWTQXIrMXo4NPVw+fbp+c/b7/PfkSdAaaFwz8em03LEFttoK2m6hrZ9Z/akQyqdPE+lG+QmRnc2qJtEU09bt5+jLpqSBksT199zhK2YTmDd+FtX6ZItXACKfwdXpz7jlG7LdL/BiEllEfrhqgMRTygTYfwEbI4moxk/Oj9HHBqf/XQxdEajNNvh70QbCUD5Ul9GSiwWBeLnMlAfOOcpfkEQYjMoenCXhxcAReZrsmyjKpWgxEgQwk3nGFTSKUed/iNCcHHx6erp1uRL8xlvjCO9KpQskz5aA4lraCDDu8+Qr8nJz5TegJfHIAYmRcmUCXLKqw0kCltAGkzDZVeIhf0lYbM9TqgWnnNbipLsgyr1Lvo1b3ju+hXR8mrTSL5x9U8HtDYXn+DuAVNZSxfGS+Wf9K2GdBxnY0xjqZi2O42Ce/Hilkaws581vJ8725iJ/U+jKdM5wqX807vaEbKYWR1dNIh7pNebVKIUy3d6GNJzGextrdxM103eoXHXafxreQS+OsT7/r+EDVK3g7sV4fSuFf4n/vyP2d9pU4IYuo4DGswB9DxUuHO+2RQbTW/iMkSUvZpMopo6aKtE3q+6xAZOEg38+N9Zy8WvhdkGzXAOySwfyUXiJvFBzGY8QggvKVDJDCOasJiKw0WNdUP4VCs7Jg1d5M6lKqjVHoNOksdDOb3ouDxEIP7eYYvgj7YRykT8UynOq3zX5P2Gv3mVAXLJvlNdedspekPDe5W5Er1Y26Q7S8UnZa2cCxVarg9WOk26a75uXG6Qm772fF9ldC6sd8dPziC8FQzy9Q9JI68fSxS0IUDN9Et39ZOhJON56VZWYlmiR6VHcnT09rah4HzMCIGyERijkqL11F76g9WRVSj9K4ruuP/RFk1CRJf3NU+W+Ai8hNEOkGAnrFrbxKTws8+1ljufLu6+XL3/XYAKTG7e3x6+CFkxPibysJ5rJnSRpEZKk1pG2xLDTptyonZOgiSOTeJVbH23iYnkl5TtwxS5pwp2mThNDY1ps72lwArYwkAcFA603Eo49FUkLX96huw1Poa2tiDo0srVy8t5dkVx0dGJ+VjGkceI+VhH49QQLIWjWK8UWvRhnqqNLXx7J4qWfUcDfij1C/QOkIO9mBp7T/P7sHKxIMFQKY8Vkp69mCPlZaZfX6Plai3MSCFX1mClaZen9tTBWpprCfUqXVMPT1a9NL3Ir0ne+8zehDrb97Sic74fw==</diagram></mxfile>" style="background-color: rgb(255, 255, 255);"><defs><style type="text/css">@import url(https://fonts.googleapis.com/css?family=Liberation+Sans);
</style></defs><g><rect x="9428" y="2640" width="1120" height="600" rx="90" ry="90" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><path d="M 8868 3120.57 Q 8656.57 3120.57 8656.57 1980.33" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 8656.57 1959.33 L 8665.9 1987.33 L 8656.57 1980.33 L 8647.24 1987.33 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 9228 3600 Q 9228 3760.57 9608 3760.57 Q 9988 3760.57 9988 3280.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9988 3253.42 L 10006 3289.42 L 9988 3280.42 L 9970 3289.42 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="8868" y="2640" width="480" height="960" rx="72" ry="72" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><rect x="2868" y="2640" width="1080" height="960" rx="144" ry="144" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><rect x="1082" y="840" width="1080" height="440" rx="66" ry="66" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><rect x="2148" y="2640" width="560" height="960" rx="84" ry="84" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><path d="M 4928 160 L 4928 360" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 4928.57 160 L 4928.57 200.57 Q 4928.57 240.57 4888.57 240.57 L 1662.29 240.57 Q 1622.29 240.57 1622.19 280.57 L 1622.06 334.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 1622.01 355.53 L 1608.08 327.49 L 1622.06 334.53 L 1636.08 327.56 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 4928.57 160 L 4928.57 200.57 Q 4928.57 240.57 4968.57 240.57 L 5808.57 240.57 Q 5848.57 240.57 5848.38 280.57 L 5848.12 334.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5848.02 355.53 L 5834.16 327.46 L 5848.12 334.53 L 5862.16 327.6 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 4928.57 160 L 4928.57 200.57 Q 4928.57 240.57 4968.57 240.57 L 7273.71 240.57 Q 7313.71 240.57 7313.81 280.57 L 7313.94 334.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7313.99 355.53 L 7299.92 327.56 L 7313.94 334.53 L 7327.92 327.49 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 4928.57 160 L 4928.57 200.57 Q 4928.57 240.57 4888.57 240.57 L 2620 240.57 Q 2580 240.57 2580.01 280.57 L 2580.02 334.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 2580.02 355.53 L 2566.01 327.53 L 2580.02 334.53 L 2594.01 327.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="4788" y="0" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 20px; margin-left: 1198px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">tmp</font></div></div></div></foreignObject><text x="1232" y="24" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">tmp</text></switch></g><path d="M 4928 520 L 4928 1040" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><rect x="4788" y="360" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 110px; margin-left: 1198px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">work</font></div></div></div></foreignObject><text x="1232" y="114" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">work</text></switch></g><path d="M 4928 1200 L 4928.29 1240.57 Q 4928.57 1280.57 4968.57 1280.57 L 5648.57 1280.57 Q 5688.57 1280.57 5688.57 1320.29 L 5688.57 1360" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 4928 1200 L 4928.29 1240.57 Q 4928.57 1280.57 4888.57 1280.57 L 3156 1280.57 Q 3116 1280.57 3115.98 1320.29 L 3115.96 1360" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 4588 1120 Q 4398.29 1120.57 4398.24 1334.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 4398.24 1355.53 L 4388.91 1327.53 L 4398.24 1334.53 L 4407.58 1327.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="4588" y="1040" width="680" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 168px; height: 1px; padding-top: 280px; margin-left: 1148px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter"><b>${MULTIMACH_TARGET_OS}</b></font></div></div></div></foreignObject><text x="1232" y="284" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">${MULTIMACH_TARGET_OS}</text></switch></g><path d="M 3115.96 1520 L 3116 1680" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><rect x="2975.96" y="1360" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 360px; margin-left: 745px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">libhello</font></div></div></div></foreignObject><text x="779" y="364" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello</text></switch></g><path d="M 5688.57 1520 L 5688.57 1560.57 Q 5688.57 1600.57 5688.57 1570.29 L 5688.57 1555.14 Q 5688.57 1540 5688.29 1580 L 5688 1620" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><rect x="5548" y="1360" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 360px; margin-left: 1388px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">sayhello</font></div></div></div></foreignObject><text x="1422" y="364" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello</text></switch></g><path d="M 3116 1840 L 3116 1960.57 Q 3116 2000.57 3076 2000.57 L 2036 2000.57 Q 1996 2000.57 1996 2040.57 L 1996 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 1996 2155.53 L 1986.67 2127.53 L 1996 2134.53 L 2005.33 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 3116 1840 L 3116 1960.57 Q 3116 2000.57 3076 2000.57 L 2468 2000.57 Q 2428 2000.57 2428 2040.57 L 2428 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 2428 2155.53 L 2418.67 2127.53 L 2428 2134.53 L 2437.33 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 3116 1840 L 3115.96 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3115.96 2155.53 L 3101.96 2127.53 L 3115.96 2134.53 L 3129.96 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 3116 1840 L 3116 1960.57 Q 3116 2000.57 3156 2000.57 L 4268 2000.57 Q 4308 2000.57 4308 2040.57 L 4308 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 4308 2155.53 L 4294 2127.53 L 4308 2134.53 L 4322 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 3116 1840 L 3116 1960.57 Q 3116 2000.57 3076 2000.57 L 1508 2000.57 Q 1468 2000.57 1468 2040.57 L 1468 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 1468 2155.53 L 1458.67 2127.53 L 1468 2134.53 L 1477.33 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="2976" y="1680" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 440px; margin-left: 745px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">0.1-r0</font></div></div></div></foreignObject><text x="779" y="444" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">0.1-r0</text></switch></g><path d="M 5688.57 1780 L 5688.57 1960.57 Q 5688.57 2000.57 5648.57 2000.57 L 5568.57 2000.57 Q 5528.57 2000.57 5528.43 2040.57 L 5528.09 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5528.02 2155.53 L 5514.12 2127.48 L 5528.09 2134.53 L 5542.12 2127.58 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5688.57 1780 L 5688.57 1960.57 Q 5688.57 2000.57 5728.57 2000.57 L 6988 2000.57 Q 7028 2000.57 7028 2040.57 L 7028 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7028 2155.53 L 7014 2127.53 L 7028 2134.53 L 7042 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5688.57 1780 L 5688.57 1960.57 Q 5688.57 2000.57 5728.57 2000.57 L 7676 2000.57 Q 7716 2000.57 7715.99 2040.57 L 7715.97 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7715.96 2155.53 L 7701.97 2127.52 L 7715.97 2134.53 L 7729.97 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5688.57 1780 L 5688.57 1960.57 Q 5688.57 2000.57 5728.57 2000.57 L 8313.71 2000.57 Q 8353.71 2000.57 8353.79 2040.57 L 8353.95 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 8353.99 2155.53 L 8339.94 2127.55 L 8353.95 2134.53 L 8367.94 2127.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5688.57 1780 L 5688.57 1960.57 Q 5688.57 2000.57 5728.57 2000.57 L 9068 2000.57 Q 9108 2000.57 9108 2040.57 L 9108 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9108 2155.53 L 9094 2127.53 L 9108 2134.53 L 9122 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5688.57 1780 L 5688.57 1960.57 Q 5688.57 2000.57 5728.57 2000.57 L 9948 2000.57 Q 9988 2000.57 9988 2040.57 L 9988 2134.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9988 2155.53 L 9974 2127.53 L 9988 2134.53 L 10002 2127.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5548" y="1620" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 425px; margin-left: 1388px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">0.1-r0</font></div></div></div></foreignObject><text x="1422" y="429" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">0.1-r0</text></switch></g><path d="M 1622.29 520 L 1622.29 560.57 Q 1622.29 600.57 1622.29 560.57 L 1622.29 540.57 Q 1622.29 520.57 1622.29 560.29 L 1622.29 600" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 1762 440 Q 2215.43 440.57 2215.04 205.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 2215.01 184.47 L 2224.39 212.46 L 2215.04 205.47 L 2205.72 212.49 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="1482" y="360" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 110px; margin-left: 371px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">downloads</font></div></div></div></foreignObject><text x="405" y="114" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">downloads</text></switch></g><path d="M 1622 760 L 1622.14 800.57 Q 1622.29 840.57 1622.29 800.57 L 1622.29 780.57 Q 1622.29 760.57 1622.29 800.29 L 1622.29 840" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><rect x="1482" y="600" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 170px; margin-left: 371px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">git2</font></div></div></div></foreignObject><text x="405" y="174" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">git2</text></switch></g><path d="M 2082 1160 L 2628 1160.53 Q 2668 1160.57 2668 1200.57 L 2668 2200.57 Q 2668 2240.57 2628 2240.41 L 2568.42 2240.16" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 2541.42 2240.05 L 2577.49 2222.2 L 2568.42 2240.16 L 2577.34 2258.2 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="1162" y="880" width="920" height="160" rx="24" ry="24" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 228px; height: 1px; padding-top: 240px; margin-left: 291px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">github.com.<username>.sayhello</div></div></div></foreignObject><text x="405" y="244" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">github.com.<username>.sayhello</text></switch></g><path d="M 2082 960 L 6628 960.57 Q 6668 960.57 6668 1000.57 L 6668 2200.57 Q 6668 2240.57 6708 2240.48 L 6887.58 2240.09" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 6914.58 2240.03 L 6878.62 2258.11 L 6887.58 2240.09 L 6878.54 2222.11 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="1162" y="1080" width="920" height="160" rx="24" ry="24" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 228px; height: 1px; padding-top: 290px; margin-left: 291px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">github.com.<username>.libhello</div></div></div></foreignObject><text x="405" y="294" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">github.com.<username>.libhello</text></switch></g><path d="M 2428 2320 Q 2428 2320 2428 2614.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 2428 2635.53 L 2414 2607.53 L 2428 2614.53 L 2442 2607.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="2328" y="2160" width="200" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 48px; height: 1px; padding-top: 560px; margin-left: 583px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">git</font></div></div></div></foreignObject><text x="607" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">git</text></switch></g><rect x="2212" y="2720" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 690px; margin-left: 554px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Makefile</div></div></div></foreignObject><text x="610" y="694" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">Makefile</text></switch></g><path d="M 2212 2880.57 L 2117.14 2880.57 Q 2077.14 2880.57 2077.14 2840.57 L 2077.14 2714.86 Q 2077.14 2674.86 2037.14 2674.9 L 1966.47 2674.97" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 1945.47 2675 L 1973.46 2665.63 L 1966.47 2674.97 L 1973.48 2684.3 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="2212" y="2840" width="456" height="80" rx="12" ry="12" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 720px; margin-left: 554px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">LICENSE</div></div></div></foreignObject><text x="610" y="724" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">LICENSE</text></switch></g><path d="M 2212 3000 Q 2028 3000.57 2028 3060.57 Q 2028 3120.57 2171.58 3120.13" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 2198.58 3120.04 L 2162.62 3132.15 L 2171.58 3120.13 L 2162.55 3108.15 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="2212" y="2960" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 750px; margin-left: 554px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">fix.patch</div></div></div></foreignObject><text x="610" y="754" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">fix.patch</text></switch></g><path d="M 2214.74 3151.44 Q 1988 3151.43 1988 3278.29 Q 1988 3405.14 2179.58 3405.02" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 2206.58 3405.01 L 2170.6 3423.03 L 2179.58 3405.02 L 2170.57 3387.03 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="2212" y="3080" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 780px; margin-left: 554px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">hellolib.c</div></div></div></foreignObject><text x="610" y="784" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">hellolib.c</text></switch></g><rect x="1896" y="2160" width="200" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 48px; height: 1px; padding-top: 560px; margin-left: 475px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">temp</font></div></div></div></foreignObject><text x="499" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">temp</text></switch></g><path d="M 4308 2320 L 4308 2640" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><rect x="4068" y="2160" width="480" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 560px; margin-left: 1018px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">sysroot-destdir</font></div></div></div></foreignObject><text x="1077" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sysroot-destdir</text></switch></g><path d="M 5528 2320 L 5528 2614.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5528 2635.53 L 5518.67 2607.53 L 5528 2614.53 L 5537.33 2607.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5308" y="2160" width="440" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 108px; height: 1px; padding-top: 560px; margin-left: 1328px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">recipe-sysroot</font></div></div></div></foreignObject><text x="1382" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">recipe-sysroot</text></switch></g><path d="M 3116 2320 L 3116 2694.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3116 2715.53 L 3106.67 2687.53 L 3116 2694.53 L 3125.33 2687.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="2989.96" y="2160" width="252" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 560px; margin-left: 748px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">image</font></div></div></div></foreignObject><text x="779" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">image</text></switch></g><path d="M 3116 2880 L 3116 2920.57 Q 3116 2960.57 3115.99 2987.55 L 3115.99 3014.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3115.98 3035.53 L 3106.65 3007.53 L 3115.99 3014.53 L 3125.32 3007.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 3116 2880 Q 3116 2960.57 3354.86 2960.57 Q 3593.71 2960.57 3593.91 3014.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3593.98 3035.53 L 3584.55 3007.56 L 3593.91 3014.53 L 3603.22 3007.49 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="3029" y="2720" width="174" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 42px; height: 1px; padding-top: 700px; margin-left: 758px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">usr</font></div></div></div></foreignObject><text x="779" y="704" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">usr</text></switch></g><path d="M 3115.98 3200 L 3116 3294.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3116 3315.53 L 3106.66 3287.53 L 3116 3294.53 L 3125.33 3287.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="3008.48" y="3040" width="215" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 52px; height: 1px; padding-top: 780px; margin-left: 753px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">include</font></div></div></div></foreignObject><text x="779" y="784" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">include</text></switch></g><path d="M 3593.71 3200 L 3593.71 3240.57 Q 3593.71 3280.57 3593.76 3287.55 L 3593.82 3294.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3593.97 3315.53 L 3579.77 3287.63 L 3593.82 3294.53 L 3607.76 3287.43 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="3507" y="3040" width="174" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 42px; height: 1px; padding-top: 780px; margin-left: 878px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">lib</font></div></div></div></foreignObject><text x="899" y="784" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">lib</text></switch></g><rect x="2956" y="3320" width="320" height="100" rx="15" ry="15" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 843px; margin-left: 740px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">hellolib.h</div></div></div></foreignObject><text x="779" y="846" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">hellolib.h</text></switch></g><rect x="3348" y="3350" width="480" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 848px; margin-left: 838px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">libhello.so.1</div></div></div></foreignObject><text x="897" y="851" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello.so.1</text></switch></g><rect x="3348" y="3450" width="480" height="100" rx="15" ry="15" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 875px; margin-left: 838px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">libhello.so.1.0</div></div></div></foreignObject><text x="897" y="879" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello.so.1.0</text></switch></g><rect x="3320" y="3320" width="548" height="250" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><path d="M 4428 3600 Q 4428 3760.57 4978.29 3760.57 Q 5528.57 3760.57 5528.14 3640.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5528.05 3613.42 L 5546.18 3649.35 L 5528.14 3640.42 L 5510.18 3649.48 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="4068" y="2640" width="480" height="960" rx="72" ry="72" fill="#eeeeee" stroke="#36393d" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 780px; margin-left: 1018px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Everything in <b>image</b> folder that is present in <b>SYSROOT_DIRS</b> will be copied here.</div></div></div></foreignObject><text x="1077" y="784" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">Everything in image...</text></switch></g><path d="M 3678 3600 Q 3678.29 3760.57 3993.14 3760.57 Q 4308 3760.57 4308 3640.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 4308 3613.42 L 4326 3649.42 L 4308 3640.42 L 4290 3649.42 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><path d="M 2428 3600 Q 2428 3760.57 2941.14 3760.57 Q 3454.29 3760.57 3454.4 3639.46" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 3454.43 3612.46 L 3472.39 3648.47 L 3454.4 3639.46 L 3436.39 3648.44 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="2748" y="3680" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 935px; margin-left: 732px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_install</font></div></div></div></foreignObject><text x="732" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_install</text></switch></g><rect x="2220" y="3350" width="456" height="110" rx="16.5" ry="16.5" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 851px; margin-left: 556px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">libhello.so.1.0</div></div></div></foreignObject><text x="612" y="855" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello.so.1.0</text></switch></g><rect x="1668" y="3180" width="440" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 810px; margin-left: 472px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_configure<br /></font></div></div></div></foreignObject><text x="472" y="814" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_configure
</text></switch></g><rect x="2212" y="3200" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 810px; margin-left: 554px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">hellolib.h</div></div></div></foreignObject><text x="610" y="814" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">hellolib.h</text></switch></g><rect x="1788" y="3000" width="320" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 765px; margin-left: 487px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_patch<br /></font></div></div></div></foreignObject><text x="487" y="769" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_patch
</text></switch></g><rect x="2494" y="1620" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 420px; margin-left: 669px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_unpack<br /></font></div></div></div></foreignObject><text x="669" y="424" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_unpack
</text></switch></g><ellipse cx="2434" cy="1680" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 420px; margin-left: 595px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">6</b></font></div></div></div></foreignObject><text x="609" y="424" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">6</text></switch></g><ellipse cx="1728" cy="3060" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 765px; margin-left: 418px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">7</b></font></div></div></div></foreignObject><text x="432" y="769" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">7</text></switch></g><ellipse cx="1608" cy="3240" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 810px; margin-left: 388px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">8</b></font></div></div></div></foreignObject><text x="402" y="814" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">8</text></switch></g><rect x="1748" y="3310" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 843px; margin-left: 482px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_compile<br /></font></div></div></div></foreignObject><text x="482" y="846" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_compile
</text></switch></g><ellipse cx="1688" cy="3370" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 843px; margin-left: 408px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">9</b></font></div></div></div></foreignObject><text x="422" y="846" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">9</text></switch></g><ellipse cx="2688" cy="3740" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 935px; margin-left: 658px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">10</b></font></div></div></div></foreignObject><text x="672" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">10</text></switch></g><rect x="3728" y="3680" width="640" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 935px; margin-left: 1012px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_populate_sysroot</font></div></div></div></foreignObject><text x="1012" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_populate_sysroot</text></switch></g><ellipse cx="3668" cy="3740" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 935px; margin-left: 903px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">11</b></font></div></div></div></foreignObject><text x="917" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">11</text></switch></g><path d="M 7028 3280 Q 7028 3760.57 7372 3760.57 Q 7716 3760.57 7715.97 3640.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7715.96 3613.42 L 7733.97 3649.41 L 7715.97 3640.42 L 7697.97 3649.42 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="6748" y="2640" width="560" height="640" rx="84" ry="84" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><path d="M 7028 2320 Q 7028 2320 7028 2614.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7028 2635.53 L 7014 2607.53 L 7028 2614.53 L 7042 2607.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="6928" y="2160" width="200" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 48px; height: 1px; padding-top: 560px; margin-left: 1733px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">git</font></div></div></div></foreignObject><text x="1757" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">git</text></switch></g><rect x="6800" y="2720" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 690px; margin-left: 1701px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Makefile</div></div></div></foreignObject><text x="1757" y="694" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">Makefile</text></switch></g><rect x="6800" y="2840" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 720px; margin-left: 1701px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">LICENSE</div></div></div></foreignObject><text x="1757" y="724" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">LICENSE</text></switch></g><path d="M 6800 3000 Q 6588 3000.57 6588 3088 Q 6588 3175.43 6759.58 3175.08" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 6786.58 3175.03 L 6750.62 3193.1 L 6759.58 3175.08 L 6750.55 3157.1 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="6800" y="2960" width="456" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 750px; margin-left: 1701px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">sayhello.c</div></div></div></foreignObject><text x="1757" y="754" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello.c</text></switch></g><rect x="6800" y="3120" width="456" height="110" rx="16.5" ry="16.5" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 112px; height: 1px; padding-top: 794px; margin-left: 1701px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">sayhello</div></div></div></foreignObject><text x="1757" y="797" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello</text></switch></g><path d="M 7835.96 3600 Q 7828 3760.57 8090.86 3760.57 Q 8353.71 3760.57 8353.94 3640.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 8353.99 3613.42 L 8371.93 3649.45 L 8353.94 3640.42 L 8335.93 3649.38 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="7475.96" y="2640" width="480" height="960" rx="72" ry="72" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><path d="M 7715.96 2320 L 7715.96 2614.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7715.96 2635.53 L 7706.63 2607.53 L 7715.96 2614.53 L 7725.29 2607.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7589.96" y="2160" width="252" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 560px; margin-left: 1898px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">image</font></div></div></div></foreignObject><text x="1929" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">image</text></switch></g><path d="M 7716 2880 L 7716 2940 Q 7716 2980 7716.01 3017.26 L 7716.01 3054.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7716.02 3075.53 L 7706.68 3047.53 L 7716.01 3054.53 L 7725.35 3047.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7629" y="2720" width="174" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 42px; height: 1px; padding-top: 700px; margin-left: 1908px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">usr</font></div></div></div></foreignObject><text x="1929" y="704" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">usr</text></switch></g><path d="M 7716.02 3240 L 7716 3394.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7716 3415.53 L 7706.67 3387.53 L 7716 3394.53 L 7725.34 3387.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7608.52" y="3080" width="215" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 52px; height: 1px; padding-top: 790px; margin-left: 1903px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">bin</font></div></div></div></foreignObject><text x="1929" y="794" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">bin</text></switch></g><rect x="1268" y="2160" width="400" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 560px; margin-left: 318px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">libhello-0.1</font></div></div></div></foreignObject><text x="367" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello-0.1</text></switch></g><path d="M 1241 2160 Q 1241.71 2220 1245.14 2050.29 Q 1248.57 1880.57 1785.14 1880.57 Q 2321.71 1880.57 2321.08 2127.06" fill="none" stroke="#000000" stroke-width="8" stroke-miterlimit="10" stroke-dasharray="8 16" pointer-events="stroke"/><path d="M 2321.02 2151.06 L 2310.44 2119.03 L 2321.08 2127.06 L 2331.77 2119.08 Z" fill="#000000" stroke="#000000" stroke-width="8" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 472px; margin-left: 435px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); border-color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 11px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); border: 1px solid rgb(0, 0, 0); white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" style="font-size: 14px;">S = "${WORKDIR}/git"</font></div></div></div></foreignObject><text x="435" y="475" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="11px" text-anchor="middle">S = "${WORKDIR}/git"</text></switch></g><rect x="3203" y="1620" width="252" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 418px; margin-left: 802px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">WORKDIR</font></div></div></div></foreignObject><text x="832" y="421" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">WORKDIR</text></switch></g><rect x="2923" y="2160" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 553px; margin-left: 732px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">D</font></div></div></div></foreignObject><text x="744" y="556" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">D</text></switch></g><rect x="2268" y="2160" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 553px; margin-left: 568px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">S</font></div></div></div></foreignObject><text x="580" y="556" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">S</text></switch></g><rect x="2162" y="2160" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 553px; margin-left: 542px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">B</font></div></div></div></foreignObject><text x="554" y="556" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">B</text></switch></g><rect x="1188" y="2160" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 553px; margin-left: 298px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">S</font></div></div></div></foreignObject><text x="310" y="556" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">S</text></switch></g><rect x="1835" y="2160" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 553px; margin-left: 460px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">T</font></div></div></div></foreignObject><text x="472" y="556" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">T</text></switch></g><rect x="3628" y="3160" width="200" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 48px; height: 1px; padding-top: 803px; margin-left: 908px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">libdir</font></div></div></div></foreignObject><text x="932" y="806" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">libdir</text></switch></g><rect x="3135" y="3160" width="320" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 803px; margin-left: 785px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">includedir</font></div></div></div></foreignObject><text x="824" y="806" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">includedir</text></switch></g><rect x="5603.48" y="2280" width="464.52" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 114px; height: 1px; padding-top: 583px; margin-left: 1402px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">RECIPE_SYSROOT</font></div></div></div></foreignObject><text x="1459" y="586" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">RECIPE_SYSROOT</text></switch></g><path d="M 7226.86 2260 Q 7226.86 2110.29 7197.14 2110.29 Q 7167.43 2110.29 7167.49 1985.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 7167.5 1964.47 L 7176.82 1992.48 L 7167.49 1985.47 L 7158.15 1992.47 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7174" y="2260" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 578px; margin-left: 1795px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">S</font></div></div></div></foreignObject><text x="1807" y="581" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">S</text></switch></g><rect x="7068" y="2260" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 578px; margin-left: 1768px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">B</font></div></div></div></foreignObject><text x="1780" y="581" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">B</text></switch></g><rect x="7803" y="2260" width="106" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 24px; height: 1px; padding-top: 578px; margin-left: 1952px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">D</font></div></div></div></foreignObject><text x="1964" y="581" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">D</text></switch></g><rect x="5788" y="1580" width="252" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 408px; margin-left: 1448px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">WORKDIR</font></div></div></div></foreignObject><text x="1479" y="411" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">WORKDIR</text></switch></g><rect x="4640" y="3680" width="800" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 935px; margin-left: 1260px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_prepare_recipe_sysroot</font></div></div></div></foreignObject><text x="1260" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_prepare_recipe_sysroot</text></switch></g><rect x="7536" y="3420" width="360" height="110" rx="16.5" ry="16.5" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 869px; margin-left: 1885px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">sayhello</div></div></div></foreignObject><text x="1929" y="872" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello</text></switch></g><rect x="4988" y="2640" width="1080" height="960" rx="144" ry="144" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><path d="M 5236 2880 Q 5236 2960.57 5235.99 3014.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5235.98 3035.53 L 5226.65 3007.53 L 5235.99 3014.53 L 5245.32 3007.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5236 2880 Q 5236 2960.57 5474.86 2960.57 Q 5713.71 2960.57 5713.91 3014.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5713.98 3035.53 L 5704.55 3007.56 L 5713.91 3014.53 L 5723.22 3007.49 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5149" y="2720" width="174" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 42px; height: 1px; padding-top: 700px; margin-left: 1288px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">usr</font></div></div></div></foreignObject><text x="1309" y="704" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">usr</text></switch></g><path d="M 5235.98 3200 L 5236 3294.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5236 3315.53 L 5226.66 3287.53 L 5236 3294.53 L 5245.33 3287.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5128.48" y="3040" width="215" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 52px; height: 1px; padding-top: 780px; margin-left: 1283px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">include</font></div></div></div></foreignObject><text x="1309" y="784" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">include</text></switch></g><path d="M 5713.71 3200 L 5713.71 3240.57 Q 5713.71 3280.57 5713.76 3287.55 L 5713.82 3294.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5713.97 3315.53 L 5704.43 3287.6 L 5713.82 3294.53 L 5723.1 3287.46 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5627" y="3040" width="174" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 42px; height: 1px; padding-top: 780px; margin-left: 1408px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">lib</font></div></div></div></foreignObject><text x="1429" y="784" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">lib</text></switch></g><rect x="5076" y="3320" width="320" height="100" rx="15" ry="15" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 843px; margin-left: 1270px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">hellolib.h</div></div></div></foreignObject><text x="1309" y="846" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">hellolib.h</text></switch></g><rect x="5468" y="3350" width="480" height="80" rx="12" ry="12" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 848px; margin-left: 1368px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">libhello.so.1</div></div></div></foreignObject><text x="1427" y="851" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello.so.1</text></switch></g><rect x="5468" y="3450" width="480" height="100" rx="15" ry="15" fill="#f5f5f5" stroke="#666666" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 875px; margin-left: 1368px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">libhello.so.1.0</div></div></div></foreignObject><text x="1427" y="879" fill="#333333" font-family="Liberation Sans" font-size="12px" text-anchor="middle">libhello.so.1.0</text></switch></g><rect x="5440" y="3320" width="548" height="250" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><rect x="3880" y="1680" width="1560" height="280" fill="none" stroke="#36393d" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 455px; margin-left: 1165px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" style="font-size: 15px;">This also contains other files from other <br />dependencies. Default dependencies are:<br />basically <b style=""><u>gcc</u></b>, <b style=""><u>compilerlibs</u></b> and <b style=""><u style="">libc</u></b></font></div></div></div></foreignObject><text x="1165" y="459" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This also contains other files from other...</text></switch></g><rect x="4368" y="2280" width="510" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 126px; height: 1px; padding-top: 583px; margin-left: 1093px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">SYSROOT_DESTDIR</font></div></div></div></foreignObject><text x="1156" y="586" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">SYSROOT_DESTDIR</text></switch></g><path d="M 330 960 L 1121.58 960" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 1148.58 960 L 1112.58 978 L 1121.58 960 L 1112.58 942 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><path d="M 330 1160 L 1121.58 1160" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 1148.58 1160 L 1112.58 1178 L 1121.58 1160 L 1112.58 1142 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="2" y="860" width="328" height="400" rx="49.2" ry="49.2" fill="#000000" stroke="#23445d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 80px; height: 1px; padding-top: 265px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font color="#fcfcfc">Github</font></div></div></div></foreignObject><text x="41" y="269" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">Github</text></switch></g><rect x="535" y="900" width="320" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 240px; margin-left: 174px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_fetch<br /></font></div></div></div></foreignObject><text x="174" y="244" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_fetch
</text></switch></g><ellipse cx="475" cy="960" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 240px; margin-left: 105px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">1</b></font></div></div></div></foreignObject><text x="119" y="244" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">1</text></switch></g><rect x="535" y="1100" width="320" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 290px; margin-left: 174px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_fetch<br /></font></div></div></div></foreignObject><text x="174" y="294" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_fetch
</text></switch></g><ellipse cx="475" cy="1160" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 290px; margin-left: 105px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">5</b></font></div></div></div></foreignObject><text x="119" y="294" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">5</text></switch></g><rect x="6228" y="2980" width="440" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 760px; margin-left: 1612px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_configure<br /></font></div></div></div></foreignObject><text x="1612" y="764" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_configure
</text></switch></g><ellipse cx="6168" cy="3040" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 760px; margin-left: 1528px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">12</b></font></div></div></div></foreignObject><text x="1542" y="764" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">12</text></switch></g><rect x="6308" y="3110" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 793px; margin-left: 1622px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_compile<br /></font></div></div></div></foreignObject><text x="1622" y="796" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_compile
</text></switch></g><ellipse cx="6248" cy="3170" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 793px; margin-left: 1548px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">13</b></font></div></div></div></foreignObject><text x="1562" y="796" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">13</text></switch></g><rect x="2508" y="900" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 240px; margin-left: 672px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_unpack<br /></font></div></div></div></foreignObject><text x="672" y="244" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_unpack
</text></switch></g><ellipse cx="2448" cy="960" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 240px; margin-left: 598px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">2</b></font></div></div></div></foreignObject><text x="612" y="244" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">2</text></switch></g><path d="M 5848.57 520 Q 5848.57 600.57 5849.05 594.61" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5847.36 615.54 L 5835.66 586.51 L 5849.05 594.61 L 5863.57 588.76 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5848.57 520 Q 5848.57 560.57 5593.14 560.57 Q 5337.71 560.57 5337.31 594.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 5337.05 615.53 L 5323.39 587.36 L 5337.31 594.53 L 5351.39 587.7 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 5848.57 520 Q 5848.57 560.57 6108.57 560.57 Q 6368.57 560.57 6368.24 594.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 6368.04 615.53 L 6354.31 587.39 L 6368.24 594.53 L 6382.31 587.66 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5708" y="360" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 110px; margin-left: 1428px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">conf</font></div></div></div></foreignObject><text x="1462" y="114" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">conf</text></switch></g><path d="M 5149 660 Q 5108 660 5108 510.29 Q 5108 360.57 5252 360.57 Q 5396 360.57 5396 205.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 5396 184.47 L 5405.33 212.47 L 5396 205.47 L 5386.67 212.47 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5149" y="620" width="376" height="80" rx="12" ry="12" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 92px; height: 1px; padding-top: 165px; margin-left: 1288px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">local.conf</div></div></div></foreignObject><text x="1334" y="169" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">local.conf</text></switch></g><path d="M 5847.43 700 Q 5847.43 860 6048 860 Q 6248.57 860 6248.09 994.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 6248.02 1015.53 L 6238.78 987.49 L 6248.09 994.53 L 6257.45 987.56 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="5627" y="620" width="440" height="80" rx="12" ry="12" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 108px; height: 1px; padding-top: 165px; margin-left: 1408px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">bblayers.conf</div></div></div></foreignObject><text x="1462" y="169" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">bblayers.conf</text></switch></g><rect x="6707" y="1360" width="921" height="600" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 228px; height: 1px; padding-top: 415px; margin-left: 1678px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;"><b><u>S</u></b> defaults generally to <b><u>${WORKDIR}/${BPN}-${PV}</u></b><br />In <b>git</b> recipes change it to <b><u>${WORKDIR}/git</u></b></font></div></div></div></foreignObject><text x="1792" y="419" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">S defaults generally to ${WORKDIR}/${B...</text></switch></g><rect x="6228" y="2700" width="440" height="160" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 695px; margin-left: 1612px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_patch<br /><i>(No patches)</i><br /></font></div></div></div></foreignObject><text x="1612" y="699" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_patch...</text></switch></g><ellipse cx="6168" cy="2780" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 695px; margin-left: 1528px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">3</b></font></div></div></div></foreignObject><text x="1542" y="699" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">3</text></switch></g><ellipse cx="4580" cy="3740" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 935px; margin-left: 1131px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">4</b></font></div></div></div></foreignObject><text x="1145" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">4</text></switch></g><rect x="6927" y="3560" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 905px; margin-left: 1777px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_install<br /></font></div></div></div></foreignObject><text x="1777" y="909" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_install
</text></switch></g><ellipse cx="6868" cy="3620" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 905px; margin-left: 1703px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">14</b></font></div></div></div></foreignObject><text x="1717" y="909" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">14</text></switch></g><path d="M 8354.02 2320 L 8354.02 2614.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 8354.02 2635.53 L 8344.69 2607.53 L 8354.02 2614.53 L 8363.35 2607.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="8228" y="2160" width="252" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 560px; margin-left: 2058px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">package</font></div></div></div></foreignObject><text x="2089" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">package</text></switch></g><rect x="8441.04" y="2260" width="146.96" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 35px; height: 1px; padding-top: 578px; margin-left: 2111px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">PKGD</font></div></div></div></foreignObject><text x="2129" y="581" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">PKGD</text></switch></g><path d="M 8461.77 3600 Q 8461.14 3760.57 8784.57 3760.57 Q 9108 3760.57 9108 3640.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9108 3613.42 L 9126 3649.42 L 9108 3640.42 L 9090 3649.42 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="8138.52" y="2640" width="431" height="960" rx="64.65" ry="64.65" fill="#eeeeee" stroke="#36393d" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 106px; height: 1px; padding-top: 780px; margin-left: 2036px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">A copy of <b>${D}<br /></b>excluding<br /><b>/sysroot-only</b></div></div></div></foreignObject><text x="2089" y="784" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">A copy of ${D}...</text></switch></g><rect x="7960.96" y="3680" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 935px; margin-left: 2035px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_package<br /></font></div></div></div></foreignObject><text x="2035" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_package
</text></switch></g><ellipse cx="7901.96" cy="3740" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 935px; margin-left: 1961px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">15</b></font></div></div></div></foreignObject><text x="1975" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">15</text></switch></g><path d="M 9108 2320 L 9108 2614.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9108 2635.53 L 9098.67 2607.53 L 9108 2614.53 L 9117.33 2607.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="8868" y="2160" width="480" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 560px; margin-left: 2218px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">packages-split</font></div></div></div></foreignObject><text x="2277" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">packages-split</text></switch></g><rect x="9308" y="2260" width="240" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 58px; height: 1px; padding-top: 578px; margin-left: 2328px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">PKGDEST</font></div></div></div></foreignObject><text x="2357" y="581" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">PKGDEST</text></switch></g><path d="M 9108 2840 L 9108 2895.1" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9108 2916.1 L 9098.67 2888.1 L 9108 2895.1 L 9117.33 2888.1 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="8982" y="2680" width="252" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 690px; margin-left: 2247px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">sayhello</font></div></div></div></foreignObject><text x="2277" y="694" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello</text></switch></g><path d="M 9108 3080 L 9108 3120.57 Q 9108 3160.57 9108 3162.55 L 9108 3164.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9107.98 3185.53 L 9098.67 3157.52 L 9108 3164.53 L 9117.34 3157.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="9021" y="2920" width="174" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 42px; height: 1px; padding-top: 750px; margin-left: 2256px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">usr</font></div></div></div></foreignObject><text x="2277" y="754" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">usr</text></switch></g><path d="M 9107.98 3350 L 9107.97 3414.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9107.96 3435.53 L 9098.63 3407.53 L 9107.97 3414.53 L 9117.3 3407.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="9000.48" y="3190" width="215" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 52px; height: 1px; padding-top: 818px; margin-left: 2251px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">bin</font></div></div></div></foreignObject><text x="2277" y="821" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">bin</text></switch></g><rect x="7689.48" y="1360" width="1287" height="595" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 320px; height: 1px; padding-top: 414px; margin-left: 1923px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><span style="font-size: 15px;">Folders created here are present in <b><u>PACKAGES</u></b> variable, BitBake knows what and where to put things using the <b><u>FILES</u></b> variable, example: <b><u>FILES:${PN}</u></b> files will go to <b><u>${PN}</u></b> folder which is in <b><u>PACKAGES</u></b></span></div></div></div></foreignObject><text x="2083" y="418" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">Folders created here are present in PACKAGES variable...</text></switch></g><rect x="8640.48" y="3680" width="360" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 935px; margin-left: 2205px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_package<br /></font></div></div></div></foreignObject><text x="2205" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_package
</text></switch></g><ellipse cx="8581.48" cy="3740" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 935px; margin-left: 2131px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">16</b></font></div></div></div></foreignObject><text x="2145" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">16</text></switch></g><path d="M 9988 2320 L 9988 2674.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9988 2695.53 L 9978.67 2667.53 L 9988 2674.53 L 9997.33 2667.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="9748" y="2160" width="480" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 560px; margin-left: 2438px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">deploy-<b><i>pkg</i></b></font></div></div></div></foreignObject><text x="2497" y="564" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">deploy-pkg</text></switch></g><path d="M 9988 2860 L 9988 3014.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 9988 3035.53 L 9978.67 3007.53 L 9988 3014.53 L 9997.33 3007.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="9748" y="2700" width="480" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 695px; margin-left: 2438px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter"><b>${PACKAGE_ARCH}</b></font></div></div></div></foreignObject><text x="2497" y="699" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">${PACKAGE_ARCH}</text></switch></g><rect x="9028" y="1360" width="1640" height="595" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 408px; height: 1px; padding-top: 414px; margin-left: 2258px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">This can be <b><u>rpms</u></b>, <b><u>debs</u></b> or <b><u>ipks</u></b>.<br />These are provided by<br /><b><u>package_rpm</u></b>, <b><u>package_deb</u></b> and <b><u>package_ipk</u></b> classes respectively, use <b><u>PACKAGE_CLASSES</u></b> for that as<br />content of <b><u>PACKAGE_CLASSES</u></b> will be appended<br />to <b><u>INHERIT</u></b><br /></font></div></div></div></foreignObject><text x="2462" y="418" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This can be rpms, debs or ipks....</text></switch></g><path d="M 10522 3105 L 10708 3105.59 Q 10748 3105.71 10748 3065.71 L 10748 1320.57 Q 10748 1280.57 10708 1280.57 L 7353.71 1280.57 Q 7313.71 1280.57 7313.8 1240.57 L 7313.92 1180.42" fill="none" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7313.97 1153.42 L 7331.9 1189.45 L 7313.92 1180.42 L 7295.9 1189.38 Z" fill="#000000" stroke="#000000" stroke-width="12" stroke-miterlimit="10" pointer-events="all"/><rect x="9454" y="3040" width="1068" height="130" rx="19.5" ry="19.5" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 265px; height: 1px; padding-top: 776px; margin-left: 2365px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">sayhello-0.1-r0.${PACKAGE_ARCH}.<i>pkg</i></div></div></div></foreignObject><text x="2497" y="780" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello-0.1-r0.${PACKAGE_ARCH}.pkg</text></switch></g><rect x="10788" y="2640" width="1480" height="680" fill="none" stroke="#36393d" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 368px; height: 1px; padding-top: 745px; margin-left: 2698px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">This task also depends on <b><u>PACKAGE_CLASSES</u></b>,<br /><b><u><i>pkg</i></u></b> can be <b><u>rpm</u></b>, <b><u>deb</u></b> or <b><u>ipk</u></b> for <b><u>package_rpm</u></b>,<br /><b><u>package_deb</u></b> or <u style="font-weight: bold;">package_ipk</u> respectively.<br />The generated package generally named using:<br /><b><u>${PN}</u></b>, <b><u>${PR}</u></b>, <b><u>${PACKAGE_ARCH}</u></b> and <b><u><i>pkg</i></u></b><br /></font></div></div></div></foreignObject><text x="2882" y="749" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This task also depends on PACKAGE_CLASSES,...</text></switch></g><path d="M 7314 520 L 7314 654.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7314 675.53 L 7300 647.53 L 7314 654.53 L 7328 647.53 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 7454 440 Q 7454 440 7742.53 440" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 7763.53 440 L 7735.53 449.33 L 7742.53 440 L 7735.53 430.67 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7174" y="360" width="280" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 68px; height: 1px; padding-top: 110px; margin-left: 1795px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">deploy</font></div></div></div></foreignObject><text x="1829" y="114" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">deploy</text></switch></g><path d="M 7313.71 840 L 7313.71 880.57 Q 7313.71 920.57 7313.71 910.29 L 7313.71 905.14 Q 7313.71 900 7313.81 927.26 L 7313.91 954.53" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 7313.98 975.53 L 7299.88 947.58 L 7313.91 954.53 L 7327.88 947.48 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7054.48" y="680" width="519" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 128px; height: 1px; padding-top: 190px; margin-left: 1765px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><b>${DEPLOY_DIR_<i>pkg</i>}</b></div></div></div></foreignObject><text x="1828" y="194" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">${DEPLOY_DIR_pkg}</text></switch></g><rect x="9488" y="3680" width="600" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 935px; margin-left: 2447px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_package_write_<i>pkg</i><br /></font></div></div></div></foreignObject><text x="2447" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_package_write_pkg
</text></switch></g><ellipse cx="9408" cy="3740" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 935px; margin-left: 2338px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">17</b></font></div></div></div></foreignObject><text x="2352" y="939" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">17</text></switch></g><path d="M 10048 3740 Q 11528.57 3740 11528.03 3345.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 11528.01 3324.47 L 11537.38 3352.46 L 11528.03 3345.47 L 11518.71 3352.48 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="7074" y="980" width="480" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 265px; margin-left: 1770px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">${PACKAGE_ARCH}</div></div></div></foreignObject><text x="1829" y="269" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">${PACKAGE_ARCH}</text></switch></g><rect x="7768" y="672.52" width="1660" height="167.48" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 413px; height: 1px; padding-top: 189px; margin-left: 1943px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">For packages, this can be <b><u>IPK</u></b>, <b><u>RPM</u></b> or <b><u>DEB</u></b> (<i>check step 17</i>)</font></div></div></div></foreignObject><text x="2150" y="193" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">For packages, this can be IPK, RPM or DEB (check step 17)</text></switch></g><rect x="7369.48" y="480" width="320" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 133px; margin-left: 1843px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">DEPLOY_DIR</font></div></div></div></foreignObject><text x="1882" y="136" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">DEPLOY_DIR</text></switch></g><rect x="4988" y="80" width="240" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 58px; height: 1px; padding-top: 33px; margin-left: 1248px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">TMPDIR</font></div></div></div></foreignObject><text x="1277" y="36" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">TMPDIR</text></switch></g><rect x="1668" y="480" width="250.72" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 61px; height: 1px; padding-top: 133px; margin-left: 418px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">DL_DIR</font></div></div></div></foreignObject><text x="448" y="136" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">DL_DIR</text></switch></g><path d="M 7573.48 760 L 7630.29 760.34 Q 7670.29 760.57 7706.42 758.98 L 7742.55 757.38" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 7763.53 756.46 L 7735.97 767.02 L 7742.55 757.38 L 7735.15 748.37 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="10488" y="2380" width="600" height="120" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 610px; margin-left: 2697px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">do_package_write_<i>pkg</i><br /></font></div></div></div></foreignObject><text x="2697" y="614" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">do_package_write_pkg
</text></switch></g><ellipse cx="10408" cy="2440" rx="60.00000000000001" ry="60.00000000000001" fill="#000000" stroke="#56517e" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 28px; height: 1px; padding-top: 610px; margin-left: 2588px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter" color="#ffffff" size="1"><b style="font-size: 15px;">18</b></font></div></div></div></foreignObject><text x="2602" y="614" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">18</text></switch></g><path d="M 10268 2310.29 Q 10879.43 2310.29 10879.43 1999.43 Q 10879.43 1688.57 10878.68 1140.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 10878.65 1119.47 L 10888.02 1147.46 L 10878.68 1140.47 L 10869.35 1147.48 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="10148" y="2260" width="120" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><path d="M 10088 2200 Q 10088.57 2077.14 10173.14 2077.14 Q 10257.71 2077.14 10257.94 1980.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 10257.99 1959.47 L 10267.26 1987.49 L 10257.94 1980.47 L 10248.59 1987.45 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="9628" y="805" width="1667.52" height="310" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 415px; height: 1px; padding-top: 240px; margin-left: 2408px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">This can be <b><u>PKGWRITEDIRRPM</u></b>, <b><u>PKGWRITEDIRDEB</u></b> or <b><u>PKGWRITEDIRIPK</u></b> for <b><u>package_rpm</u></b>, <b><u>package_deb</u></b><br />or <b><u>package_ipk</u></b> respectively<br /></font></div></div></div></foreignObject><text x="2615" y="244" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This can be PKGWRITEDIRRPM, PKGWRITEDIRDEB or PKGWRITEDIRIPK for pack...</text></switch></g><rect x="628" y="2470" width="1313" height="410" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 326px; height: 1px; padding-top: 669px; margin-left: 158px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><span style="font-size: 15px;">License checking happens in <b><u>do_populate_lic</u></b> after <b><u>do_patch<br /></u></b>and before that a checksum check<br />happends on <b><u>LIC_FILES_CHKSUM</u></b> if the<br />license is not <b><u>CLOSED</u></b><br /></span></div></div></div></foreignObject><text x="321" y="672" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">License checking happens in do_populate_lic after do_pa...</text></switch></g><rect x="3528.48" y="1360" width="1739.52" height="280" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 433px; height: 1px; padding-top: 375px; margin-left: 883px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><span style="font-size: 15px;">This variable is used to separate recipes<br />based on their target. This has value of<br /><b><u>${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}</u></b><br /></span></div></div></div></foreignObject><text x="1100" y="379" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This variable is used to separate recipes...</text></switch></g><path d="M 6588 660 Q 6863.43 660 6863.4 505.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 6863.39 484.47 L 6872.73 512.47 L 6863.4 505.47 L 6854.06 512.47 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="6148" y="620" width="440" height="80" rx="12" ry="12" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 108px; height: 1px; padding-top: 165px; margin-left: 1538px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">conf-notes.txt</div></div></div></foreignObject><text x="1592" y="169" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">conf-notes.txt</text></switch></g><path d="M 2580.02 520 Q 2580 660 3042.53 660" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 3063.53 660 L 3035.53 669.33 L 3042.53 660 L 3035.53 650.67 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><path d="M 2374 440 Q 2215.43 440.57 2215.04 205.47" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 2215.01 184.47 L 2224.39 212.46 L 2215.04 205.47 L 2205.72 212.49 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="2374" y="360" width="412.04" height="160" rx="24" ry="24" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 101px; height: 1px; padding-top: 110px; margin-left: 595px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">sstate-cache</font></div></div></div></foreignObject><text x="645" y="114" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sstate-cache</text></switch></g><rect x="2643.92" y="480" width="332.04" height="100" rx="15" ry="15" fill="#000000" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 81px; height: 1px; padding-top: 133px; margin-left: 662px;"><div data-drawio-colors="color: #ffffff; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;"><font data-font-src="https://fonts.googleapis.com/css?family=Architects+Daughter">SSTATE_DIR</font></div></div></div></foreignObject><text x="702" y="136" fill="#ffffff" font-family="Liberation Sans" font-size="12px" text-anchor="middle" font-weight="bold">SSTATE_DIR</text></switch></g><rect x="8927.96" y="3440" width="360" height="110" rx="16.5" ry="16.5" fill="#eeeeee" stroke="#36393d" stroke-width="4" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 874px; margin-left: 2233px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">sayhello</div></div></div></foreignObject><text x="2277" y="877" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">sayhello</text></switch></g><path d="M 4660 1960 Q 4660 2300 4904.57 2300 Q 5149.14 2300 5148.94 2611.65" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" stroke-dasharray="12 12" pointer-events="stroke"/><path d="M 5148.92 2632.65 L 5139.61 2604.64 L 5148.94 2611.65 L 5158.27 2604.65 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-miterlimit="10" pointer-events="all"/><rect x="3068" y="480" width="1640" height="360" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 408px; height: 1px; padding-top: 165px; margin-left: 768px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><span style="font-size: 15px;">This folder contains cache for recipes build output, this is used by BitBake, if the recipe checksum did not change it knows that the output to use is the same.<br /></span></div></div></div></foreignObject><text x="972" y="169" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This folder contains cache for recipes build output, this is used by...</text></switch></g><rect x="1395" y="0" width="1640" height="180" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 408px; height: 1px; padding-top: 23px; margin-left: 350px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><span style="font-size: 15px;"><font data-font-src="https://fonts.googleapis.com/css?family=Liberation+Sans">These directories can be shared accross builds to save disk space and build time</font><br /></span></div></div></div></foreignObject><text x="554" y="26" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">These directories can be shared accross builds to save disk space an...</text></switch></g><rect x="7768" y="350" width="1667.52" height="180" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 415px; height: 1px; padding-top: 110px; margin-left: 1943px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">This directory contains other output directories such as <b><u>images</u></b>, <b><u>sdk</u></b> and <b><u>licenses</u></b><br /></font></div></div></div></foreignObject><text x="2150" y="114" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This directory contains other output directories such as images, sdk...</text></switch></g><rect x="5908" y="1020" width="680" height="520" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 168px; height: 1px; padding-top: 320px; margin-left: 1478px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">This file contains all <b>layers</b> that BitBake should consider when looking for metadata.<br /></font></div></div></div></foreignObject><text x="1562" y="324" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This file contains all layer...</text></switch></g><rect x="5396" y="20" width="1760" height="160" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 438px; height: 1px; padding-top: 25px; margin-left: 1350px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">This is base configuration file containing essential user config such as <b><u>MACHINE</u></b> and <b><u>DISTRO</u></b><br /></font></div></div></div></foreignObject><text x="1569" y="29" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">This is base configuration file containing essential user config such as...</text></switch></g><rect x="6140" y="320" width="964.52" height="160" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" stroke-dasharray="12 12" pointer-events="all"/><g transform="translate(-0.5 -0.5)scale(4)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 239px; height: 1px; padding-top: 100px; margin-left: 1536px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: "Liberation Sans"; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><font style="font-size: 15px;">The message to show after <b>source oe-init-build-env</b><br /></font></div></div></div></foreignObject><text x="1656" y="104" fill="rgb(0, 0, 0)" font-family="Liberation Sans" font-size="12px" text-anchor="middle">The message to show after source oe-init...</text></switch></g><rect x="10948" y="2400" width="120" height="80" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><rect x="10348" y="3065" width="80" height="80" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><rect x="9948" y="3700" width="100" height="80" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><rect x="10028" y="2200" width="80" height="80" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/><rect x="7454" y="725" width="80" height="80" fill="none" stroke="rgb(0, 0, 0)" stroke-width="4" pointer-events="all"/></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://www.drawio.com/doc/faq/svg-export-text-problems" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Text is not SVG - cannot display</text></a></switch></svg>
\ No newline at end of file diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index a8ca9e9440..4a27e12e01 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -24,7 +24,7 @@ software customizations and build interchange for multiple hardware platforms as well as software stacks that can be maintained and scaled. .. image:: figures/key-dev-elements.png - :align: center + :width: 100% For further introductory information on the Yocto Project, you might be interested in this @@ -129,7 +129,7 @@ Here are features and advantages of the Yocto Project: arbitrarily include packages. - *License Manifest:* The Yocto Project provides a :ref:`license - manifest <dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle>` + manifest <dev-manual/licenses:maintaining open source license compliance during your product's lifecycle>` for review by people who need to track the use of open source licenses (e.g. legal teams). @@ -151,7 +151,7 @@ Here are challenges you might encounter when developing using the Yocto Project: ":ref:`transitioning-to-a-custom-environment:transitioning to a custom environment for systems development`" documents on the Yocto Project website. -- *Project Workflow Could Be Confusing:* The `Yocto Project +- *Project Workflow Could Be Confusing:* The :ref:`Yocto Project workflow <overview-manual/development-environment:the yocto project development environment>` could be confusing if you are used to traditional desktop and server software development. @@ -217,15 +217,15 @@ your Metadata, the easier it is to cope with future changes. - Use Board Support Package (BSP) layers from silicon vendors when possible. - - Familiarize yourself with the `Yocto Project curated layer - index <https://www.yoctoproject.org/software-overview/layers/>`__ - or the :oe_layerindex:`OpenEmbedded layer index <>`. + - Familiarize yourself with the + :yocto_home:`Yocto Project Compatible Layers </software-overview/layers/>` + or the :oe_layerindex:`OpenEmbedded Layer Index <>`. The latter contains more layers but they are less universally validated. - Layers support the inclusion of technologies, hardware components, and software components. The :ref:`Yocto Project - Compatible <dev-manual/common-tasks:making sure your layer is compatible with yocto project>` + Compatible <dev-manual/layers:making sure your layer is compatible with yocto project>` designation provides a minimum level of standardization that contributes to a strong ecosystem. "YP Compatible" is applied to appropriate products and software components such as BSPs, other @@ -269,7 +269,7 @@ of the ``poky`` repository, you will see several layers: ``meta``, layer. For procedures on how to create layers, see the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. Components and Tools @@ -340,6 +340,18 @@ the Yocto Project: view information about builds. For information on Toaster, see the :doc:`/toaster-manual/index`. +- *VSCode IDE Extension:* The `Yocto Project BitBake + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + extension for Visual Studio Code provides a rich set of features for working + with BitBake recipes. The extension provides syntax highlighting, + hover tips, and completion for BitBake files as well as embedded Python and + Bash languages. Additional views and commands allow you to efficiently + browse, build and edit recipes. It also provides SDK integration for + cross-compiling and debugging through ``devtool``. + + Learn more about the VSCode Extension on the `extension's frontpage + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__. + Production Tools ---------------- @@ -351,7 +363,7 @@ Yocto Project: (BitBake and OE-Core) automatically generates upgrades for recipes that are based on new versions of the recipes published upstream. See - :ref:`dev-manual/common-tasks:using the auto upgrade helper (auh)` + :ref:`dev-manual/upgrading-recipes:using the auto upgrade helper (auh)` for how to set it up. - *Recipe Reporting System:* The Recipe Reporting System tracks recipe @@ -361,7 +373,7 @@ Yocto Project: of the :oe_layerindex:`OpenEmbedded Layer Index <>`, which is a website that indexes OpenEmbedded-Core layers. -- *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__ +- *Patchwork:* `Patchwork <https://patchwork.yoctoproject.org/>`__ is a fork of a project originally started by `OzLabs <https://ozlabs.org/>`__. The project is a web-based tracking system designed to streamline the process of bringing contributions @@ -387,39 +399,6 @@ Yocto Project: You can learn more about the AutoBuilder used by the Yocto Project Autobuilder :doc:`here </test-manual/understand-autobuilder>`. -- *Cross-Prelink:* Prelinking is the process of pre-computing the load - addresses and link tables generated by the dynamic linker as compared - to doing this at runtime. Doing this ahead of time results in - performance improvements when the application is launched and reduced - memory usage for libraries shared by many applications. - - Historically, cross-prelink is a variant of prelink, which was - conceived by `Jakub - Jelínek <https://people.redhat.com/jakub/prelink.pdf>`__ a number of - years ago. Both prelink and cross-prelink are maintained in the same - repository albeit on separate branches. By providing an emulated - runtime dynamic linker (i.e. ``glibc``-derived ``ld.so`` emulation), - the cross-prelink project extends the prelink software's ability to - prelink a sysroot environment. Additionally, the cross-prelink - software enables the ability to work in sysroot style environments. - - The dynamic linker determines standard load address calculations - based on a variety of factors such as mapping addresses, library - usage, and library function conflicts. The prelink tool uses this - information, from the dynamic linker, to determine unique load - addresses for executable and linkable format (ELF) binaries that are - shared libraries and dynamically linked. The prelink tool modifies - these ELF binaries with the pre-computed information. The result is - faster loading and often lower memory consumption because more of the - library code can be re-used from shared Copy-On-Write (COW) pages. - - The original upstream prelink project only supports running prelink - on the end target device due to the reliance on the target device's - dynamic linker. This restriction causes issues when developing a - cross-compiled system. The cross-prelink adds a synthesized dynamic - loader that runs on the host, thus permitting cross-prelinking - without ever having to run on a read-write target filesystem. - - *Pseudo:* Pseudo is the Yocto Project implementation of `fakeroot <http://man.he.net/man1/fakeroot>`__, which is used to run commands in an environment that seemingly has root privileges. @@ -550,18 +529,18 @@ Historically, the Build Appliance was the second of three methods by which you could use the Yocto Project on a system that was not native to Linux. -1. *Hob:* Hob, which is now deprecated and is no longer available since +#. *Hob:* Hob, which is now deprecated and is no longer available since the 2.1 release of the Yocto Project provided a rudimentary, GUI-based interface to the Yocto Project. Toaster has fully replaced Hob. -2. *Build Appliance:* Post Hob, the Build Appliance became available. It +#. *Build Appliance:* Post Hob, the Build Appliance became available. It was never recommended that you use the Build Appliance as a day-to-day production development environment with the Yocto Project. Build Appliance was useful as a way to try out development in the Yocto Project environment. -3. *CROPS:* The final and best solution available now for developing +#. *CROPS:* The final and best solution available now for developing using the Yocto Project on a system not native to Linux is with :ref:`CROPS <overview-manual/yp-intro:development tools>`. @@ -617,20 +596,15 @@ Build Host runs, you have several choices. ":ref:`dev-manual/start:setting up to use cross platforms (crops)`" section in the Yocto Project Development Tasks Manual. -- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem - For Linux v2 to set up a Build Host using Windows 10. - - .. note:: - - 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. +- *Windows Subsystem For Linux (WSL 2):* You may use Windows Subsystem + For Linux version 2 to set up a Build Host using Windows 10 or later, + or Windows Server 2019 or later. - The Windows Subsystem For Linux allows Windows 10 to run a real Linux + The Windows Subsystem For Linux allows Windows to run a real Linux kernel inside of a lightweight virtual machine (VM). - For information on how to set up a Build Host with WSLv2, see the - ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`" + For information on how to set up a Build Host with WSL 2, see the + ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)`" section in the Yocto Project Development Tasks Manual. - *Toaster:* Regardless of what your Build Host is running, you can use @@ -643,6 +617,14 @@ Build Host runs, you have several choices. For information about and how to use Toaster, see the :doc:`/toaster-manual/index`. +- *Using the VSCode Extension:* You can use the `Yocto Project BitBake + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + extension for Visual Studio Code to start your BitBake builds through a + graphical user interface. + + Learn more about the VSCode Extension on the `extension's marketplace page + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + Reference Embedded Distribution (Poky) ====================================== @@ -671,7 +653,7 @@ these items that make up the Poky repository in the The following figure illustrates what generally comprises Poky: .. image:: figures/poky-reference-distribution.png - :align: center + :width: 100% - BitBake is a task executor and scheduler that is the heart of the OpenEmbedded build system. @@ -721,8 +703,8 @@ Sato. One of the most powerful properties of Poky is that every aspect of a build is controlled by the metadata. You can use metadata to augment -these base image types by adding metadata -`layers <overview-manual/yp-intro:the yocto project layer model>` that extend +these base image types by adding metadata :ref:`layers +<overview-manual/yp-intro:the yocto project layer model>` that extend functionality. These layers can provide, for example, an additional software stack for an image type, add a board support package (BSP) for additional @@ -742,7 +724,7 @@ BitBake also supports both ``:prepend`` and ``:append`` operators as a method of extending task functionality. These operators inject code into the beginning or end of a task. For information on these BitBake operators, see the -":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)`" +":ref:`bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)`" section in the BitBake User's Manual. The OpenEmbedded Build System Workflow @@ -753,31 +735,31 @@ accomplish image and SDK generation. The following figure overviews that workflow: .. image:: figures/YP-flow-diagram.png - :align: center + :width: 100% -Following is a brief summary of the "workflow": +Here is a brief summary of the "workflow": -1. Developers specify architecture, policies, patches and configuration +#. Developers specify architecture, policies, patches and configuration details. -2. The build system fetches and downloads the source code from the +#. The build system fetches and downloads the source code from the specified location. The build system supports standard methods such as tarballs or source code repositories systems such as Git. -3. Once source code is downloaded, the build system extracts the sources +#. Once source code is downloaded, the build system extracts the sources into a local work area where patches are applied and common steps for configuring and compiling the software are run. -4. The build system then installs the software into a temporary staging +#. The build system then installs the software into a temporary staging area where the binary package format you select (DEB, RPM, or IPK) is used to roll up the software. -5. Different QA and sanity checks run throughout entire build process. +#. Different QA and sanity checks run throughout entire build process. -6. After the binaries are created, the build system generates a binary +#. After the binaries are created, the build system generates a binary package feed that is used to create the final root file image. -7. The build system generates the file system image and a customized +#. The build system generates the file system image and a customized Extensible SDK (eSDK) for application development in parallel. For a very detailed look at this workflow, see the @@ -814,7 +796,7 @@ helpful for getting started: Yocto Project. For more detailed information on layers, see the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":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 @@ -875,7 +857,7 @@ helpful for getting started: 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 diff --git a/documentation/poky.yaml b/documentation/poky.yaml deleted file mode 100644 index 62589acd9f..0000000000 --- a/documentation/poky.yaml +++ /dev/null @@ -1,48 +0,0 @@ -DISTRO : "3.4.1" -DISTRO_NAME_NO_CAP : "honister" -DISTRO_NAME : "Honister" -DISTRO_NAME_NO_CAP_MINUS_ONE : "hardknott" -DISTRO_NAME_NO_CAP_LTS : "dunfell" -YOCTO_DOC_VERSION : "3.4.1" -YOCTO_DOC_VERSION_MINUS_ONE : "3.3.4" -DISTRO_REL_TAG : "yocto-3.4.1" -POKYVERSION : "26.0.1" -YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" -YOCTO_DL_URL : "https://downloads.yoctoproject.org" -YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" -YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" -UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ - build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ - xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ - pylint3 xterm python3-subunit mesa-common-dev zstd liblz4-tool" -FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ - diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ - ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ - python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ - python3-jinja2 SDL-devel xterm rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \ - perl-File-Copy perl-locale zstd lz4" -OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ - diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ - python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel xterm rpcgen Mesa-dri-devel \ - zstd lz4 - \n\ $ sudo pip3 install GitPython" -CENTOS7_HOST_PACKAGES_ESSENTIAL : "-y epel-release - \n\ $ sudo yum makecache - \n\ $ sudo yum install gawk make wget tar bzip2 gzip python3 unzip perl patch \ - diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \ - perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip xz \ - which SDL-devel xterm mesa-libGL-devel zstd lz4 - \n\ $ sudo pip3 install GitPython jinja2" -CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release - \n\ $ sudo dnf config-manager --set-enabled PowerTools - \n\ $ sudo dnf makecache - \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ - diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ - socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ - python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \ - rpcgen mesa-libGL-devel zstd lz4" -PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml" -MIN_PYTHON_VERSION : "3.6.0" -MIN_TAR_VERSION : "1.28" -MIN_GIT_VERSION : "1.8.3.1" -MIN_GCC_VERSION : "5.0" diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in new file mode 100644 index 0000000000..7a686ac4e1 --- /dev/null +++ b/documentation/poky.yaml.in @@ -0,0 +1,49 @@ +DISTRO : "4.3" +DISTRO_NAME_NO_CAP : "nanbield" +DISTRO_NAME : "Nanbield" +DISTRO_NAME_NO_CAP_MINUS_ONE : "mickledore" +DISTRO_NAME_NO_CAP_LTS : "kirkstone" +YOCTO_DOC_VERSION : "4.3" +DISTRO_REL_TAG : "yocto-4.3" +DOCCONF_VERSION : "dev" +BITBAKE_SERIES : "" +YOCTO_DL_URL : "https://downloads.yoctoproject.org" +YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" +YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" +UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ + build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ + xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ + python3-subunit mesa-common-dev zstd liblz4-tool file locales libacl1 + \n\ $ sudo locale-gen en_US.UTF-8" +FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ + diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ + ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ + python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ + python3-jinja2 SDL-devel rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \ + perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en libacl" +OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ + diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ + python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \ + zstd lz4 bzip2 gzip hostname libacl1 + \n\ $ sudo pip3 install GitPython" +ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release + \n\ $ sudo yum install dnf-plugins-core + \n\ $ sudo dnf config-manager --set-enabled crb + \n\ $ sudo dnf makecache + \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ + diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ + socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ + python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel \ + rpcgen mesa-libGL-devel zstd lz4 cpio glibc-langpack-en libacl" +PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml" +MIN_PYTHON_VERSION : "3.8.0" +MIN_TAR_VERSION : "1.28" +MIN_GIT_VERSION : "1.8.3.1" +MIN_GCC_VERSION : "8.0" +MIN_MAKE_VERSION : "4.0" +# Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64), rounded up from 87 +MIN_DISK_SPACE : "90" +# Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) with "rm_work", rounded up from 38 +MIN_DISK_SPACE_RM_WORK : "40" +# RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system +MIN_RAM : "8" diff --git a/documentation/profile-manual/intro.rst b/documentation/profile-manual/intro.rst index 9c8fa3dbfa..86310cf318 100644 --- a/documentation/profile-manual/intro.rst +++ b/documentation/profile-manual/intro.rst @@ -7,43 +7,45 @@ Yocto Project Profiling and Tracing Manual Introduction ============ -Yocto bundles a number of tracing and profiling tools - this 'HOWTO' +Yocto Project bundles a number of tracing and profiling tools --- this manual describes their basic usage and shows by example how to make use of them -to examine application and system behavior. +to analyze application and system behavior. -The tools presented are for the most part completely open-ended and have +The tools presented are, for the most part, completely open-ended and have quite good and/or extensive documentation of their own which can be used to solve just about any problem you might come across in Linux. Each section that describes a particular tool has links to that tool's documentation and website. -The purpose of this 'HOWTO' is to present a set of common and generally +The purpose of this manual is to present a set of common and generally useful tracing and profiling idioms along with their application (as appropriate) to each tool, in the context of a general-purpose 'drill-down' methodology that can be applied to solving a large number -(90%?) of problems. For help with more advanced usages and problems, -please see the documentation and/or websites listed for each tool. +of problems. For help with more advanced usages and problems, +refer to the documentation and/or websites provided for each tool. -The final section of this 'HOWTO' is a collection of real-world examples -which we'll be continually adding to as we solve more problems using the -tools - feel free to add your own examples to the list! +The final section of this manual is a collection of real-world examples +which we'll be continually updating as we solve more problems using the +tools --- feel free to suggest additions to what you read here. General Setup ============= -Most of the tools are available only in 'sdk' images or in images built -after adding 'tools-profile' to your local.conf. So, in order to be able -to access all of the tools described here, please first build and boot -an 'sdk' image e.g. :: +Most of the tools are available only in ``sdk`` images or in images built +after adding ``tools-profile`` to your ``local.conf`` file. So, in order to be able +to access all of the tools described here, you can build and boot +an ``sdk`` image, perhaps one of:: $ bitbake core-image-sato-sdk + $ bitbake core-image-weston-sdk + $ bitbake core-image-rt-sdk -or alternatively by adding 'tools-profile' to the EXTRA_IMAGE_FEATURES line in -your local.conf:: +Alternatively, you can add ``tools-profile`` to the :term:`EXTRA_IMAGE_FEATURES` line in +your ``local.conf`` file:: EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" -If you use the 'tools-profile' method, you don't need to build an sdk image - +If you use the ``tools-profile`` method, you don't need to build an sdk image --- the tracing and profiling tools will be included in non-sdk images as well e.g.:: $ bitbake core-image-sato @@ -64,12 +66,12 @@ the tracing and profiling tools will be included in non-sdk images as well e.g.: If you've already built a stripped image, you can generate debug packages (xxx-dbg) which you can manually install as needed. -To generate debug info for packages, you can add dbg-pkgs to -EXTRA_IMAGE_FEATURES in local.conf. For example:: +To generate debug info for packages, you can add ``dbg-pkgs`` to +:term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" -Additionally, in order to generate the right type of debuginfo, we also need to +Additionally, in order to generate the right type of debug info, we also need to set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 56f1e66674..17be149580 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst @@ -13,11 +13,11 @@ tools. perf ==== -The 'perf' tool is the profiling and tracing tool that comes bundled +The perf tool is the profiling and tracing tool that comes bundled with the Linux kernel. Don't let the fact that it's part of the kernel fool you into thinking -that it's only for tracing and profiling the kernel - you can indeed use +that it's only for tracing and profiling the kernel --- you can indeed use it to trace and profile just the kernel, but you can also use it to profile specific applications separately (with or without kernel context), and you can also use it to trace and profile the kernel and @@ -26,22 +26,22 @@ of what's going on. In many ways, perf aims to be a superset of all the tracing and profiling tools available in Linux today, including all the other tools -covered in this HOWTO. The past couple of years have seen perf subsume a +covered in this How-to. The past couple of years have seen perf subsume a lot of the functionality of those other tools and, at the same time, those other tools have removed large portions of their previous functionality and replaced it with calls to the equivalent functionality now implemented by the perf subsystem. Extrapolation suggests that at -some point those other tools will simply become completely redundant and +some point those other tools will become completely redundant and go away; until then, we'll cover those other tools in these pages and in many cases show how the same things can be accomplished in perf and the other tools when it seems useful to do so. The coverage below details some of the most common ways you'll likely want to apply the tool; full documentation can be found either within -the tool itself or in the man pages at +the tool itself or in the manual pages at `perf(1) <https://linux.die.net/man/1/perf>`__. -Perf Setup +perf Setup ---------- For this section, we'll assume you've already performed the basic setup @@ -54,14 +54,14 @@ image built with the following in your ``local.conf`` file:: perf runs on the target system for the most part. You can archive profile data and copy it to the host for analysis, but for the rest of -this document we assume you've ssh'ed to the host and will be running -the perf commands on the target. +this document we assume you're connected to the host through SSH and will be +running the perf commands on the target. -Basic Perf Usage +Basic perf Usage ---------------- The perf tool is pretty much self-documenting. To remind yourself of the -available commands, simply type 'perf', which will show you basic usage +available commands, just type ``perf``, which will show you basic usage along with the available perf subcommands:: root@crownbay:~# perf @@ -97,19 +97,19 @@ along with the available perf subcommands:: Using perf to do Basic Profiling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -As a simple test case, we'll profile the 'wget' of a fairly large file, +As a simple test case, we'll profile the ``wget`` of a fairly large file, which is a minimally interesting case because it has both file and network I/O aspects, and at least in the case of standard Yocto images, it's implemented as part of BusyBox, so the methods we use to analyze it -can be used in a very similar way to the whole host of supported BusyBox -applets in Yocto. :: +can be used in a similar way to the whole host of supported BusyBox +applets in Yocto:: root@crownbay:~# rm linux-2.6.19.2.tar.bz2; \ wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 The quickest and easiest way to get some basic overall data about what's -going on for a particular workload is to profile it using 'perf stat'. -'perf stat' basically profiles using a few default counters and displays +going on for a particular workload is to profile it using ``perf stat``. +This command basically profiles using a few default counters and displays the summed counts at the end of the run:: root@crownbay:~# perf stat wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 @@ -131,13 +131,13 @@ the summed counts at the end of the run:: 59.836627620 seconds time elapsed -Many times such a simple-minded test doesn't yield much of -interest, but sometimes it does (see Real-world Yocto bug (slow -loop-mounted write speed)). +Such a simple-minded test doesn't always yield much of interest, but sometimes +it does (see the :yocto_bugs:`Slow write speed on live images with denzil +</show_bug.cgi?id=3049>` bug report). -Also, note that 'perf stat' isn't restricted to a fixed set of counters -- basically any event listed in the output of 'perf list' can be tallied -by 'perf stat'. For example, suppose we wanted to see a summary of all +Also, note that ``perf stat`` isn't restricted to a fixed set of counters +--- basically any event listed in the output of ``perf list`` can be tallied +by ``perf stat``. For example, suppose we wanted to see a summary of all the events related to kernel memory allocation/freeing along with cache hits and misses:: @@ -164,22 +164,22 @@ hits and misses:: 44.831023415 seconds time elapsed -So 'perf stat' gives us a nice easy +As you can see, ``perf stat`` gives us a nice easy way to get a quick overview of what might be happening for a set of events, but normally we'd need a little more detail in order to understand what's going on in a way that we can act on in a useful way. -To dive down into a next level of detail, we can use 'perf record'/'perf -report' which will collect profiling data and present it to use using an -interactive text-based UI (or simply as text if we specify --stdio to -'perf report'). +To dive down into a next level of detail, we can use ``perf record`` / +``perf report`` which will collect profiling data and present it to use using an +interactive text-based UI (or just as text if we specify ``--stdio`` to +``perf report``). -As our first attempt at profiling this workload, we'll simply run 'perf -record', handing it the workload we want to profile (everything after -'perf record' and any perf options we hand it - here none - will be +As our first attempt at profiling this workload, we'll just run ``perf +record``, handing it the workload we want to profile (everything after +``perf record`` and any perf options we hand it --- here none, will be executed in a new shell). perf collects samples until the process exits -and records them in a file named 'perf.data' in the current working -directory. :: +and records them in a file named ``perf.data`` in the current working +directory:: root@crownbay:~# perf record wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 @@ -189,7 +189,7 @@ directory. :: [ perf record: Captured and wrote 0.176 MB perf.data (~7700 samples) ] To see the results in a -'text-based UI' (tui), simply run 'perf report', which will read the +"text-based UI" (tui), just run ``perf report``, which will read the perf.data file in the current working directory and display the results in an interactive UI:: @@ -197,27 +197,28 @@ in an interactive UI:: .. image:: figures/perf-wget-flat-stripped.png :align: center + :width: 70% -The above screenshot displays a 'flat' profile, one entry for each -'bucket' corresponding to the functions that were profiled during the +The above screenshot displays a "flat" profile, one entry for each +"bucket" corresponding to the functions that were profiled during the profiling run, ordered from the most popular to the least (perf has options to sort in various orders and keys as well as display entries -only above a certain threshold and so on - see the perf documentation -for details). Note that this includes both userspace functions (entries -containing a [.]) and kernel functions accounted to the process (entries -containing a [k]). (perf has command-line modifiers that can be used to -restrict the profiling to kernel or userspace, among others). - -Notice also that the above report shows an entry for 'busybox', which is -the executable that implements 'wget' in Yocto, but that instead of a +only above a certain threshold and so on --- see the perf documentation +for details). Note that this includes both user space functions (entries +containing a ``[.]``) and kernel functions accounted to the process (entries +containing a ``[k]``). perf has command-line modifiers that can be used to +restrict the profiling to kernel or user space, among others. + +Notice also that the above report shows an entry for ``busybox``, which is +the executable that implements ``wget`` in Yocto, but that instead of a useful function name in that entry, it displays a not-so-friendly hex value instead. The steps below will show how to fix that problem. Before we do that, however, let's try running a different profile, one which shows something a little more interesting. The only difference -between the new profile and the previous one is that we'll add the -g +between the new profile and the previous one is that we'll add the ``-g`` option, which will record not just the address of a sampled function, -but the entire callchain to the sampled function as well:: +but the entire call chain to the sampled function as well:: root@crownbay:~# perf record -g wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 Connecting to downloads.yoctoproject.org (140.211.169.59:80) @@ -230,45 +231,47 @@ but the entire callchain to the sampled function as well:: .. image:: figures/perf-wget-g-copy-to-user-expanded-stripped.png :align: center + :width: 70% -Using the callgraph view, we can actually see not only which functions +Using the call graph view, we can actually see not only which functions took the most time, but we can also see a summary of how those functions were called and learn something about how the program interacts with the kernel in the process. -Notice that each entry in the above screenshot now contains a '+' on the -left-hand side. This means that we can expand the entry and drill down -into the callchains that feed into that entry. Pressing 'enter' on any -one of them will expand the callchain (you can also press 'E' to expand -them all at the same time or 'C' to collapse them all). +Notice that each entry in the above screenshot now contains a ``+`` on the +left side. This means that we can expand the entry and drill down +into the call chains that feed into that entry. Pressing ``Enter`` on any +one of them will expand the call chain (you can also press ``E`` to expand +them all at the same time or ``C`` to collapse them all). In the screenshot above, we've toggled the ``__copy_to_user_ll()`` entry -and several subnodes all the way down. This lets us see which callchains +and several subnodes all the way down. This lets us see which call chains contributed to the profiled ``__copy_to_user_ll()`` function which contributed 1.77% to the total profile. -As a bit of background explanation for these callchains, think about -what happens at a high level when you run wget to get a file out on the +As a bit of background explanation for these call chains, think about +what happens at a high level when you run ``wget`` to get a file out on the network. Basically what happens is that the data comes into the kernel -via the network connection (socket) and is passed to the userspace -program 'wget' (which is actually a part of BusyBox, but that's not +via the network connection (socket) and is passed to the user space +program ``wget`` (which is actually a part of BusyBox, but that's not important for now), which takes the buffers the kernel passes to it and writes it to a disk file to save it. The part of this process that we're looking at in the above call stacks is the part where the kernel passes the data it has read from the socket -down to wget i.e. a copy-to-user. +down to wget i.e. a ``copy-to-user``. Notice also that here there's also a case where the hex value is -displayed in the callstack, here in the expanded ``sys_clock_gettime()`` -function. Later we'll see it resolve to a userspace function call in -busybox. +displayed in the call stack, here in the expanded ``sys_clock_gettime()`` +function. Later we'll see it resolve to a user space function call in +BusyBox. .. image:: figures/perf-wget-g-copy-from-user-expanded-stripped.png :align: center + :width: 70% -The above screenshot shows the other half of the journey for the data - -from the wget program's userspace buffers to disk. To get the buffers to +The above screenshot shows the other half of the journey for the data --- +from the ``wget`` program's user space buffers to disk. To get the buffers to disk, the wget program issues a ``write(2)``, which does a ``copy-from-user`` to the kernel, which then takes care via some circuitous path (probably also present somewhere in the profile data), to get it safely to disk. @@ -278,18 +281,19 @@ of how to extract useful information out of it, let's get back to the task at hand and see if we can get some basic idea about where the time is spent in the program we're profiling, wget. Remember that wget is actually implemented as an applet in BusyBox, so while the process name -is 'wget', the executable we're actually interested in is BusyBox. So -let's expand the first entry containing BusyBox: +is ``wget``, the executable we're actually interested in is ``busybox``. +Therefore, let's expand the first entry containing BusyBox: .. image:: figures/perf-wget-busybox-expanded-stripped.png :align: center + :width: 70% Again, before we expanded we saw that the function was labeled with a hex value instead of a symbol as with most of the kernel entries. Expanding the BusyBox entry doesn't make it any better. The problem is that perf can't find the symbol information for the -busybox binary, which is actually stripped out by the Yocto build +``busybox`` binary, which is actually stripped out by the Yocto build system. One way around that is to put the following in your ``local.conf`` file @@ -299,90 +303,95 @@ when you build the image:: However, we already have an image with the binaries stripped, so what can we do to get perf to resolve the symbols? Basically we need to -install the debuginfo for the BusyBox package. +install the debugging information for the BusyBox package. To generate the debug info for the packages in the image, we can add ``dbg-pkgs`` to :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" -Additionally, in order to generate the type of debuginfo that perf -understands, we also need to set -:term:`PACKAGE_DEBUG_SPLIT_STYLE` +Additionally, in order to generate the type of debugging information that perf +understands, we also need to set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' -Once we've done that, we can install the -debuginfo for BusyBox. The debug packages once built can be found in -``build/tmp/deploy/rpm/*`` on the host system. Find the busybox-dbg-...rpm -file and copy it to the target. For example:: +Once we've done that, we can install the debugging information for BusyBox. The +debug packages once built can be found in ``build/tmp/deploy/rpm/*`` +on the host system. Find the ``busybox-dbg-...rpm`` file and copy it +to the target. For example:: [trz@empanada core2]$ scp /home/trz/yocto/crownbay-tracing-dbg/build/tmp/deploy/rpm/core2_32/busybox-dbg-1.20.2-r2.core2_32.rpm root@192.168.1.31: busybox-dbg-1.20.2-r2.core2_32.rpm 100% 1826KB 1.8MB/s 00:01 -Now install the debug rpm on the target:: +Now install the debug RPM on the target:: root@crownbay:~# rpm -i busybox-dbg-1.20.2-r2.core2_32.rpm -Now that the debuginfo is installed, we see that the BusyBox entries now display +Now that the debugging information is installed, we see that the BusyBox entries now display their functions symbolically: .. image:: figures/perf-wget-busybox-debuginfo.png :align: center + :width: 70% -If we expand one of the entries and press 'enter' on a leaf node, we're +If we expand one of the entries and press ``Enter`` on a leaf node, we're presented with a menu of actions we can take to get more information related to that entry: .. image:: figures/perf-wget-busybox-dso-zoom-menu.png :align: center + :width: 70% One of these actions allows us to show a view that displays a busybox-centric view of the profiled functions (in this case we've also -expanded all the nodes using the 'E' key): +expanded all the nodes using the ``E`` key): .. image:: figures/perf-wget-busybox-dso-zoom.png :align: center + :width: 70% -Finally, we can see that now that the BusyBox debuginfo is installed, +Finally, we can see that now that the BusyBox debugging information is installed, the previously unresolved symbol in the ``sys_clock_gettime()`` entry mentioned previously is now resolved, and shows that the -sys_clock_gettime system call that was the source of 6.75% of the -copy-to-user overhead was initiated by the ``handle_input()`` BusyBox +``sys_clock_gettime`` system call that was the source of 6.75% of the +``copy-to-user`` overhead was initiated by the ``handle_input()`` BusyBox function: .. image:: figures/perf-wget-g-copy-to-user-expanded-debuginfo.png :align: center + :width: 70% At the lowest level of detail, we can dive down to the assembly level and see which instructions caused the most overhead in a function. -Pressing 'enter' on the 'udhcpc_main' function, we're again presented +Pressing ``Enter`` on the ``udhcpc_main`` function, we're again presented with a menu: .. image:: figures/perf-wget-busybox-annotate-menu.png :align: center + :width: 70% -Selecting 'Annotate udhcpc_main', we get a detailed listing of -percentages by instruction for the udhcpc_main function. From the +Selecting ``Annotate udhcpc_main``, we get a detailed listing of +percentages by instruction for the ``udhcpc_main`` function. From the display, we can see that over 50% of the time spent in this function is taken up by a couple tests and the move of a constant (1) to a register: .. image:: figures/perf-wget-busybox-annotate-udhcpc.png :align: center + :width: 70% As a segue into tracing, let's try another profile using a different -counter, something other than the default 'cycles'. +counter, something other than the default ``cycles``. The tracing and profiling infrastructure in Linux has become unified in a way that allows us to use the same tool with a completely different set of counters, not just the standard hardware counters that -traditional tools have had to restrict themselves to (of course the -traditional tools can also make use of the expanded possibilities now +traditional tools have had to restrict themselves to (the +traditional tools can now actually make use of the expanded possibilities now available to them, and in some cases have, as mentioned previously). We can get a list of the available events that can be used to profile a -workload via 'perf list':: +workload via ``perf list``:: root@crownbay:~# perf list @@ -518,14 +527,14 @@ workload via 'perf list':: .. admonition:: Tying it Together These are exactly the same set of events defined by the trace event - subsystem and exposed by ftrace/tracecmd/kernelshark as files in - /sys/kernel/debug/tracing/events, by SystemTap as + subsystem and exposed by ftrace / trace-cmd / KernelShark as files in + ``/sys/kernel/debug/tracing/events``, by SystemTap as kernel.trace("tracepoint_name") and (partially) accessed by LTTng. Only a subset of these would be of interest to us when looking at this workload, so let's choose the most likely subsystems (identified by the -string before the colon in the Tracepoint events) and do a 'perf stat' -run using only those wildcarded subsystems:: +string before the colon in the ``Tracepoint`` events) and do a ``perf stat`` +run using only those subsystem wildcards:: root@crownbay:~# perf stat -e skb:* -e net:* -e napi:* -e sched:* -e workqueue:* -e irq:* -e syscalls:* wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 Performance counter stats for 'wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2': @@ -593,11 +602,12 @@ and tell perf to do a profile using it as the sampling event:: .. image:: figures/sched-wakeup-profile.png :align: center + :width: 70% The screenshot above shows the results of running a profile using sched:sched_switch tracepoint, which shows the relative costs of various -paths to sched_wakeup (note that sched_wakeup is the name of the -tracepoint - it's actually defined just inside ttwu_do_wakeup(), which +paths to ``sched_wakeup`` (note that ``sched_wakeup`` is the name of the +tracepoint --- it's actually defined just inside ``ttwu_do_wakeup()``, which accounts for the function name actually displayed in the profile: .. code-block:: c @@ -615,15 +625,15 @@ accounts for the function name actually displayed in the profile: } A couple of the more interesting -callchains are expanded and displayed above, basically some network -receive paths that presumably end up waking up wget (busybox) when +call chains are expanded and displayed above, basically some network +receive paths that presumably end up waking up wget (BusyBox) when network data is ready. Note that because tracepoints are normally used for tracing, the default -sampling period for tracepoints is 1 i.e. for tracepoints perf will -sample on every event occurrence (this can be changed using the -c +sampling period for tracepoints is ``1`` i.e. for tracepoints perf will +sample on every event occurrence (this can be changed using the ``-c`` option). This is in contrast to hardware counters such as for example -the default 'cycles' hardware counter used for normal profiling, where +the default ``cycles`` hardware counter used for normal profiling, where sampling periods are much higher (in the thousands) because profiling should have as low an overhead as possible and sampling on every cycle would be prohibitively expensive. @@ -634,10 +644,10 @@ Using perf to do Basic Tracing Profiling is a great tool for solving many problems or for getting a high-level view of what's going on with a workload or across the system. It is however by definition an approximation, as suggested by the most -prominent word associated with it, 'sampling'. On the one hand, it +prominent word associated with it, ``sampling``. On the one hand, it allows a representative picture of what's going on in the system to be -cheaply taken, but on the other hand, that cheapness limits its utility -when that data suggests a need to 'dive down' more deeply to discover +cheaply taken, but alternatively, that cheapness limits its utility +when that data suggests a need to "dive down" more deeply to discover what's really going on. In such cases, the only way to see what's really going on is to be able to look at (or summarize more intelligently) the individual steps that go into the higher-level behavior exposed by the @@ -650,7 +660,7 @@ applicable to our workload:: -e syscalls:sys_enter_read -e syscalls:sys_exit_read -e syscalls:sys_enter_write -e syscalls:sys_exit_write wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 -We can look at the raw trace output using 'perf script' with no +We can look at the raw trace output using ``perf script`` with no arguments:: root@crownbay:~# perf script @@ -681,7 +691,7 @@ arguments:: This gives us a detailed timestamped sequence of events that occurred within the workload with respect to those events. -In many ways, profiling can be viewed as a subset of tracing - +In many ways, profiling can be viewed as a subset of tracing --- theoretically, if you have a set of trace events that's sufficient to capture all the important aspects of a workload, you can derive any of the results or views that a profiling run can. @@ -701,23 +711,23 @@ an infinite variety of ways. Another way to look at it is that there are only so many ways that the 'primitive' counters can be used on their own to generate interesting output; to get anything more complicated than simple counts requires -some amount of additional logic, which is typically very specific to the +some amount of additional logic, which is typically specific to the problem at hand. For example, if we wanted to make use of a 'counter' that maps to the value of the time difference between when a process was scheduled to run on a processor and the time it actually ran, we wouldn't expect such a counter to exist on its own, but we could derive -one called say 'wakeup_latency' and use it to extract a useful view of +one called say ``wakeup_latency`` and use it to extract a useful view of that metric from trace data. Likewise, we really can't figure out from standard profiling tools how much data every process on the system reads and writes, along with how many of those reads and writes fail completely. If we have sufficient trace data, however, we could with the right tools easily extract and present that information, but we'd need -something other than pre-canned profiling tools to do that. +something other than ready-made profiling tools to do that. Luckily, there is a general-purpose way to handle such needs, called -'programming languages'. Making programming languages easily available +"programming languages". Making programming languages easily available to apply to such problems given the specific format of data is called a -'programming language binding' for that data and language. Perf supports +'programming language binding' for that data and language. perf supports two programming language bindings, one for Python and one for Perl. .. admonition:: Tying it Together @@ -727,21 +737,21 @@ two programming language bindings, one for Python and one for Perl. DProbes dpcc compiler, an ANSI C compiler which targeted a low-level assembly language running on an in-kernel interpreter on the target system. This is exactly analogous to what Sun's DTrace did, except - that DTrace invented its own language for the purpose. Systemtap, + that DTrace invented its own language for the purpose. SystemTap, heavily inspired by DTrace, also created its own one-off language, but rather than running the product on an in-kernel interpreter, created an elaborate compiler-based machinery to translate its language into kernel modules written in C. -Now that we have the trace data in perf.data, we can use 'perf script --g' to generate a skeleton script with handlers for the read/write -entry/exit events we recorded:: +Now that we have the trace data in ``perf.data``, we can use ``perf script +-g`` to generate a skeleton script with handlers for the read / write +entry / exit events we recorded:: root@crownbay:~# perf script -g python generated Python script: perf-script.py -The skeleton script simply creates a python function for each event type in the -perf.data file. The body of each function simply prints the event name along +The skeleton script just creates a Python function for each event type in the +``perf.data`` file. The body of each function just prints the event name along with its parameters. For example: .. code-block:: python @@ -755,7 +765,7 @@ with its parameters. For example: print "skbaddr=%u, len=%u, name=%s\n" % (skbaddr, len, name), We can run that script directly to print all of the events contained in the -perf.data file:: +``perf.data`` file:: root@crownbay:~# perf script -s perf-script.py @@ -784,8 +794,8 @@ perf.data file:: syscalls__sys_exit_read 1 11624.859944032 1262 wget nr=3, ret=1024 That in itself isn't very useful; after all, we can accomplish pretty much the -same thing by simply running 'perf script' without arguments in the same -directory as the perf.data file. +same thing by just running ``perf script`` without arguments in the same +directory as the ``perf.data`` file. We can however replace the print statements in the generated function bodies with whatever we want, and thereby make it infinitely more @@ -806,8 +816,8 @@ event. For example: Each event handler function in the generated code is modified to do this. For convenience, we define a common function -called inc_counts() that each handler calls; inc_counts() simply tallies -a count for each event using the 'counts' hash, which is a specialized +called ``inc_counts()`` that each handler calls; ``inc_counts()`` just tallies +a count for each event using the ``counts`` hash, which is a specialized hash function that does Perl-like autovivification, a capability that's extremely useful for kinds of multi-level aggregation commonly used in processing traces (see perf's documentation on the Python language @@ -825,7 +835,7 @@ binding for details): Finally, at the end of the trace processing run, we want to print the result of all the per-event tallies. For that, we use the special -'trace_end()' function: +``trace_end()`` function: .. code-block:: python @@ -854,55 +864,56 @@ The end result is a summary of all the events recorded in the trace:: syscalls__sys_exit_write 8990 Note that this is -pretty much exactly the same information we get from 'perf stat', which +pretty much exactly the same information we get from ``perf stat``, which goes a little way to support the idea mentioned previously that given the right kind of trace data, higher-level profiling-type summaries can be derived from it. -Documentation on using the `'perf script' python +Documentation on using the `'perf script' Python binding <https://linux.die.net/man/1/perf-script-python>`__. System-Wide Tracing and Profiling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The examples so far have focused on tracing a particular program or -workload - in other words, every profiling run has specified the program -to profile in the command-line e.g. 'perf record wget ...'. +workload --- that is, every profiling run has specified the program +to profile in the command-line e.g. ``perf record wget ...``. It's also possible, and more interesting in many cases, to run a system-wide profile or trace while running the workload in a separate shell. -To do system-wide profiling or tracing, you typically use the -a flag to -'perf record'. +To do system-wide profiling or tracing, you typically use the ``-a`` flag to +``perf record``. To demonstrate this, open up one window and start the profile using the --a flag (press Ctrl-C to stop tracing):: +``-a`` flag (press ``Ctrl-C`` to stop tracing):: root@crownbay:~# perf record -g -a ^C[ perf record: Woken up 6 times to write data ] [ perf record: Captured and wrote 1.400 MB perf.data (~61172 samples) ] -In another window, run the wget test:: +In another window, run the ``wget`` test:: root@crownbay:~# wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2 Connecting to downloads.yoctoproject.org (140.211.169.59:80) linux-2.6.19.2.tar.b 100% \|*******************************\| 41727k 0:00:00 ETA -Here we see entries not only for our wget load, but for +Here we see entries not only for our ``wget`` load, but for other processes running on the system as well: .. image:: figures/perf-systemwide.png :align: center + :width: 70% -In the snapshot above, we can see callchains that originate in libc, and -a callchain from Xorg that demonstrates that we're using a proprietary X -driver in userspace (notice the presence of 'PVR' and some other -unresolvable symbols in the expanded Xorg callchain). +In the snapshot above, we can see call chains that originate in ``libc``, and +a call chain from ``Xorg`` that demonstrates that we're using a proprietary X +driver in user space (notice the presence of ``PVR`` and some other +unresolvable symbols in the expanded ``Xorg`` call chain). -Note also that we have both kernel and userspace entries in the above -snapshot. We can also tell perf to focus on userspace but providing a -modifier, in this case 'u', to the 'cycles' hardware counter when we +Note also that we have both kernel and user space entries in the above +snapshot. We can also tell perf to focus on user space but providing a +modifier, in this case ``u``, to the ``cycles`` hardware counter when we record a profile:: root@crownbay:~# perf record -g -a -e cycles:u @@ -911,25 +922,27 @@ record a profile:: .. image:: figures/perf-report-cycles-u.png :align: center + :width: 70% -Notice in the screenshot above, we see only userspace entries ([.]) +Notice in the screenshot above, we see only user space entries (``[.]``) -Finally, we can press 'enter' on a leaf node and select the 'Zoom into -DSO' menu item to show only entries associated with a specific DSO. In -the screenshot below, we've zoomed into the 'libc' DSO which shows all -the entries associated with the libc-xxx.so DSO. +Finally, we can press ``Enter`` on a leaf node and select the ``Zoom into +DSO`` menu item to show only entries associated with a specific DSO. In +the screenshot below, we've zoomed into the ``libc`` DSO which shows all +the entries associated with the ``libc-xxx.so`` DSO. .. image:: figures/perf-systemwide-libc.png :align: center + :width: 70% -We can also use the system-wide -a switch to do system-wide tracing. +We can also use the system-wide ``-a`` switch to do system-wide tracing. Here we'll trace a couple of scheduler events:: root@crownbay:~# perf record -a -e sched:sched_switch -e sched:sched_wakeup ^C[ perf record: Woken up 38 times to write data ] [ perf record: Captured and wrote 9.780 MB perf.data (~427299 samples) ] -We can look at the raw output using 'perf script' with no arguments:: +We can look at the raw output using ``perf script`` with no arguments:: root@crownbay:~# perf script @@ -947,11 +960,11 @@ We can look at the raw output using 'perf script' with no arguments:: Filtering ^^^^^^^^^ -Notice that there are a lot of events that don't really have anything to -do with what we're interested in, namely events that schedule 'perf' +Notice that there are many events that don't really have anything to +do with what we're interested in, namely events that schedule ``perf`` itself in and out or that wake perf up. We can get rid of those by using -the '--filter' option - for each event we specify using -e, we can add a ---filter after that to filter out trace events that contain fields with +the ``--filter`` option --- for each event we specify using ``-e``, we can add a +``--filter`` after that to filter out trace events that contain fields with specific values:: root@crownbay:~# perf record -a -e sched:sched_switch --filter 'next_comm != perf && prev_comm != perf' -e sched:sched_wakeup --filter 'comm != perf' @@ -977,16 +990,16 @@ specific values:: kworker/0:3 1209 [000] 7932.326214: sched_switch: prev_comm=kworker/0:3 prev_pid=1209 prev_prio=120 prev_state=S ==> next_comm=swapper/0 next_pid=0 next_prio=120 In this case, we've filtered out all events that have -'perf' in their 'comm' or 'comm_prev' or 'comm_next' fields. Notice that +``perf`` in their ``comm``, ``comm_prev`` or ``comm_next`` fields. Notice that there are still events recorded for perf, but notice that those events -don't have values of 'perf' for the filtered fields. To completely +don't have values of ``perf`` for the filtered fields. To completely filter out anything from perf will require a bit more work, but for the purpose of demonstrating how to use filters, it's close enough. .. admonition:: Tying it Together These are exactly the same set of event filters defined by the trace - event subsystem. See the ftrace/tracecmd/kernelshark section for more + event subsystem. See the ftrace / trace-cmd / KernelShark section for more discussion about these event filters. .. admonition:: Tying it Together @@ -996,14 +1009,14 @@ purpose of demonstrating how to use filters, it's close enough. indispensable part of the perf design as it relates to tracing. kernel-based event filters provide a mechanism to precisely throttle the event stream that appears in user space, where it makes sense to - provide bindings to real programming languages for postprocessing the + provide bindings to real programming languages for post-processing the event stream. This architecture allows for the intelligent and flexible partitioning of processing between the kernel and user space. Contrast this with other tools such as SystemTap, which does all of its processing in the kernel and as such requires a special project-defined language in order to accommodate that design, or - LTTng, where everything is sent to userspace and as such requires a - super-efficient kernel-to-userspace transport mechanism in order to + LTTng, where everything is sent to user space and as such requires a + super-efficient kernel-to-user space transport mechanism in order to function properly. While perf certainly can benefit from for instance advances in the design of the transport, it doesn't fundamentally depend on them. Basically, if you find that your perf tracing @@ -1014,9 +1027,9 @@ Using Dynamic Tracepoints ~~~~~~~~~~~~~~~~~~~~~~~~~ perf isn't restricted to the fixed set of static tracepoints listed by -'perf list'. Users can also add their own 'dynamic' tracepoints anywhere -in the kernel. For instance, suppose we want to define our own -tracepoint on do_fork(). We can do that using the 'perf probe' perf +``perf list``. Users can also add their own "dynamic" tracepoints anywhere +in the kernel. For example, suppose we want to define our own +tracepoint on ``do_fork()``. We can do that using the ``perf probe`` perf subcommand:: root@crownbay:~# perf probe do_fork @@ -1028,8 +1041,8 @@ subcommand:: perf record -e probe:do_fork -aR sleep 1 Adding a new tracepoint via -'perf probe' results in an event with all the expected files and format -in /sys/kernel/debug/tracing/events, just the same as for static +``perf probe`` results in an event with all the expected files and format +in ``/sys/kernel/debug/tracing/events``, just the same as for static tracepoints (as discussed in more detail in the trace events subsystem section:: @@ -1045,13 +1058,13 @@ section:: name: do_fork ID: 944 format: - field:unsigned short common_type; offset:0; size:2; signed:0; - field:unsigned char common_flags; offset:2; size:1; signed:0; - field:unsigned char common_preempt_count; offset:3; size:1; signed:0; - field:int common_pid; offset:4; size:4; signed:1; - field:int common_padding; offset:8; size:4; signed:1; + field:unsigned short common_type; offset:0; size:2; signed:0; + field:unsigned char common_flags; offset:2; size:1; signed:0; + field:unsigned char common_preempt_count; offset:3; size:1; signed:0; + field:int common_pid; offset:4; size:4; signed:1; + field:int common_padding; offset:8; size:4; signed:1; - field:unsigned long __probe_ip; offset:12; size:4; signed:0; + field:unsigned long __probe_ip; offset:12; size:4; signed:0; print fmt: "(%lx)", REC->__probe_ip @@ -1062,7 +1075,7 @@ existence:: probe:do_fork (on do_fork) probe:schedule (on schedule) -Let's record system-wide ('sleep 30' is a +Let's record system-wide (``sleep 30`` is a trick for recording system-wide but basically do nothing and then wake up after 30 seconds):: @@ -1070,7 +1083,7 @@ up after 30 seconds):: [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.087 MB perf.data (~3812 samples) ] -Using 'perf script' we can see each do_fork event that fired:: +Using ``perf script`` we can see each ``do_fork`` event that fired:: root@crownbay:~# perf script @@ -1111,72 +1124,73 @@ Using 'perf script' we can see each do_fork event that fired:: matchbox-deskto 1311 [001] 34237.114106: do_fork: (c1028460) gaku 1312 [000] 34237.202388: do_fork: (c1028460) -And using 'perf report' on the same file, we can see the -callgraphs from starting a few programs during those 30 seconds: +And using ``perf report`` on the same file, we can see the +call graphs from starting a few programs during those 30 seconds: .. image:: figures/perf-probe-do_fork-profile.png :align: center + :width: 70% .. admonition:: Tying it Together The trace events subsystem accommodate static and dynamic tracepoints - in exactly the same way - there's no difference as far as the + in exactly the same way --- there's no difference as far as the infrastructure is concerned. See the ftrace section for more details on the trace event subsystem. .. admonition:: Tying it Together - Dynamic tracepoints are implemented under the covers by kprobes and - uprobes. kprobes and uprobes are also used by and in fact are the + Dynamic tracepoints are implemented under the covers by Kprobes and + Uprobes. Kprobes and Uprobes are also used by and in fact are the main focus of SystemTap. -Perf Documentation +perf Documentation ------------------ -Online versions of the man pages for the commands discussed in this +Online versions of the manual pages for the commands discussed in this section can be found here: -- The `'perf stat' manpage <https://linux.die.net/man/1/perf-stat>`__. +- The `'perf stat' manual page <https://linux.die.net/man/1/perf-stat>`__. - The `'perf record' - manpage <https://linux.die.net/man/1/perf-record>`__. + manual page <https://linux.die.net/man/1/perf-record>`__. - The `'perf report' - manpage <https://linux.die.net/man/1/perf-report>`__. + manual page <https://linux.die.net/man/1/perf-report>`__. -- The `'perf probe' manpage <https://linux.die.net/man/1/perf-probe>`__. +- The `'perf probe' manual page <https://linux.die.net/man/1/perf-probe>`__. - The `'perf script' - manpage <https://linux.die.net/man/1/perf-script>`__. + manual page <https://linux.die.net/man/1/perf-script>`__. -- Documentation on using the `'perf script' python +- Documentation on using the `'perf script' Python binding <https://linux.die.net/man/1/perf-script-python>`__. -- The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__. +- The top-level `perf(1) manual page <https://linux.die.net/man/1/perf>`__. -Normally, you should be able to invoke the man pages via perf itself -e.g. 'perf help' or 'perf help record'. +Normally, you should be able to open the manual pages via perf itself +e.g. ``perf help`` or ``perf help record``. -To have the perf manpages installed on your target, modify your +To have the perf manual pages installed on your target, modify your configuration as follows:: IMAGE_INSTALL:append = " perf perf-doc" DISTRO_FEATURES:append = " api-documentation" -The man pages in text form, along with some other files, such as a set -of examples, can also be found in the 'perf' directory of the kernel tree:: +The manual pages in text form, along with some other files, such as a set +of examples, can also be found in the ``perf`` directory of the kernel tree:: tools/perf/Documentation There's also a nice perf tutorial on the perf -wiki that goes into more detail than we do here in certain areas: `Perf +wiki that goes into more detail than we do here in certain areas: `perf Tutorial <https://perf.wiki.kernel.org/index.php/Tutorial>`__ ftrace ====== -'ftrace' literally refers to the 'ftrace function tracer' but in reality -this encompasses a number of related tracers along with the +"ftrace" literally refers to the "ftrace function tracer" but in reality +this encompasses several related tracers along with the infrastructure that they all make use of. ftrace Setup @@ -1185,20 +1199,20 @@ ftrace Setup For this section, we'll assume you've already performed the basic setup outlined in the ":ref:`profile-manual/intro:General Setup`" section. -ftrace, trace-cmd, and kernelshark run on the target system, and are -ready to go out-of-the-box - no additional setup is necessary. For the -rest of this section we assume you've ssh'ed to the host and will be -running ftrace on the target. kernelshark is a GUI application and if -you use the '-X' option to ssh you can have the kernelshark GUI run on +ftrace, trace-cmd, and KernelShark run on the target system, and are +ready to go out-of-the-box --- no additional setup is necessary. For the +rest of this section we assume you're connected to the host through SSH and +will be running ftrace on the target. KernelShark is a GUI application and if +you use the ``-X`` option to ``ssh`` you can have the KernelShark GUI run on the target but display remotely on the host if you want. Basic ftrace usage ------------------ -'ftrace' essentially refers to everything included in the /tracing +"ftrace" essentially refers to everything included in the ``/tracing`` directory of the mounted debugfs filesystem (Yocto follows the standard -convention and mounts it at /sys/kernel/debug). Here's a listing of all -the files found in /sys/kernel/debug/tracing on a Yocto system:: +convention and mounts it at ``/sys/kernel/debug``). All the files found in +``/sys/kernel/debug/tracing`` on a Yocto system are:: root@sugarbay:/sys/kernel/debug/tracing# ls README kprobe_events trace @@ -1214,7 +1228,7 @@ the files found in /sys/kernel/debug/tracing on a Yocto system:: free_buffer set_graph_function The files listed above are used for various purposes -- some relate directly to the tracers themselves, others are used to set +--- some relate directly to the tracers themselves, others are used to set tracing options, and yet others actually contain the tracing output when a tracer is in effect. Some of the functions can be guessed from their names, others need explanation; in any case, we'll cover some of the @@ -1223,30 +1237,30 @@ the ftrace documentation. We'll start by looking at some of the available built-in tracers. -cat'ing the 'available_tracers' file lists the set of available tracers:: +The ``available_tracers`` file lists the set of available tracers:: root@sugarbay:/sys/kernel/debug/tracing# cat available_tracers blk function_graph function nop -The 'current_tracer' file contains the tracer currently in effect:: +The ``current_tracer`` file contains the tracer currently in effect:: root@sugarbay:/sys/kernel/debug/tracing# cat current_tracer nop -The above listing of current_tracer shows that the -'nop' tracer is in effect, which is just another way of saying that +The above listing of ``current_tracer`` shows that the +``nop`` tracer is in effect, which is just another way of saying that there's actually no tracer currently in effect. -echo'ing one of the available_tracers into current_tracer makes the +Writing one of the available tracers into ``current_tracer`` makes the specified tracer the current tracer:: root@sugarbay:/sys/kernel/debug/tracing# echo function > current_tracer root@sugarbay:/sys/kernel/debug/tracing# cat current_tracer function -The above sets the current tracer to be the 'function tracer'. This tracer +The above sets the current tracer to be the ``function`` tracer. This tracer traces every function call in the kernel and makes it available as the -contents of the 'trace' file. Reading the 'trace' file lists the +contents of the ``trace`` file. Reading the ``trace`` file lists the currently buffered function calls that have been traced by the function tracer:: @@ -1293,7 +1307,7 @@ tracer:: . Each line in the trace above shows what was happening in the kernel on a given -cpu, to the level of detail of function calls. Each entry shows the function +CPU, to the level of detail of function calls. Each entry shows the function called, followed by its caller (after the arrow). The function tracer gives you an extremely detailed idea of what the @@ -1303,11 +1317,11 @@ great way to learn about how the kernel code works in a dynamic sense. .. admonition:: Tying it Together The ftrace function tracer is also available from within perf, as the - ftrace:function tracepoint. + ``ftrace:function`` tracepoint. It is a little more difficult to follow the call chains than it needs to -be - luckily there's a variant of the function tracer that displays the -callchains explicitly, called the 'function_graph' tracer:: +be --- luckily there's a variant of the function tracer that displays the +call chains explicitly, called the ``function_graph`` tracer:: root@sugarbay:/sys/kernel/debug/tracing# echo function_graph > current_tracer root@sugarbay:/sys/kernel/debug/tracing# cat trace | less @@ -1422,11 +1436,11 @@ callchains explicitly, called the 'function_graph' tracer:: 3) + 13.784 us | } 3) | sys_ioctl() { -As you can see, the function_graph display is much easier +As you can see, the ``function_graph`` display is much easier to follow. Also note that in addition to the function calls and associated braces, other events such as scheduler events are displayed in context. In fact, you can freely include any tracepoint available in -the trace events subsystem described in the next section by simply +the trace events subsystem described in the next section by just enabling those events, and they'll appear in context in the function graph display. Quite a powerful tool for understanding kernel dynamics. @@ -1440,9 +1454,9 @@ The 'trace events' Subsystem ---------------------------- One especially important directory contained within the -/sys/kernel/debug/tracing directory is the 'events' subdirectory, which +``/sys/kernel/debug/tracing`` directory is the ``events`` subdirectory, which contains representations of every tracepoint in the system. Listing out -the contents of the 'events' subdirectory, we see mainly another set of +the contents of the ``events`` subdirectory, we see mainly another set of subdirectories:: root@sugarbay:/sys/kernel/debug/tracing# cd events @@ -1490,9 +1504,9 @@ subdirectories:: drwxr-xr-x 26 root root 0 Nov 14 23:19 writeback Each one of these subdirectories -corresponds to a 'subsystem' and contains yet again more subdirectories, +corresponds to a "subsystem" and contains yet again more subdirectories, each one of those finally corresponding to a tracepoint. For example, -here are the contents of the 'kmem' subsystem:: +here are the contents of the ``kmem`` subsystem:: root@sugarbay:/sys/kernel/debug/tracing/events# cd kmem root@sugarbay:/sys/kernel/debug/tracing/events/kmem# ls -al @@ -1514,7 +1528,7 @@ here are the contents of the 'kmem' subsystem:: drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_pcpu_drain Let's see what's inside the subdirectory for a -specific tracepoint, in this case the one for kmalloc:: +specific tracepoint, in this case the one for ``kmalloc``:: root@sugarbay:/sys/kernel/debug/tracing/events/kmem# cd kmalloc root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# ls -al @@ -1525,28 +1539,28 @@ specific tracepoint, in this case the one for kmalloc:: -r--r--r-- 1 root root 0 Nov 14 23:19 format -r--r--r-- 1 root root 0 Nov 14 23:19 id -The 'format' file for the +The ``format`` file for the tracepoint describes the event in memory, which is used by the various tracing tools that now make use of these tracepoint to parse the event -and make sense of it, along with a 'print fmt' field that allows tools -like ftrace to display the event as text. Here's what the format of the -kmalloc event looks like:: +and make sense of it, along with a ``print fmt`` field that allows tools +like ftrace to display the event as text. The format of the +``kmalloc`` event looks like:: root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# cat format name: kmalloc ID: 313 format: - field:unsigned short common_type; offset:0; size:2; signed:0; - field:unsigned char common_flags; offset:2; size:1; signed:0; - field:unsigned char common_preempt_count; offset:3; size:1; signed:0; - field:int common_pid; offset:4; size:4; signed:1; - field:int common_padding; offset:8; size:4; signed:1; - - field:unsigned long call_site; offset:16; size:8; signed:0; - field:const void * ptr; offset:24; size:8; signed:0; - field:size_t bytes_req; offset:32; size:8; signed:0; - field:size_t bytes_alloc; offset:40; size:8; signed:0; - field:gfp_t gfp_flags; offset:48; size:4; signed:0; + field:unsigned short common_type; offset:0; size:2; signed:0; + field:unsigned char common_flags; offset:2; size:1; signed:0; + field:unsigned char common_preempt_count; offset:3; size:1; signed:0; + field:int common_pid; offset:4; size:4; signed:1; + field:int common_padding; offset:8; size:4; signed:1; + + field:unsigned long call_site; offset:16; size:8; signed:0; + field:const void * ptr; offset:24; size:8; signed:0; + field:size_t bytes_req; offset:32; size:8; signed:0; + field:size_t bytes_alloc; offset:40; size:8; signed:0; + field:gfp_t gfp_flags; offset:48; size:4; signed:0; print fmt: "call_site=%lx ptr=%p bytes_req=%zu bytes_alloc=%zu gfp_flags=%s", REC->call_site, REC->ptr, REC->bytes_req, REC->bytes_alloc, (REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {(unsigned long)(((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | (( @@ -1565,11 +1579,11 @@ kmalloc event looks like:: long)(( gfp_t)0x08u), "GFP_MOVABLE"}, {(unsigned long)(( gfp_t)0), "GFP_NOTRACK"}, {(unsigned long)(( gfp_t)0x400000u), "GFP_NO_KSWAPD"}, {(unsigned long)(( gfp_t)0x800000u), "GFP_OTHER_NODE"} ) : "GFP_NOWAIT" -The 'enable' file +The ``enable`` file in the tracepoint directory is what allows the user (or tools such as -trace-cmd) to actually turn the tracepoint on and off. When enabled, the -corresponding tracepoint will start appearing in the ftrace 'trace' file -described previously. For example, this turns on the kmalloc tracepoint:: +``trace-cmd``) to actually turn the tracepoint on and off. When enabled, the +corresponding tracepoint will start appearing in the ftrace ``trace`` file +described previously. For example, this turns on the ``kmalloc`` tracepoint:: root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# echo 1 > enable @@ -1581,8 +1595,8 @@ events in the output buffer:: root@sugarbay:/sys/kernel/debug/tracing# echo nop > current_tracer root@sugarbay:/sys/kernel/debug/tracing# echo 1 > tracing_on -Now, if we look at the 'trace' file, we see nothing -but the kmalloc events we just turned on:: +Now, if we look at the ``trace`` file, we see nothing +but the ``kmalloc`` events we just turned on:: root@sugarbay:/sys/kernel/debug/tracing# cat trace | less # tracer: nop @@ -1628,17 +1642,17 @@ but the kmalloc events we just turned on:: <idle>-0 [000] ..s3 18156.400660: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d554800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC matchbox-termin-1361 [001] ...1 18156.552800: kmalloc: call_site=ffffffff81614050 ptr=ffff88006db34800 bytes_req=576 bytes_alloc=1024 gfp_flags=GFP_KERNEL|GFP_REPEAT -To again disable the kmalloc event, we need to send 0 to the enable file:: +To again disable the ``kmalloc`` event, we need to send ``0`` to the ``enable`` file:: root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# echo 0 > enable You can enable any number of events or complete subsystems (by -using the 'enable' file in the subsystem directory) and get an +using the ``enable`` file in the subsystem directory) and get an arbitrarily fine-grained idea of what's going on in the system by enabling as many of the appropriate tracepoints as applicable. -A number of the tools described in this HOWTO do just that, including -trace-cmd and kernelshark in the next section. +Several tools described in this How-to do just that, including +``trace-cmd`` and KernelShark in the next section. .. admonition:: Tying it Together @@ -1646,80 +1660,83 @@ trace-cmd and kernelshark in the next section. ftrace, but by many of the other tools covered in this document and they form a central point of integration for the various tracers available in Linux. They form a central part of the instrumentation - for the following tools: perf, lttng, ftrace, blktrace and SystemTap + for the following tools: perf, LTTng, ftrace, blktrace and SystemTap .. admonition:: Tying it Together Eventually all the special-purpose tracers currently available in - /sys/kernel/debug/tracing will be removed and replaced with - equivalent tracers based on the 'trace events' subsystem. + ``/sys/kernel/debug/tracing`` will be removed and replaced with + equivalent tracers based on the "trace events" subsystem. -trace-cmd/kernelshark ---------------------- +trace-cmd / KernelShark +----------------------- -trace-cmd is essentially an extensive command-line 'wrapper' interface +trace-cmd is essentially an extensive command-line "wrapper" interface that hides the details of all the individual files in -/sys/kernel/debug/tracing, allowing users to specify specific particular -events within the /sys/kernel/debug/tracing/events/ subdirectory and to +``/sys/kernel/debug/tracing``, allowing users to specify specific particular +events within the ``/sys/kernel/debug/tracing/events/`` subdirectory and to collect traces and avoid having to deal with those details directly. -As yet another layer on top of that, kernelshark provides a GUI that +As yet another layer on top of that, KernelShark provides a GUI that allows users to start and stop traces and specify sets of events using an intuitive interface, and view the output as both trace events and as -a per-CPU graphical display. It directly uses 'trace-cmd' as the +a per-CPU graphical display. It directly uses trace-cmd as the plumbing that accomplishes all that underneath the covers (and actually displays the trace-cmd command it uses, as we'll see). -To start a trace using kernelshark, first start kernelshark:: +To start a trace using KernelShark, first start this tool:: root@sugarbay:~# kernelshark -Then bring up the 'Capture' dialog by -choosing from the kernelshark menu:: +Then open up the ``Capture`` dialog by choosing from the KernelShark menu:: Capture | Record That will display the following dialog, which allows you to choose one or more -events (or even one or more complete subsystems) to trace: +events (or even entire subsystems) to trace: .. image:: figures/kernelshark-choose-events.png :align: center + :width: 70% Note that these are exactly the same sets of events described in the previous trace events subsystem section, and in fact is where trace-cmd -gets them for kernelshark. +gets them for KernelShark. In the above screenshot, we've decided to explore the graphics subsystem a bit and so have chosen to trace all the tracepoints contained within -the 'i915' and 'drm' subsystems. +the ``i915`` and ``drm`` subsystems. -After doing that, we can start and stop the trace using the 'Run' and -'Stop' button on the lower right corner of the dialog (the same button +After doing that, we can start and stop the trace using the ``Run`` and +``Stop`` button on the lower right corner of the dialog (the same button will turn into the 'Stop' button after the trace has started): .. image:: figures/kernelshark-output-display.png :align: center + :width: 70% -Notice that the right-hand pane shows the exact trace-cmd command-line +Notice that the right pane shows the exact trace-cmd command-line that's used to run the trace, along with the results of the trace-cmd run. -Once the 'Stop' button is pressed, the graphical view magically fills up -with a colorful per-cpu display of the trace data, along with the +Once the ``Stop`` button is pressed, the graphical view magically fills up +with a colorful per-CPU display of the trace data, along with the detailed event listing below that: .. image:: figures/kernelshark-i915-display.png :align: center + :width: 70% -Here's another example, this time a display resulting from tracing 'all -events': +Here's another example, this time a display resulting from tracing ``all +events``: .. image:: figures/kernelshark-all.png :align: center + :width: 70% The tool is pretty self-explanatory, but for more detailed information -on navigating through the data, see the `kernelshark -website <https://rostedt.homelinux.com/kernelshark/>`__. +on navigating through the data, see the `KernelShark +website <https://kernelshark.org/Documentation.html>`__. ftrace Documentation -------------------- @@ -1734,41 +1751,41 @@ Documentation directory:: Documentation/trace/events.txt -There is a nice series of articles on using ftrace and trace-cmd at LWN: +A nice series of articles on using ftrace and trace-cmd are available at LWN: -- `Debugging the kernel using Ftrace - part +- `Debugging the kernel using ftrace - part 1 <https://lwn.net/Articles/365835/>`__ -- `Debugging the kernel using Ftrace - part +- `Debugging the kernel using ftrace - part 2 <https://lwn.net/Articles/366796/>`__ -- `Secrets of the Ftrace function +- `Secrets of the ftrace function tracer <https://lwn.net/Articles/370423/>`__ - `trace-cmd: A front-end for - Ftrace <https://lwn.net/Articles/410200/>`__ + ftrace <https://lwn.net/Articles/410200/>`__ -There's more detailed documentation kernelshark usage here: -`KernelShark <https://rostedt.homelinux.com/kernelshark/>`__ +See also `KernelShark's documentation <https://kernelshark.org/Documentation.html>`__ +for further usage details. -An amusing yet useful README (a tracing mini-HOWTO) can be found in +An amusing yet useful README (a tracing mini-How-to) can be found in ``/sys/kernel/debug/tracing/README``. -systemtap +SystemTap ========= SystemTap is a system-wide script-based tracing and profiling tool. SystemTap scripts are C-like programs that are executed in the kernel to -gather/print/aggregate data extracted from the context they end up being -invoked under. +gather / print / aggregate data extracted from the context they end up being +called under. For example, this probe from the `SystemTap -tutorial <https://sourceware.org/systemtap/tutorial/>`__ simply prints a -line every time any process on the system open()s a file. For each line, +tutorial <https://sourceware.org/systemtap/tutorial/>`__ just prints a +line every time any process on the system runs ``open()`` on a file. For each line, it prints the executable name of the program that opened the file, along -with its PID, and the name of the file it opened (or tried to open), -which it extracts from the open syscall's argstr. +with its PID, and the name of the file it opened (or tried to open), which it +extracts from the argument string (``argstr``) of the ``open`` system call. .. code-block:: none @@ -1783,48 +1800,48 @@ which it extracts from the open syscall's argstr. } Normally, to execute this -probe, you'd simply install systemtap on the system you want to probe, +probe, you'd just install SystemTap on the system you want to probe, and directly run the probe on that system e.g. assuming the name of the -file containing the above text is trace_open.stp:: +file containing the above text is ``trace_open.stp``:: # stap trace_open.stp -What systemtap does under the covers to run this probe is 1) parse and -convert the probe to an equivalent 'C' form, 2) compile the 'C' form +What SystemTap does under the covers to run this probe is 1) parse and +convert the probe to an equivalent "C" form, 2) compile the "C" form into a kernel module, 3) insert the module into the kernel, which arms it, and 4) collect the data generated by the probe and display it to the user. -In order to accomplish steps 1 and 2, the 'stap' program needs access to +In order to accomplish steps 1 and 2, the ``stap`` program needs access to the kernel build system that produced the kernel that the probed system -is running. In the case of a typical embedded system (the 'target'), the +is running. In the case of a typical embedded system (the "target"), the kernel build system unfortunately isn't typically part of the image -running on the target. It is normally available on the 'host' system +running on the target. It is normally available on the "host" system that produced the target image however; in such cases, steps 1 and 2 are executed on the host system, and steps 3 and 4 are executed on the -target system, using only the systemtap 'runtime'. +target system, using only the SystemTap "runtime". -The systemtap support in Yocto assumes that only steps 3 and 4 are run +The SystemTap support in Yocto assumes that only steps 3 and 4 are run on the target; it is possible to do everything on the target, but this section assumes only the typical embedded use-case. -So basically what you need to do in order to run a systemtap script on +Therefore, what you need to do in order to run a SystemTap script on the target is to 1) on the host system, compile the probe into a kernel module that makes sense to the target, 2) copy the module onto the target system and 3) insert the module into the target kernel, which arms it, and 4) collect the data generated by the probe and display it to the user. -systemtap Setup +SystemTap Setup --------------- -Those are a lot of steps and a lot of details, but fortunately Yocto -includes a script called 'crosstap' that will take care of those -details, allowing you to simply execute a systemtap script on the remote +Those are many steps and details, but fortunately Yocto +includes a script called ``crosstap`` that will take care of those +details, allowing you to just execute a SystemTap script on the remote target, with arguments if necessary. In order to do this from a remote host, however, you need to have access -to the build for the image you booted. The 'crosstap' script provides +to the build for the image you booted. The ``crosstap`` script provides details on how to do this if you run the script on the host without having done a build:: @@ -1833,29 +1850,35 @@ having done a build:: Error: No target kernel build found. Did you forget to create a local build of your image? - 'crosstap' requires a local sdk build of the target system - (or a build that includes 'tools-profile') in order to build - kernel modules that can probe the target system. - - Practically speaking, that means you need to do the following: - - If you're running a pre-built image, download the release - and/or BSP tarballs used to build the image. - - If you're working from git sources, just clone the metadata - and BSP layers needed to build the image you'll be booting. - - Make sure you're properly set up to build a new image (see - the BSP README and/or the widely available basic documentation - that discusses how to build images). - - Build an -sdk version of the image e.g.: - $ bitbake core-image-sato-sdk - OR - - Build a non-sdk image but include the profiling tools: - [ edit local.conf and add 'tools-profile' to the end of - the EXTRA_IMAGE_FEATURES variable ] - $ bitbake core-image-sato +'crosstap' requires a local SDK build of the target system +(or a build that includes 'tools-profile') in order to build +kernel modules that can probe the target system. + +Practically speaking, that means you need to do the following: + +- If you're running a pre-built image, download the release + and/or BSP tarballs used to build the image. + +- If you're working from git sources, just clone the metadata + and BSP layers needed to build the image you'll be booting. + +- Make sure you're properly set up to build a new image (see + the BSP README and/or the widely available basic documentation + that discusses how to build images). + +- Build an ``-sdk`` version of the image e.g.:: + + $ bitbake core-image-sato-sdk + +- Or build a non-SDK image but include the profiling tools + (edit ``local.conf`` and add ``tools-profile`` to the end of + :term:`EXTRA_IMAGE_FEATURES` variable):: + + $ bitbake core-image-sato Once you've build the image on the host system, you're ready to - boot it (or the equivalent pre-built image) and use 'crosstap' - to probe it (you need to source the environment as usual first): + boot it (or the equivalent pre-built image) and use ``crosstap`` + to probe it (you need to source the environment as usual first):: $ source oe-init-build-env $ cd ~/my/systemtap/scripts @@ -1863,29 +1886,27 @@ having done a build:: .. note:: - SystemTap, which uses 'crosstap', assumes you can establish an ssh + SystemTap, which uses ``crosstap``, assumes you can establish an SSH connection to the remote target. Please refer to the crosstap wiki - page for details on verifying ssh connections at - . Also, the ability to ssh into the target system is not enabled by - default in \*-minimal images. + page for details on verifying SSH connections. Also, the ability to SSH + into the target system is not enabled by default in ``*-minimal`` images. -So essentially what you need to -do is build an SDK image or image with 'tools-profile' as detailed in -the ":ref:`profile-manual/intro:General Setup`" section of this -manual, and boot the resulting target image. +Therefore, what you need to do is build an SDK image or image with +``tools-profile`` as detailed in the ":ref:`profile-manual/intro:General Setup`" +section of this manual, and boot the resulting target image. .. note:: - If you have a build directory containing multiple machines, you need - to have the MACHINE you're connecting to selected in local.conf, and - the kernel in that machine's build directory must match the kernel on - the booted system exactly, or you'll get the above 'crosstap' message - when you try to invoke a script. + If you have a :term:`Build Directory` containing multiple machines, you need + to have the :term:`MACHINE` you're connecting to selected in ``local.conf``, and + the kernel in that machine's :term:`Build Directory` must match the kernel on + the booted system exactly, or you'll get the above ``crosstap`` message + when you try to call a script. Running a Script on a Target ---------------------------- -Once you've done that, you should be able to run a systemtap script on +Once you've done that, you should be able to run a SystemTap script on the target:: $ cd /path/to/yocto @@ -1903,8 +1924,8 @@ the target:: You can also run generated QEMU images with a command like 'runqemu qemux86-64' -Once you've done that, you can cd to whatever -directory contains your scripts and use 'crosstap' to run the script:: +Once you've done that, you can ``cd`` to whatever +directory contains your scripts and use ``crosstap`` to run the script:: $ cd /path/to/my/systemap/script $ crosstap root@192.168.7.2 trace_open.stp @@ -1914,13 +1935,12 @@ If you get an error connecting to the target e.g.:: $ crosstap root@192.168.7.2 trace_open.stp error establishing ssh connection on remote 'root@192.168.7.2' -Try ssh'ing to the target and see what happens:: +Try connecting to the target through SSH and see what happens:: $ ssh root@192.168.7.2 -A lot of the time, connection -problems are due specifying a wrong IP address or having a 'host key -verification error'. +Connection problems are often due specifying a wrong IP address or having a ``host key +verification error``. If everything worked as planned, you should see something like this (enter the password when prompted, or press enter if it's set up to use @@ -1933,7 +1953,7 @@ no password): matchbox-termin(1036) open ("/tmp/vte3FS2LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600) matchbox-termin(1036) open ("/tmp/vteJMC7LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600) -systemtap Documentation +SystemTap Documentation ----------------------- The SystemTap language reference can be found here: `SystemTap Language @@ -1946,7 +1966,7 @@ page <https://sourceware.org/systemtap/documentation.html>`__ Sysprof ======= -Sysprof is a very easy to use system-wide profiler that consists of a +Sysprof is an easy to use system-wide profiler that consists of a single window with three panes and a few buttons which allow you to start, stop, and view the profile from one place. @@ -1956,41 +1976,43 @@ Sysprof Setup For this section, we'll assume you've already performed the basic setup outlined in the ":ref:`profile-manual/intro:General Setup`" section. -Sysprof is a GUI-based application that runs on the target system. For -the rest of this document we assume you've ssh'ed to the host and will -be running Sysprof on the target (you can use the '-X' option to ssh and +Sysprof is a GUI-based application that runs on the target system. For the rest +of this document we assume you're connected to the host through SSH and will be +running Sysprof on the target (you can use the ``-X`` option to ``ssh`` and have the Sysprof GUI run on the target but display remotely on the host if you want). Basic Sysprof Usage ------------------- -To start profiling the system, you simply press the 'Start' button. To +To start profiling the system, you just press the ``Start`` button. To stop profiling and to start viewing the profile data in one easy step, -press the 'Profile' button. +press the ``Profile`` button. Once you've pressed the profile button, the three panes will fill up with profiling data: .. image:: figures/sysprof-copy-to-user.png :align: center + :width: 70% The left pane shows a list of functions and processes. Selecting one of those expands that function in the right pane, showing all its callees. Note that this caller-oriented display is essentially the inverse of -perf's default callee-oriented callchain display. +perf's default callee-oriented call chain display. In the screenshot above, we're focusing on ``__copy_to_user_ll()`` and -looking up the callchain we can see that one of the callers of -``__copy_to_user_ll`` is sys_read() and the complete callpath between them. +looking up the call chain we can see that one of the callers of +``__copy_to_user_ll`` is ``sys_read()`` and the complete call path between them. Notice that this is essentially a portion of the same information we saw in the perf display shown in the perf section of this page. .. image:: figures/sysprof-copy-from-user.png :align: center + :width: 70% Similarly, the above is a snapshot of the Sysprof display of a -copy-from-user callchain. +``copy-from-user`` call chain. Finally, looking at the third Sysprof pane in the lower left, we can see a list of all the callers of a particular function selected in the top @@ -1999,24 +2021,24 @@ left pane. In this case, the lower pane is showing all the callers of .. image:: figures/sysprof-callers.png :align: center + :width: 70% Double-clicking on one of those functions will in turn change the focus to the selected function, and so on. .. admonition:: Tying it Together - If you like sysprof's 'caller-oriented' display, you may be able to - approximate it in other tools as well. For example, 'perf report' has - the -g (--call-graph) option that you can experiment with; one of the - options is 'caller' for an inverted caller-based callgraph display. + If you like Sysprof's ``caller-oriented`` display, you may be able to + approximate it in other tools as well. For example, ``perf report`` has + the ``-g`` (``--call-graph``) option that you can experiment with; one of the + options is ``caller`` for an inverted caller-based call graph display. Sysprof Documentation --------------------- There doesn't seem to be any documentation for Sysprof, but maybe that's -because it's pretty self-explanatory. The Sysprof website, however, is -here: `Sysprof, System-wide Performance Profiler for -Linux <http://sysprof.com/>`__ +because it's pretty self-explanatory. The Sysprof website, however, is here: +`Sysprof, System-wide Performance Profiler for Linux <http://sysprof.com/>`__ LTTng (Linux Trace Toolkit, next generation) ============================================ @@ -2026,20 +2048,20 @@ LTTng Setup For this section, we'll assume you've already performed the basic setup outlined in the ":ref:`profile-manual/intro:General Setup`" section. -LTTng is run on the target system by ssh'ing to it. +LTTng is run on the target system by connecting to it through SSH. Collecting and Viewing Traces ----------------------------- Once you've applied the above commits and built and booted your image -(you need to build the core-image-sato-sdk image or use one of the other +(you need to build the ``core-image-sato-sdk`` image or use one of the other methods described in the ":ref:`profile-manual/intro:General Setup`" section), you're ready to start tracing. Collecting and viewing a trace on the target (inside a shell) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -First, from the host, ssh to the target:: +First, from the host, connect to the target through SSH:: $ ssh -l root 192.168.1.47 The authenticity of host '192.168.1.47 (192.168.1.47)' can't be established. @@ -2116,31 +2138,31 @@ You can now view the trace in text form on the target:: . You can now safely destroy the trace -session (note that this doesn't delete the trace - it's still there in -~/lttng-traces):: +session (note that this doesn't delete the trace --- it's still there in +``~/lttng-traces``):: root@crownbay:~# lttng destroy Session auto-20121015-232120 destroyed at /home/root Note that the trace is saved in a directory of the same name as returned by -'lttng create', under the ~/lttng-traces directory (note that you can change this by -supplying your own name to 'lttng create'):: +``lttng create``, under the ``~/lttng-traces`` directory (note that you can change this by +supplying your own name to ``lttng create``):: root@crownbay:~# ls -al ~/lttng-traces drwxrwx--- 3 root root 1024 Oct 15 23:21 . drwxr-xr-x 5 root root 1024 Oct 15 23:57 .. drwxrwx--- 3 root root 1024 Oct 15 23:21 auto-20121015-232120 -Collecting and viewing a userspace trace on the target (inside a shell) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Collecting and viewing a user space trace on the target (inside a shell) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For LTTng userspace tracing, you need to have a properly instrumented -userspace program. For this example, we'll use the 'hello' test program -generated by the lttng-ust build. +For LTTng user space tracing, you need to have a properly instrumented +user space program. For this example, we'll use the ``hello`` test program +generated by the ``lttng-ust`` build. -The 'hello' test program isn't installed on the root filesystem by the lttng-ust -build, so we need to copy it over manually. First cd into the build -directory that contains the hello executable:: +The ``hello`` test program isn't installed on the root filesystem by the ``lttng-ust`` +build, so we need to copy it over manually. First ``cd`` into the build +directory that contains the ``hello`` executable:: $ cd build/tmp/work/core2_32-poky-linux/lttng-ust/2.0.5-r0/git/tests/hello/.libs @@ -2148,10 +2170,10 @@ Copy that over to the target machine:: $ scp hello root@192.168.1.20: -You now have the instrumented lttng 'hello world' test program on the +You now have the instrumented LTTng "hello world" test program on the target, ready to test. -First, from the host, ssh to the target:: +First, from the host, connect to the target through SSH:: $ ssh -l root 192.168.1.47 The authenticity of host '192.168.1.47 (192.168.1.47)' can't be established. @@ -2166,7 +2188,7 @@ Once on the target, use these steps to create a trace:: Session auto-20190303-021943 created. Traces will be written in /home/root/lttng-traces/auto-20190303-021943 -Enable the events you want to trace (in this case all userspace events):: +Enable the events you want to trace (in this case all user space events):: root@crownbay:~# lttng enable-event --userspace --all All UST events are enabled in channel channel0 @@ -2176,7 +2198,7 @@ Start the trace:: root@crownbay:~# lttng start Tracing started for session auto-20190303-021943 -Run the instrumented hello world program:: +Run the instrumented "hello world" program:: root@crownbay:~# ./hello Hello, World! @@ -2200,7 +2222,7 @@ You can now view the trace in text form on the target:: . You can now safely destroy the trace session (note that this doesn't delete the -trace - it's still there in ~/lttng-traces):: +trace --- it's still there in ``~/lttng-traces``):: root@crownbay:~# lttng destroy Session auto-20190303-021943 destroyed at /home/root @@ -2238,27 +2260,27 @@ the entire blktrace and blkparse pipeline on the target, or you can run blktrace in 'listen' mode on the target and have blktrace and blkparse collect and analyze the data on the host (see the ":ref:`profile-manual/usage:Using blktrace Remotely`" section -below). For the rest of this section we assume you've ssh'ed to the host and -will be running blkrace on the target. +below). For the rest of this section we assume you've to the host through SSH +and will be running blktrace on the target. Basic blktrace Usage -------------------- -To record a trace, simply run the 'blktrace' command, giving it the name +To record a trace, just run the ``blktrace`` command, giving it the name of the block device you want to trace activity on:: root@crownbay:~# blktrace /dev/sdc -In another shell, execute a workload you want to trace. :: +In another shell, execute a workload you want to trace:: root@crownbay:/media/sdc# rm linux-2.6.19.2.tar.bz2; wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2; sync Connecting to downloads.yoctoproject.org (140.211.169.59:80) linux-2.6.19.2.tar.b 100% \|*******************************\| 41727k 0:00:00 ETA -Press Ctrl-C in the blktrace shell to stop the trace. It +Press ``Ctrl-C`` in the blktrace shell to stop the trace. It will display how many events were logged, along with the per-cpu file -sizes (blktrace records traces in per-cpu kernel buffers and simply -dumps them to userspace for blkparse to merge and sort later). :: +sizes (blktrace records traces in per-cpu kernel buffers and just +dumps them to user space for blkparse to merge and sort later):: ^C=== sdc === CPU 0: 7082 events, 332 KiB data @@ -2274,7 +2296,7 @@ with the device name as the first part of the filename:: -rw-r--r-- 1 root root 339938 Oct 27 22:40 sdc.blktrace.0 -rw-r--r-- 1 root root 75753 Oct 27 22:40 sdc.blktrace.1 -To view the trace events, simply invoke 'blkparse' in the directory +To view the trace events, just call ``blkparse`` in the directory containing the trace files, giving it the device name that forms the first part of the filenames:: @@ -2333,29 +2355,29 @@ first part of the filenames:: 8,32 1 0 58.516990819 0 m N cfq3551 put_queue CPU0 (sdc): - Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB - Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB - Reads Requeued: 0 Writes Requeued: 0 - Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB - Read Merges: 0, 0KiB Write Merges: 13, 160KiB - Read depth: 0 Write depth: 2 - IO unplugs: 23 Timer unplugs: 0 + Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB + Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB + Reads Requeued: 0 Writes Requeued: 0 + Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB + Read Merges: 0, 0KiB Write Merges: 13, 160KiB + Read depth: 0 Write depth: 2 + IO unplugs: 23 Timer unplugs: 0 CPU1 (sdc): - Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB - Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB - Reads Requeued: 0 Writes Requeued: 0 - Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB - Read Merges: 0, 0KiB Write Merges: 40, 276KiB - Read depth: 0 Write depth: 2 - IO unplugs: 30 Timer unplugs: 1 + Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB + Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB + Reads Requeued: 0 Writes Requeued: 0 + Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB + Read Merges: 0, 0KiB Write Merges: 40, 276KiB + Read depth: 0 Write depth: 2 + IO unplugs: 30 Timer unplugs: 1 Total (sdc): - Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB - Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB - Reads Requeued: 0 Writes Requeued: 0 - Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB - Read Merges: 0, 0KiB Write Merges: 53, 436KiB - IO unplugs: 53 Timer unplugs: 1 + Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB + Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB + Reads Requeued: 0 Writes Requeued: 0 + Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB + Read Merges: 0, 0KiB Write Merges: 53, 436KiB + IO unplugs: 53 Timer unplugs: 1 Throughput (R/W): 0KiB/s / 719KiB/s Events (sdc): 6,592 entries @@ -2366,15 +2388,15 @@ first part of the filenames:: The report shows each event that was found in the blktrace data, along with a summary of the overall block I/O traffic during the run. You can look at the -`blkparse <https://linux.die.net/man/1/blkparse>`__ manpage to learn the +`blkparse <https://linux.die.net/man/1/blkparse>`__ manual page to learn the meaning of each field displayed in the trace listing. Live Mode ~~~~~~~~~ blktrace and blkparse are designed from the ground up to be able to -operate together in a 'pipe mode' where the stdout of blktrace can be -fed directly into the stdin of blkparse:: +operate together in a "pipe mode" where the standard output of blktrace can be +fed directly into the standard input of blkparse:: root@crownbay:~# blktrace /dev/sdc -o - | blkparse -i - @@ -2401,30 +2423,31 @@ tracer writes to, blktrace provides a way to trace without perturbing the traced device at all by providing native support for sending all trace data over the network. -To have blktrace operate in this mode, start blktrace on the target -system being traced with the -l option, along with the device to trace:: +To have blktrace operate in this mode, start blktrace in server mode on the +host system, which is going to store the captured data:: - root@crownbay:~# blktrace -l /dev/sdc + $ blktrace -l server: waiting for connections... -On the host system, use the -h option to connect to the target system, -also passing it the device to trace:: +On the target system that is going to be traced, start blktrace in client +mode with the -h option to connect to the host system, also passing it the +device to trace:: - $ blktrace -d /dev/sdc -h 192.168.1.43 + root@crownbay:~# blktrace -d /dev/sdc -h 192.168.1.43 blktrace: connecting to 192.168.1.43 blktrace: connected! -On the target system, you should see this:: +On the host system, you should see this:: server: connection from 192.168.1.43 -In another shell, execute a workload you want to trace. :: +In another shell, execute a workload you want to trace:: root@crownbay:/media/sdc# rm linux-2.6.19.2.tar.bz2; wget &YOCTO_DL_URL;/mirror/sources/linux-2.6.19.2.tar.bz2; sync Connecting to downloads.yoctoproject.org (140.211.169.59:80) linux-2.6.19.2.tar.b 100% \|*******************************\| 41727k 0:00:00 ETA -When it's done, do a Ctrl-C on the host system to stop the +When it's done, do a ``Ctrl-C`` on the target system to stop the trace:: ^C=== sdc === @@ -2432,7 +2455,7 @@ trace:: CPU 1: 4109 events, 193 KiB data Total: 11800 events (dropped 0), 554 KiB data -On the target system, you should also see a trace summary for the trace +On the host system, you should also see a trace summary for the trace just ended:: server: end of run for 192.168.1.43:sdc @@ -2442,14 +2465,14 @@ just ended:: Total: 11800 events (dropped 0), 554 KiB data The blktrace instance on the host will -save the target output inside a hostname-timestamp directory:: +save the target output inside a ``<hostname>-<timestamp>`` directory:: $ ls -al drwxr-xr-x 10 root root 1024 Oct 28 02:40 . drwxr-sr-x 4 root root 1024 Oct 26 18:24 .. drwxr-xr-x 2 root root 1024 Oct 28 02:40 192.168.1.43-2012-10-28-02:40:56 -cd into that directory to see the output files:: +``cd`` into that directory to see the output files:: $ ls -l -rw-r--r-- 1 root root 369193 Oct 28 02:44 sdc.blktrace.0 @@ -2477,29 +2500,29 @@ And run blkparse on the host system using the device name:: 8,32 1 0 177.266696560 0 m N cfq1267 put_queue CPU0 (sdc): - Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB - Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB - Reads Requeued: 0 Writes Requeued: 0 - Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB - Read Merges: 0, 0KiB Write Merges: 9, 344KiB - Read depth: 2 Write depth: 2 - IO unplugs: 20 Timer unplugs: 1 + Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB + Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB + Reads Requeued: 0 Writes Requeued: 0 + Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB + Read Merges: 0, 0KiB Write Merges: 9, 344KiB + Read depth: 2 Write depth: 2 + IO unplugs: 20 Timer unplugs: 1 CPU1 (sdc): - Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB - Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB - Reads Requeued: 0 Writes Requeued: 0 - Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB - Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB - Read depth: 2 Write depth: 2 - IO unplugs: 52 Timer unplugs: 0 + Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB + Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB + Reads Requeued: 0 Writes Requeued: 0 + Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB + Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB + Read depth: 2 Write depth: 2 + IO unplugs: 52 Timer unplugs: 0 Total (sdc): - Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB - Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB - Reads Requeued: 0 Writes Requeued: 0 - Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB - Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB - IO unplugs: 72 Timer unplugs: 1 + Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB + Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB + Reads Requeued: 0 Writes Requeued: 0 + Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB + Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB + IO unplugs: 72 Timer unplugs: 1 Throughput (R/W): 15KiB/s / 238KiB/s Events (sdc): 9,301 entries @@ -2514,16 +2537,16 @@ Tracing Block I/O via 'ftrace' It's also possible to trace block I/O using only :ref:`profile-manual/usage:The 'trace events' Subsystem`, which can be useful for casual tracing if you don't want to bother dealing with the -userspace tools. +user space tools. -To enable tracing for a given device, use /sys/block/xxx/trace/enable, -where xxx is the device name. This for example enables tracing for -/dev/sdc:: +To enable tracing for a given device, use ``/sys/block/xxx/trace/enable``, +where ``xxx`` is the device name. This for example enables tracing for +``/dev/sdc``:: root@crownbay:/sys/kernel/debug/tracing# echo 1 > /sys/block/sdc/trace/enable Once you've selected the device(s) you want -to trace, selecting the 'blk' tracer will turn the blk tracer on:: +to trace, selecting the ``blk`` tracer will turn the blk tracer on:: root@crownbay:/sys/kernel/debug/tracing# cat available_tracers blk function_graph function nop @@ -2534,8 +2557,8 @@ Execute the workload you're interested in:: root@crownbay:/sys/kernel/debug/tracing# cat /media/sdc/testfile.txt -And look at the output (note here that we're using 'trace_pipe' instead of -trace to capture this trace - this allows us to wait around on the pipe +And look at the output (note here that we're using ``trace_pipe`` instead of +trace to capture this trace --- this allows us to wait around on the pipe for data to appear):: root@crownbay:/sys/kernel/debug/tracing# cat trace_pipe @@ -2562,7 +2585,7 @@ And this turns off tracing for the specified device:: blktrace Documentation ---------------------- -Online versions of the man pages for the commands discussed in this +Online versions of the manual pages for the commands discussed in this section can be found here: - https://linux.die.net/man/8/blktrace @@ -2571,8 +2594,8 @@ section can be found here: - https://linux.die.net/man/8/btrace -The above manpages, along with manpages for the other blktrace utilities -(btt, blkiomon, etc) can be found in the /doc directory of the blktrace -tools git repo:: +The above manual pages, along with manuals for the other blktrace utilities +(``btt``, ``blkiomon``, etc) can be found in the ``/doc`` directory of the blktrace +tools git repository:: $ git clone git://git.kernel.dk/blktrace.git 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 d9065b3619..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. To use this class, inherit -the class globally and set :term:`PNBLACKLIST` for -each recipe you wish to ignore. 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 ignore 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. -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`. +By default, the :ref:`ref-classes-cmake` class uses +`Ninja <https://ninja-build.org/>`__ instead of GNU make for building, which +offers better build performance. If a recipe is broken with Ninja, then the +recipe can set the :term:`OECMAKE_GENERATOR` variable to ``Unix Makefiles`` to +use GNU make instead. + +If you need to install custom CMake toolchain files supplied by the application +being built, you should install them (during :ref:`ref-tasks-install`) to the +preferred CMake Module directory: ``${D}${datadir}/cmake/modules/``. + +.. _ref-classes-cmake-qemu: + +``cmake-qemu`` +============== + +The :ref:`ref-classes-cmake-qemu` class might be used instead of the +:ref:`ref-classes-cmake` class. In addition to the features provided by the +:ref:`ref-classes-cmake` class, the :ref:`ref-classes-cmake-qemu` class passes +the ``CMAKE_CROSSCOMPILING_EMULATOR`` setting to ``cmake``. This allows to use +QEMU user-mode emulation for the execution of cross-compiled binaries on the +host machine. For more information about ``CMAKE_CROSSCOMPILING_EMULATOR`` +please refer to the `related section of the CMake documentation +<https://cmake.org/cmake/help/latest/variable/CMAKE_CROSSCOMPILING_EMULATOR.html>`__. + +Not all platforms are supported by QEMU. This class only works for machines with +``qemu-usermode`` in the :ref:`ref-features-machine`. Using QEMU user-mode therefore +involves a certain risk, which is also the reason why this feature is not part of +the main :ref:`ref-classes-cmake` class by default. + +One use case is the execution of cross-compiled unit tests with CTest on the build +machine. If ``CMAKE_CROSSCOMPILING_EMULATOR`` is configured:: + + cmake --build --target test + +works transparently with QEMU user-mode. + +If the CMake project is developed with this use case in mind this works very nicely. +This also applies to an IDE configured to use ``cmake-native`` for cross-compiling. .. _ref-classes-cml1: -``cml1.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,51 +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. - - .. note:: - - ``distutils`` has been deprecated in Python 3.10 and will be removed - in Python 3.12. For this reason the ``distutils3*`` classes are now - deprecated and will be removed from core in the near future. Instead, - use the ``setuptools3*`` classes. - - -- 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. @@ -540,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 @@ -557,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 @@ -577,13 +777,11 @@ be performed using the .. note:: - The user and group operations added using the - :ref:`extrausers <ref-classes-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 - :ref:`useradd <ref-classes-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:: @@ -598,12 +796,11 @@ 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. First on host, create the password hash:: +passwords. First on host, create the (escaped) password hash:: - mkpasswd -m sha256crypt tester01 + printf "%q" $(mkpasswd -m sha256crypt tester01) -The resulting hash is set to a variable and used in ``useradd`` command parameters. -Remember to escape the character ``$``:: +The resulting hash is set to a variable and used in ``useradd`` command parameters:: inherit extrausers PASSWD = "\$X\$ABC123\$A-Long-Hash" @@ -619,14 +816,22 @@ Finally, here is an example that sets the root password:: 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: @@ -647,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 @@ -663,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 @@ -685,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 @@ -718,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: @@ -756,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 @@ -767,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 @@ -788,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. @@ -806,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. @@ -826,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 @@ -834,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. @@ -845,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 ask them to be ignored by Icecream by listing the recipes and classes using the -:term:`ICECC_USER_PACKAGE_BL` and -:term:`ICECC_USER_CLASS_BL` variables, +: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:: @@ -888,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. @@ -903,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 @@ -911,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: + +#. `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. -The ``image-buildinfo`` class writes information to the target -filesystem on ``/etc/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:: @@ -951,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 @@ -962,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 @@ -1010,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 @@ -1028,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 @@ -1042,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 @@ -1051,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. @@ -1090,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``. @@ -1124,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`, @@ -1162,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. @@ -1220,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. @@ -1236,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`). @@ -1245,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 @@ -1272,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. -The ``kernel-devicetree`` class, which is inherited by the -:ref:`kernel <ref-classes-kernel>` class, supports device tree -generation. +Its behavior is mainly controlled by the following variables: + +- :term:`KERNEL_DEVICETREE_BUNDLE`: whether to bundle the kernel and device tree +- :term:`KERNEL_DTBDEST`: directory where to install DTB files +- :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories +- :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler +- :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages .. _ref-classes-kernel-fitimage: -``kernel-fitimage.bbclass`` -=========================== +``kernel-fitimage`` +=================== -The ``kernel-fitimage`` class provides support to pack a kernel image, -device trees, a U-boot script, a Initramfs bundle and a RAM disk +The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, +device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk into a single FIT image. In theory, a FIT image can support any number -of kernels, U-boot scripts, Initramfs bundles, RAM disks and device-trees. -However, ``kernel-fitimage`` currently only supports -limited usescases: just one kernel image, an optional U-boot script, -an optional Initramfs bundle, an optional RAM disk, and any number of -device tree. +of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. +However, :ref:`ref-classes-kernel-fitimage` currently only supports +limited usecases: just one kernel image, an optional U-boot script, +an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of +device trees. To create a FIT image, it is required that :term:`KERNEL_CLASSES` -is set to include "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` -is set to "fitImage". +is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`, +:term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage". The options for the device tree compiler passed to ``mkimage -D`` when creating the FIT image are specified using the :term:`UBOOT_MKIMAGE_DTCOPTS` variable. Only a single kernel can be added to the FIT image created by -``kernel-fitimage`` and the kernel image in FIT is mandatory. The +:ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The address where the kernel image is to be loaded by U-Boot is specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by -:term:`UBOOT_ENTRYPOINT`. +:term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2" +is necessary if such addresses are 64 bit ones. Multiple device trees can be added to the FIT image created by -``kernel-fitimage`` and the device tree is optional. +:ref:`ref-classes-kernel-fitimage` and the device tree is optional. The address where the device tree is to be loaded by U-Boot is specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. Only a single RAM disk can be added to the FIT image created by -``kernel-fitimage`` and the RAM disk in FIT is optional. +:ref:`ref-classes-kernel-fitimage` and the RAM disk in FIT is optional. The address where the RAM disk image is to be loaded by U-Boot is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by -:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to FIT image when -:term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` -is set to 0. +:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when +:term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` +is not set to 1. -Only a single Initramfs bundle can be added to the FIT image created by -``kernel-fitimage`` and the Initramfs bundle in FIT is optional. -In case of Initramfs, the kernel is configured to be bundled with the root filesystem +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 root filesystem. -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 @@ -1457,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 @@ -1498,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 @@ -1571,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:: @@ -1630,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`). @@ -1648,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" @@ -1671,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:: @@ -1698,33 +2063,33 @@ 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 root filesystem. But a lot of different applications might want to have read-write access to some parts of a filesystem. It can be especially useful when your update mechanism overwrites the whole root filesystem, but you may want your application data to be preserved -between updates. The :ref:`overlayfs <ref-classes-overlayfs>` class provides a way +between updates. The :ref:`ref-classes-overlayfs` class provides a way to achieve that by means of ``overlayfs`` and at the same time keeping the base root filesystem read-only. @@ -1739,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. @@ -1764,7 +2129,7 @@ and then in your recipe:: 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:`overlayfs <ref-classes-overlayfs>` provides a ``systemd`` +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 @@ -1777,12 +2142,12 @@ to the unit the following:: .. note:: The class does not support the ``/etc`` directory itself, because ``systemd`` depends on it. - In order to get ``/etc`` in overlayfs, see :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`. + In order to get ``/etc`` in overlayfs, see :ref:`ref-classes-overlayfs-etc`. .. _ref-classes-overlayfs-etc: -``overlayfs-etc.bbclass`` -========================= +``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 @@ -1826,10 +2191,10 @@ The class provides two options for ``/sbin/init`` generation: .. _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. @@ -1845,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 @@ -1887,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: @@ -1912,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. @@ -2040,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`" @@ -2066,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 @@ -2106,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 @@ -2123,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:: @@ -2136,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:: @@ -2149,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 @@ -2220,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. @@ -2266,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, @@ -2285,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 @@ -2297,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 @@ -2359,74 +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-setuptools3-base: + .. note:: -``setuptools3-base.bbclass`` -============================ + 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/>`__). -The ``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:`setuptools3 <ref-classes-setuptools3>` class, you may -want to ``inherit setuptools3-base``. Some recipes do not need the tasks -in the :ref:`setuptools3 <ref-classes-setuptools3>` class and inherit this class instead. + 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``. -.. _ref-classes-sign_rpm: + .. note:: + + The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now + installs the ``wheel`` binary archive. In current versions of + ``setuptools`` the legacy ``setup.py install`` method is deprecated. If + the ``setup.py`` cannot be used with wheels, for example it creates files + outside of the Python module or standard entry points, then + :ref:`ref-classes-setuptools3_legacy` should be used. + +.. _ref-classes-setuptools3_legacy: + +``setuptools3_legacy`` +====================== + +The :ref:`ref-classes-setuptools3_legacy` class supports +Python version 3.x extensions that use build systems based on ``setuptools`` +(e.g. only have a ``setup.py`` and have not migrated to the official +``pyproject.toml`` format). Unlike :ref:`ref-classes-setuptools3`, +this uses the traditional ``setup.py`` ``build`` and ``install`` commands and +not wheels. This use of ``setuptools`` like this is +`deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__ +but still relatively common. -``sign_rpm.bbclass`` +.. _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 @@ -2443,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`" @@ -2456,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, @@ -2472,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:: @@ -2546,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 @@ -2556,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: @@ -2599,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`. @@ -2628,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`, @@ -2661,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 @@ -2722,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 @@ -2745,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. @@ -2756,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:: @@ -2776,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:: @@ -2792,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 @@ -2810,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 @@ -2844,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:: @@ -2854,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. @@ -2868,10 +3406,10 @@ 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 @@ -2880,16 +3418,16 @@ group. The :oe_git:`meta-skeleton/recipes-skeleton/useradd/useradd-example.bb recipe in the :term:`Source Directory` provides a simple example that shows how to add three users and groups to two packages. -The ``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. @@ -2905,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` @@ -2923,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 e06dfd972b..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. -**Q:** How do I add my package to the Yocto Project? +When the build system searches for source code, it first tries the local +download directory. If that location fails, Poky tries +:term:`PREMIRRORS`, the upstream source, and then +:term:`MIRRORS` in that order. -**A:** To add a package, you need to create a BitBake recipe. For -information on how to create a BitBake recipe, see the -":ref:`dev-manual/common-tasks:writing a new recipe`" -section in the Yocto Project Development Tasks Manual. +Assuming your distribution is "poky", the OpenEmbedded build system uses +the Yocto Project source :term:`PREMIRRORS` by default for SCM-based +sources, upstreams for normal tarballs, and then falls back to a number +of other mirrors including the Yocto Project source mirror if those +fail. -**Q:** Do I have to reflash my entire board with a new Yocto Project -image when recompiling a package? +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:: -**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. + 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/" -**Q:** I see the error -'``chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x``'. What is -wrong? +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. -**A:** You are probably running the build on an NTFS filesystem. Use -``ext2``, ``ext3``, or ``ext4`` instead. +Another option is to set:: -**Q:** I see lots of 404 responses for files when the OpenEmbedded build -system is trying to download sources. Is something wrong? + BB_NO_NETWORK = "1" -**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. +This statement tells BitBake to issue an error +instead of trying to access the Internet. This technique is useful if +you want to ensure code builds only from local sources. + +Here is another technique:: + + BB_FETCH_PREMIRRORONLY = "1" + +This statement limits the build system to pulling source from the +:term:`PREMIRRORS` only. Again, this technique is useful for reproducing +builds. + +Here is yet another technique:: + + BB_GENERATE_MIRROR_TARBALLS = "1" -**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" -**A:** Most source fetching by the OpenEmbedded build system is done by +These changes would cause the build system to successfully fetch source +over HTTP and any network accesses to anything other than the +:term:`PREMIRRORS` would fail. + +Most source fetching by the OpenEmbedded build system is done by ``wget`` and you therefore need to specify the proxy settings in a ``.wgetrc`` file, which can be in your home directory if you are a single user or can be in ``/usr/local/etc/wgetrc`` as a global user file. -Following is the applicable code for setting various proxy types in the +Here is the applicable code for setting various proxy types in the ``.wgetrc`` file. By default, these settings are disabled with comments. To use them, remove the comments:: @@ -136,24 +148,53 @@ To use them, remove the comments:: # If you do not want to use proxy at all, set this to off. #use_proxy = on +The build system also accepts ``http_proxy``, ``ftp_proxy``, ``https_proxy``, +and ``all_proxy`` set as to standard shell environment variables to redirect +requests through proxy servers. + The Yocto Project also includes a -``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS -and Git proxy servers if needed. For more information on setting up -various proxy types and configuring proxy servers, see the -":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" -Wiki page. +``meta-poky/conf/templates/default/site.conf.sample`` file that shows +how to configure CVS and Git proxy servers if needed. -**Q:** What's the difference between ``target`` and ``target-native``? +.. note:: -**A:** The ``*-native`` targets are designed to run on the system being -used for the build. These are usually tools that are needed to assist -the build in some way such as ``quilt-native``, which is used to apply -patches. The non-native version is the one that runs on the target -device. + You can find more information on the + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" + Wiki page. + +Using the OpenEmbedded Build system +=================================== + +How do I use an external toolchain? +----------------------------------- + +See the ":ref:`dev-manual/external-toolchain:optionally using an external toolchain`" +section in the Development Task manual. + +Why do I get chmod permission issues? +------------------------------------- -**Q:** I'm seeing random build failures. Help?! +If you see the error +``chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x``, +you are probably running the build on an NTFS filesystem. Instead, +run the build system on a partition with a modern Linux filesystem such as +``ext4``, ``btrfs`` or ``xfs``. -**A:** If the same build is failing in totally different and random +I see many 404 errors trying to download sources. Is anything wrong? +-------------------------------------------------------------------- + +Nothing is wrong. The OpenEmbedded build system checks any +configured source mirrors before downloading from the upstream sources. +The build system does this searching for both source archives and +pre-checked out versions of SCM-managed software. These checks help in +large installations because it can reduce load on the SCM servers +themselves. This can also allow builds to continue to work if an +upstream source disappears. + +Why do I get random build failures? +----------------------------------- + +If the same build is failing in totally different and random ways, the most likely explanation is: - The hardware you are running the build on has some problem. @@ -166,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/ \ - ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ - http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ - https://.*/.* &YOCTO_DL_URL;/mirror/sources/" +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/ \ - ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ - http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ - https://.*/.* &YOCTO_DL_URL;/mirror/sources/" - 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 f7abb417ba..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 root - logins and logins from accounts having an empty password string. +- *allow-empty-password:* Allows Dropbear and OpenSSH to accept + logins from accounts having an empty password string. + +- *allow-root-login:* Allows Dropbear and OpenSSH to accept root logins. - *dbg-pkgs:* Installs debug symbol packages for all packages installed in a given image. - *debug-tweaks:* Makes an image suitable for development (e.g. allows - root logins 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,22 @@ 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 @@ -239,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. @@ -268,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 @@ -276,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`. @@ -285,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. @@ -296,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 0e3351bb7b..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 @@ -117,17 +119,17 @@ Following is a list of supported recipes: 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 885c721297..297887805c 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -82,7 +82,7 @@ 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 @@ -125,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 @@ -175,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 @@ -209,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. @@ -225,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 3364311219..53b1836e74 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst @@ -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 =================================== 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 5d2e3a86ef..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 :ref:`buildhistory <ref-classes-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 d7b7cec283..0fc92550a5 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst @@ -29,37 +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: - -- Ubuntu 18.04 (LTS) +Currently, the &DISTRO; release ("&DISTRO_NAME;") of the Yocto Project is +supported on the following distributions: - Ubuntu 20.04 (LTS) -- Fedora 33 +- Ubuntu 22.04 (LTS) + +- Fedora 38 + +- CentOS Stream 8 + +- Debian GNU/Linux 11 (Bullseye) -- Fedora 34 +- Debian GNU/Linux 12 (Bookworm) -- CentOS 7.x +- OpenSUSE Leap 15.4 -- CentOS 8.x +- AlmaLinux 8 -- Debian GNU/Linux 8.x (Jessie) +- AlmaLinux 9 -- Debian GNU/Linux 9.x (Stretch) +- Rocky 9 + +The following distribution versions are still tested, even though the +organizations publishing them no longer make updates publicly available: + +- Ubuntu 18.04 (LTS) -- Debian GNU/Linux 10.x (Buster) +- Ubuntu 23.04 -- Debian GNU/Linux 11.x (Bullseye) +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. -- OpenSUSE Leap 15.1 +Finally, here are the distribution versions which were previously +tested on former revisions of "&DISTRO_NAME;", but no longer are: -- OpenSUSE Leap 15.2 +*This list is currently empty* .. note:: @@ -77,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 ==================================== @@ -109,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:: @@ -122,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:: +Here are the packages needed to build Project documentation manuals:: - $ sudo apt install make python3-pip - &PIP3_HOST_PACKAGES_DOC; - - .. note:: - - It is currently not possible to build out documentation from Debian 8 - (Jessie) because of outdated ``pip3`` and ``python3``. ``python3-sphinx`` - is too outdated. + $ sudo apt install git make inkscape texlive-latex-extra + $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme Fedora Packages --------------- -Here are the required packages by function given a -supported Fedora Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system:: +Here are the packages needed to build an image on a headless system +with a supported Fedora Linux distribution:: - $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; + $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals:: +Here are the packages needed to build Project documentation manuals:: - $ sudo dnf install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; + $ sudo dnf install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; openSUSE Packages ----------------- -Here are the required packages by function given a -supported openSUSE Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system:: - - $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals:: - - $ sudo zypper install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - - -CentOS-7 Packages ------------------ - -Here are the required packages by function given a -supported CentOS-7 Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system:: - - $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; +Here are the packages needed to build an image on a headless system +with a supported openSUSE distribution:: - .. note:: + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; - - 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. +Here are the packages needed to build Project documentation manuals:: - - The ``makecache`` command consumes additional Metadata from - ``epel-release``. + $ sudo zypper install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; -- *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; +AlmaLinux Packages +------------------ -CentOS-8 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-8 Linux distribution: + $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL; -- *Essentials:* Packages needed to build an image for a headless - system:: +.. note:: - $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; + - 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. - .. note:: + - The ``PowerTools/CRB`` repo provides additional packages such as + ``rpcgen`` and ``texinfo``. - - 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``. - - The ``PowerTools`` repo provides additional packages such as - ``rpcgen`` and ``texinfo``. +Here are the packages needed to build Project documentation manuals:: - - The ``makecache`` command consumes additional Metadata from - ``epel-release``. + $ sudo dnf install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals:: +.. _system-requirements-buildtools: - $ sudo dnf install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - -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: @@ -248,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: @@ -259,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 \ @@ -282,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. @@ -293,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``. @@ -319,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 @@ -333,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 @@ -386,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 b51462b79a..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 :ref:`deploy <ref-classes-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 :ref:`base <ref-classes-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`` @@ -327,7 +316,7 @@ file as a patch file:: " Conversely, if you have a file whose file type is ``.patch`` or ``.diff`` -and you want to exclude it so that the ``do_patch`` task does not apply +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:: @@ -343,7 +332,7 @@ 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: @@ -369,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. @@ -392,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"). @@ -406,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: @@ -447,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 @@ -473,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. @@ -481,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: @@ -492,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. @@ -501,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:: @@ -522,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``. @@ -532,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``. @@ -575,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: @@ -597,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: @@ -610,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 @@ -657,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. @@ -668,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 @@ -686,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 @@ -719,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 @@ -791,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 09e0a98bb5..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 @@ -138,17 +160,15 @@ universal, the list includes them just in case: 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 - `meta-openembedded <https://github.com/openembedded/meta-openembedded>`_ + 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 - `meta-openembedded/meta-oe <https://github.com/openembedded/meta-openembedded/tree/master/meta-oe>`_, - `meta-openembedded/meta-python <https://github.com/openembedded/meta-openembedded/tree/master/meta-python>`_ - and so on. + :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 - `meta-security <https://git.yoctoproject.org/cgit/cgit.cgi/meta-security>`_) + :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. @@ -192,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 @@ -205,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 @@ -230,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 @@ -270,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`). @@ -323,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 @@ -357,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 @@ -383,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`, diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index b0621168ae..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 @@ -125,8 +126,7 @@ system and gives an overview of their function and contents. ":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, @@ -134,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 @@ -193,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 @@ -219,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) @@ -249,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>"" @@ -271,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}" @@ -314,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. @@ -328,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 @@ -336,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" @@ -365,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 @@ -383,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. @@ -504,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 @@ -511,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" @@ -523,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 @@ -538,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 @@ -554,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:: @@ -584,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 @@ -601,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 @@ -626,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. @@ -659,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. @@ -683,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. @@ -728,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 @@ -763,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 - :ref:`binconfig-disabled <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. + 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:: @@ -782,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 @@ -799,11 +942,14 @@ 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:`ref-classes-binconfig`" section. + :term:`BITBAKE_UI` + See :term:`bitbake:BITBAKE_UI` in the BitBake manual. + :term:`BP` The base recipe name and version but without any special recipe name suffix (i.e. ``-native``, ``lib64-``, and so forth). :term:`BP` is @@ -898,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 @@ -916,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`, @@ -929,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 :ref:`buildhistory <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". + When inheriting the :ref:`ref-classes-buildhistory` class, this variable + specifies whether or not to commit the build history output in a local + Git repository. If set to "1", this local repository will be maintained + automatically by the :ref:`ref-classes-buildhistory` class and a commit + will be created on every build for changes to each top-level subdirectory + of the build history output (images, packages, and sdk). If you want to + track changes to build history over time, you should set this value to + "1". - By default, the :ref:`buildhistory <ref-classes-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 @@ -963,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 :ref:`buildhistory <ref-classes-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.bbclass`` file. + see the :ref:`ref-classes-buildhistory` class. - By default, the :ref:`buildhistory <ref-classes-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: @@ -1000,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 :ref:`buildhistory <ref-classes-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 @@ -1016,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 :ref:`buildhistory <ref-classes-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 :ref:`buildhistory <ref-classes-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 :ref:`buildhistory <ref-classes-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, @@ -1078,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/``. @@ -1093,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 @@ -1122,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:: @@ -1166,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 @@ -1192,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 @@ -1217,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 @@ -1268,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` @@ -1297,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 @@ -1306,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. @@ -1321,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 :ref:`archiver <ref-classes-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 :ref:`archiver <ref-classes-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 :ref:`archiver <ref-classes-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 :ref:`archiver <ref-classes-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 :ref:`archiver <ref-classes-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 @@ -1472,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. @@ -1495,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. @@ -1541,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 @@ -1550,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 @@ -1568,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 @@ -1600,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 @@ -1621,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:: @@ -1646,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:: @@ -1676,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 @@ -1701,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 @@ -1711,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 @@ -1730,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 @@ -1744,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 @@ -1764,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 @@ -1781,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 :ref:`deploy <ref-classes-deploy>` class as follows:: + is set in the :ref:`ref-classes-deploy` class as follows:: DEPLOYDIR = "${WORKDIR}/deploy-${PN}" - Recipes inheriting the :ref:`deploy <ref-classes-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. @@ -1818,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` @@ -1877,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 @@ -1919,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 @@ -1936,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 @@ -1982,24 +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>` 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" - - .. note:: - - ``distutils`` has been deprecated in Python 3.10 and will be removed - in Python 3.12. For this reason, the use of :ref:`distutils3 <ref-classes-distutils3>` - is deprecated. Instead use :ref:`setuptools3 <ref-classes-setuptools3>` and the - :term:`SETUPTOOLS_SETUP_PATH` variable. + DISTROOVERRIDES = "poky:poky-tiny" :term:`DL_DIR` The central download directory used by the build process to store @@ -2012,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" @@ -2040,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 @@ -2055,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 @@ -2065,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``. @@ -2086,6 +2371,68 @@ system and gives an overview of their function and contents. can control with this variable, see the ":ref:`ref-classes-insane`" section. + :term:`ESDK_CLASS_INHERIT_DISABLE` + A list of classes to remove from the :term:`INHERIT` + value globally within the extensible SDK configuration. The + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the + default value:: + + ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc" + + Some classes are not generally applicable within the extensible SDK + context. You can use this variable to disable those classes. + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`ESDK_LOCALCONF_ALLOW` + A list of variables allowed through from the OpenEmbedded build + system configuration into the extensible SDK configuration. By + default, the list of variables is empty and is set in the + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. + + This list overrides the variables specified using the + :term:`ESDK_LOCALCONF_REMOVE` variable as well as + other variables automatically added due to the "/" character + being found at the start of the + value, which is usually indicative of being a path and thus might not + be valid on the system where the SDK is installed. + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`ESDK_LOCALCONF_REMOVE` + A list of variables not allowed through from the OpenEmbedded build + system configuration into the extensible SDK configuration. Usually, + these are variables that are specific to the machine on which the + build system is running and thus would be potentially problematic + within the extensible SDK. + + By default, :term:`ESDK_LOCALCONF_REMOVE` is set in the + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and + excludes the following variables: + + - :term:`CONF_VERSION` + - :term:`BB_NUMBER_THREADS` + - :term:`BB_NUMBER_PARSE_THREADS` + - :term:`PARALLEL_MAKE` + - :term:`PRSERV_HOST` + - :term:`SSTATE_MIRRORS` :term:`DL_DIR` + - :term:`SSTATE_DIR` :term:`TMPDIR` + - :term:`BB_SERVER_TIMEOUT` + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + :term:`EXCLUDE_FROM_SHLIBS` Triggers the OpenEmbedded build system's shared libraries resolver to exclude an entire package when scanning for shared libraries. @@ -2151,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:`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:`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. @@ -2195,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:: @@ -2206,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` @@ -2255,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 @@ -2285,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 :ref:`extrausers <ref-classes-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; \ @@ -2310,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:: @@ -2321,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`. @@ -2356,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 @@ -2372,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. @@ -2404,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 @@ -2470,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:: @@ -2492,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 @@ -2501,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}", \ @@ -2544,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. @@ -2563,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 :ref:`fontcache <ref-classes-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. @@ -2676,13 +3144,20 @@ system and gives an overview of their function and contents. 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/common-tasks:enabling gobject introspection support`" + 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. @@ -2693,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. @@ -2708,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. @@ -2726,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` @@ -2735,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` @@ -2743,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. @@ -2821,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 @@ -2841,9 +3396,15 @@ 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 @@ -2862,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 @@ -2897,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, the recipes inheriting - those classes will not benefit from distributed compilation across - remote hosts. Instead they will be built 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 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 @@ -2995,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 @@ -3025,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 @@ -3038,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 @@ -3054,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` @@ -3081,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:: @@ -3107,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 @@ -3153,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}" + + .. 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}" - IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}-${MACHINE}" + :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 @@ -3178,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 @@ -3223,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. + the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`, + or :ref:`ref-classes-package_ipk` class. - .. note:: - - The ``package_tar`` class is broken and is not supported. It is - recommended that you do not use it. - - The :ref:`populate_sdk_* <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 @@ -3253,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 @@ -3266,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 @@ -3332,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" @@ -3388,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 @@ -3399,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 @@ -3543,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:: @@ -3556,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). @@ -3587,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` @@ -3613,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 ?= "" @@ -3654,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}" @@ -3675,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 @@ -3701,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` @@ -3716,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. @@ -3729,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, @@ -3790,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. @@ -3823,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" @@ -3840,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:: @@ -3876,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 @@ -3888,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 :ref:`kernel <ref-classes-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. @@ -3914,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}" @@ -3936,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. - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + It is set by default to "${KERNEL_IMAGEDEST}" by the + :ref:`ref-classes-kernel` class. + + :term:`KERNEL_DTBVENDORED` + This variable, used by the :ref:`ref-classes-kernel-devicetree`, + allows to ignore vendor subdirectories when installing DTB + (Device Tree Binary) files, when it is set to "false". + + To keep vendor subdirectories, set this variable to "true". + + It is set by default to "false" by the :ref:`ref-classes-kernel` class. :term:`KERNEL_DTC_FLAGS` Specifies the ``dtc`` flags that are passed to the Linux kernel build system when generating the device trees (via ``DTC_FLAGS`` environment variable). - In order to use this variable, the - :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must - be inherited. + In order to use this variable, the :ref:`ref-classes-kernel-devicetree` + class must be inherited. :term:`KERNEL_EXTRA_ARGS` Specifies additional ``make`` command-line arguments the OpenEmbedded @@ -3980,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}" @@ -4003,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}" @@ -4043,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 @@ -4059,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. @@ -4099,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. @@ -4115,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. @@ -4127,6 +4777,10 @@ 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 @@ -4140,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` @@ -4171,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". @@ -4195,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` @@ -4220,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. @@ -4238,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 @@ -4294,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 :ref:`debian <ref-classes-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. @@ -4310,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` @@ -4333,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 @@ -4350,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` @@ -4374,12 +5008,12 @@ 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 allow through - :term:`LICENSE_FLAGS_WHITELIST` in + :term:`LICENSE_FLAGS_ACCEPTED` in order for the recipe to be built. When providing multiple flags, separate them with spaces. @@ -4387,16 +5021,33 @@ system and gives an overview of their function and contents. 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. 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_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 @@ -4487,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. @@ -4630,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 @@ -4673,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`). @@ -4681,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 @@ -4689,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" @@ -4737,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. @@ -4775,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}" @@ -4789,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 @@ -4808,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 @@ -4911,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 @@ -4919,10 +5600,20 @@ 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. + :term:`OECMAKE_GENERATOR` + A variable for the :ref:`ref-classes-cmake` class, allowing to choose + which back-end will be generated by CMake to build an application. + + By default, this variable is set to ``Ninja``, which is faster than GNU + make, but if building is broken with Ninja, a recipe can use this + variable to use GNU make instead:: + + OECMAKE_GENERATOR = "Unix Makefiles" + :term:`OE_IMPORTS` An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system. @@ -4943,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: @@ -4966,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 @@ -4976,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 @@ -4992,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. @@ -5010,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` @@ -5018,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. @@ -5031,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` @@ -5073,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" + variable:: - .. note:: - - While it is a legal option, the ``package_tar`` - class has limited functionality due to no support for package - dependencies by that backend. Therefore, it is recommended that - you do not use it. + PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk" The build system uses only the first argument in the list as the package manager when creating your image or SDK. However, packages @@ -5138,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:: @@ -5180,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 @@ -5295,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` @@ -5320,7 +6105,7 @@ system and gives an overview of their function and contents. :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` @@ -5348,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" @@ -5413,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, @@ -5471,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` @@ -5485,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. @@ -5503,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 @@ -5516,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` @@ -5573,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 @@ -5580,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. @@ -5595,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. @@ -5625,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`. @@ -5685,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 @@ -5712,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 @@ -5753,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` @@ -5770,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:: @@ -5787,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 @@ -5856,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 @@ -5933,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 @@ -5953,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:: @@ -5968,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. @@ -5990,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 @@ -6006,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 :ref:`distutils3 <ref-classes-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``. @@ -6090,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 @@ -6102,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 @@ -6137,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. @@ -6170,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, @@ -6184,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 @@ -6207,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:`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 @@ -6240,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 @@ -6258,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 @@ -6273,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 @@ -6286,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 @@ -6296,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 @@ -6346,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 @@ -6413,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 @@ -6425,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:: @@ -6439,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` @@ -6463,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" @@ -6544,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 - 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:`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 @@ -6644,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 @@ -6652,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}-". @@ -6661,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 @@ -6724,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 @@ -6743,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` @@ -6784,6 +7627,10 @@ system and gives an overview of their function and contents. 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 @@ -6793,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 @@ -6808,64 +7655,31 @@ 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:: - - SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0" - - 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:: - - EXTRA_IMAGE_FEATURES += "read-only-rootfs" - :term:`SETUPTOOLS_BUILD_ARGS` - When used by recipes that inherit the - :ref:`setuptools3 <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. + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, this variable can be used to specify additional arguments to be + passed to ``setup.py build`` in the ``setuptools3_do_compile()`` task. :term:`SETUPTOOLS_INSTALL_ARGS` - When used by recipes that inherit the - :ref:`setuptools3 <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. + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, this variable can be used to specify additional arguments to be + passed to ``setup.py install`` in the ``setuptools3_do_install()`` task. :term:`SETUPTOOLS_SETUP_PATH` - When used by recipes that inherit the - :ref:`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:: + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, this variable should be used to specify the directory in which + the ``setup.py`` file is located if it is not at the root of the source + tree (as specified by :term:`S`). For example, in a recipe where the + sources are fetched from a Git repository and ``setup.py`` is in a + ``python/pythonmodule`` subdirectory, you would have this:: S = "${WORKDIR}/git" SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" @@ -6926,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:: @@ -6999,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" @@ -7009,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` @@ -7046,10 +7985,77 @@ 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:`SPL_MKIMAGE_DTCOPTS` + Options for the device tree compiler passed to ``mkimage -D`` feature + while creating a FIT image with the :ref:`ref-classes-uboot-sign` + class. If :term:`SPL_MKIMAGE_DTCOPTS` is not set then the + :ref:`ref-classes-uboot-sign` class will not pass the ``-D`` option + to ``mkimage``. + + The default value is set to "" by the :ref:`ref-classes-uboot-config` + class. + + :term:`SPL_SIGN_ENABLE` + Enable signing of the U-Boot FIT image. The default value is "0". + This variable is used by the :ref:`ref-classes-uboot-sign` class. + + :term:`SPL_SIGN_KEYDIR` + Location of the directory containing the RSA key and certificate used for + signing the U-Boot FIT image, used by the :ref:`ref-classes-uboot-sign` + class. + + :term:`SPL_SIGN_KEYNAME` + The name of keys used by the :ref:`ref-classes-kernel-fitimage` class + for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR` + directory. If we have for example a ``dev.key`` key and a ``dev.crt`` + certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will + have to set :term:`SPL_SIGN_KEYNAME` to ``dev``. + + :term:`SPLASH` + This variable, used by the :ref:`ref-classes-image` class, allows + to choose splashscreen applications. Set it to the names of packages + for such applications to use. This variable is set by default to + ``psplash``. + + :term:`SPLASH_IMAGES` + This variable, used by the ``psplash`` recipe, allows to customize + the default splashscreen image. + + Specified images in PNG format are converted to ``.h`` files by the recipe, + and are included in the ``psplash`` binary, so you won't find them in + the root filesystem. + + To make such a change, it is recommended to customize the + ``psplash`` recipe in a custom layer. Here is an example structure for + an ``ACME`` board:: + + meta-acme/recipes-core/psplash + ├── files + │ └── logo-acme.png + └── psplash_%.bbappend + + And here are the contents of the ``psplash_%.bbappend`` file in + this example:: + + SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default" + FILESEXTRAPATHS:prepend := "${THISDIR}/files:" + + You could even add specific configuration options for ``psplash``, + for example:: + + EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen" + + For information on append files, see the + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" + section. + + :term:`SRCREV_FORMAT` + See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual. + :term:`SRC_URI` See the BitBake manual for the initial description for this variable: @@ -7059,35 +8065,35 @@ system and gives an overview of their function and contents. 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``. .. note:: @@ -7131,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 \ @@ -7168,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 @@ -7193,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 @@ -7223,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 @@ -7296,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: @@ -7328,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 @@ -7406,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``. @@ -7432,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` @@ -7440,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" @@ -7455,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" @@ -7466,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. @@ -7490,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} \ @@ -7513,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 @@ -7542,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" @@ -7557,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/>`__. @@ -7569,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 ?= "" @@ -7582,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" @@ -7590,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 @@ -7604,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). @@ -7718,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 @@ -7761,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 @@ -7791,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, @@ -7823,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``) @@ -7841,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 @@ -7898,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` @@ -7953,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" @@ -7971,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` @@ -7990,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. @@ -8006,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` @@ -8043,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:`ref-classes-testimage*`" section. + ":ref:`ref-classes-testimage`" section. :term:`THISDIR` The directory in which the file BitBake is currently parsing is @@ -8069,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 @@ -8102,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` @@ -8110,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 @@ -8139,6 +9268,9 @@ system and gives an overview of their function and contents. information on setting up a cross-development environment, see the :doc:`/sdk-manual/index` manual. + :term:`TOPDIR` + See :term:`bitbake:TOPDIR` in the BitBake manual. + :term:`TRANSLATED_TARGET_ARCH` A sanitized version of :term:`TARGET_ARCH`. This variable is used where the architecture is needed in a value where @@ -8279,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 @@ -8347,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`` @@ -8411,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 @@ -8421,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 @@ -8444,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" @@ -8458,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" @@ -8467,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" @@ -8479,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" @@ -8491,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" @@ -8502,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 @@ -8522,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 @@ -8586,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. @@ -8603,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. @@ -8657,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. @@ -8665,6 +9937,18 @@ 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 @@ -8672,12 +9956,21 @@ system and gives an overview of their function and contents. can control with this variable, see the ":ref:`ref-classes-insane`" section. + :term:`WATCHDOG_TIMEOUT` + Specifies the timeout in seconds used by the ``watchdog`` recipe and + also by ``systemd`` during reboot. The default is 60 seconds. + + :term:`WIRELESS_DAEMON` + For ``connman`` and ``packagegroup-base``, specifies the wireless + daemon to use. The default is "wpa-supplicant" (note that the value + uses a dash and not an underscore). + :term:`WKS_FILE` Specifies the location of the Wic kickstart file that is used by the OpenEmbedded build system to create a partitioned image (``image.wic``). For information on how to create a partitioned image, see the - ":ref:`dev-manual/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. @@ -8697,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" @@ -8705,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 @@ -8720,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 @@ -8743,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: diff --git a/documentation/releases.rst b/documentation/releases.rst deleted file mode 100644 index c2c2232dca..0000000000 --- a/documentation/releases.rst +++ /dev/null @@ -1,234 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -.. - NOTE FOR RELEASE MAINTAINERS: - This file only needs updating in the development release ("master" branch) - When documentation for stable releases is built, - the latest version from "master" is used - by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-build - -=========================== - Supported Release Manuals -=========================== - -****************************** -Release Series 3.4 (honister) -****************************** - -- :yocto_docs:`3.4 Documentation </3.4>` -- :yocto_docs:`3.4.1 Documentation </3.4.1>` - -****************************** -Release Series 3.3 (hardknott) -****************************** - -- :yocto_docs:`3.3 Documentation </3.3>` -- :yocto_docs:`3.3.1 Documentation </3.3.1>` -- :yocto_docs:`3.3.2 Documentation </3.3.2>` -- :yocto_docs:`3.3.3 Documentation </3.3.3>` -- :yocto_docs:`3.3.4 Documentation </3.3.4>` - -**************************** -Release Series 3.1 (dunfell) -**************************** - -- :yocto_docs:`3.1 Documentation </3.1>` -- :yocto_docs:`3.1.1 Documentation </3.1.1>` -- :yocto_docs:`3.1.2 Documentation </3.1.2>` -- :yocto_docs:`3.1.3 Documentation </3.1.3>` -- :yocto_docs:`3.1.4 Documentation </3.1.4>` -- :yocto_docs:`3.1.5 Documentation </3.1.5>` -- :yocto_docs:`3.1.6 Documentation </3.1.6>` -- :yocto_docs:`3.1.7 Documentation </3.1.7>` -- :yocto_docs:`3.1.8 Documentation </3.1.8>` -- :yocto_docs:`3.1.9 Documentation </3.1.9>` -- :yocto_docs:`3.1.10 Documentation </3.1.10>` -- :yocto_docs:`3.1.11 Documentation </3.1.11>` -- :yocto_docs:`3.1.12 Documentation </3.1.12>` -- :yocto_docs:`3.1.13 Documentation </3.1.13>` - -========================== - Outdated Release Manuals -========================== - -******************************* -Release Series 3.2 (gatesgarth) -******************************* - -- :yocto_docs:`3.2 Documentation </3.2>` -- :yocto_docs:`3.2.1 Documentation </3.2.1>` -- :yocto_docs:`3.2.2 Documentation </3.2.2>` -- :yocto_docs:`3.2.3 Documentation </3.2.3>` -- :yocto_docs:`3.2.4 Documentation </3.2.4>` - -************************* -Release Series 3.0 (zeus) -************************* - -- :yocto_docs:`3.0 Documentation </3.0>` -- :yocto_docs:`3.0.1 Documentation </3.0.1>` -- :yocto_docs:`3.0.2 Documentation </3.0.2>` -- :yocto_docs:`3.0.3 Documentation </3.0.3>` -- :yocto_docs:`3.0.4 Documentation </3.0.4>` - -**************************** -Release Series 2.7 (warrior) -**************************** - -- :yocto_docs:`2.7 Documentation </2.7>` -- :yocto_docs:`2.7.1 Documentation </2.7.1>` -- :yocto_docs:`2.7.2 Documentation </2.7.2>` -- :yocto_docs:`2.7.3 Documentation </2.7.3>` -- :yocto_docs:`2.7.4 Documentation </2.7.4>` - -************************* -Release Series 2.6 (thud) -************************* - -- :yocto_docs:`2.6 Documentation </2.6>` -- :yocto_docs:`2.6.1 Documentation </2.6.1>` -- :yocto_docs:`2.6.2 Documentation </2.6.2>` -- :yocto_docs:`2.6.3 Documentation </2.6.3>` -- :yocto_docs:`2.6.4 Documentation </2.6.4>` - -************************* -Release Series 2.5 (sumo) -************************* - -- :yocto_docs:`2.5 Documentation </2.5>` -- :yocto_docs:`2.5.1 Documentation </2.5.1>` -- :yocto_docs:`2.5.2 Documentation </2.5.2>` -- :yocto_docs:`2.5.3 Documentation </2.5.3>` - -************************** -Release Series 2.4 (rocko) -************************** - -- :yocto_docs:`2.4 Documentation </2.4>` -- :yocto_docs:`2.4.1 Documentation </2.4.1>` -- :yocto_docs:`2.4.2 Documentation </2.4.2>` -- :yocto_docs:`2.4.3 Documentation </2.4.3>` -- :yocto_docs:`2.4.4 Documentation </2.4.4>` - -************************* -Release Series 2.3 (pyro) -************************* - -- :yocto_docs:`2.3 Documentation </2.3>` -- :yocto_docs:`2.3.1 Documentation </2.3.1>` -- :yocto_docs:`2.3.2 Documentation </2.3.2>` -- :yocto_docs:`2.3.3 Documentation </2.3.3>` -- :yocto_docs:`2.3.4 Documentation </2.3.4>` - -************************** -Release Series 2.2 (morty) -************************** - -- :yocto_docs:`2.2 Documentation </2.2>` -- :yocto_docs:`2.2.1 Documentation </2.2.1>` -- :yocto_docs:`2.2.2 Documentation </2.2.2>` -- :yocto_docs:`2.2.3 Documentation </2.2.3>` - -**************************** -Release Series 2.1 (krogoth) -**************************** - -- :yocto_docs:`2.1 Documentation </2.1>` -- :yocto_docs:`2.1.1 Documentation </2.1.1>` -- :yocto_docs:`2.1.2 Documentation </2.1.2>` -- :yocto_docs:`2.1.3 Documentation </2.1.3>` - -*************************** -Release Series 2.0 (jethro) -*************************** - -- :yocto_docs:`1.9 Documentation </1.9>` -- :yocto_docs:`2.0 Documentation </2.0>` -- :yocto_docs:`2.0.1 Documentation </2.0.1>` -- :yocto_docs:`2.0.2 Documentation </2.0.2>` -- :yocto_docs:`2.0.3 Documentation </2.0.3>` - -************************* -Release Series 1.8 (fido) -************************* - -- :yocto_docs:`1.8 Documentation </1.8>` -- :yocto_docs:`1.8.1 Documentation </1.8.1>` -- :yocto_docs:`1.8.2 Documentation </1.8.2>` - -************************** -Release Series 1.7 (dizzy) -************************** - -- :yocto_docs:`1.7 Documentation </1.7>` -- :yocto_docs:`1.7.1 Documentation </1.7.1>` -- :yocto_docs:`1.7.2 Documentation </1.7.2>` -- :yocto_docs:`1.7.3 Documentation </1.7.3>` - -************************** -Release Series 1.6 (daisy) -************************** - -- :yocto_docs:`1.6 Documentation </1.6>` -- :yocto_docs:`1.6.1 Documentation </1.6.1>` -- :yocto_docs:`1.6.2 Documentation </1.6.2>` -- :yocto_docs:`1.6.3 Documentation </1.6.3>` - -************************* -Release Series 1.5 (dora) -************************* - -- :yocto_docs:`1.5 Documentation </1.5>` -- :yocto_docs:`1.5.1 Documentation </1.5.1>` -- :yocto_docs:`1.5.2 Documentation </1.5.2>` -- :yocto_docs:`1.5.3 Documentation </1.5.3>` -- :yocto_docs:`1.5.4 Documentation </1.5.4>` - -************************** -Release Series 1.4 (dylan) -************************** - -- :yocto_docs:`1.4 Documentation </1.4>` -- :yocto_docs:`1.4.1 Documentation </1.4.1>` -- :yocto_docs:`1.4.2 Documentation </1.4.2>` -- :yocto_docs:`1.4.3 Documentation </1.4.3>` -- :yocto_docs:`1.4.4 Documentation </1.4.4>` -- :yocto_docs:`1.4.5 Documentation </1.4.5>` - -************************** -Release Series 1.3 (danny) -************************** - -- :yocto_docs:`1.3 Documentation </1.3>` -- :yocto_docs:`1.3.1 Documentation </1.3.1>` -- :yocto_docs:`1.3.2 Documentation </1.3.2>` - -*************************** -Release Series 1.2 (denzil) -*************************** - -- :yocto_docs:`1.2 Documentation </1.2>` -- :yocto_docs:`1.2.1 Documentation </1.2.1>` -- :yocto_docs:`1.2.2 Documentation </1.2.2>` - -*************************** -Release Series 1.1 (edison) -*************************** - -- :yocto_docs:`1.1 Documentation </1.1>` -- :yocto_docs:`1.1.1 Documentation </1.1.1>` -- :yocto_docs:`1.1.2 Documentation </1.1.2>` - -**************************** -Release Series 1.0 (bernard) -**************************** - -- :yocto_docs:`1.0 Documentation </1.0>` -- :yocto_docs:`1.0.1 Documentation </1.0.1>` -- :yocto_docs:`1.0.2 Documentation </1.0.2>` - -**************************** -Release Series 0.9 (laverne) -**************************** - -- :yocto_docs:`0.9 Documentation </0.9>` diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index cac199bf7a..61091d83ba 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst @@ -1,11 +1,17 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -****************************** -Customizing the Extensible SDK -****************************** +*************************************************** +Customizing the Extensible SDK standalone installer +*************************************************** This appendix describes customizations you can apply to the extensible -SDK. +SDK when using in the standalone installer version. + +.. note:: + + It is also possible to use the Extensible SDK functionality directly in a + Yocto build, avoiding separate installer artefacts. Please refer to + ":ref:`sdk-manual/extensible:Installing the Extensible SDK`" Configuring the Extensible SDK ============================== @@ -21,7 +27,7 @@ build system applies them against ``local.conf`` and ``auto.conf``: specific to the :term:`Build Host`. - Variables listed in - :term:`SDK_LOCAL_CONF_BLACKLIST` + :term:`ESDK_LOCALCONF_REMOVE` are excluded. These variables are not allowed through from the OpenEmbedded build system configuration into the extensible SDK configuration. Typically, these variables are specific to the machine @@ -29,23 +35,21 @@ build system applies them against ``local.conf`` and ``auto.conf``: of the extensible SDK configuration. For a list of the variables excluded by default, see the - :term:`SDK_LOCAL_CONF_BLACKLIST` + :term:`ESDK_LOCALCONF_REMOVE` in the glossary of the Yocto Project Reference Manual. - Variables listed in - :term:`SDK_LOCAL_CONF_WHITELIST` + :term:`ESDK_LOCALCONF_ALLOW` are included. Including a variable in the value of - :term:`SDK_LOCAL_CONF_WHITELIST` overrides either of the previous two + :term:`ESDK_LOCALCONF_ALLOW` overrides either of the previous two filters. The default value is blank. -- Classes inherited globally with - :term:`INHERIT` that are listed in - :term:`SDK_INHERIT_BLACKLIST` - are disabled. Using :term:`SDK_INHERIT_BLACKLIST` to disable these - classes is the typical method to disable classes that are problematic - or unnecessary in the SDK context. The default value disables the - :ref:`buildhistory <ref-classes-buildhistory>` - and :ref:`icecc <ref-classes-icecc>` classes. +- Classes inherited globally with :term:`INHERIT` that are listed in + :term:`ESDK_CLASS_INHERIT_DISABLE` are disabled. Using + :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these classes is the typical + method to disable classes that are problematic or unnecessary in the SDK + context. The default value disables the + :ref:`ref-classes-buildhistory` and :ref:`ref-classes-icecc` classes. Additionally, the contents of ``conf/sdk-extra.conf``, when present, are appended to the end of ``conf/local.conf`` within the produced SDK, @@ -63,18 +67,17 @@ adjustments: - If your SDK configuration inherits additional classes using the :term:`INHERIT` variable and you do not need or want those classes enabled in the SDK, you can - disable them by adding them to the :term:`SDK_INHERIT_BLACKLIST` + disable them by adding them to the :term:`ESDK_CLASS_INHERIT_DISABLE` variable as described in the previous section. .. note:: - The default value of - SDK_INHERIT_BLACKLIST + The default value of :term:`ESDK_CLASS_INHERIT_DISABLE` is set using the "?=" operator. Consequently, you will need to either define the entire list by using the "=" operator, or you will need to append a value using either ":append" or the "+=" operator. You can learn more about these operators in the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" + ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section of the BitBake User Manual. - If you have classes or recipes that add additional tasks to the @@ -92,7 +95,7 @@ adjustments: - Disable the tasks if they are added by a class and you do not need the functionality the class provides in the extensible SDK. To - disable the tasks, add the class to the :term:`SDK_INHERIT_BLACKLIST` + disable the tasks, add the class to the :term:`ESDK_CLASS_INHERIT_DISABLE` variable as described in the previous section. - Generally, you want to have a shared state mirror set up so users of @@ -169,13 +172,12 @@ perform additional steps. These steps make it possible for anyone using the installed SDKs to update the installed SDKs by using the ``devtool sdk-update`` command: -1. Create a directory that can be shared over HTTP or HTTPS. You can do - this by setting up a web server such as an `Apache HTTP - Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ or - `Nginx <https://en.wikipedia.org/wiki/Nginx>`__ server in the cloud +#. Create a directory that can be shared over HTTP or HTTPS. You can do + this by setting up a web server such as an :wikipedia:`Apache HTTP Server + <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server in the cloud to host the directory. This directory must contain the published SDK. -2. Set the +#. Set the :term:`SDK_UPDATE_URL` variable to point to the corresponding HTTP or HTTPS URL. Setting this variable causes any SDK built to default to that URL and thus, @@ -184,10 +186,10 @@ the installed SDKs to update the installed SDKs by using the ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`" section. -3. Build the extensible SDK normally (i.e., use the +#. Build the extensible SDK normally (i.e., use the ``bitbake -c populate_sdk_ext`` imagename command). -4. Publish the SDK using the following command:: +#. Publish the SDK using the following command:: $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory @@ -242,7 +244,7 @@ If you want the users of an extensible SDK you build to be able to add items to the SDK without requiring the users to build the items from source, you need to do a number of things: -1. Ensure the additional items you want the user to be able to install +#. Ensure the additional items you want the user to be able to install are already built: - Build the items explicitly. You could use one or more "meta" @@ -254,17 +256,16 @@ source, you need to do a number of things: :term:`EXCLUDE_FROM_WORLD` variable for additional information. -2. Expose the ``sstate-cache`` directory produced by the build. +#. Expose the ``sstate-cache`` directory produced by the build. Typically, you expose this directory by making it available through - an `Apache HTTP - Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ or - `Nginx <https://en.wikipedia.org/wiki/Nginx>`__ server. + an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or + :wikipedia:`Nginx <Nginx>` server. -3. Set the appropriate configuration so that the produced SDK knows how +#. Set the appropriate configuration so that the produced SDK knows how to find the configuration. The variable you need to set is :term:`SSTATE_MIRRORS`:: - SSTATE_MIRRORS = "file://.* http://example.com/some_path/sstate-cache/PATH" + SSTATE_MIRRORS = "file://.* https://example.com/some_path/sstate-cache/PATH" You can set the :term:`SSTATE_MIRRORS` variable in two different places: @@ -277,12 +278,11 @@ source, you need to do a number of things: configuration file. You can then pass the variable to the SDK by adding the following:: - SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS" + ESDK_LOCALCONF_ALLOW = "SSTATE_MIRRORS" - Alternatively, if you just want to set the :term:`SSTATE_MIRRORS` - variable's value for the SDK alone, create a - ``conf/sdk-extra.conf`` file either in your - :term:`Build Directory` or within any + variable's value for the SDK alone, create a ``conf/sdk-extra.conf`` + file either in your :term:`Build Directory` or within any layer and put your :term:`SSTATE_MIRRORS` setting within that file. .. note:: diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index 841abac5aa..d06d6ec6b5 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst @@ -4,8 +4,22 @@ Obtaining the SDK ***************** +Working with the SDK components directly in a Yocto build +========================================================= + +Please refer to section +":ref:`sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build`" + +Note that to use this feature effectively either a powerful build +machine, or a well-functioning sstate cache infrastructure is required: +otherwise significant time could be spent waiting for components to be built +by BitBake from source code. + +Working with standalone SDK Installers +====================================== + Locating Pre-Built SDK Installers -================================= +--------------------------------- You can use existing, pre-built toolchains by locating and running an SDK installer script that ships with the Yocto Project. Using this @@ -14,38 +28,31 @@ and then run the script to hand-install the toolchain. Follow these steps to locate and hand-install the toolchain: -1. *Go to the Installers Directory:* Go to +#. *Go to the Installers Directory:* Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/` -2. *Open the Folder for Your Build Host:* Open the folder that matches +#. *Open the Folder for Your Build Host:* Open the folder that matches your :term:`Build Host` (i.e. ``i686`` for 32-bit machines or ``x86_64`` for 64-bit machines). -3. *Locate and Download the SDK Installer:* You need to find and +#. *Locate and Download the SDK Installer:* You need to find and download the installer appropriate for your build host, target hardware, and image type. - The installer files (``*.sh``) follow this naming convention:: - - poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh - - Where: - host_system is a string representing your development system: - "i686" or "x86_64" + The installer files (``*.sh``) follow this naming convention: + ``poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh``: - type is a string representing the image: - "sato" or "minimal" + - ``host_system``: string representing your development system: ``i686`` or ``x86_64`` - arch is a string representing the target architecture: - "aarch64", "armv5e", "core2-64", "cortexa8hf-neon", "i586", "mips32r2", - "mips64", or "ppc7400" + - ``type``: string representing the image: ``sato`` or ``minimal`` - release is the version of Yocto Project. + - ``arch``: string representing the target architecture such as ``cortexa57-qemuarm64`` - NOTE: - The standard SDK installer does not have the "-ext" string as - part of the filename. + - ``release``: version of the Yocto Project. + .. note:: + The standard SDK installer does not have the ``-ext`` string as + part of the filename. The toolchains provided by the Yocto Project are based off of the ``core-image-sato`` and @@ -53,16 +60,16 @@ Follow these steps to locate and hand-install the toolchain: developing against those images. For example, if your build host is a 64-bit x86 system and you need - an extended SDK for a 64-bit core2 target, go into the ``x86_64`` + an extended SDK for a 64-bit core2 QEMU target, go into the ``x86_64`` folder and download the following installer:: - poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh + poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh -4. *Run the Installer:* Be sure you have execution privileges and run - the installer. Following is an example from the ``Downloads`` +#. *Run the Installer:* Be sure you have execution privileges and run + the installer. Here is an example from the ``Downloads`` directory:: - $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh + $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh During execution of the script, you choose the root location for the toolchain. See the @@ -72,18 +79,18 @@ Follow these steps to locate and hand-install the toolchain: section for more information. Building an SDK Installer -========================= +------------------------- As an alternative to locating and downloading an SDK installer, you can build the SDK installer. Follow these steps: -1. *Set Up the Build Environment:* Be sure you are set up to use BitBake +#. *Set Up the Build Environment:* Be sure you are set up to use BitBake in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section in the Yocto Project Development Tasks Manual for information on how to get a build host ready that is either a native Linux machine or a machine that uses CROPS. -2. *Clone the ``poky`` Repository:* You need to have a local copy of the +#. *Clone the ``poky`` Repository:* You need to have a local copy of the Yocto Project :term:`Source Directory` (i.e. a local ``poky`` repository). See the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and @@ -93,50 +100,46 @@ build the SDK installer. Follow these steps: how to clone the ``poky`` repository and check out the appropriate branch for your work. -3. *Initialize the Build Environment:* While in the root directory of +#. *Initialize the Build Environment:* While in the root directory of the Source Directory (i.e. ``poky``), run the :ref:`structure-core-script` environment setup script to define the OpenEmbedded build environment on your - build host. - :: + build host:: $ source oe-init-build-env - Among other things, the script - creates the :term:`Build Directory`, - which is - ``build`` in this case and is located in the Source Directory. After - the script runs, your current working directory is set to the - ``build`` directory. - -4. *Make Sure You Are Building an Installer for the Correct Machine:* - Check to be sure that your - :term:`MACHINE` variable in the - ``local.conf`` file in your Build Directory matches the architecture + Among other things, the script creates the :term:`Build Directory`, which + is ``build`` in this case and is located in the Source Directory. After + the script runs, your current working directory is set to the ``build`` + directory. + +#. *Make Sure You Are Building an Installer for the Correct Machine:* + Check to be sure that your :term:`MACHINE` variable in the ``local.conf`` + file in your :term:`Build Directory` matches the architecture for which you are building. -5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a +#. *Make Sure Your SDK Machine is Correctly Set:* If you are building a toolchain designed to run on an architecture that differs from your current development host machine (i.e. the build host), be sure that - the :term:`SDKMACHINE` variable - in the ``local.conf`` file in your Build Directory is correctly set. + the :term:`SDKMACHINE` variable in the ``local.conf`` file in your + :term:`Build Directory` is correctly set. .. note:: If you are building an SDK installer for the Extensible SDK, the - SDKMACHINE - value must be set for the architecture of the machine you are - using to build the installer. If - SDKMACHINE + :term:`SDKMACHINE` value must be set for the architecture of the + machine you are using to build the installer. If :term:`SDKMACHINE` is not set appropriately, the build fails and provides an error message similar to the following:: - The extensible SDK can currently only be built for the same architecture as the machine being built on - SDK_ARCH is - set to i686 (likely via setting SDKMACHINE) which is different from the architecture of the build machine (x86_64). - Unable to continue. + The extensible SDK can currently only be built for the same + architecture as the machine being built on - SDK_ARCH + is set to i686 (likely via setting SDKMACHINE) which is + different from the architecture of the build machine (x86_64). + Unable to continue. -6. *Build the SDK Installer:* To build the SDK installer for a standard +#. *Build the SDK Installer:* To build the SDK installer for a standard SDK and populate the SDK image, use the following command form. Be sure to replace ``image`` with an image (e.g. "core-image-sato"):: @@ -150,7 +153,7 @@ build the SDK installer. Follow these steps: that matches your target root filesystem. When the ``bitbake`` command completes, the SDK installer will be in - ``tmp/deploy/sdk`` in the Build Directory. + ``tmp/deploy/sdk`` in the :term:`Build Directory`. .. note:: @@ -162,12 +165,12 @@ build the SDK installer. Follow these steps: variable inside your ``local.conf`` file before building the SDK installer. Doing so ensures that the eventual SDK installation process installs the appropriate library packages - as part of the SDK. Following is an example using ``libc`` + as part of the SDK. Here is an example using ``libc`` static development libraries: TOOLCHAIN_TARGET_TASK:append = " libc-staticdev" -7. *Run the Installer:* You can now run the SDK installer from - ``tmp/deploy/sdk`` in the Build Directory. Following is an example:: +#. *Run the Installer:* You can now run the SDK installer from + ``tmp/deploy/sdk`` in the :term:`Build Directory`. Here is an example:: $ cd poky/build/tmp/deploy/sdk $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh @@ -194,7 +197,7 @@ separately extract a root filesystem: Follow these steps to extract the root filesystem: -1. *Locate and Download the Tarball for the Pre-Built Root Filesystem +#. *Locate and Download the Tarball for the Pre-Built Root Filesystem Image File:* You need to find and download the root filesystem image file that is appropriate for your target system. These files are kept in machine-specific folders in the @@ -206,21 +209,14 @@ Follow these steps to extract the root filesystem: also contain flattened root filesystem image files (``*.ext4``), which you can use with QEMU directly. - The pre-built root filesystem image files follow these naming - conventions:: - - core-image-profile-arch.tar.bz2 + The pre-built root filesystem image files follow the + ``core-image-profile-machine.tar.bz2`` naming convention: - Where: - profile is the filesystem image's profile: - lsb, lsb-dev, lsb-sdk, minimal, minimal-dev, minimal-initramfs, - sato, sato-dev, sato-sdk, sato-sdk-ptest. For information on - these types of image profiles, see the "Images" chapter in - the Yocto Project Reference Manual. + - ``profile``: filesystem image's profile, such as ``minimal``, + ``minimal-dev`` or ``sato``. For information on these types of image + profiles, see the "Images" chapter in the Yocto Project Reference Manual. - arch is a string representing the target architecture: - beaglebone-yocto, beaglebone-yocto-lsb, edgerouter, edgerouter-lsb, - genericx86, genericx86-64, genericx86-64-lsb, genericx86-lsb and qemu*. + - ``machine``: same string as the name of the parent download directory. The root filesystems provided by the Yocto Project are based off of the @@ -232,22 +228,22 @@ Follow these steps to extract the root filesystem: core-image-sato-sdk-beaglebone-yocto.tar.bz2 -2. *Initialize the Cross-Development Environment:* You must ``source`` +#. *Initialize the Cross-Development Environment:* You must ``source`` the cross-development environment setup script to establish necessary environment variables. This script is located in the top-level directory in which you installed the toolchain (e.g. ``poky_sdk``). - Following is an example based on the toolchain installed in the + Here is an example based on the toolchain installed in the ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section:: $ source poky_sdk/environment-setup-core2-64-poky-linux -3. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` +#. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` command and provide the root filesystem image. - Following is an example command that extracts the root filesystem + Here is an example command that extracts the root filesystem from a previously built root filesystem image that was downloaded from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`. This command extracts the root filesystem into the ``core2-64-sato`` @@ -265,8 +261,7 @@ install the Standard SDK by running the ``*.sh`` SDK installation script: .. image:: figures/sdk-installed-standard-sdk-directory.png - :scale: 80% - :align: center + :scale: 100% The installed SDK consists of an environment setup script for the SDK, a configuration file for the target, a version file for the target, and diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index c5970f74fa..3f6a754d88 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst @@ -41,6 +41,46 @@ functionality. Installing the Extensible SDK ============================= +Two ways to install the Extensible SDK +-------------------------------------- + +Extensible SDK can be installed in two different ways, and both have +their own pros and cons: + +#. *Setting up the Extensible SDK environment directly in a Yocto build*. This + avoids having to produce, test, distribute and maintain separate SDK + installer archives, which can get very large. There is only one environment + for the regular Yocto build and the SDK and less code paths where things can + go not according to plan. It's easier to update the SDK: it simply means + updating the Yocto layers with git fetch or layer management tooling. The + SDK extensibility is better than in the second option: just run ``bitbake`` + again to add more things to the sysroot, or add layers if even more things + are required. + +#. *Setting up the Extensible SDK from a standalone installer*. This has the + benefit of having a single, self-contained archive that includes all the + needed binary artifacts. So nothing needs to be rebuilt, and there is no + need to provide a well-functioning binary artefact cache over the network + for developers with underpowered laptops. + +.. _setting_up_ext_sdk_in_build: + +Setting up the Extensible SDK environment directly in a Yocto build +------------------------------------------------------------------- + +#. Set up all the needed layers and a Yocto :term:`Build Directory`, e.g. a regular Yocto + build where ``bitbake`` can be executed. + +#. Run:: + + $ bitbake meta-ide-support + $ bitbake -c populate_sysroot gtk+3 + # or any other target or native item that the application developer would need + $ bitbake build-sysroots -c build_native_sysroot && bitbake build-sysroots -c build_target_sysroot + +Setting up the Extensible SDK from a standalone installer +--------------------------------------------------------- + The first thing you need to do is install the SDK on your :term:`Build Host` by running the ``*.sh`` installation script. @@ -102,16 +142,7 @@ must be writable for whichever users need to use the SDK. The following command shows how to run the installer given a toolchain tarball for a 64-bit x86 development host system and a 64-bit x86 target architecture. The example assumes the SDK installer is located in -``~/Downloads/`` and has execution rights. - -.. note:: - - If you do not have write permissions for the directory into which you - are installing the SDK, the installer notifies you and exits. For - that case, set up the proper permissions in the directory and run the - installer again. - -:: +``~/Downloads/`` and has execution rights:: $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5 @@ -132,11 +163,25 @@ architecture. The example assumes the SDK installer is located in Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux +.. note:: + + If you do not have write permissions for the directory into which you + are installing the SDK, the installer notifies you and exits. For + that case, set up the proper permissions in the directory and run the + installer again. + +.. _running_the_ext_sdk_env: + Running the Extensible SDK Environment Setup Script =================================================== Once you have the SDK installed, you must run the SDK environment setup -script before you can actually use the SDK. This setup script resides in +script before you can actually use the SDK. + +When using a SDK directly in a Yocto build, you will find the script in +``tmp/deploy/images/qemux86-64/`` in your :term:`Build Directory`. + +When using a standalone SDK installer, this setup script resides in the directory you chose when you installed the SDK, which is either the default ``poky_sdk`` directory or the directory you chose during installation. @@ -154,13 +199,18 @@ script is for an IA-based target machine using i586 tuning:: SDK environment now set up; additionally you may now run devtool to perform development tasks. Run devtool --help for further details. -Running the setup script defines many environment variables needed in -order to use the SDK (e.g. ``PATH``, -:term:`CC`, -:term:`LD`, and so forth). If you want to -see all the environment variables the script exports, examine the +When using the environment script directly in a Yocto build, it can +be run similarly:: + + $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux + +Running the setup script defines many environment variables needed in order to +use the SDK (e.g. ``PATH``, :term:`CC`, :term:`LD`, and so forth). If you want +to see all the environment variables the script exports, examine the installation file itself. +.. _using_devtool: + Using ``devtool`` in Your SDK Workflow ====================================== @@ -172,11 +222,8 @@ system. .. note:: - The use of - devtool - is not limited to the extensible SDK. You can use - devtool - to help you easily develop any project whose build output must be + The use of ``devtool`` is not limited to the extensible SDK. You can use + ``devtool`` to help you easily develop any project whose build output must be part of an image built using the build system. The ``devtool`` command line is organized similarly to @@ -186,21 +233,18 @@ all the commands. .. note:: - See the " - devtool - Quick Reference - " in the Yocto Project Reference Manual for a - devtool - quick reference. + See the ":doc:`/ref-manual/devtool-reference`" + section in the Yocto Project Reference Manual. -Three ``devtool`` subcommands provide entry-points into -development: +``devtool`` subcommands provide entry-points into development: - *devtool add*: Assists in adding new software to be built. - *devtool modify*: Sets up an environment to enable you to modify the source of an existing component. +- *devtool ide-sdk*: Generates a configuration for an IDE. + - *devtool upgrade*: Updates an existing recipe so that you can build it for an updated set of source files. @@ -233,9 +277,9 @@ shows common development flows you would use with the ``devtool add`` command: .. image:: figures/sdk-devtool-add-flow.png - :align: center + :width: 100% -1. *Generating the New Recipe*: The top part of the flow shows three +#. *Generating the New Recipe*: The top part of the flow shows three scenarios by which you could use ``devtool add`` to generate a recipe based on existing source code. @@ -252,7 +296,7 @@ command: - *Left*: The left scenario in the figure represents a common situation where the source code does not exist locally and needs to be extracted. In this situation, the source code is extracted - to the default workspace - you do not want the files in some + to the default workspace --- you do not want the files in some specific location outside of the workspace. Thus, everything you need will be located in the workspace:: @@ -267,13 +311,12 @@ command: - *Middle*: The middle scenario in the figure also represents a situation where the source code does not exist locally. In this case, the code is again upstream and needs to be extracted to some - local area - this time outside of the default workspace. + local area --- this time outside of the default workspace. .. note:: - If required, - devtool - always creates a Git repository locally during the extraction. + If required, ``devtool`` always creates a Git repository locally + during the extraction. Furthermore, the first positional argument ``srctree`` in this case identifies where the ``devtool add`` command will locate the @@ -282,8 +325,7 @@ command: $ devtool add recipe srctree fetchuri - In summary, - the source code is pulled from fetchuri and extracted into the + In summary, the source code is pulled from fetchuri and extracted into the location defined by ``srctree`` as a local Git repository. Within workspace, ``devtool`` creates a recipe named recipe along @@ -302,28 +344,26 @@ command: recipe for the code and places the recipe into the workspace. Because the extracted source code already exists, ``devtool`` does - not try to relocate the source code into the workspace - only the + not try to relocate the source code into the workspace --- only the new recipe is placed in the workspace. Aside from a recipe folder, the command also creates an associated append folder and places an initial ``*.bbappend`` file within. -2. *Edit the Recipe*: You can use ``devtool edit-recipe`` to open up the +#. *Edit the Recipe*: You can use ``devtool edit-recipe`` to open up the editor as defined by the ``$EDITOR`` environment variable and modify the file:: $ devtool edit-recipe recipe - From within the editor, you - can make modifications to the recipe that take effect when you build - it later. + From within the editor, you can make modifications to the recipe that + take effect when you build it later. -3. *Build the Recipe or Rebuild the Image*: The next step you take +#. *Build the Recipe or Rebuild the Image*: The next step you take depends on what you are going to do with the new code. If you need to eventually move the build output to the target - hardware, use the following ``devtool`` command: - :; + hardware, use the following ``devtool`` command:: $ devtool build recipe @@ -334,7 +374,7 @@ command: $ devtool build-image image -4. *Deploy the Build Output*: When you use the ``devtool build`` command +#. *Deploy the Build Output*: When you use the ``devtool build`` command to build out your recipe, you probably want to see if the resulting build output works as expected on the target hardware. @@ -348,20 +388,22 @@ command: development machine. You can deploy your build output to that target hardware by using the - ``devtool deploy-target`` command: $ devtool deploy-target recipe - target The target is a live target machine running as an SSH server. + ``devtool deploy-target`` command:: + + $ devtool deploy-target recipe target + + The target is a live target machine running as an SSH server. You can, of course, also deploy the image you build to actual hardware by using the ``devtool build-image`` command. However, ``devtool`` does not provide a specific command that allows you to deploy the image to actual hardware. -5. *Finish Your Work With the Recipe*: The ``devtool finish`` command +#. *Finish Your Work With the Recipe*: The ``devtool finish`` command creates any patches corresponding to commits in the local Git repository, moves the new recipe to a more permanent layer, and then resets the recipe so that the recipe is built normally rather than - from the workspace. - :: + from the workspace:: $ devtool finish recipe layer @@ -379,11 +421,9 @@ command: .. note:: - You can use the - devtool reset - command to put things back should you decide you do not want to - proceed with your work. If you do use this command, realize that - the source tree is preserved. + You can use the ``devtool reset`` command to put things back should you + decide you do not want to proceed with your work. If you do use this + command, realize that the source tree is preserved. Use ``devtool modify`` to Modify the Source of an Existing Component -------------------------------------------------------------------- @@ -401,9 +441,9 @@ diagram shows common development flows for the ``devtool modify`` command: .. image:: figures/sdk-devtool-modify-flow.png - :align: center + :width: 100% -1. *Preparing to Modify the Code*: The top part of the flow shows three +#. *Preparing to Modify the Code*: The top part of the flow shows three scenarios by which you could use ``devtool modify`` to prepare to work on source files. Each scenario assumes the following: @@ -430,11 +470,9 @@ command: $ devtool modify recipe - Once - ``devtool``\ locates the recipe, ``devtool`` uses the recipe's - :term:`SRC_URI` statements to - locate the source code and any local patch files from other - developers. + Once ``devtool`` locates the recipe, ``devtool`` uses the recipe's + :term:`SRC_URI` statements to locate the source code and any local + patch files from other developers. With this scenario, there is no ``srctree`` argument. Consequently, the default behavior of the ``devtool modify`` command is to extract @@ -470,11 +508,7 @@ command: .. note:: - You cannot provide a URL for - srctree - using the - devtool - command. + You cannot provide a URL for ``srctree`` using the ``devtool`` command. As with all extractions, the command uses the recipe's :term:`SRC_URI` statements to locate the source files and any associated patch @@ -512,11 +546,11 @@ command: append file for the recipe in the ``devtool`` workspace. The recipe and the source code remain in their original locations. -2. *Edit the Source*: Once you have used the ``devtool modify`` command, +#. *Edit the Source*: Once you have used the ``devtool modify`` command, you are free to make changes to the source files. You can use any editor you like to make and save your source code modifications. -3. *Build the Recipe or Rebuild the Image*: The next step you take +#. *Build the Recipe or Rebuild the Image*: The next step you take depends on what you are going to do with the new code. If you need to eventually move the build output to the target @@ -527,9 +561,11 @@ command: On the other hand, if you want an image to contain the recipe's packages from the workspace for immediate deployment onto a device (e.g. for testing purposes), you can use the ``devtool build-image`` - command: $ devtool build-image image + command:: + + $ devtool build-image image -4. *Deploy the Build Output*: When you use the ``devtool build`` command +#. *Deploy the Build Output*: When you use the ``devtool build`` command to build out your recipe, you probably want to see if the resulting build output works as expected on target hardware. @@ -554,13 +590,12 @@ command: ``devtool`` does not provide a specific command to deploy the image to actual hardware. -5. *Finish Your Work With the Recipe*: The ``devtool finish`` command +#. *Finish Your Work With the Recipe*: The ``devtool finish`` command creates any patches corresponding to commits in the local Git repository, updates the recipe to point to them (or creates a ``.bbappend`` file to do so, depending on the specified destination layer), and then resets the recipe so that the recipe is built - normally rather than from the workspace. - :: + normally rather than from the workspace:: $ devtool finish recipe layer @@ -568,8 +603,7 @@ command: Any changes you want to turn into patches must be staged and committed within the local Git repository before you use the - devtool finish - command. + ``devtool finish`` command. Because there is no need to move the recipe, ``devtool finish`` either updates the original recipe in the original layer or the @@ -584,11 +618,282 @@ command: .. note:: - You can use the - devtool reset - command to put things back should you decide you do not want to - proceed with your work. If you do use this command, realize that - the source tree is preserved. + You can use the ``devtool reset`` command to put things back should you + decide you do not want to proceed with your work. If you do use this + command, realize that the source tree is preserved. + +``devtool ide-sdk`` configures IDEs for the extensible SDK +---------------------------------------------------------- + +``devtool ide-sdk`` automatically configures IDEs to use the extensible SDK. +To make sure that all parts of the extensible SDK required by the generated +IDE configuration are available, ``devtool ide-sdk`` uses BitBake in the +background to bootstrap the extensible SDK. + +The extensible SDK supports two different development modes. +``devtool ide-sdk`` supports both of them: + +#. *Modified mode*: + + By default ``devtool ide-sdk`` generates IDE configurations for recipes in + workspaces created by ``devtool modify`` or ``devtool add`` as described in + :ref:`using_devtool`. This mode creates IDE configurations with support for + advanced features, such as deploying the binaries to the remote target + device and performing remote debugging sessions. The generated IDE + configurations use the per recipe sysroots as Bitbake does internally. + + In order to use the tool, a few settings are needed. As a starting example, + the following lines of code can be added to the ``local.conf`` file:: + + # Build the companion debug file system + IMAGE_GEN_DEBUGFS = "1" + # Optimize build time: with devtool ide-sdk the dbg tar is not needed + IMAGE_FSTYPES_DEBUGFS = "" + # Without copying the binaries into roofs-dbg, GDB does not find all source files. + IMAGE_CLASSES += "image-combined-dbg" + + # SSH is mandatory, no password simplifies the usage + EXTRA_IMAGE_FEATURES += "\ + ssh-server-openssh \ + debug-tweaks \ + " + + # Remote debugging needs gdbserver on the target device + IMAGE_INSTALL:append = " gdbserver" + + # Add the recipes which should be modified to the image + # Otherwise some dependencies might be missing. + IMAGE_INSTALL:append = " my-recipe" + + Assuming the BitBake environment is set up correctly and a workspace has + been created for the recipe using ``devtool modify my-recipe``, the + following command can create the SDK and the configuration for VSCode in + the recipe workspace:: + + $ devtool ide-sdk my-recipe core-image-minimal --target root@192.168.7.2 + + The command requires an image recipe (``core-image-minimal`` for this example) + that is used to create the SDK. This firmware image should also be installed + on the target device. It is possible to pass multiple package recipes. + ``devtool ide-sdk`` tries to create an IDE configuration for all package + recipes. + + What this command does exactly depends on the recipe, more precisely on the + build tool used by the recipe. The basic idea is to configure the IDE so + that it calls the build tool exactly as ``bitbake`` does. + + For example, a CMake preset is created for a recipe that inherits + :ref:`ref-classes-cmake`. In the case of VSCode, CMake presets are supported + by the CMake Tools plugin. This is an example of how the build + configuration used by ``bitbake`` is exported to an IDE configuration that + gives exactly the same build results. + + Support for remote debugging with seamless integration into the IDE is + important for a cross-SDK. ``devtool ide-sdk`` automatically generates the + necessary helper scripts for deploying the compiled artifacts to the target + device as well as the necessary configuration for the debugger and the IDE. + + .. note:: + + To ensure that the debug symbols on the build machine match the binaries + running on the target device, it is essential that the image built by + ``devtool ide-sdk`` is running on the target device. + + ``devtool ide-sdk`` aims to support multiple programming languages and + multiple IDEs natively. "Natively" means that the IDE is configured to call + the build tool (e.g. CMake or Meson) directly. This has several advantages. + First of all, it is much faster than ``devtool build``, but it also allows + to use the very good integration of tools like CMake or GDB in VSCode and + other IDEs. However, supporting many programming languages and multiple + IDEs is quite an elaborate and constantly evolving thing. Support for IDEs + is therefore implemented as plugins. Plugins can also be provided by + optional layers. + + The default IDE is VSCode. Some hints about using VSCode: + + - To work on the source code of a recipe an instance of VSCode is started in + the recipe's workspace. Example:: + + code build/workspace/sources/my-recipe + + - To work with CMake press ``Ctrl + Shift + p``, type ``cmake``. This will + show some possible commands like selecting a CMake preset, compiling or + running CTest. + + For recipes inheriting :ref:`ref-classes-cmake-qemu` rather than + :ref:`ref-classes-cmake`, executing cross-compiled unit tests on the host + can be supported transparently with QEMU user-mode. + + - To work with Meson press ``Ctrl + Shift + p``, type ``meson``. This will + show some possible commands like compiling or executing the unit tests. + + A note on running cross-compiled unit tests on the host: Meson enables + support for QEMU user-mode by default. It is expected that the execution + of the unit tests from the IDE will work easily without any additional + steps, provided that the code is suitable for execution on the host + machine. + + - For the deployment to the target device, just press ``Ctrl + Shift + p``, + type ``task``. Select ``install && deploy-target``. + + - For remote debugging, switch to the debugging view by pressing the "play" + button with the ``bug icon`` on the left side. This will provide a green + play button with a drop-down list where a debug configuration can be + selected. After selecting one of the generated configurations, press the + "play" button. + + Starting a remote debugging session automatically initiates the deployment + to the target device. If this is not desired, the + ``"dependsOn": ["install && deploy-target...]`` parameter of the tasks + with ``"label": "gdbserver start...`` can be removed from the + ``tasks.json`` file. + + VSCode supports GDB with many different setups and configurations for many + different use cases. However, most of these setups have some limitations + when it comes to cross-development, support only a few target + architectures or require a high performance target device. Therefore + ``devtool ide-sdk`` supports the classic, generic setup with GDB on the + development host and gdbserver on the target device. + + Roughly summarized, this means: + + - The binaries are copied via SSH to the remote target device by a script + referred by ``tasks.json``. + + - gdbserver is started on the remote target device via SSH by a script + referred by ``tasks.json``. + + Changing the parameters that are passed to the debugging executable + requires modifying the generated script. The script is located at + ``oe-scripts/gdbserver_*``. Defining the parameters in the ``args`` + field in the ``launch.json`` file does not work. + + - VSCode connects to gdbserver as documented in + `Remote debugging or debugging with a local debugger server + <https://code.visualstudio.com/docs/cpp/launch-json-reference#_remote-debugging-or-debugging-with-a-local-debugger-server>`__. + + Additionally ``--ide=none`` is supported. With the ``none`` IDE parameter, + some generic configuration files like ``gdbinit`` files and some helper + scripts starting gdbserver remotely on the target device as well as the GDB + client on the host are generated. + + Here is a usage example for the ``cmake-example`` recipe from the + ``meta-selftest`` layer which inherits :ref:`ref-classes-cmake-qemu`: + + .. code-block:: sh + + # Create the SDK + devtool modify cmake-example + devtool ide-sdk cmake-example core-image-minimal -c --debug-build-config --ide=none + + # Install the firmware on a target device or start QEMU + runqemu + + # From exploring the workspace of cmake-example + cd build/workspace/sources/cmake-example + + # Find cmake-native and save the path into a variable + # Note: using just cmake instead of $CMAKE_NATIVE would work in many cases + CMAKE_NATIVE="$(jq -r '.configurePresets[0] | "\(.cmakeExecutable)"' CMakeUserPresets.json)" + + # List available CMake presets + "$CMAKE_NATIVE" --list-presets + Available configure presets: + + "cmake-example-cortexa57" - cmake-example: cortexa57 + + # Re-compile the already compiled sources + "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 + ninja: no work to do. + # Do a clean re-build + "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 --target clean + [1/1] Cleaning all built files... + Cleaning... 8 files. + "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 --target all + [7/7] Linking CXX executable cmake-example + + # Run the cross-compiled unit tests with QEMU user-mode + "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 --target test + [0/1] Running tests... + Test project .../build/tmp/work/cortexa57-poky-linux/cmake-example/1.0/cmake-example-1.0 + Start 1: test-cmake-example + 1/1 Test #1: test-cmake-example ............... Passed 0.03 sec + + 100% tests passed, 0 tests failed out of 1 + + Total Test time (real) = 0.03 sec + + # Using CTest directly is possible as well + CTEST_NATIVE="$(dirname "$CMAKE_NATIVE")/ctest" + + # List available CMake presets + "$CTEST_NATIVE" --list-presets + Available test presets: + + "cmake-example-cortexa57" - cmake-example: cortexa57 + + # Run the cross-compiled unit tests with QEMU user-mode + "$CTEST_NATIVE" --preset "cmake-example-cortexa57" + Test project ...build/tmp/work/cortexa57-poky-linux/cmake-example/1.0/cmake-example-1.0 + Start 1: test-cmake-example + 1/1 Test #1: test-cmake-example ............... Passed 0.03 sec + + 100% tests passed, 0 tests failed out of 1 + + Total Test time (real) = 0.03 sec + + # Deploying the new build to the target device (default is QEUM at 192.168.7.2) + oe-scripts/install_and_deploy_cmake-example-cortexa57 + + # Start a remote debugging session with gdbserver on the target and GDB on the host + oe-scripts/gdbserver_1234_usr-bin-cmake-example_m + oe-scripts/gdb_1234_usr-bin-cmake-example + break main + run + step + stepi + continue + quit + + # Stop gdbserver on the target device + oe-scripts/gdbserver_1234_usr-bin-cmake-example_m stop + +#. *Shared sysroots mode* + + For some recipes and use cases a per-recipe sysroot based SDK is not + suitable. Optionally ``devtool ide-sdk`` configures the IDE to use the + toolchain provided by the extensible SDK as described in + :ref:`running_the_ext_sdk_env`. ``devtool ide-sdk --mode=shared`` is + basically a wrapper for the setup of the extensible SDK as described in + :ref:`setting_up_ext_sdk_in_build`. The IDE gets a configuration to use the + shared sysroots. + + Creating a SDK with shared sysroots that contains all the dependencies needed + to work with ``my-recipe`` is possible with the following example command:: + + $ devtool ide-sdk --mode=shared my-recipe + + For VSCode the cross-toolchain is exposed as a CMake kit. CMake kits are + defined in ``~/.local/share/CMakeTools/cmake-tools-kits.json``. + The following example shows how the cross-toolchain can be selected in + VSCode. First of all we need a folder containing a CMake project. + For this example, let's create a CMake project and start VSCode:: + + mkdir kit-test + echo "project(foo VERSION 1.0)" > kit-test/CMakeLists.txt + code kit-test + + If there is a CMake project in the workspace, cross-compilation is supported: + + - Press ``Ctrl + Shift + P``, type ``CMake: Scan for Kits`` + - Press ``Ctrl + Shift + P``, type ``CMake: Select a Kit`` + + Finally most of the features provided by CMake and the IDE should be available. + + Other IDEs than VSCode are supported as well. However, + ``devtool ide-sdk --mode=shared --ide=none my-recipe`` is currently + just a simple wrapper for the setup of the extensible SDK, as described in + :ref:`setting_up_ext_sdk_in_build`. Use ``devtool upgrade`` to Create a Version of the Recipe that Supports a Newer Version of the Software ------------------------------------------------------------------------------------------------------- @@ -602,27 +907,25 @@ counterparts. .. note:: - Several methods exist by which you can upgrade recipes - - ``devtool upgrade`` - happens to be one. You can read about all the methods by which you - can upgrade recipes in the - :ref:`dev-manual/common-tasks:upgrading recipes` section - of the Yocto Project Development Tasks Manual. + Several methods exist by which you can upgrade recipes --- + ``devtool upgrade`` happens to be one. You can read about all the methods by + which you can upgrade recipes in the + :ref:`dev-manual/upgrading-recipes:upgrading recipes` section of the Yocto + Project Development Tasks Manual. -The ``devtool upgrade`` command is flexible enough to allow you to -specify source code revision and versioning schemes, extract code into -or out of the ``devtool`` -:ref:`devtool-the-workspace-layer-structure`, -and work with any source file forms that the -:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers` support. +The ``devtool upgrade`` command is flexible enough to allow you to specify +source code revision and versioning schemes, extract code into or out of the +``devtool`` :ref:`devtool-the-workspace-layer-structure`, and work with any +source file forms that the +:ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` support. The following diagram shows the common development flow used with the ``devtool upgrade`` command: .. image:: figures/sdk-devtool-upgrade-flow.png - :align: center + :width: 100% -1. *Initiate the Upgrade*: The top part of the flow shows the typical +#. *Initiate the Upgrade*: The top part of the flow shows the typical scenario by which you use the ``devtool upgrade`` command. The following conditions exist: @@ -674,7 +977,7 @@ The following diagram shows the common development flow used with the are incorporated into the build the next time you build the software just as are other changes you might have made to the source. -2. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen +#. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen after upgrading the software to a new version. Conflicts occur if your recipe specifies some patch files in :term:`SRC_URI` that conflict with changes made in the new version of the software. For @@ -685,7 +988,7 @@ The following diagram shows the common development flow used with the conflicts created through use of a newer or different version of the software. -3. *Build the Recipe or Rebuild the Image*: The next step you take +#. *Build the Recipe or Rebuild the Image*: The next step you take depends on what you are going to do with the new code. If you need to eventually move the build output to the target @@ -700,7 +1003,7 @@ The following diagram shows the common development flow used with the $ devtool build-image image -4. *Deploy the Build Output*: When you use the ``devtool build`` command +#. *Deploy the Build Output*: When you use the ``devtool build`` command or ``bitbake`` to build your recipe, you probably want to see if the resulting build output works as expected on target hardware. @@ -714,15 +1017,18 @@ The following diagram shows the common development flow used with the development machine. You can deploy your build output to that target hardware by using the - ``devtool deploy-target`` command: $ devtool deploy-target recipe - target The target is a live target machine running as an SSH server. + ``devtool deploy-target`` command:: + + $ devtool deploy-target recipe target + + The target is a live target machine running as an SSH server. You can, of course, also deploy the image you build using the ``devtool build-image`` command to actual hardware. However, ``devtool`` does not provide a specific command that allows you to do this. -5. *Finish Your Work With the Recipe*: The ``devtool finish`` command +#. *Finish Your Work With the Recipe*: The ``devtool finish`` command creates any patches corresponding to commits in the local Git repository, moves the new recipe to a more permanent layer, and then resets the recipe so that the recipe is built normally rather than @@ -734,8 +1040,7 @@ The following diagram shows the common development flow used with the If you specify a destination layer that is the same as the original source, then the old version of the recipe and associated files are - removed prior to adding the new version. - :: + removed prior to adding the new version:: $ devtool finish recipe layer @@ -750,11 +1055,9 @@ The following diagram shows the common development flow used with the .. note:: - You can use the - devtool reset - command to put things back should you decide you do not want to - proceed with your work. If you do use this command, realize that - the source tree is preserved. + You can use the ``devtool reset`` command to put things back should you + decide you do not want to proceed with your work. If you do use this + command, realize that the source tree is preserved. A Closer Look at ``devtool add`` ================================ @@ -822,10 +1125,9 @@ run ``devtool add`` again and provide the name or the version. Dependency Detection and Mapping -------------------------------- -The ``devtool add`` command attempts to detect build-time dependencies -and map them to other recipes in the system. During this mapping, the -command fills in the names of those recipes as part of the -:term:`DEPENDS` variable within the +The ``devtool add`` command attempts to detect build-time dependencies and map +them to other recipes in the system. During this mapping, the command fills in +the names of those recipes as part of the :term:`DEPENDS` variable within the recipe. If a dependency cannot be mapped, ``devtool`` places a comment in the recipe indicating such. The inability to map a dependency can result from naming not being recognized or because the dependency simply @@ -842,10 +1144,8 @@ following to your recipe:: .. note:: - The - devtool add - command often cannot distinguish between mandatory and optional - dependencies. Consequently, some of the detected dependencies might + The ``devtool add`` command often cannot distinguish between mandatory and + optional dependencies. Consequently, some of the detected dependencies might in fact be optional. When in doubt, consult the documentation or the configure script for the software the recipe is building for further details. In some cases, you might find you can substitute the @@ -855,16 +1155,14 @@ following to your recipe:: License Detection ----------------- -The ``devtool add`` command attempts to determine if the software you -are adding is able to be distributed under a common, open-source -license. If so, the command sets the -:term:`LICENSE` value accordingly. +The ``devtool add`` command attempts to determine if the software you are +adding is able to be distributed under a common, open-source license. If +so, the command sets the :term:`LICENSE` value accordingly. You should double-check the value added by the command against the documentation or source files for the software you are building and, if necessary, update that :term:`LICENSE` value. -The ``devtool add`` command also sets the -:term:`LIC_FILES_CHKSUM` +The ``devtool add`` command also sets the :term:`LIC_FILES_CHKSUM` value to point to all files that appear to be license-related. Realize that license statements often appear in comments at the top of source files or within the documentation. In such cases, the command does not @@ -944,10 +1242,9 @@ mind: Adding Native Tools ------------------- -Often, you need to build additional tools that run on the :term:`Build -Host` as opposed to -the target. You should indicate this requirement by using one of the -following methods when you run ``devtool add``: +Often, you need to build additional tools that run on the :term:`Build Host` +as opposed to the target. You should indicate this requirement by using one of +the following methods when you run ``devtool add``: - Specify the name of the recipe such that it ends with "-native". Specifying the name like this produces a recipe that only builds for @@ -971,8 +1268,7 @@ Adding Node.js Modules ---------------------- You can use the ``devtool add`` command two different ways to add -Node.js modules: 1) Through ``npm`` and, 2) from a repository or local -source. +Node.js modules: through ``npm`` or from a repository or local source. Use the following form to add Node.js modules through ``npm``:: @@ -987,7 +1283,7 @@ these behaviors ensure the reproducibility and integrity of the build. .. note:: - - You must use quotes around the URL. The ``devtool add`` does not + - You must use quotes around the URL. ``devtool add`` does not require the quotes, but the shell considers ";" as a splitter between multiple commands. Thus, without the quotes, ``devtool add`` does not receive the other parts, which results in @@ -1002,9 +1298,8 @@ repository or local source tree. To add modules this way, use $ devtool add https://github.com/diversario/node-ssdp -In this example, ``devtool`` -fetches the specified Git repository, detects the code as Node.js code, -fetches dependencies using ``npm``, and sets +In this example, ``devtool`` fetches the specified Git repository, detects the +code as Node.js code, fetches dependencies using ``npm``, and sets :term:`SRC_URI` accordingly. Working With Recipes @@ -1013,17 +1308,17 @@ Working With Recipes When building a recipe using the ``devtool build`` command, the typical build progresses as follows: -1. Fetch the source +#. Fetch the source -2. Unpack the source +#. Unpack the source -3. Configure the source +#. Configure the source -4. Compile the source +#. Compile the source -5. Install the build output +#. Install the build output -6. Package the installed output +#. Package the installed output For recipes in the workspace, fetching and unpacking is disabled as the source tree has already been prepared and is persistent. Each of these @@ -1038,9 +1333,8 @@ does not include complete instructions for building the software. Instead, common functionality is encapsulated in classes inherited with the ``inherit`` directive. This technique leaves the recipe to describe just the things that are specific to the software being built. There is -a :ref:`base <ref-classes-base>` class that -is implicitly inherited by all recipes and provides the functionality -that most recipes typically need. +a :ref:`ref-classes-base` class that is implicitly inherited by all recipes +and provides the functionality that most recipes typically need. The remainder of this section presents information useful when working with recipes. @@ -1066,9 +1360,9 @@ links created within the source tree: ``${``\ :term:`D`\ ``}``. - ``sysroot-destdir/``: Contains a subset of files installed within - ``do_install`` that have been put into the shared sysroot. For + :ref:`ref-tasks-install` that have been put into the shared sysroot. For more information, see the - ":ref:`dev-manual/common-tasks:sharing files between recipes`" section. + ":ref:`dev-manual/new-recipe:sharing files between recipes`" section. - ``packages-split/``: Contains subdirectories for each package produced by the recipe. For more information, see the @@ -1082,18 +1376,13 @@ Setting Configure Arguments If the software your recipe is building uses GNU autoconf, then a fixed set of arguments is passed to it to enable cross-compilation plus any -extras specified by -:term:`EXTRA_OECONF` or -:term:`PACKAGECONFIG_CONFARGS` +extras specified by :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS` set within the recipe. If you wish to pass additional options, add them to :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS`. Other supported build -tools have similar variables (e.g. -:term:`EXTRA_OECMAKE` for -CMake, :term:`EXTRA_OESCONS` -for Scons, and so forth). If you need to pass anything on the ``make`` -command line, you can use :term:`EXTRA_OEMAKE` or the -:term:`PACKAGECONFIG_CONFARGS` -variables to do so. +tools have similar variables (e.g. :term:`EXTRA_OECMAKE` for CMake, +:term:`EXTRA_OESCONS` for Scons, and so forth). If you need to pass anything on +the ``make`` command line, you can use :term:`EXTRA_OEMAKE` or the +:term:`PACKAGECONFIG_CONFARGS` variables to do so. You can use the ``devtool configure-help`` command to help you set the arguments listed in the previous paragraph. The command determines the @@ -1117,8 +1406,7 @@ the build host. Recipes should never write files directly into the sysroot. Instead, files should be installed into standard locations during the -:ref:`ref-tasks-install` task within -the ``${``\ :term:`D`\ ``}`` directory. A +:ref:`ref-tasks-install` task within the ``${``\ :term:`D`\ ``}`` directory. A subset of these files automatically goes into the sysroot. The reason for this limitation is that almost all files that go into the sysroot are cataloged in manifests in order to ensure they can be removed later @@ -1134,14 +1422,12 @@ the target device, it is important to understand packaging because the contents of the image are expressed in terms of packages and not recipes. -During the :ref:`ref-tasks-package` -task, files installed during the -:ref:`ref-tasks-install` task are -split into one main package, which is almost always named the same as -the recipe, and into several other packages. This separation exists -because not all of those installed files are useful in every image. For -example, you probably do not need any of the documentation installed in -a production image. Consequently, for each recipe the documentation +During the :ref:`ref-tasks-package` task, files installed during the +:ref:`ref-tasks-install` task are split into one main package, which is almost +always named the same as the recipe, and into several other packages. This +separation exists because not all of those installed files are useful in every +image. For example, you probably do not need any of the documentation installed +in a production image. Consequently, for each recipe the documentation files are separated into a ``-doc`` package. Recipes that package software containing optional modules or plugins might undergo additional package splitting as well. @@ -1149,8 +1435,7 @@ package splitting as well. After building a recipe, you can see where files have gone by looking in the ``oe-workdir/packages-split`` directory, which contains a subdirectory for each package. Apart from some advanced cases, the -:term:`PACKAGES` and -:term:`FILES` variables controls +:term:`PACKAGES` and :term:`FILES` variables controls splitting. The :term:`PACKAGES` variable lists all of the packages to be produced, while the :term:`FILES` variable specifies which files to include in each package by using an override to specify the package. For @@ -1192,16 +1477,11 @@ target machine. .. note:: - The - devtool deploy-target - and - devtool undeploy-target - commands do not currently interact with any package management system - on the target device (e.g. RPM or OPKG). Consequently, you should not - intermingle - devtool deploy-target - and package manager operations on the target device. Doing so could - result in a conflicting set of files. + The ``devtool deploy-target`` and ``devtool undeploy-target`` commands do + not currently interact with any package management system on the target + device (e.g. RPM or OPKG). Consequently, you should not intermingle + ``devtool deploy-target`` and package manager operations on the target + device. Doing so could result in a conflicting set of files. Installing Additional Items Into the Extensible SDK =================================================== @@ -1215,9 +1495,29 @@ need to link to libGL but you are not sure which recipe provides libGL. You can use the following command to find out:: $ devtool search libGL mesa + A free implementation of the OpenGL API + +Once you know the recipe +(i.e. ``mesa`` in this example), you can install it. -A free implementation of the OpenGL API Once you know the recipe -(i.e. ``mesa`` in this example), you can install it:: +When using the extensible SDK directly in a Yocto build +------------------------------------------------------- + +In this scenario, the Yocto build tooling, e.g. ``bitbake`` +is directly accessible to build additional items, and it +can simply be executed directly:: + + $ bitbake curl-native + # Add newly built native items to native sysroot + $ bitbake build-sysroots -c build_native_sysroot + $ bitbake mesa + # Add newly built target items to target sysroot + $ bitbake build-sysroots -c build_target_sysroot + +When using a standalone installer for the Extensible SDK +-------------------------------------------------------- + +:: $ devtool sdk-install mesa @@ -1244,13 +1544,13 @@ To update your installed SDK, use ``devtool`` as follows:: $ devtool sdk-update -The previous command assumes your SDK provider has set the -default update URL for you through the :term:`SDK_UPDATE_URL` -variable as described in the +The previous command assumes your SDK provider has set the default update URL +for you through the :term:`SDK_UPDATE_URL` variable as described in the ":ref:`sdk-manual/appendix-customizing:Providing Updates to the Extensible SDK After Installation`" section. If the SDK provider has not set that default URL, you need to -specify it yourself in the command as follows: $ devtool sdk-update -path_to_update_directory +specify it yourself in the command as follows:: + + $ devtool sdk-update path_to_update_directory .. note:: @@ -1267,15 +1567,15 @@ those customers need an SDK that has custom libraries. In such a case, you can produce a derivative SDK based on the currently installed SDK fairly easily by following these steps: -1. If necessary, install an extensible SDK that you want to use as a +#. If necessary, install an extensible SDK that you want to use as a base for your derivative SDK. -2. Source the environment script for the SDK. +#. Source the environment script for the SDK. -3. Add the extra libraries or other components you want by using the +#. Add the extra libraries or other components you want by using the ``devtool add`` command. -4. Run the ``devtool build-sdk`` command. +#. Run the ``devtool build-sdk`` command. The previous steps take the recipes added to the workspace and construct a new SDK installer that contains those recipes and the resulting binary diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst index 802d3f3d42..e8fd191dbc 100644 --- a/documentation/sdk-manual/intro.rst +++ b/documentation/sdk-manual/intro.rst @@ -66,7 +66,7 @@ The SDK development environment consists of the following: In summary, the extensible and standard SDK share many features. However, the extensible SDK has powerful development tools to help you -more quickly develop applications. Following is a table that summarizes +more quickly develop applications. Here is a table that summarizes the primary differences between the standard and extensible SDK types when considering which to build: @@ -149,7 +149,7 @@ SDK Development Model Fundamentally, the SDK fits into the development process as follows: .. image:: figures/sdk-environment.png - :align: center + :width: 100% The SDK is installed on any machine and can be used to develop applications, images, and kernels. An SDK can even be used by a QA Engineer or Release @@ -164,11 +164,11 @@ image. You just need to follow these general steps: -1. *Install the SDK for your target hardware:* For information on how to +#. *Install the SDK for your target hardware:* For information on how to install the SDK, see the ":ref:`sdk-manual/using:installing the sdk`" section. -2. *Download or Build the Target Image:* The Yocto Project supports +#. *Download or Build the Target Image:* The Yocto Project supports several target architectures and has many pre-built kernel images and root filesystem images. @@ -195,7 +195,7 @@ You just need to follow these general steps: ":ref:`sdk-manual/appendix-obtain:extracting the root filesystem`" section for information on how to do this extraction. -3. *Develop and Test your Application:* At this point, you have the +#. *Develop and Test your Application:* At this point, you have the tools to develop your application. If you need to separately install and use the QEMU emulator, you can go to `QEMU Home Page <https://wiki.qemu.org/Main_Page>`__ to download and learn about diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst index 301627812c..f1ff0c76ca 100644 --- a/documentation/sdk-manual/using.rst +++ b/documentation/sdk-manual/using.rst @@ -52,8 +52,7 @@ libraries appropriate for developing against the corresponding image. The names of the tarball installer scripts are such that a string representing the host system appears first in the filename and then is -immediately followed by a string representing the target architecture. -:: +immediately followed by a string representing the target architecture:: poky-glibc-host_system-image_type-arch-toolchain-release_version.sh @@ -97,16 +96,7 @@ must be writable for whichever users need to use the SDK. The following command shows how to run the installer given a toolchain tarball for a 64-bit x86 development host system and a 64-bit x86 target architecture. The example assumes the SDK installer is located in -``~/Downloads/`` and has execution rights. - -.. note:: - - If you do not have write permissions for the directory into which you - are installing the SDK, the installer notifies you and exits. For - that case, set up the proper permissions in the directory and run the - installer again. - -:: +``~/Downloads/`` and has execution rights:: $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; @@ -119,6 +109,13 @@ architecture. The example assumes the SDK installer is located in Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux +.. note:: + + If you do not have write permissions for the directory into which you + are installing the SDK, the installer notifies you and exits. For + that case, set up the proper permissions in the directory and run the + installer again. + Again, reference the ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`" section for more details on the resulting directory structure of the installed diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index 276daa9bb6..4236bcec24 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst @@ -11,14 +11,15 @@ Autotools-Based Projects ======================== Once you have a suitable :ref:`sdk-manual/intro:the cross-development toolchain` -installed, it is very easy to develop a project using the `GNU -Autotools-based <https://en.wikipedia.org/wiki/GNU_Build_System>`__ -workflow, which is outside of the :term:`OpenEmbedded Build System`. +installed, it is very easy to develop a project using the :wikipedia:`GNU +Autotools-based <GNU_Build_System>` workflow, which is outside of the +:term:`OpenEmbedded Build System`. The following figure presents a simple Autotools workflow. .. image:: figures/sdk-autotools-flow.png :align: center + :width: 70% Follow these steps to create a simple Autotools-based "Hello World" project: @@ -30,10 +31,9 @@ project: GNOME Developer site. -1. *Create a Working Directory and Populate It:* Create a clean +#. *Create a Working Directory and Populate It:* Create a clean directory for your project and then make that directory your working - location. - :: + location:: $ mkdir $HOME/helloworld $ cd $HOME/helloworld @@ -74,7 +74,7 @@ project: bin_PROGRAMS = hello hello_SOURCES = hello.c -2. *Source the Cross-Toolchain Environment Setup File:* As described +#. *Source the Cross-Toolchain Environment Setup File:* As described earlier in the manual, installing the cross-toolchain creates a cross-toolchain environment setup script in the directory that the SDK was installed. Before you can use the tools to develop your @@ -87,9 +87,13 @@ project: $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux -3. *Create the configure Script:* Use the ``autoreconf`` command to - generate the ``configure`` script. - :: + Another example is sourcing the environment setup directly in a Yocto + build:: + + $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux + +#. *Create the configure Script:* Use the ``autoreconf`` command to + generate the ``configure`` script:: $ autoreconf @@ -104,7 +108,7 @@ project: which ensures missing auxiliary files are copied to the build host. -4. *Cross-Compile the Project:* This command compiles the project using +#. *Cross-Compile the Project:* This command compiles the project using the cross-compiler. The :term:`CONFIGURE_FLAGS` environment variable provides the minimal arguments for GNU @@ -125,7 +129,7 @@ project: $ ./configure --host=armv5te-poky-linux-gnueabi --with-libtool-sysroot=sysroot_dir -5. *Make and Install the Project:* These two commands generate and +#. *Make and Install the Project:* These two commands generate and install the project into the destination directory:: $ make @@ -141,12 +145,11 @@ project: This next command is a simple way to verify the installation of your project. Running the command prints the architecture on which the binary file can run. This architecture should be the same - architecture that the installed cross-toolchain supports. - :: + architecture that the installed cross-toolchain supports:: $ file ./tmp/usr/local/bin/hello -6. *Execute Your Project:* To execute the project, you would need to run +#. *Execute Your Project:* To execute the project, you would need to run it on your target hardware. If your target hardware happens to be your build host, you could run the project as follows:: @@ -168,23 +171,24 @@ variables and Makefile variables during development. .. image:: figures/sdk-makefile-flow.png :align: center + :width: 70% The main point of this section is to explain the following three cases regarding variable behavior: -- *Case 1 - No Variables Set in the Makefile Map to Equivalent +- *Case 1 --- No Variables Set in the Makefile Map to Equivalent Environment Variables Set in the SDK Setup Script:* Because matching variables are not specifically set in the ``Makefile``, the variables retain their values based on the environment setup script. -- *Case 2 - Variables Are Set in the Makefile that Map to Equivalent +- *Case 2 --- Variables Are Set in the Makefile that Map to Equivalent Environment Variables from the SDK Setup Script:* Specifically setting matching variables in the ``Makefile`` during the build results in the environment settings of the variables being overwritten. In this case, the variables you set in the ``Makefile`` are used. -- *Case 3 - Variables Are Set Using the Command Line that Map to +- *Case 3 --- Variables Are Set Using the Command Line that Map to Equivalent Environment Variables from the SDK Setup Script:* Executing the ``Makefile`` from the command line results in the environment variables being overwritten. In this case, the @@ -204,8 +208,7 @@ demonstrates these variable behaviors. In a new shell environment variables are not established for the SDK until you run the setup script. For example, the following commands show a null value for the compiler variable (i.e. -:term:`CC`). -:: +:term:`CC`):: $ echo ${CC} @@ -224,10 +227,9 @@ established through the script:: To illustrate variable use, work through this simple "Hello World!" example: -1. *Create a Working Directory and Populate It:* Create a clean +#. *Create a Working Directory and Populate It:* Create a clean directory for your project and then make that directory your working - location. - :: + location:: $ mkdir $HOME/helloworld $ cd $HOME/helloworld @@ -264,7 +266,7 @@ example: printf("\n"); } -2. *Source the Cross-Toolchain Environment Setup File:* As described +#. *Source the Cross-Toolchain Environment Setup File:* As described earlier in the manual, installing the cross-toolchain creates a cross-toolchain environment setup script in the directory that the SDK was installed. Before you can use the tools to develop your @@ -277,7 +279,12 @@ example: $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux -3. *Create the Makefile:* For this example, the Makefile contains + Another example is sourcing the environment setup directly in a Yocto + build:: + + $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux + +#. *Create the Makefile:* For this example, the Makefile contains two lines that can be used to set the :term:`CC` variable. One line is identical to the value that is set when you run the SDK environment setup script, and the other line sets :term:`CC` to "gcc", the default @@ -286,16 +293,16 @@ example: # CC=i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/2.5/sysroots/i586-poky-linux # CC="gcc" all: main.o module.o - ${CC} main.o module.o -o target_bin + ${CC} main.o module.o -o target_bin main.o: main.c module.h - ${CC} -I . -c main.c - module.o: module.c - module.h ${CC} -I . -c module.c + ${CC} -I . -c main.c + module.o: module.c module.h + ${CC} -I . -c module.c clean: - rm -rf *.o - rm target_bin + rm -rf *.o + rm target_bin -4. *Make the Project:* Use the ``make`` command to create the binary +#. *Make the Project:* Use the ``make`` command to create the binary output file. Because variables are commented out in the Makefile, the value used for :term:`CC` is the value set when the SDK environment setup file was run:: @@ -311,8 +318,7 @@ example: You can override the :term:`CC` environment variable with the same variable as set from the Makefile by uncommenting the line in the - Makefile and running ``make`` again. - :: + Makefile and running ``make`` again:: $ make clean rm -rf *.o @@ -381,7 +387,7 @@ example: use the SDK environment variables regardless of the values in the Makefile. -5. *Execute Your Project:* To execute the project (i.e. ``target_bin``), +#. *Execute Your Project:* To execute the project (i.e. ``target_bin``), use the following command:: $ ./target_bin diff --git a/documentation/set_versions.py b/documentation/set_versions.py new file mode 100755 index 0000000000..90e08fc5e0 --- /dev/null +++ b/documentation/set_versions.py @@ -0,0 +1,316 @@ +#!/usr/bin/env python3 +# +# Add version information to poky.yaml based upon current git branch/tags +# Also generate the list of available manuals (releases.rst file) +# +# Copyright Linux Foundation +# Author: Richard Purdie <richard.purdie@linuxfoundation.org> +# Author: Quentin Schulz <foss@0leil.net> +# +# SPDX-License-Identifier: MIT +# + + +import subprocess +import collections +import sys +import os +import itertools +import re + +ourversion = None +if len(sys.argv) == 2: + ourversion = sys.argv[1] + +ourversion = None +if len(sys.argv) == 2: + ourversion = sys.argv[1] + +activereleases = ["nanbield", "kirkstone", "dunfell"] +devbranch = "scarthgap" +ltsseries = ["kirkstone", "dunfell"] + +# used by run-docs-builds to get the default page +if ourversion == "getlatest": + print(activereleases[0]) + sys.exit(0) + +release_series = collections.OrderedDict() +release_series["scarthgap"] = "5.0" +release_series["nanbield"] = "4.3" +release_series["mickledore"] = "4.2" +release_series["langdale"] = "4.1" +release_series["kirkstone"] = "4.0" +release_series["honister"] = "3.4" +release_series["hardknott"] = "3.3" +release_series["gatesgarth"] = "3.2" +release_series["dunfell"] = "3.1" +release_series["zeus"] = "3.0" +release_series["warrior"] = "2.7" +release_series["thud"] = "2.6" +release_series["sumo"] = "2.5" +release_series["rocko"] = "2.4" +release_series["pyro"] = "2.3" +release_series["morty"] = "2.2" +release_series["krogoth"] = "2.1" +release_series["jethro"] = "2.0" +release_series["jethro-pre"] = "1.9" +release_series["fido"] = "1.8" +release_series["dizzy"] = "1.7" +release_series["daisy"] = "1.6" +release_series["dora"] = "1.5" +release_series["dylan"] = "1.4" +release_series["danny"] = "1.3" +release_series["denzil"] = "1.2" +release_series["edison"] = "1.1" +release_series["bernard"] = "1.0" +release_series["laverne"] = "0.9" + + +bitbake_mapping = { + "scarthgap" : "2.8", + "nanbield" : "2.6", + "mickledore" : "2.4", + "langdale" : "2.2", + "kirkstone" : "2.0", + "honister" : "1.52", + "hardknott" : "1.50", + "gatesgarth" : "1.48", + "dunfell" : "1.46", +} + +# 3.4 onwards doesn't have poky version +# Early 3.4 release docs do reference it though +poky_mapping = { + "3.4" : "26.0", + "3.3" : "25.0", + "3.2" : "24.0", + "3.1" : "23.0", +} + +ourseries = None +ourbranch = None +bitbakeversion = None +docconfver = None + +# Test tags exist and inform the user to fetch if not +try: + subprocess.run(["git", "show", "yocto-%s" % release_series[activereleases[0]]], capture_output=True, check=True) +except subprocess.CalledProcessError: + sys.exit("Please run 'git fetch --tags' before building the documentation") + +# Try and figure out what we are +tags = subprocess.run(["git", "tag", "--points-at", "HEAD"], capture_output=True, text=True).stdout +for t in tags.split(): + if t.startswith("yocto-"): + ourversion = t[6:] + +if ourversion: + # We're a tagged release + components = ourversion.split(".") + baseversion = components[0] + "." + components[1] + docconfver = ourversion + for i in release_series: + if release_series[i] == baseversion: + ourseries = i + ourbranch = i + if i in bitbake_mapping: + bitbakeversion = bitbake_mapping[i] +else: + # We're floating on a branch + branch = subprocess.run(["git", "branch", "--show-current"], capture_output=True, text=True).stdout.strip() + ourbranch = branch + if branch != "master" and branch not in release_series: + # We're not on a known release branch so we have to guess. Compare the numbers of commits + # from each release branch and assume the smallest number of commits is the one we're based off + possible_branch = None + branch_count = 0 + for b in itertools.chain(release_series.keys(), ["master"]): + result = subprocess.run(["git", "log", "--format=oneline", "HEAD..origin/" + b], capture_output=True, text=True) + if result.returncode == 0: + count = result.stdout.count('\n') + if not possible_branch or count < branch_count: + print("Branch %s has count %s" % (b, count)) + possible_branch = b + branch_count = count + if possible_branch: + branch = possible_branch + else: + branch = "master" + print("Nearest release branch estimated to be %s" % branch) + if branch == "master": + ourseries = devbranch + docconfver = "dev" + bitbakeversion = "dev" + elif branch in release_series: + ourseries = branch + if branch in bitbake_mapping: + bitbakeversion = bitbake_mapping[branch] + else: + sys.exit("Unknown series for branch %s" % branch) + + previoustags = subprocess.run(["git", "tag", "--merged", "HEAD"], capture_output=True, text=True).stdout + previoustags = [t[6:] for t in previoustags.split() if t.startswith("yocto-" + release_series[ourseries])] + futuretags = subprocess.run(["git", "tag", "--merged", ourbranch], capture_output=True, text=True).stdout + futuretags = [t[6:] for t in futuretags.split() if t.startswith("yocto-" + release_series[ourseries])] + + # Append .999 against the last known version + if len(previoustags) != len(futuretags): + ourversion = previoustags[-1] + ".999" + else: + ourversion = release_series[ourseries] + ".999" + if not docconfver: + docconfver = ourversion + +series = [k for k in release_series] +previousseries = series[series.index(ourseries)+1:] or [""] +lastlts = [k for k in previousseries if k in ltsseries] or "dunfell" + +print("Version calculated to be %s" % ourversion) +print("Release series calculated to be %s" % ourseries) + +replacements = { + "DISTRO" : ourversion, + "DISTRO_NAME_NO_CAP" : ourseries, + "DISTRO_NAME" : ourseries.capitalize(), + "DISTRO_NAME_NO_CAP_MINUS_ONE" : previousseries[0], + "DISTRO_NAME_NO_CAP_LTS" : lastlts[0], + "YOCTO_DOC_VERSION" : ourversion, + "DISTRO_REL_TAG" : "yocto-" + ourversion, + "DOCCONF_VERSION" : docconfver, + "BITBAKE_SERIES" : bitbakeversion, +} + +if release_series[ourseries] in poky_mapping: + pokyversion = poky_mapping[release_series[ourseries]] + if ourversion != release_series[ourseries]: + pokyversion = pokyversion + "." + ourversion.rsplit(".", 1)[1] + else: + pokyversion = pokyversion + ".0" + replacements["POKYVERSION"] = pokyversion + +if os.path.exists("poky.yaml.in"): + with open("poky.yaml.in", "r") as r, open("poky.yaml", "w") as w: + lines = r.readlines() + for line in lines: + data = line.split(":") + k = data[0].strip() + if k in replacements: + w.write("%s : \"%s\"\n" % (k, replacements[k])) + else: + w.write(line) + + print("poky.yaml generated from poky.yaml.in") + + +# In the switcher list of versions we display: +# - latest dev +# - latest stable release +# - latest LTS +# - latest for each releases listed as active +# - latest doc version in current series +# - current doc version +# (with duplicates removed) + +versions = [] +with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switchers.js", "w") as w: + lines = r.readlines() + for line in lines: + if "ALL_RELEASES_PLACEHOLDER" in line: + w.write(str(list(release_series.keys()))) + continue + if "VERSIONS_PLACEHOLDER" in line: + w.write(" 'dev': { 'title': 'Unstable (dev)', 'obsolete': false,},\n") + for branch in activereleases + ([ourseries] if ourseries not in activereleases else []): + if branch == devbranch: + continue + branch_versions = subprocess.run('git tag --list yocto-%s*' % (release_series[branch]), shell=True, capture_output=True, text=True).stdout.split() + branch_versions = sorted([v.replace("yocto-" + release_series[branch] + ".", "").replace("yocto-" + release_series[branch], "0") for v in branch_versions], key=int) + if not branch_versions: + continue + version = release_series[branch] + if branch_versions[-1] != "0": + version = version + "." + branch_versions[-1] + versions.append(version) + w.write(" '%s': {'title': '%s (%s)', 'obsolete': %s,},\n" % (version, branch.capitalize(), version, str(branch not in activereleases).lower())) + if ourversion not in versions and ourseries != devbranch: + w.write(" '%s': {'title': '%s (%s)', 'obsolete': %s,},\n" % (ourversion, ourseries.capitalize(), ourversion, str(ourseries not in activereleases).lower())) + else: + w.write(line) + +print("switchers.js generated from switchers.js.in") + +# generate releases.rst + +# list missing tags in yocto-docs +missing_tags = [ + 'yocto-0.9', + 'yocto-1.0', 'yocto-1.0.1', + 'yocto-1.1', 'yocto-1.1.1', + 'yocto-1.2', + 'yocto-1.4.4', 'yocto-1.4.5', + 'yocto-1.5', 'yocto-1.5.2', 'yocto-1.5.3', 'yocto-1.5.4', + 'yocto-1.6', 'yocto-1.6.1', 'yocto-1.6.2', + 'yocto-1.7', 'yocto-1.7.1', + 'yocto-1.9', + 'yocto-2.5.3', + 'yocto-3.1', 'yocto-3.1.1', 'yocto-3.1.2', 'yocto-3.1.3', + ] + +semver = re.compile(r'yocto-(\d+)\.(\d+)(?:\.)?(\d*)') + +# git is able to properly order semver versions but not python +# instead of adding a dependency on semver module, let's convert the version +# into a decimal number, e.g. 11.23.1 will be 112301 and 1.5 will be 010500 so +# it can be used as a key for the sorting algorithm. +# This can be removed once all the old tags are re-created. +def tag_to_semver_like(v): + v_semver = semver.search(v) + v_maj, v_min, v_patch = v_semver.groups('0') + return int("{:0>2}{:0>2}{:0>2}".format(v_maj, v_min, v_patch), 10) + +yocto_tags = subprocess.run(["git", "tag", "--list", "--sort=version:refname", "yocto-*"], capture_output=True, text=True).stdout +yocto_tags = sorted(yocto_tags.split() + missing_tags, key=tag_to_semver_like) +tags = [tag[6:] for tag in yocto_tags] + +with open('releases.rst', 'w') as f: + f.write('===========================\n') + f.write(' Supported Release Manuals\n') + f.write('===========================\n') + f.write('\n') + + for activerelease in activereleases: + title = "Release Series %s (%s)" % (release_series[activerelease], activerelease) + f.write('*' * len(title) + '\n') + f.write(title + '\n') + f.write('*' * len(title) + '\n') + f.write('\n') + + for tag in tags: + if tag == release_series[activerelease] or tag.startswith('%s.' % release_series[activerelease]): + f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag)) + f.write('\n') + + f.write('==========================\n') + f.write(' Outdated Release Manuals\n') + f.write('==========================\n') + f.write('\n') + + for series in release_series: + if series == devbranch or series in activereleases: + continue + + if series == "jethro-pre": + continue + + title = "Release Series %s (%s)" % (release_series[series], series) + f.write('*' * len(title) + '\n') + f.write(title + '\n') + f.write('*' * len(title) + '\n') + f.write('\n') + if series == "jethro": + f.write('- :yocto_docs:`1.9 Documentation </1.9>`\n') + for tag in tags: + if tag == release_series[series] or tag.startswith('%s.' % release_series[series]): + f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag)) + f.write('\n') diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js.in index 885104c407..8c016859bc 100644 --- a/documentation/sphinx-static/switchers.js +++ b/documentation/sphinx-static/switchers.js.in @@ -9,14 +9,12 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b (function() { 'use strict'; - var all_versions = { - 'dev': 'dev (3.5)', - '3.4.1': '3.4.1', - '3.3.4': '3.3.4', - '3.2.4': '3.2.4', - '3.1.13': '3.1.13', - '3.0.4': '3.0.4', - '2.7.4': '2.7.4', + var all_releases = + ALL_RELEASES_PLACEHOLDER + ; + + var switcher_versions = { + VERSIONS_PLACEHOLDER }; var all_doctypes = { @@ -71,18 +69,15 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b function build_version_select(current_series, current_version) { var buf = ['<select>']; - $.each(all_versions, function(version, title) { + $.each(switcher_versions, function(version, vers_data) { var series = version.substr(0, 3); if (series == current_series) { if (version == current_version) - buf.push('<option value="' + version + '" selected="selected">' + title + '</option>'); - else - buf.push('<option value="' + version + '">' + title + '</option>'); - - if (version != current_version) - buf.push('<option value="' + current_version + '" selected="selected">' + current_version + '</option>'); + buf.push('<option value="' + version + '" selected="selected">' + vers_data["title"] + '</option>'); + else + buf.push('<option value="' + version + '">' + vers_data["title"] + '</option>'); } else { - buf.push('<option value="' + version + '">' + title + '</option>'); + buf.push('<option value="' + version + '">' + vers_data["title"] + '</option>'); } }); @@ -158,14 +153,20 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b var docroot = get_docroot_url() var new_versionpath = selected_version + '/'; - if (selected_version == "dev") - new_versionpath = ''; - // dev versions have no version prefix - if (current_version == "dev") { + // latest tag is also the default page (without version information) + if (docroot.endsWith(current_version + '/') == false) { var new_url = docroot + new_versionpath + url.replace(docroot, ""); var fallback_url = docroot + new_versionpath; } else { + // check for named releases (e.g. dunfell) in the subpath + $.each(all_releases, function(idx, release) { + if (docroot.endsWith('/' + release + '/')) { + current_version = release; + return false; + } + }); + var new_url = url.replace('/' + current_version + '/', '/' + new_versionpath); var fallback_url = new_url.replace(url.replace(docroot, ""), ""); } @@ -228,15 +229,20 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b $('.doctype_switcher_placeholder').html(doctype_select); $('.doctype_switcher_placeholder select').bind('change', on_doctype_switch); - if (ver_compare(release, "3.1") < 0) { - $('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version'); - $('#outdated-warning').css('padding', '.5em'); - } else if (release != "dev") { - $.each(all_versions, function(version, title) { + if (release != "dev") { + $.each(switcher_versions, function(version, vers_data) { var series = version.substr(0, 3); - if (series == current_series && version != release) { - $('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.'); - $('#outdated-warning').css('padding', '.5em'); + if (series == current_series) { + if (version != release && release.endsWith('.999') == false) { + $('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.'); + $('#outdated-warning').css('padding', '.5em'); + return false; + } + if (vers_data["obsolete"]) { + $('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version'); + $('#outdated-warning').css('padding', '.5em'); + return false; + } } }); } diff --git a/documentation/sphinx/yocto-vars.py b/documentation/sphinx/yocto-vars.py index 8795eee0a0..643c0df904 100644 --- a/documentation/sphinx/yocto-vars.py +++ b/documentation/sphinx/yocto-vars.py @@ -13,7 +13,7 @@ try: import yaml except ImportError: sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ - \nPlease make sure to install pyyaml python package.\n") + \nPlease make sure to install pyyaml Python package.\n") sys.exit(1) __version__ = '1.0' diff --git a/documentation/standards.md b/documentation/standards.md index a2274f6d6e..bc403e393e 100644 --- a/documentation/standards.md +++ b/documentation/standards.md @@ -5,9 +5,109 @@ documentation is created. It is currently a work in progress. +## Automatic style validation + +There is an ongoing effort to automate style validation +through the [Vale](https://vale.sh/). To try it, run: + + $ make stylecheck + +Note that this just applies to text. Therefore, the syntax +conventions described below still apply. + +If you wish to add a new word to an "accept.txt" file +(./styles/config/vocabularies/<Vocab>/accept.txt), +make sure the spelling and capitalization matches +what Wikipedia or the project defining this word uses. + ## Text standards -This section has not been filled yet +### Bulleted lists + +Though Sphinx supports both the ``*`` and ``-`` characters +for introducing bulleted lists, we have chosen to use +only ``-`` for this purpose. + +Though not strictly required by Sphinx, we have also chosen +to use two space characters after ``-`` to introduce each +list item: + + - Paragraph 1 + + - Paragraph 2 + +As shown in the above example, there should also be an empty +line between each list item. + +An exception to this rule is when the list items are just made +of a few words, instead of entire paragraphs: + + - Item 1 + - Item 2 + +This is again a matter of style, not syntax. + +### Line wrapping + +Source code for the documentation shouldn't have lines +wider than 80 characters. This makes patch lines more +readable and code easier to quote in e-mail clients. + +If you have to include long commands or lines in configuration +files, provided the syntax makes this possible, split them +into multiple lines, using the ``\`` character. + +Here is an example: + + $ scripts/install-buildtools \ + --without-extended-buildtools \ + --base-url https://downloads.yoctoproject.org/releases/yocto \ + --release yocto-4.0.1 \ + --installer-version 4.0.1 + +Exceptions are granted for file contents whose lines +cannot be split without infringing syntactic rules +or reducing readability, as well as for command output +which should be kept unmodified. + +### File, tool and command names + +File, tool, command and package names should be double tick-quoted. +For example, ``` ``conf/local.conf`` ``` is preferred over +`"conf/local.conf"`. + +### Project names + +Project names should be introduced with single quotes, to have them rendered +with an italic font and make them easier to distinguish from command names +(double tick-quoted) and from regular English words. + +An exception is when project names appear in hyperlinks, as nested markup +is not supported by Sphinx yet. + +Project names should also be capitalized (or not) in the same way they are on +Wikipedia, or on their own project pages if they are not described on +Wikipedia. If a project name isn't capitalized, it should remain so even +at the beginning of a sentence. + +For example: + +* ``` `BitBake` ``` +* ``` `ftrace` ``` + +### Variables + +Every variable should be mentioned with: + + :term:`VARIABLE` + +This assumes that `VARIABLE` is described either +in the Yocto Project documentation variable index (`ref-manual/variables.rst`) +or in the BitBake User Manual +(`doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst`) + +If it is not described yet, the variable should be added to the +glossary before or in the same patch it is used, so that `:term:` can be used. ## ReStructured Text Syntax standards @@ -26,8 +126,14 @@ To include a screenshot in PNG format: .. image:: figures/user-configuration.png :align: center -Depending on the size of the image, you may also shrink it -to prevent it from filling the whole page width: +A diagram with many details usually needs to use +the whole page width to be readable on all media. +In this case, the `:align:` directive is unnecessary: + + :scale: 100% + +Conversely, you may also shrink some images to +to prevent them from filling the whole page width: :scale: 50% diff --git a/documentation/styles/config/vocabularies/OpenSource/accept.txt b/documentation/styles/config/vocabularies/OpenSource/accept.txt new file mode 100644 index 0000000000..e378fbf79b --- /dev/null +++ b/documentation/styles/config/vocabularies/OpenSource/accept.txt @@ -0,0 +1,20 @@ +autovivification +blkparse +blktrace +callee +debugfs +ftrace +KernelShark +Kprobe +LTTng +perf +profiler +subcommand +subnode +superset +Sysprof +systemd +toolchain +tracepoint +Uprobe +wget diff --git a/documentation/styles/config/vocabularies/Yocto/accept.txt b/documentation/styles/config/vocabularies/Yocto/accept.txt new file mode 100644 index 0000000000..ca622ba412 --- /dev/null +++ b/documentation/styles/config/vocabularies/Yocto/accept.txt @@ -0,0 +1,5 @@ +BitBake +BSP +crosstap +OpenEmbedded +Yocto diff --git a/documentation/template/template.svg b/documentation/template/template.svg index 43043e3afb..50715c08b0 100644 --- a/documentation/template/template.svg +++ b/documentation/template/template.svg @@ -1019,7 +1019,7 @@ id="tspan1183-1-8" x="-52.348656" y="518.42615" - style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.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;stroke:none">Objets</tspan></text> + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:37.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;stroke:none">Objects</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" diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 4a3a97e29a..c31fd11c7a 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -14,15 +14,13 @@ release works as intended. All the project's testing infrastructure and processes are publicly visible and available so that the community can see what testing is being performed, how it's being done and the current status of the tests and the project at any given time. It is intended -that Other organizations can leverage off the process and testing +that other organizations can leverage off the process and testing environment used by the Yocto Project to create their own automated, production test environment, building upon the foundations from the project core. -Currently, the Yocto Project Test Environment Manual has no projected -release date. This manual is a work-in-progress and is being initially -loaded with information from the README files and notes from key -engineers: +This manual is a work-in-progress and is being initially loaded with +information from the README files and notes from key engineers: - *yocto-autobuilder2:* This :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` @@ -39,7 +37,7 @@ engineers: As a result, it can be used by any Continuous Improvement (CI) system to run builds, support getting the correct code revisions, configure builds and layers, run builds, and collect results. The code is - independent of any CI system, which means the code can work `Buildbot <https://docs.buildbot.net/0.9.15.post1/>`__, + independent of any CI system, which means the code can work `Buildbot <https://docs.buildbot.net/current/>`__, Jenkins, or others. This repository has a branch per release of the project defining the tests to run on a per release basis. @@ -54,8 +52,8 @@ the Autobuilder tests if things work. The Autobuilder builds all test targets and runs all the tests. The Yocto Project uses now uses standard upstream -`Buildbot <https://docs.buildbot.net/0.9.15.post1/>`__ (version 9) to -drive its integration and testing. Buildbot Nine has a plug-in interface +Buildbot (`version 3.8 <https://docs.buildbot.net/3.8.0/>`__) to +drive its integration and testing. Buildbot has a plug-in interface that the Yocto Project customizes using code from the ``yocto-autobuilder2`` repository, adding its own console UI plugin. The resulting UI plug-in allows you to visualize builds in a way suited to @@ -72,10 +70,9 @@ simple JSON files. .. note:: The project uses Buildbot for historical reasons but also because - many of the project developers have knowledge of python. It is + many of the project developers have knowledge of Python. It is possible to use the outer layers from another Continuous Integration - (CI) system such as - `Jenkins <https://en.wikipedia.org/wiki/Jenkins_(software)>`__ + (CI) system such as :wikipedia:`Jenkins <Jenkins_(software)>` instead of Buildbot. The following figure shows the Yocto Project Autobuilder stack with a @@ -83,9 +80,10 @@ topology that includes a controller and a cluster of workers: .. image:: figures/ab-test-cluster.png :align: center + :width: 70% -Yocto Project Tests - Types of Testing Overview -=============================================== +Yocto Project Tests --- Types of Testing Overview +================================================= The Autobuilder tests different elements of the project by using the following types of tests: @@ -93,19 +91,18 @@ the following types of tests: - *Build Testing:* Tests whether specific configurations build by varying :term:`MACHINE`, :term:`DISTRO`, other configuration - options, and the specific target images being built (or world). Used - to trigger builds of all the different test configurations on the + options, and the specific target images being built (or ``world``). This is + used to trigger builds of all the different test configurations on the Autobuilder. Builds usually cover many different targets for different architectures, machines, and distributions, as well as different configurations, such as different init systems. The Autobuilder tests literally hundreds of configurations and targets. - - *Sanity Checks During the Build Process:* Tests initiated through - the :ref:`insane <ref-classes-insane>` - class. These checks ensure the output of the builds are correct. - For example, does the ELF architecture in the generated binaries - match the target system? ARM binaries would not work in a MIPS - system! + - *Sanity Checks During the Build Process:* Tests initiated through the + :ref:`ref-classes-insane` class. These checks ensure the output of the + builds are correct. For example, does the ELF architecture in the + generated binaries match the target system? ARM binaries would not work + in a MIPS system! - *Build Performance Testing:* Tests whether or not commonly used steps during builds work efficiently and avoid regressions. Tests to time @@ -121,7 +118,8 @@ the following types of tests: $ bitbake image -c testsdkext - The tests utilize the :ref:`testsdkext <ref-classes-testsdk>` class and the ``do_testsdkext`` task. + The tests use the :ref:`ref-classes-testsdk` class and the + ``do_testsdkext`` task. - *Feature Testing:* Various scenario-based tests are run through the :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distributions @@ -131,8 +129,8 @@ the following types of tests: $ bitbake image -c testimage - The tests utilize the :ref:`testimage* <ref-classes-testimage*>` - classes and the :ref:`ref-tasks-testimage` task. + The tests use the :ref:`ref-classes-testimage` + class and the :ref:`ref-tasks-testimage` task. - *Layer Testing:* The Autobuilder has the possibility to test whether specific layers work with the test of the system. The layers tested @@ -142,7 +140,7 @@ the following types of tests: - *Package Testing:* A Package Test (ptest) runs tests against packages built by the OpenEmbedded build system on the target machine. See the :ref:`Testing Packages With - ptest <dev-manual/common-tasks:Testing Packages With ptest>` section + ptest <dev-manual/packages:Testing Packages With ptest>` section in the Yocto Project Development Tasks Manual and the ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more information on Ptest. @@ -151,7 +149,7 @@ the following types of tests: $ bitbake image -c testsdk - The tests utilize the :ref:`testsdk <ref-classes-testsdk>` class and + The tests use the :ref:`ref-classes-testsdk` class and the ``do_testsdk`` task. - *Unit Testing:* Unit tests on various components of the system run @@ -174,48 +172,55 @@ Tests map into the codebase as follows: which include the fetchers. The tests are located in ``bitbake/lib/*/tests``. + Some of these tests run the ``bitbake`` command, so ``bitbake/bin`` + must be added to the ``PATH`` before running ``bitbake-selftest``. From within the BitBake repository, run the following:: - $ bitbake-selftest + $ export PATH=$PWD/bin:$PATH - To skip tests that access the Internet, use the ``BB_SKIP_NETTEST`` - variable when running "bitbake-selftest" as follows:: + After that, you can run the selftest script:: - $ BB_SKIP_NETTEST=yes bitbake-selftest + $ bitbake-selftest The default output is quiet and just prints a summary of what was run. To see more information, there is a verbose option:: $ bitbake-selftest -v + To skip tests that access the Internet, use the ``BB_SKIP_NETTESTS`` + variable when running ``bitbake-selftest`` as follows:: + + $ BB_SKIP_NETTESTS=yes bitbake-selftest + Use this option when you wish to skip tests that access the network, which are mostly necessary to test the fetcher modules. To specify individual test modules to run, append the test module name to the - "bitbake-selftest" command. For example, to specify the tests for the - bb.data.module, run:: + ``bitbake-selftest`` command. For example, to specify the tests for + ``bb.tests.data.DataExpansions``, run:: - $ bitbake-selftest bb.test.data.module + $ bitbake-selftest bb.tests.data.DataExpansions You can also specify individual tests by defining the full name and module plus the class path of the test, for example:: - $ bitbake-selftest bb.tests.data.TestOverrides.test_one_override + $ bitbake-selftest bb.tests.data.DataExpansions.test_one_var - The tests are based on `Python - unittest <https://docs.python.org/3/library/unittest.html>`__. + The tests are based on + `Python unittest <https://docs.python.org/3/library/unittest.html>`__. - *oe-selftest:* - These tests use OE to test the workflows, which include testing specific features, behaviors of tasks, and API unit tests. - - The tests can take advantage of parallelism through the "-j" + - The tests can take advantage of parallelism through the ``-j`` option, which can specify a number of threads to spread the tests across. Note that all tests from a given class of tests will run in the same thread. To parallelize large numbers of tests you can split the class into multiple units. - - The tests are based on Python unittest. + - The tests are based on + `Python unittest <https://docs.python.org/3/library/unittest.html>`__. - The code for the tests resides in ``meta/lib/oeqa/selftest/cases/``. @@ -225,18 +230,18 @@ Tests map into the codebase as follows: $ oe-selftest -a - To run a specific test, use the following command form where - testname is the name of the specific test:: + ``testname`` is the name of the specific test:: $ oe-selftest -r <testname> - For example, the following command would run the tinfoil - getVar API test:: + For example, the following command would run the ``tinfoil`` + ``getVar`` API test:: $ oe-selftest -r tinfoil.TinfoilTests.test_getvar It is also possible to run a set of tests. For example the following command will run all of the - tinfoil tests:: + ``tinfoil`` tests:: $ oe-selftest -r tinfoil @@ -271,7 +276,7 @@ Tests map into the codebase as follows: - These tests build an extended SDK (eSDK), install that eSDK, and run tests against the eSDK. - - The code for these tests resides in ``meta/lib/oeqa/esdk``. + - The code for these tests resides in ``meta/lib/oeqa/sdkext/cases/``. - To run the tests, use the following command form:: @@ -298,13 +303,13 @@ Tests map into the codebase as follows: Git repository. Use the ``oe-build-perf-report`` command to generate text reports - and HTML reports with graphs of the performance data. For - examples, see - :yocto_dl:`/releases/yocto/yocto-2.7/testresults/buildperf-centos7/perf-centos7.yoctoproject.org_warrior_20190414204758_0e39202.html` + and HTML reports with graphs of the performance data. See + :yocto_dl:`html </releases/yocto/yocto-4.3/testresults/buildperf-debian11/perf-debian11_nanbield_20231019191258_15b576c410.html>` and - :yocto_dl:`/releases/yocto/yocto-2.7/testresults/buildperf-centos7/perf-centos7.yoctoproject.org_warrior_20190414204758_0e39202.txt`. + :yocto_dl:`txt </releases/yocto/yocto-4.3/testresults/buildperf-debian11/perf-debian11_nanbield_20231019191258_15b576c410.txt>` + examples. - - The tests are contained in ``lib/oeqa/buildperf/test_basic.py``. + - The tests are contained in ``meta/lib/oeqa/buildperf/test_basic.py``. Test Examples ============= @@ -312,16 +317,14 @@ Test Examples This section provides example tests for each of the tests listed in the :ref:`test-manual/intro:How Tests Map to Areas of Code` section. -For oeqa tests, testcases for each area reside in the main test -directory at ``meta/lib/oeqa/selftest/cases`` directory. +- ``oe-selftest`` testcases reside in the ``meta/lib/oeqa/selftest/cases`` directory. -For oe-selftest. bitbake testcases reside in the ``lib/bb/tests/`` -directory. +- ``bitbake-selftest`` testcases reside in the ``bitbake/lib/bb/tests/`` directory. ``bitbake-selftest`` -------------------- -A simple test example from ``lib/bb/tests/data.py`` is:: +A simple test example from ``bitbake/lib/bb/tests/data.py`` is:: class DataExpansions(unittest.TestCase): def setUp(self): @@ -334,21 +337,24 @@ A simple test example from ``lib/bb/tests/data.py`` is:: val = self.d.expand("${foo}") self.assertEqual(str(val), "value_of_foo") -In this example, a ``DataExpansions`` class of tests is created, -derived from standard python unittest. The class has a common ``setUp`` -function which is shared by all the tests in the class. A simple test is -then added to test that when a variable is expanded, the correct value -is found. +In this example, a ``DataExpansions`` class of tests is created, derived from +standard `Python unittest <https://docs.python.org/3/library/unittest.html>`__. +The class has a common ``setUp`` function which is shared by all the tests in +the class. A simple test is then added to test that when a variable is +expanded, the correct value is found. -Bitbake selftests are straightforward python unittest. Refer to the -Python unittest documentation for additional information on writing -these tests at: https://docs.python.org/3/library/unittest.html. +BitBake selftests are straightforward +`Python unittest <https://docs.python.org/3/library/unittest.html>`__. +Refer to the `Python unittest documentation +<https://docs.python.org/3/library/unittest.html>`__ for additional information +on writing such tests. ``oe-selftest`` --------------- These tests are more complex due to the setup required behind the scenes -for full builds. Rather than directly using Python's unittest, the code +for full builds. Rather than directly using `Python unittest +<https://docs.python.org/3/library/unittest.html>`__, the code wraps most of the standard objects. The tests can be simple, such as testing a command from within the OE build environment using the following example:: @@ -385,14 +391,14 @@ so tests within a given test class should always run in the same build, while tests in different classes or modules may be split into different builds. There is no data store available for these tests since the tests launch the ``bitbake`` command and exist outside of its context. As a -result, common bitbake library functions (bb.\*) are also unavailable. +result, common BitBake library functions (``bb.\*``) are also unavailable. ``testimage`` ------------- These tests are run once an image is up and running, either on target hardware or under QEMU. As a result, they are assumed to be running in a -target image environment, as opposed to a host build environment. A +target image environment, as opposed to in a host build environment. A simple example from ``meta/lib/oeqa/runtime/cases/python.py`` contains the following:: @@ -407,19 +413,19 @@ the following:: In this example, the ``OERuntimeTestCase`` class wraps ``unittest.TestCase``. Within the test, ``self.target`` represents the -target system, where commands can be run on it using the ``run()`` +target system, where commands can be run using the ``run()`` method. -To ensure certain test or package dependencies are met, you can use the +To ensure certain tests or package dependencies are met, you can use the ``OETestDepends`` and ``OEHasPackage`` decorators. For example, the test -in this example would only make sense if python3-core is installed in +in this example would only make sense if ``python3-core`` is installed in the image. ``testsdk_ext`` --------------- These tests are run against built extensible SDKs (eSDKs). The tests can -assume that the eSDK environment has already been setup. An example from +assume that the eSDK environment has already been set up. An example from ``meta/lib/oeqa/sdk/cases/devtool.py`` contains the following:: class DevtoolTest(OESDKExtTestCase): @@ -466,9 +472,9 @@ following:: output = self._run(cmd) self.assertEqual(output, "Hello, world\n") -In this example, if nativesdk-python3-core has been installed into the SDK, the code runs -the python3 interpreter with a basic command to check it is working -correctly. The test would only run if python3 is installed in the SDK. +In this example, if ``nativesdk-python3-core`` has been installed into the SDK, +the code runs the ``python3`` interpreter with a basic command to check it is +working correctly. The test would only run if Python3 is installed in the SDK. ``oe-build-perf-test`` ---------------------- @@ -506,15 +512,15 @@ workers, consider the following: **Running "cleanall" is not permitted.** -This can delete files from DL_DIR which would potentially break other -builds running in parallel. If this is required, DL_DIR must be set to +This can delete files from :term:`DL_DIR` which would potentially break other +builds running in parallel. If this is required, :term:`DL_DIR` must be set to an isolated directory. **Running "cleansstate" is not permitted.** -This can delete files from SSTATE_DIR which would potentially break -other builds running in parallel. If this is required, SSTATE_DIR must -be set to an isolated directory. Alternatively, you can use the "-f" +This can delete files from :term:`SSTATE_DIR` which would potentially break +other builds running in parallel. If this is required, :term:`SSTATE_DIR` must +be set to an isolated directory. Alternatively, you can use the ``-f`` option with the ``bitbake`` command to "taint" tasks by changing the sstate checksums to ensure sstate cache items will not be reused. diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst index 5977366c9e..91f94a5c74 100644 --- a/documentation/test-manual/reproducible-builds.rst +++ b/documentation/test-manual/reproducible-builds.rst @@ -19,13 +19,13 @@ Why it matters ============== The project aligns with the `Reproducible Builds project -<https://reproducible-builds.org/>`_, which shares information about why +<https://reproducible-builds.org/>`__, which shares information about why reproducibility matters. The primary focus of the project is the ability to detect security issues being introduced. However, from a Yocto Project perspective, it is also hugely important that our builds are deterministic. When you build a given input set of metadata, we expect you to get consistent output. -This has always been a key focus but, :yocto_docs:`since release 3.1 ("dunfell") -</ref-manual/migration-3.1.html#reproducible-builds-now-enabled-by-default>`, +This has always been a key focus but, :ref:`since release 3.1 ("dunfell") +<migration-guides/migration-3.1:reproducible builds now enabled by default>`, it is now true down to the binary level including timestamps. For example, at some point in the future life of a product, you find that you @@ -68,17 +68,6 @@ things we do within the build system to ensure reproducibility include: - Filtering the tools available from the host's ``PATH`` to only a specific set of tools, set using the :term:`HOSTTOOLS` variable. -.. note:: - - Because of an open bug in GCC, using ``DISTRO_FEATURES:append = " lto"`` or - adding ``-flto`` (Link Time Optimization) to ``CFLAGS`` makes the resulting - binary non-reproducible, in that it depends on the full absolute build path - to ``recipe-sysroot-native``, so installing the Yocto Project in a different - directory results in a different binary. - - This issue is addressed by - :yocto_bugs:`bug 14481 - Programs built with -flto are not reproducible</show_bug.cgi?id=14481>`. - ========================================= Can we prove the project is reproducible? ========================================= @@ -103,10 +92,12 @@ run:: oe-selftest -r reproducible.ReproducibleTests.test_reproducible_builds This defaults to including a ``world`` build so, if other layers are added, it would -also run the tests for recipes in the additional layers. The first build will be -run using :ref:`Shared State <overview-manual/concepts:Shared State>` if +also run the tests for recipes in the additional layers. Different build targets +can be defined using the :term:`OEQA_REPRODUCIBLE_TEST_TARGET` variable in ``local.conf``. +The first build will be run using :ref:`Shared State <overview-manual/concepts:Shared State>` if available, the second build explicitly disables -:ref:`Shared State <overview-manual/concepts:Shared State>` and builds on the +:ref:`Shared State <overview-manual/concepts:Shared State>` except for recipes defined in +the :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS` variable, and builds on the specific host the build is running on. This means we can test reproducibility builds between different host distributions over time on the Autobuilder. diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 4c3b32bfea..7bec5ba828 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst @@ -20,8 +20,8 @@ helps review and test patches and this is his testing tree). We have two broad categories of test builds, including "full" and "quick". On the Autobuilder, these can be seen as "a-quick" and "a-full", simply for ease of sorting in the UI. Use our Autobuilder -console view to see where me manage most test-related items, available -at: :yocto_ab:`/typhoon/#/console`. +:yocto_ab:`console view </typhoon/#/console>` to see where we manage most +test-related items. Builds are triggered manually when the test branches are ready. The builds are monitored by the SWAT team. For additional information, see @@ -34,24 +34,21 @@ which the result was required. The Autobuilder does build the ``master`` branch once daily for several reasons, in particular, to ensure the current ``master`` branch does -build, but also to keep ``yocto-testresults`` -(:yocto_git:`/yocto-testresults/`), -buildhistory -(:yocto_git:`/poky-buildhistory/`), and -our sstate up to date. On the weekend, there is a master-next build +build, but also to keep (:yocto_git:`yocto-testresults </yocto-testresults/>`), +(:yocto_git:`buildhistory </poky-buildhistory/>`), and +our sstate up to date. On the weekend, there is a ``master-next`` build instead to ensure the test results are updated for the less frequently run targets. -Performance builds (buildperf-\* targets in the console) are triggered +Performance builds (``buildperf-\*`` targets in the console) are triggered separately every six hours and automatically push their results to the -buildstats repository at: -:yocto_git:`/yocto-buildstats/`. +:yocto_git:`buildstats </yocto-buildstats/>` repository. -The 'quick' targets have been selected to be the ones which catch the -most failures or give the most valuable data. We run 'fast' ptests in +The "quick" targets have been selected to be the ones which catch the +most failures or give the most valuable data. We run "fast" ptests in this case for example but not the ones which take a long time. The quick -target doesn't include \*-lsb builds for all architectures, some world -builds and doesn't trigger performance tests or ltp testing. The full +target doesn't include ``\*-lsb`` builds for all architectures, some ``world`` +builds and doesn't trigger performance tests or ``ltp`` testing. The full build includes all these things and is slower but more comprehensive. Release Builds @@ -67,12 +64,12 @@ that in :ref:`test-manual/test-process:day to day development`, in that the a-full target of the Autobuilder is used but in addition the form is configured to generate and publish artifacts and the milestone number, version, release candidate number and other information is entered. The -box to "generate an email to QA"is also checked. +box to "generate an email to QA" is also checked. -When the build completes, an email is sent out using the send-qa-email -script in the ``yocto-autobuilder-helper`` repository to the list of -people configured for that release. Release builds are placed into a -directory in https://autobuilder.yocto.io/pub/releases on the +When the build completes, an email is sent out using the ``send-qa-email`` +script in the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` +repository to the list of people configured for that release. Release builds +are placed into a directory in https://autobuilder.yocto.io/pub/releases on the Autobuilder which is included in the email. The process from here is more manual and control is effectively passed to release engineering. The next steps include: @@ -80,14 +77,15 @@ The next steps include: - QA teams respond to the email saying which tests they plan to run and when the results will be available. -- QA teams run their tests and share their results in the yocto- - testresults-contrib repository, along with a summary of their - findings. +- QA teams run their tests and share their results in the + :yocto_git:`yocto-testresults-contrib </yocto-testresults-contrib>` + repository, along with a summary of their findings. - Release engineering prepare the release as per their process. - Test results from the QA teams are included into the release in - separate directories and also uploaded to the yocto-testresults + separate directories and also uploaded to the + :yocto_git:`yocto-testresults </yocto-testresults>` repository alongside the other test results for the given revision. - The QA report in the final release is regenerated using resulttool to diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index b6809ce7bd..6b4fab4f0b 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst @@ -9,8 +9,8 @@ Execution Flow within the Autobuilder The "a-full" and "a-quick" targets are the usual entry points into the Autobuilder and it makes sense to follow the process through the system -starting there. This is best visualized from the Autobuilder Console -view (:yocto_ab:`/typhoon/#/console`). +starting there. This is best visualized from the :yocto_ab:`Autobuilder +Console view </typhoon/#/console>`. Each item along the top of that view represents some "target build" and these targets are all run in parallel. The 'full' build will trigger the @@ -18,9 +18,9 @@ majority of them, the "quick" build will trigger some subset of them. The Autobuilder effectively runs whichever configuration is defined for each of those targets on a separate buildbot worker. To understand the configuration, you need to look at the entry on ``config.json`` file -within the ``yocto-autobuilder-helper`` repository. The targets are -defined in the ‘overrides' section, a quick example could be qemux86-64 -which looks like:: +within the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` +repository. The targets are defined in the ``overrides`` section, a quick +example could be ``qemux86-64`` which looks like:: "qemux86-64" : { "MACHINE" : "qemux86-64", @@ -32,8 +32,8 @@ which looks like:: } }, -And to expand that, you need the "arch-qemu" entry from -the "templates" section, which looks like:: +And to expand that, you need the ``arch-qemu`` entry from +the ``templates`` section, which looks like:: "arch-qemu" : { "BUILDINFO" : true, @@ -54,11 +54,11 @@ the "templates" section, which looks like:: } }, -Combining these two entries you can see that "qemux86-64" is a three step build where the -``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` for each step; all for -``MACHINE="qemx86-64"`` but with differing SDKMACHINE settings. In step -1 an extra variable is added to the ``auto.conf`` file to enable wic -image generation. +Combining these two entries you can see that ``qemux86-64`` is a three step +build where ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` +for each step; all for ``MACHINE="qemux86-64"`` but with differing +:term:`SDKMACHINE` settings. In step 1, an extra variable is added to the +``auto.conf`` file to enable wic image generation. While not every detail of this is covered here, you can see how the template mechanism allows quite complex configurations to be built up @@ -88,9 +88,9 @@ roughly consist of: #. *Obtain yocto-autobuilder-helper* - This step clones the ``yocto-autobuilder-helper`` git repository. - This is necessary to prevent the requirement to maintain all the - release or project-specific code within Buildbot. The branch chosen + This step clones the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` + git repository. This is necessary to avoid the requirement to maintain all + the release or project-specific code within Buildbot. The branch chosen matches the release being built so we can support older releases and still make changes in newer ones. @@ -163,16 +163,17 @@ Autobuilder Worker Janitor -------------------------- This is a process running on each Worker that performs two basic -operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and -maintenance of a cache of cloned repositories to improve the speed +operations, including background file deletion at IO idle (see +"Run clobberdir" in :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`) +and maintenance of a cache of cloned repositories to improve the speed the system can checkout repositories. Shared DL_DIR ------------- -The Workers are all connected over NFS which allows DL_DIR to be shared +The Workers are all connected over NFS which allows :term:`DL_DIR` to be shared between them. This reduces network accesses from the system and allows -the build to be sped up. Usage of the directory within the build system +the build to be sped up. The usage of the directory within the build system is designed to be able to be shared over NFS. Shared SSTATE_DIR @@ -180,8 +181,8 @@ Shared SSTATE_DIR The Workers are all connected over NFS which allows the ``sstate`` directory to be shared between them. This means once a Worker has built -an artifact, all the others can benefit from it. Usage of the directory -within the directory is designed for sharing over NFS. +an artifact, all the others can benefit from it. The usage of the directory +within the build system is designed for sharing over NFS. Resulttool ---------- @@ -192,7 +193,7 @@ in a given build and their status. Additional information, such as failure logs or the time taken to run the tests, may also be included. Resulttool is part of OpenEmbedded-Core and is used to manipulate these -json results files. It has the ability to merge files together, display +JSON results files. It has the ability to merge files together, display reports of the test results and compare different result files. For details, see :yocto_wiki:`/Resulttool`. @@ -204,9 +205,9 @@ The ``scripts/run-config`` execution is where most of the work within the Autobuilder happens. It runs through a number of steps; the first are general setup steps that are run once and include: -#. Set up any ``buildtools-tarball`` if configured. +#. Set up any :term:`buildtools` tarball if configured. -#. Call "buildhistory-init" if buildhistory is configured. +#. Call ``buildhistory-init`` if :ref:`ref-classes-buildhistory` is configured. For each step that is configured in ``config.json``, it will perform the following: @@ -242,7 +243,7 @@ of post-build steps, including: #. Call ``scripts/upload-error-reports`` to send any error reports generated to the remote server. -#. Cleanup the build directory using +#. Cleanup the :term:`Build Directory` using :ref:`test-manual/understand-autobuilder:clobberdir` if the build was successful, else rename it to "build-renamed" for potential future debugging. @@ -250,15 +251,16 @@ Deploying Yocto Autobuilder =========================== The most up to date information about how to setup and deploy your own -Autobuilder can be found in README.md in the ``yocto-autobuilder2`` -repository. +Autobuilder can be found in :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` +in the :yocto_git:`yocto-autobuilder2 </yocto-autobuilder2>` repository. -We hope that people can use the ``yocto-autobuilder2`` code directly but -it is inevitable that users will end up needing to heavily customise the -``yocto-autobuilder-helper`` repository, particularly the -``config.json`` file as they will want to define their own test matrix. +We hope that people can use the :yocto_git:`yocto-autobuilder2 </yocto-autobuilder2>` +code directly but it is inevitable that users will end up needing to heavily +customize the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` +repository, particularly the ``config.json`` file as they will want to define +their own test matrix. -The Autobuilder supports wo customization options: +The Autobuilder supports two customization options: - variable substitution @@ -278,7 +280,7 @@ environment:: $ ABHELPER_JSON="config.json /some/location/local.json" One issue users often run into is validation of the ``config.json`` files. A -tip for minimizing issues from invalid json files is to use a Git +tip for minimizing issues from invalid JSON files is to use a Git ``pre-commit-hook.sh`` script to verify the JSON file before committing it. Create a symbolic link as follows:: diff --git a/documentation/test-manual/yocto-project-compatible.rst b/documentation/test-manual/yocto-project-compatible.rst index 96c12ac083..65d924fad9 100644 --- a/documentation/test-manual/yocto-project-compatible.rst +++ b/documentation/test-manual/yocto-project-compatible.rst @@ -27,7 +27,7 @@ In the second version of the program, a script was added to make validation easier and clearer, the script is called ``yocto-check-layer`` and is available in :term:`OpenEmbedded-Core (OE-Core)`. -See :ref:`dev-manual/common-tasks:making sure your layer is compatible with yocto project` +See :ref:`dev-manual/layers:making sure your layer is compatible with yocto project` for details. ======== diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst index 57e5b2bb7b..046ff88ce8 100644 --- a/documentation/toaster-manual/intro.rst +++ b/documentation/toaster-manual/intro.rst @@ -76,9 +76,8 @@ extensive information about the build process. - See performance information such as build time, task time, CPU usage, and disk I/O. -For an overview of Toaster shipped with the Yocto Project &DISTRO; -Release, see the "`Toaster - Yocto Project -2.2 <https://youtu.be/BlXdOYLgPxA>`__" video. +For an overview of Toaster, see this +`introduction video <https://youtu.be/BlXdOYLgPxA>`__. Installation Options ==================== @@ -92,6 +91,7 @@ suited for a single user developing on a single build host. .. image:: figures/simple-configuration.png :align: center + :width: 70% Toaster as a hosted service is suited for multiple users developing across several build hosts. When Toaster is set up as a hosted service, @@ -99,3 +99,4 @@ its components can be spread across several machines: .. image:: figures/hosted-service.png :align: center + :width: 50% diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index 1bb9f98cca..755b895cee 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst @@ -28,8 +28,7 @@ at :oe_layerindex:`/`. You can find the code for this layer index's web application at :yocto_git:`/layerindex-web/`. When you tie a layer source into Toaster, it can query the layer source -through a -`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ +through a :wikipedia:`REST <Representational_state_transfer>` API, store the information about the layers in the Toaster database, and then show the information to users. Users are then able to view that information and build layers from Toaster itself without having to @@ -66,7 +65,7 @@ layers. For general information on layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" section in the Yocto Project Overview and Concepts Manual. For information on how -to create layers, see the ":ref:`dev-manual/common-tasks:understanding and creating layers`" +to create layers, see the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. Configuring Toaster to Hook Into Your Layer Index @@ -189,17 +188,17 @@ The ``bldcontrol/management/commands/checksettings.py`` file controls workflow configuration. Here is the process to initially populate this database. -1. The default project settings are set from +#. The default project settings are set from ``orm/fixtures/settings.xml``. -2. The default project distro and layers are added from +#. The default project distro and layers are added from ``orm/fixtures/poky.xml`` if poky is installed. If poky is not installed, they are added from ``orm/fixtures/oe-core.xml``. -3. If the ``orm/fixtures/custom.xml`` file exists, then its values are +#. If the ``orm/fixtures/custom.xml`` file exists, then its values are added. -4. The layer index is then scanned and added to the database. +#. The layer index is then scanned and added to the database. Once these steps complete, Toaster is set up and ready to use. @@ -369,8 +368,8 @@ Remote Toaster Monitoring Toaster has an API that allows remote management applications to directly query the state of the Toaster server and its builds in a machine-to-machine manner. This API uses the -`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ -interface and the transfer of JSON files. For example, you might monitor +:wikipedia:`REST <Representational_state_transfer>` interface and the +transfer of JSON files. For example, you might monitor a build inside a container through well supported known HTTP ports in order to easily access a Toaster server inside the container. In this example, when you use this direct JSON API, you avoid having web page @@ -522,14 +521,13 @@ tasks. You can locate these commands in the - When using ``manage.py`` commands given a default configuration, you must be sure that your working directory is set to the - :term:`Build Directory`. Using - ``manage.py`` commands from the Build Directory allows Toaster to - find the ``toaster.sqlite`` file, which is located in the Build - Directory. + :term:`Build Directory`. Using ``manage.py`` commands from the + :term:`Build Directory` allows Toaster to find the ``toaster.sqlite`` + file, which is located in the :term:`Build Directory`. - For non-default database configurations, it is possible that you can use ``manage.py`` commands from a directory other than the - Build Directory. To do so, the ``toastermain/settings.py`` file + :term:`Build Directory`. To do so, the ``toastermain/settings.py`` file must be configured to point to the correct database backend. ``buildslist`` @@ -549,7 +547,7 @@ database. You need to run the ``buildslist`` command first to identify existing builds in the database before using the :ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an -example that assumes default repository and build directory names: +example that assumes default repository and :term:`Build Directory` names: .. code-block:: shell diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index 0da8326926..a0c27499ba 100644 --- a/documentation/toaster-manual/setup-and-use.rst +++ b/documentation/toaster-manual/setup-and-use.rst @@ -23,8 +23,8 @@ Once in that directory, source the build environment script:: $ source oe-init-build-env -Next, from the build directory (e.g. -``poky/build``), start Toaster using this command:: +Next, from the :term:`Build Directory` (e.g. ``poky/build``), start Toaster +using this command:: $ source toaster start @@ -124,14 +124,14 @@ causes Toaster to create and use ``$TOASTER_DIR./_toaster_clones``. The Build Directory =================== -Toaster creates a build directory within your Source Directory (e.g. +Toaster creates a :term:`Build Directory` within your Source Directory (e.g. ``poky``) to execute the builds. Alternatively, if you would like all of your Toaster related files and directories to be in a particular location, you can set the ``TOASTER_DIR`` environment variable, which takes precedence over your current working directory. Setting this environment variable causes -Toaster to use ``$TOASTER_DIR/build`` as the build directory. +Toaster to use ``$TOASTER_DIR/build`` as the :term:`Build Directory`. Creating a Django Superuser =========================== @@ -152,8 +152,8 @@ superuser by following these steps: $ export PATH=$PATH:$HOME/.local/bin #. From the directory containing the Toaster database, which by default - is the :term:`Build Directory`, - invoke the ``createsuperuser`` command from ``manage.py``:: + is the :term:`Build Directory`, invoke the ``createsuperuser`` command from + ``manage.py``:: $ cd poky/build $ ../bitbake/lib/toaster/manage.py createsuperuser @@ -179,7 +179,7 @@ example, if you are running Toaster locally, use the following URL:: http://127.0.0.1:8000/admin You can use the Django administration interface to set Toaster configuration -parameters such as the build directory, layer sources, default variable +parameters such as the :term:`Build Directory`, layer sources, default variable values, and BitBake versions. Setting Up a Production Instance of Toaster @@ -239,7 +239,7 @@ Perform the following steps to install Toaster: $ git clone git://git.yoctoproject.org/poky $ git checkout &DISTRO_NAME_NO_CAP; -#. Install Toaster dependencies using the --user flag which keeps the +#. Install Toaster dependencies using the ``--user`` flag which keeps the Python packages isolated from your system-provided packages:: $ cd /var/www/toaster/ @@ -311,14 +311,13 @@ Perform the following steps to install Toaster: migrations). The next line sets the Toaster root directory ``TOASTER_DIR`` and the location of the Toaster configuration file ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The - ``TEMPLATECONF`` value reflects the contents of + :term:`TEMPLATECONF` value reflects the contents of ``poky/.templateconf``, and by default, should include the string "poky". For more information on the Toaster configuration file, see the ":ref:`toaster-manual/reference:Configuring Toaster`" section. This line also runs the ``checksettings`` command, which configures - the location of the Toaster :term:`Build Directory`. - The Toaster + the location of the Toaster :term:`Build Directory`. The Toaster root directory ``TOASTER_DIR`` determines where the Toaster build directory is created on the file system. In the example above, ``TOASTER_DIR`` is set as follows:: @@ -326,7 +325,7 @@ Perform the following steps to install Toaster: /var/www/toaster/poky - This setting causes the Toaster build directory to be:: + This setting causes the Toaster :term:`Build Directory` to be:: /var/www/toaster/poky/build @@ -366,7 +365,7 @@ Perform the following steps to install Toaster: /etc/apache2/conf.d/toaster.conf - Following is a sample Apache configuration for Toaster you can follow: + Here is a sample Apache configuration for Toaster you can follow: .. code-block:: apache @@ -496,7 +495,7 @@ The Toaster web interface allows you to do the following: Toaster Web Interface Videos ---------------------------- -Following are several videos that show how to use the Toaster GUI: +Here are several videos that show how to use the Toaster GUI: - *Build Configuration:* This `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and diff --git a/documentation/toaster-manual/start.rst b/documentation/toaster-manual/start.rst index cab5d1f673..2d6474852a 100644 --- a/documentation/toaster-manual/start.rst +++ b/documentation/toaster-manual/start.rst @@ -40,7 +40,7 @@ command:: $ pip3 install --user -r bitbake/toaster-requirements.txt The previous command installs the necessary Toaster modules into a local -python 3 cache in your ``$HOME`` directory. The caches is actually +Python 3 cache in your ``$HOME`` directory. The caches is actually located in ``$HOME/.local``. To see what packages have been installed into your ``$HOME`` directory, do the following:: diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst index f0035bd3af..6ff55e5619 100644 --- a/documentation/transitioning-to-a-custom-environment.rst +++ b/documentation/transitioning-to-a-custom-environment.rst @@ -28,9 +28,9 @@ Transitioning to a custom environment for systems development for you to get comfortable with project concepts. #. **Find and acquire the best BSP for your target**. - Use the :yocto_home:`Yocto Project curated layer index + Use the :yocto_home:`Yocto Project Compatible Layers </software-overview/layers/>` or even the :oe_layerindex:`OpenEmbedded - layer index <>` to find and acquire the best BSP for your + Layer Index <>` to find and acquire the best BSP for your target board. The Yocto Project layer index BSPs are regularly validated. The best place to get your first BSP is from your silicon manufacturer or board vendor – they can point you to their most qualified efforts. In general, for @@ -42,7 +42,7 @@ Transitioning to a custom environment for systems development You might want to start with the build specification that Poky provides (which is reference embedded distribution) and then add your newly chosen layers to that. Here is the information :ref:`about adding layers - <dev-manual/common-tasks:Understanding and Creating Layers>`. + <dev-manual/layers:Understanding and Creating Layers>`. #. **Based on the layers you've chosen, make needed changes in your configuration**. @@ -58,7 +58,7 @@ Transitioning to a custom environment for systems development releases. If you are using a Yocto Project release earlier than 2.4, use the ``yocto-layer create`` tool. The ``bitbake-layers`` tool also provides a number of other useful layer-related commands. See - :ref:`dev-manual/common-tasks:creating a general layer using the + :ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script` section. #. **Create your own layer for the BSP you're going to use**. @@ -79,12 +79,12 @@ Transitioning to a custom environment for systems development process of refinement. Start by getting each step of the build process working beginning with fetching all the way through packaging. Next, run the software on your target and refine further as needed. See :ref:`Writing a New - Recipe <dev-manual/common-tasks:writing a new recipe>` in the + Recipe <dev-manual/new-recipe:writing a new recipe>` in the Yocto Project Development Tasks Manual for more information. #. **Now you're ready to create an image recipe**. There are a number of ways to do this. However, it is strongly recommended - that you have your own image recipe - don't try appending to existing image + that you have your own image recipe --- don't try appending to existing image recipes. Recipes for images are trivial to create and you usually want to fully customize their contents. @@ -103,7 +103,7 @@ Transitioning to a custom environment for systems development needs to change for your distribution. If you find yourself adding a lot of configuration to your local.conf file aside from paths and other typical local settings, it's time to :ref:`consider creating your own distribution - <dev-manual/common-tasks:creating your own distribution>`. + <dev-manual/custom-distribution:creating your own distribution>`. You can add product specifications that can customize the distribution if needed in other layers. You can also add other functionality specific to the diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index dec5617173..5bc55804f6 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst @@ -29,8 +29,9 @@ contact us with other suggestions. #. **Get to know the layer index:** All layers can be found in the :oe_layerindex:`layer index <>`. Layers which have applied for Yocto Project Compatible status (structure continuity - assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index - </software-over/layer/>`. Generally check the Compatible layer index first, + assurance and testing) can be found in the :yocto_home:`Yocto Project + Compatible Layers </development/yocto-project-compatible-layers/>` page. + Generally check the Compatible layer index first, and if you don't find the necessary layer check the general layer index. The layer index is an original artifact from the Open Embedded Project. As such, that index doesn't have the curating and testing that the Yocto Project @@ -98,6 +99,7 @@ contact us with other suggestions. be going wrong. .. image:: figures/yp-how-it-works-new-diagram.png + :width: 100% #. **Know that you can generate a dependency graph and learn how to do it:** A dependency graph shows dependencies between recipes, tasks, and targets. @@ -131,7 +133,7 @@ contact us with other suggestions. say "bitbake foo" where "foo" is the name for a specific recipe. As you become more advanced using the Yocto Project, and if builds are failing, it can be useful to make sure the fetch itself works as desired. Here are some - valuable links: :ref:`dev-manual/common-tasks:Using a Development + valuable links: :ref:`dev-manual/development-shell:Using a Development Shell` for information on how to build and run a specific task using devshell. Also, the :ref:`SDK manual shows how to build out a specific recipe <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`. @@ -179,7 +181,7 @@ contact us with other suggestions. * understand devtool and how it simplifies your workflow * improve build speeds with shared downloads and shared state cache * generate and understand a dependency graph - * generate and understand bitbake environment + * generate and understand BitBake environment * build an Extensible SDK for applications development #. **Depending on what you primary interests are with the Yocto Project, you @@ -212,6 +214,13 @@ contact us with other suggestions. OpenEmbedded build system. If you are interested in using this type of interface to create images, see the :doc:`/toaster-manual/index`. + * **Discover the VSCode extension**: The `Yocto Project BitBake + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + extension for the Visual Studio Code IDE provides language features and + commands for working with the Yocto Project. If you are interested in using + this extension, visit its `marketplace page + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__. + * **Have Available the Yocto Project Reference Manual**: Unlike the rest of the Yocto Project manual set, this manual is comprised of material suited for reference rather than procedures. You can get build details, a closer |
