summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst15
-rw-r--r--documentation/bsp-guide/bsp.rst5
-rw-r--r--documentation/conf.py24
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst76
-rw-r--r--documentation/dev-manual/dev-manual-start.rst19
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst2
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst4
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst4
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst6
-rw-r--r--documentation/poky.yaml15
-rw-r--r--documentation/profile-manual/profile-manual-usage.rst11
-rw-r--r--documentation/ref-manual/migration-3.0.rst3
-rw-r--r--documentation/ref-manual/ref-classes.rst10
-rw-r--r--documentation/ref-manual/ref-features.rst2
-rw-r--r--documentation/ref-manual/ref-images.rst17
-rw-r--r--documentation/ref-manual/ref-release-process.rst2
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst41
-rw-r--r--documentation/ref-manual/ref-tasks.rst19
-rw-r--r--documentation/ref-manual/ref-variables.rst76
-rw-r--r--documentation/releases.rst94
-rw-r--r--documentation/sphinx-static/switchers.js7
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.rst4
22 files changed, 294 insertions, 162 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index c9622d3647..6a44511af2 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -222,19 +222,10 @@ an entire Linux distribution, including the toolchain, from source.
222 .. tip:: 222 .. tip::
223 223
224 You can significantly speed up your build and guard against fetcher 224 You can significantly speed up your build and guard against fetcher
225 failures by using mirrors. To use mirrors, add these lines to your 225 failures by using mirrors. To use mirrors, add this line to your
226 local.conf file in the Build directory: :: 226 ``local.conf`` file in the :term:`Build Directory`: ::
227 227
228 SSTATE_MIRRORS = "\ 228 SSTATE_MIRRORS ?= "file://.* https://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH"
229 file://.* http://sstate.yoctoproject.org/dev/PATH;downloadfilename=PATH \n \
230 file://.* http://sstate.yoctoproject.org/&YOCTO_DOC_VERSION_MINUS_ONE;/PATH;downloadfilename=PATH \n \
231 file://.* http://sstate.yoctoproject.org/&YOCTO_DOC_VERSION;/PATH;downloadfilename=PATH \n \
232 "
233
234
235 The previous examples showed how to add sstate paths for Yocto Project
236 &YOCTO_DOC_VERSION_MINUS_ONE;, &YOCTO_DOC_VERSION;, and a development
237 area. For a complete index of sstate locations, see http://sstate.yoctoproject.org/.
238 229
239#. **Start the Build:** Continue with the following command to build an OS 230#. **Start the Build:** Continue with the following command to build an OS
240 image for the target, which is ``core-image-sato`` in this example: 231 image for the target, which is ``core-image-sato`` in this example:
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index d0275eea9a..efb5328911 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -166,8 +166,9 @@ section.
166#. *Determine the BSP Layer You Want:* The Yocto Project supports many 166#. *Determine the BSP Layer You Want:* The Yocto Project supports many
167 BSPs, which are maintained in their own layers or in layers designed 167 BSPs, which are maintained in their own layers or in layers designed
168 to contain several BSPs. To get an idea of machine support through 168 to contain several BSPs. To get an idea of machine support through
169 BSP layers, you can look at the `index of 169 BSP layers, you can look at the
170 machines <&YOCTO_RELEASE_DL_URL;/machines>`__ for the release. 170 :yocto_dl:`index of machines </releases/yocto/&DISTRO_REL_TAG;/machines>`
171 for the release.
171 172
172#. *Optionally Clone the meta-intel BSP Layer:* If your hardware is 173#. *Optionally Clone the meta-intel BSP Layer:* If your hardware is
173 based on current Intel CPUs and devices, you can leverage this BSP 174 based on current Intel CPUs and devices, you can leverage this BSP
diff --git a/documentation/conf.py b/documentation/conf.py
index c2e9801fd9..e9078e054e 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -15,8 +15,27 @@
15import os 15import os
16import sys 16import sys
17import datetime 17import datetime
18try:
19 import yaml
20except ImportError:
21 sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
22 \nPlease make sure to install pyyaml python package.\n")
23 sys.exit(1)
18 24
19current_version = "3.1.6" 25# current_version = "dev"
26# bitbake_version = "" # Leave empty for development branch
27# Obtain versions from poky.yaml instead
28with open("poky.yaml") as data:
29 buff = data.read()
30 subst_vars = yaml.safe_load(buff)
31 if "DOCCONF_VERSION" not in subst_vars:
32 sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml")
33 sys.exit(1)
34 current_version = subst_vars["DOCCONF_VERSION"]
35 if "BITBAKE_SERIES" not in subst_vars:
36 sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml")
37 sys.exit(1)
38 bitbake_version = subst_vars["BITBAKE_SERIES"]
20 39
21# String used in sidebar 40# String used in sidebar
22version = 'Version: ' + current_version 41version = 'Version: ' + current_version
@@ -78,11 +97,12 @@ extlinks = {
78 'yocto_git': ('https://git.yoctoproject.org%s', None), 97 'yocto_git': ('https://git.yoctoproject.org%s', None),
79 'oe_home': ('https://www.openembedded.org%s', None), 98 'oe_home': ('https://www.openembedded.org%s', None),
80 'oe_lists': ('https://lists.openembedded.org%s', None), 99 'oe_lists': ('https://lists.openembedded.org%s', None),
100 'oe_git': ('https://git.openembedded.org%s', None),
81} 101}
82 102
83# Intersphinx config to use cross reference with Bitbake user manual 103# Intersphinx config to use cross reference with Bitbake user manual
84intersphinx_mapping = { 104intersphinx_mapping = {
85 'bitbake': ('https://docs.yoctoproject.org/bitbake/1.46', None) 105 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None)
86} 106}
87 107
88# -- Options for HTML output ------------------------------------------------- 108# -- Options for HTML output -------------------------------------------------
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index d401d3b4ee..d1dde6d0f3 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -2168,7 +2168,7 @@ recipe, but which one? You can configure your build to call out the
2168kernel recipe you want by using the 2168kernel recipe you want by using the
2169:term:`PREFERRED_PROVIDER` 2169:term:`PREFERRED_PROVIDER`
2170variable. As an example, consider the 2170variable. As an example, consider the
2171`x86-base.inc <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`_ 2171:yocto_git:`x86-base.inc </cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`
2172include file, which is a machine (i.e. 2172include file, which is a machine (i.e.
2173:term:`MACHINE`) configuration file. 2173:term:`MACHINE`) configuration file.
2174This include file is the reason all x86-based machines use the 2174This include file is the reason all x86-based machines use the
@@ -2628,7 +2628,7 @@ Recipe Syntax
2628Understanding recipe file syntax is important for writing recipes. The 2628Understanding recipe file syntax is important for writing recipes. The
2629following list overviews the basic items that make up a BitBake recipe 2629following list overviews the basic items that make up a BitBake recipe
2630file. For more complete BitBake syntax descriptions, see the 2630file. For more complete BitBake syntax descriptions, see the
2631":doc:`bitbake-user-manual/bitbake-user-manual-metadata`" 2631":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`"
2632chapter of the BitBake User Manual. 2632chapter of the BitBake User Manual.
2633 2633
2634- *Variable Assignments and Manipulations:* Variable assignments allow 2634- *Variable Assignments and Manipulations:* Variable assignments allow
@@ -3854,7 +3854,7 @@ Setting Up and Running a Multiple Configuration Build
3854 3854
3855To accomplish a multiple configuration build, you must define each 3855To accomplish a multiple configuration build, you must define each
3856target's configuration separately using a parallel configuration file in 3856target's configuration separately using a parallel configuration file in
3857the :term:`Build Directory`, and you 3857the :term:`Build Directory` or configuration directory within a layer, and you
3858must follow a required file hierarchy. Additionally, you must enable the 3858must follow a required file hierarchy. Additionally, you must enable the
3859multiple configuration builds in your ``local.conf`` file. 3859multiple configuration builds in your ``local.conf`` file.
3860 3860
@@ -3862,47 +3862,47 @@ Follow these steps to set up and execute multiple configuration builds:
3862 3862
3863- *Create Separate Configuration Files*: You need to create a single 3863- *Create Separate Configuration Files*: You need to create a single
3864 configuration file for each build target (each multiconfig). 3864 configuration file for each build target (each multiconfig).
3865 Minimally, each configuration file must define the machine and the 3865 The configuration definitions are implementation dependent but often
3866 temporary directory BitBake uses for the build. Suggested practice 3866 each configuration file will define the machine and the
3867 dictates that you do not overlap the temporary directories used 3867 temporary directory BitBake uses for the build. Whether the same
3868 during the builds. However, it is possible that you can share the 3868 temporary directory (:term:`TMPDIR`) can be shared will depend on what is
3869 temporary directory 3869 similar and what is different between the configurations. Multiple MACHINE
3870 (:term:`TMPDIR`). For example, 3870 targets can share the same (:term:`TMPDIR`) as long as the rest of the
3871 consider a scenario with two different multiconfigs for the same 3871 configuration is the same, multiple DISTRO settings would need separate
3872 (:term:`TMPDIR`) directories.
3873
3874 For example, consider a scenario with two different multiconfigs for the same
3872 :term:`MACHINE`: "qemux86" built 3875 :term:`MACHINE`: "qemux86" built
3873 for two distributions such as "poky" and "poky-lsb". In this case, 3876 for two distributions such as "poky" and "poky-lsb". In this case,
3874 you might want to use the same ``TMPDIR``. 3877 you would need to use the different :term:`TMPDIR`.
3875 3878
3876 Here is an example showing the minimal statements needed in a 3879 Here is an example showing the minimal statements needed in a
3877 configuration file for a "qemux86" target whose temporary build 3880 configuration file for a "qemux86" target whose temporary build
3878 directory is ``tmpmultix86``: 3881 directory is ``tmpmultix86``::
3879 ::
3880 3882
3881 MACHINE = "qemux86" 3883 MACHINE = "qemux86"
3882 TMPDIR = "${TOPDIR}/tmpmultix86" 3884 TMPDIR = "${TOPDIR}/tmpmultix86"
3883 3885
3884 The location for these multiconfig configuration files is specific. 3886 The location for these multiconfig configuration files is specific.
3885 They must reside in the current build directory in a sub-directory of 3887 They must reside in the current :term:`Build Directory` in a sub-directory of
3886 ``conf`` named ``multiconfig``. Following is an example that defines 3888 ``conf`` named ``multiconfig`` or within a layer's ``conf`` directory
3889 under a directory named ``multiconfig``. Following is an example that defines
3887 two configuration files for the "x86" and "arm" multiconfigs: 3890 two configuration files for the "x86" and "arm" multiconfigs:
3888 3891
3889 .. image:: figures/multiconfig_files.png 3892 .. image:: figures/multiconfig_files.png
3890 :align: center 3893 :align: center
3894 :width: 50%
3891 3895
3892 The reason for this required file hierarchy is because the ``BBPATH`` 3896 The usual :term:`BBPATH` search path is used to locate multiconfig files in
3893 variable is not constructed until the layers are parsed. 3897 a similar way to other conf files.
3894 Consequently, using the configuration file as a pre-configuration
3895 file is not possible unless it is located in the current working
3896 directory.
3897 3898
3898- *Add the BitBake Multi-configuration Variable to the Local 3899- *Add the BitBake Multi-configuration Variable to the Local
3899 Configuration File*: Use the 3900 Configuration File*: Use the
3900 :term:`BBMULTICONFIG` 3901 :term:`BBMULTICONFIG`
3901 variable in your ``conf/local.conf`` configuration file to specify 3902 variable in your ``conf/local.conf`` configuration file to specify
3902 each multiconfig. Continuing with the example from the previous 3903 each multiconfig. Continuing with the example from the previous
3903 figure, the ``BBMULTICONFIG`` variable needs to enable two 3904 figure, the :term:`BBMULTICONFIG` variable needs to enable two
3904 multiconfigs: "x86" and "arm" by specifying each configuration file: 3905 multiconfigs: "x86" and "arm" by specifying each configuration file::
3905 ::
3906 3906
3907 BBMULTICONFIG = "x86 arm" 3907 BBMULTICONFIG = "x86 arm"
3908 3908
@@ -3916,13 +3916,11 @@ Follow these steps to set up and execute multiple configuration builds:
3916 with "". 3916 with "".
3917 3917
3918- *Launch BitBake*: Use the following BitBake command form to launch 3918- *Launch BitBake*: Use the following BitBake command form to launch
3919 the multiple configuration build: 3919 the multiple configuration build::
3920 ::
3921 3920
3922 $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ] 3921 $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ]
3923 3922
3924 For the example in this section, the following command applies: 3923 For the example in this section, the following command applies::
3925 ::
3926 3924
3927 $ bitbake mc:x86:core-image-minimal mc:arm:core-image-sato mc::core-image-base 3925 $ bitbake mc:x86:core-image-minimal mc:arm:core-image-sato mc::core-image-base
3928 3926
@@ -3937,7 +3935,7 @@ Follow these steps to set up and execute multiple configuration builds:
3937 Support for multiple configuration builds in the Yocto Project &DISTRO; 3935 Support for multiple configuration builds in the Yocto Project &DISTRO;
3938 (&DISTRO_NAME;) Release does not include Shared State (sstate) 3936 (&DISTRO_NAME;) Release does not include Shared State (sstate)
3939 optimizations. Consequently, if a build uses the same object twice 3937 optimizations. Consequently, if a build uses the same object twice
3940 in, for example, two different ``TMPDIR`` 3938 in, for example, two different :term:`TMPDIR`
3941 directories, the build either loads from an existing sstate cache for 3939 directories, the build either loads from an existing sstate cache for
3942 that build at the start or builds the object fresh. 3940 that build at the start or builds the object fresh.
3943 3941
@@ -3958,38 +3956,34 @@ essentially that the
3958 3956
3959To enable dependencies in a multiple configuration build, you must 3957To enable dependencies in a multiple configuration build, you must
3960declare the dependencies in the recipe using the following statement 3958declare the dependencies in the recipe using the following statement
3961form: 3959form::
3962::
3963 3960
3964 task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend" 3961 task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend"
3965 3962
3966To better show how to use this statement, consider the example scenario 3963To better show how to use this statement, consider the example scenario
3967from the first paragraph of this section. The following statement needs 3964from the first paragraph of this section. The following statement needs
3968to be added to the recipe that builds the ``core-image-sato`` image: 3965to be added to the recipe that builds the ``core-image-sato`` image::
3969::
3970 3966
3971 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs" 3967 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs"
3972 3968
3973In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The 3969In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The
3974task on which the ``do_image`` task in the recipe depends is the 3970task on which the :ref:`ref-tasks-image` task in the recipe depends is the
3975``do_rootfs`` task from the ``core-image-minimal`` recipe associated 3971:ref:`ref-tasks-rootfs` task from the ``core-image-minimal`` recipe associated
3976with the "arm" multiconfig. 3972with the "arm" multiconfig.
3977 3973
3978Once you set up this dependency, you can build the "x86" multiconfig 3974Once you set up this dependency, you can build the "x86" multiconfig
3979using a BitBake command as follows: 3975using a BitBake command as follows::
3980::
3981 3976
3982 $ bitbake mc:x86:core-image-sato 3977 $ bitbake mc:x86:core-image-sato
3983 3978
3984This command executes all the tasks needed to create the 3979This command executes all the tasks needed to create the
3985``core-image-sato`` image for the "x86" multiconfig. Because of the 3980``core-image-sato`` image for the "x86" multiconfig. Because of the
3986dependency, BitBake also executes through the ``do_rootfs`` task for the 3981dependency, BitBake also executes through the :ref:`ref-tasks-rootfs` task for the
3987"arm" multiconfig build. 3982"arm" multiconfig build.
3988 3983
3989Having a recipe depend on the root filesystem of another build might not 3984Having a recipe depend on the root filesystem of another build might not
3990seem that useful. Consider this change to the statement in the 3985seem that useful. Consider this change to the statement in the
3991``core-image-sato`` recipe: 3986``core-image-sato`` recipe::
3992::
3993 3987
3994 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_image" 3988 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_image"
3995 3989
@@ -4967,7 +4961,7 @@ configuration would be as follows:
4967 require conf/multilib.conf 4961 require conf/multilib.conf
4968 MULTILIBS = "multilib:lib32" 4962 MULTILIBS = "multilib:lib32"
4969 DEFAULTTUNE_virtclass-multilib-lib32 = "x86" 4963 DEFAULTTUNE_virtclass-multilib-lib32 = "x86"
4970 IMAGE_INSTALL_append = "lib32-glib-2.0" 4964 IMAGE_INSTALL_append = " lib32-glib-2.0"
4971 4965
4972This example enables an additional library named 4966This example enables an additional library named
4973``lib32`` alongside the normal target packages. When combining these 4967``lib32`` alongside the normal target packages. When combining these
@@ -8658,6 +8652,8 @@ In order to run tests, you need to do the following:
8658 - Be sure to use an absolute path when calling this script 8652 - Be sure to use an absolute path when calling this script
8659 with sudo. 8653 with sudo.
8660 8654
8655 - Ensure that your host has the package ``iptables`` installed.
8656
8661 - The package recipe ``qemu-helper-native`` is required to run 8657 - The package recipe ``qemu-helper-native`` is required to run
8662 this script. Build the package using the following command: 8658 this script. Build the package using the following command:
8663 :: 8659 ::
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index a85b86fbfb..6a330d4a32 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -659,7 +659,7 @@ Follow these steps to locate and download a particular tarball:
659Using the Downloads Page 659Using the Downloads Page
660------------------------ 660------------------------
661 661
662The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page 662The :yocto_home:`Yocto Project Website <>` uses a "RELEASES" page
663from which you can locate and download tarballs of any Yocto Project 663from which you can locate and download tarballs of any Yocto Project
664release. Rather than Git repositories, these files represent snapshot 664release. Rather than Git repositories, these files represent snapshot
665tarballs similar to the tarballs located in the Index of Releases 665tarballs similar to the tarballs located in the Index of Releases
@@ -676,12 +676,13 @@ Releases <#accessing-index-of-releases>`__" section.
6761. *Go to the Yocto Project Website:* Open The 6761. *Go to the Yocto Project Website:* Open The
677 :yocto_home:`Yocto Project Website <>` in your browser. 677 :yocto_home:`Yocto Project Website <>` in your browser.
678 678
6792. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the 679#. *Get to the Downloads Area:* Select the "RELEASES" item from the
680 pull-down "SOFTWARE" tab menu near the top of the page. 680 pull-down "DEVELOPMENT" tab menu near the top of the page.
681 681
6823. *Select a Yocto Project Release:* Use the menu next to "RELEASE" to 682#. *Select a Yocto Project Release:* On the top of the "RELEASE" page currently
683 display and choose a recent or past supported Yocto Project release 683 supported releases are displayed, further down past supported Yocto Project
684 (e.g. &DISTRO_NAME_NO_CAP;, &DISTRO_NAME_NO_CAP_MINUS_ONE;, and so forth). 684 releases are visible. The "Download" links in the rows of the table there
685 will lead to the download tarballs for the release.
685 686
686 .. note:: 687 .. note::
687 688
@@ -691,9 +692,9 @@ Releases <#accessing-index-of-releases>`__" section.
691 You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto 692 You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto
692 Project releases. 693 Project releases.
693 694
6944. *Download Tools or Board Support Packages (BSPs):* From the 695#. *Download Tools or Board Support Packages (BSPs):* Next to the tarballs you
695 "DOWNLOADS" page, you can download tools or BSPs as well. Just scroll 696 will find download tools or BSPs as well. Just select a Yocto Project
696 down the page and look for what you need. 697 release and look for what you need.
697 698
698Accessing Nightly Builds 699Accessing Nightly Builds
699------------------------ 700------------------------
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index 830b3e88ca..6b5e9484d0 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -1100,7 +1100,7 @@ Section.
1100 :: 1100 ::
1101 1101
1102 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1102 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
1103 SRC_URI_append = "file://0001-calibrate.c-Added-some-printk-statements.patch" 1103 SRC_URI_append = " file://0001-calibrate.c-Added-some-printk-statements.patch"
1104 1104
1105 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements 1105 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements
1106 enable the OpenEmbedded build system to find the patch file. 1106 enable the OpenEmbedded build system to find the patch file.
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index d9f50e5194..3401f534b1 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -1986,9 +1986,7 @@ Behind the scenes, the shared state code works by looking in
1986shared state files. Here is an example: 1986shared state files. Here is an example:
1987:: 1987::
1988 1988
1989 SSTATE_MIRRORS ?= "\ 1989 SSTATE_MIRRORS ?= "file://.* https://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH"
1990 file://.\* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
1991 file://.\* file:///some/local/dir/sstate/PATH"
1992 1990
1993.. note:: 1991.. note::
1994 1992
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index 4bedd6df67..a5469d4d78 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -422,7 +422,7 @@ files. Git uses "branches" to organize different development efforts.
422For example, the ``poky`` repository has several branches that include 422For example, the ``poky`` repository has several branches that include
423the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many 423the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many
424branches for past Yocto Project releases. You can see all the branches 424branches for past Yocto Project releases. You can see all the branches
425by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the 425by going to :yocto_git:`/cgit.cgi/poky/` and clicking on the
426``[...]`` link beneath the "Branch" heading. 426``[...]`` link beneath the "Branch" heading.
427 427
428Each of these branches represents a specific area of development. The 428Each of these branches represents a specific area of development. The
@@ -468,7 +468,7 @@ Git uses "tags" to mark specific changes in a repository branch
468structure. Typically, a tag is used to mark a special point such as the 468structure. Typically, a tag is used to mark a special point such as the
469final change (or commit) before a project is released. You can see the 469final change (or commit) before a project is released. You can see the
470tags used with the ``poky`` Git repository by going to 470tags used with the ``poky`` Git repository by going to
471https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link 471:yocto_git:`/cgit.cgi/poky/` and clicking on the ``[...]`` link
472beneath the "Tag" heading. 472beneath the "Tag" heading.
473 473
474Some key tags for the ``poky`` repository are ``jethro-14.0.3``, 474Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index f1c725ac27..2675074f14 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -271,8 +271,8 @@ with the string ``meta-``.
271 , but it is a commonly accepted standard in the Yocto Project 271 , but it is a commonly accepted standard in the Yocto Project
272 community. 272 community.
273 273
274For example, if you were to examine the `tree 274For example, if you were to examine the :yocto_git:`tree
275view <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/>`__ of the 275view </cgit/cgit.cgi/poky/tree/>` of the
276``poky`` repository, you will see several layers: ``meta``, 276``poky`` repository, you will see several layers: ``meta``,
277``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and 277``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and
278``meta-yocto-bsp``. Each of these repositories represents a distinct 278``meta-yocto-bsp``. Each of these repositories represents a distinct
@@ -377,7 +377,7 @@ activities using the Yocto Project:
377 Index <http://layers.openembedded.org/layerindex/layers/>`__, which 377 Index <http://layers.openembedded.org/layerindex/layers/>`__, which
378 is a website that indexes OpenEmbedded-Core layers. 378 is a website that indexes OpenEmbedded-Core layers.
379 379
380- *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__ 380- *Patchwork:* `Patchwork <https://patchwork.yoctoproject.org/>`__
381 is a fork of a project originally started by 381 is a fork of a project originally started by
382 `OzLabs <http://ozlabs.org/>`__. The project is a web-based tracking 382 `OzLabs <http://ozlabs.org/>`__. The project is a web-based tracking
383 system designed to streamline the process of bringing contributions 383 system designed to streamline the process of bringing contributions
diff --git a/documentation/poky.yaml b/documentation/poky.yaml
index ee9b2acbeb..0ab046428b 100644
--- a/documentation/poky.yaml
+++ b/documentation/poky.yaml
@@ -1,11 +1,13 @@
1DISTRO : "3.1.6" 1DISTRO : "3.1.33"
2DISTRO_NAME_NO_CAP : "dunfell" 2DISTRO_NAME_NO_CAP : "dunfell"
3DISTRO_NAME : "Dunfell" 3DISTRO_NAME : "Dunfell"
4DISTRO_NAME_NO_CAP_MINUS_ONE : "zeus" 4DISTRO_NAME_NO_CAP_MINUS_ONE : "zeus"
5YOCTO_DOC_VERSION : "3.1.6" 5YOCTO_DOC_VERSION : "3.1.33"
6YOCTO_DOC_VERSION_MINUS_ONE : "3.0.2" 6YOCTO_DOC_VERSION_MINUS_ONE : "3.0.4"
7DISTRO_REL_TAG : "yocto-3.1.6" 7DISTRO_REL_TAG : "yocto-3.1.33"
8POKYVERSION : "23.0.6" 8DOCCONF_VERSION : "3.1.33"
9BITBAKE_SERIES : "1.46"
10POKYVERSION : "23.0.33"
9YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" 11YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;"
10YOCTO_DL_URL : "https://downloads.yoctoproject.org" 12YOCTO_DL_URL : "https://downloads.yoctoproject.org"
11YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" 13YOCTO_AB_URL : "https://autobuilder.yoctoproject.org"
@@ -18,7 +20,8 @@ FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip pe
18 diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ 20 diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
19 ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ 21 ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \
20 python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ 22 python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \
21 python3-jinja2 SDL-devel xterm rpcgen mesa-libGL-devel" 23 python3-jinja2 SDL-devel xterm rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \
24 perl-File-Copy perl-locale"
22OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ 25OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \
23 diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ 26 diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \
24 python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel xterm rpcgen Mesa-dri-devel 27 python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel xterm rpcgen Mesa-dri-devel
diff --git a/documentation/profile-manual/profile-manual-usage.rst b/documentation/profile-manual/profile-manual-usage.rst
index d3c020a1cf..e389a13fc0 100644
--- a/documentation/profile-manual/profile-manual-usage.rst
+++ b/documentation/profile-manual/profile-manual-usage.rst
@@ -1169,9 +1169,8 @@ e.g. 'perf help' or 'perf help record'.
1169 1169
1170However, by default Yocto doesn't install man pages, but perf invokes 1170However, by default Yocto doesn't install man pages, but perf invokes
1171the man pages for most help functionality. This is a bug and is being 1171the man pages for most help functionality. This is a bug and is being
1172addressed by a Yocto bug: `Bug 3388 - perf: enable man pages for basic 1172addressed by a Yocto bug: :yocto_bugs:`Bug 3388 - perf: enable man pages for basic
1173'help' 1173'help' functionality </show_bug.cgi?id=3388>`.
1174functionality <https://bugzilla.yoctoproject.org/show_bug.cgi?id=3388>`__.
1175 1174
1176The man pages in text form, along with some other files, such as a set 1175The man pages in text form, along with some other files, such as a set
1177of examples, can be found in the 'perf' directory of the kernel tree: :: 1176of examples, can be found in the 'perf' directory of the kernel tree: ::
@@ -1735,7 +1734,7 @@ events':
1735 1734
1736The tool is pretty self-explanatory, but for more detailed information 1735The tool is pretty self-explanatory, but for more detailed information
1737on navigating through the data, see the `kernelshark 1736on navigating through the data, see the `kernelshark
1738website <http://rostedt.homelinux.com/kernelshark/>`__. 1737website <https://kernelshark.org/Documentation.html>`__.
1739 1738
1740.. _ftrace-documentation: 1739.. _ftrace-documentation:
1741 1740
@@ -1766,8 +1765,8 @@ There is a nice series of articles on using ftrace and trace-cmd at LWN:
1766- `trace-cmd: A front-end for 1765- `trace-cmd: A front-end for
1767 Ftrace <https://lwn.net/Articles/410200/>`__ 1766 Ftrace <https://lwn.net/Articles/410200/>`__
1768 1767
1769There's more detailed documentation kernelshark usage here: 1768See also `KernelShark's documentation <https://kernelshark.org/Documentation.html>`__
1770`KernelShark <http://rostedt.homelinux.com/kernelshark/>`__ 1769for further usage details.
1771 1770
1772An amusing yet useful README (a tracing mini-HOWTO) can be found in 1771An amusing yet useful README (a tracing mini-HOWTO) can be found in
1773``/sys/kernel/debug/tracing/README``. 1772``/sys/kernel/debug/tracing/README``.
diff --git a/documentation/ref-manual/migration-3.0.rst b/documentation/ref-manual/migration-3.0.rst
index 047b75526f..50f7d697b0 100644
--- a/documentation/ref-manual/migration-3.0.rst
+++ b/documentation/ref-manual/migration-3.0.rst
@@ -184,8 +184,7 @@ The following BitBake changes have occurred.
184 exceptions. Remove this argument in any calls to 184 exceptions. Remove this argument in any calls to
185 ``bb.build.exec_func()`` in custom classes or scripts. 185 ``bb.build.exec_func()`` in custom classes or scripts.
186 186
187- The 187- The ``BB_SETSCENE_VERIFY_FUNCTION2`` variable
188 :term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2`
189 is no longer used. In the unlikely event that you have any references 188 is no longer used. In the unlikely event that you have any references
190 to it, they should be removed. 189 to it, they should be removed.
191 190
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index e657fe0e55..dea27eea88 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -1315,16 +1315,6 @@ The following list shows the tests you can list with the ``WARN_QA`` and
1315 automatically get these versions. Consequently, you should only need 1315 automatically get these versions. Consequently, you should only need
1316 to explicitly add dependencies to binary driver recipes. 1316 to explicitly add dependencies to binary driver recipes.
1317 1317
1318.. _ref-classes-insserv:
1319
1320``insserv.bbclass``
1321===================
1322
1323The ``insserv`` class uses the ``insserv`` utility to update the order
1324of symbolic links in ``/etc/rc?.d/`` within an image based on
1325dependencies specified by LSB headers in the ``init.d`` scripts
1326themselves.
1327
1328.. _ref-classes-kernel: 1318.. _ref-classes-kernel:
1329 1319
1330``kernel.bbclass`` 1320``kernel.bbclass``
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index f28ad2bb4c..be3a9e3a3e 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -63,6 +63,8 @@ Project metadata:
63 63
64- *keyboard:* Hardware has a keyboard 64- *keyboard:* Hardware has a keyboard
65 65
66- *numa:* Hardware has non-uniform memory access
67
66- *pcbios:* Support for booting through BIOS 68- *pcbios:* Support for booting through BIOS
67 69
68- *pci:* Hardware has a PCI bus 70- *pci:* Hardware has a PCI bus
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index 56ec8562f8..70feadf1ff 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -14,16 +14,17 @@ image you want.
14 Building an image without GNU General Public License Version 3 14 Building an image without GNU General Public License Version 3
15 (GPLv3), GNU Lesser General Public License Version 3 (LGPLv3), and 15 (GPLv3), GNU Lesser General Public License Version 3 (LGPLv3), and
16 the GNU Affero General Public License Version 3 (AGPL-3.0) components 16 the GNU Affero General Public License Version 3 (AGPL-3.0) components
17 is only supported for minimal and base images. Furthermore, if you 17 is only tested for core-image-minimal image. Furthermore, if you would like to
18 are going to build an image using non-GPLv3 and similarly licensed 18 build an image and verify that it does not include GPLv3 and similarly licensed
19 components, you must make the following changes in the ``local.conf`` 19 components, you must make the following changes in the image recipe
20 file before using the BitBake command to build the minimal or base 20 file before using the BitBake command to build the image:
21 image:
22 ::
23 21
24 1. Comment out the EXTRA_IMAGE_FEATURES line 22 INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0*"
25 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0"
26 23
24 Alternatively, you can adjust ``local.conf`` file, repeating and adjusting the line
25 for all images where the license restriction must apply:
26
27 INCOMPATIBLE_LICENSE_pn-your-image-name = "GPL-3.0* LGPL-3.0*"
27 28
28From within the ``poky`` Git repository, you can use the following 29From within the ``poky`` Git repository, you can use the following
29command to display the list of directories within the :term:`Source Directory` 30command to display the list of directories within the :term:`Source Directory`
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index a6d9ff60ec..8dcbea7beb 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -138,7 +138,7 @@ consists of the following pieces:
138 piece of software. The test allows the packages to be be run within a 138 piece of software. The test allows the packages to be be run within a
139 target image. 139 target image.
140 140
141- ``oe-selftest``: Tests combination BitBake invocations. These tests 141- ``oe-selftest``: Tests combinations of BitBake invocations. These tests
142 operate outside the OpenEmbedded build system itself. The 142 operate outside the OpenEmbedded build system itself. The
143 ``oe-selftest`` can run all tests by default or can run selected 143 ``oe-selftest`` can run all tests by default or can run selected
144 tests or test suites. 144 tests or test suites.
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index 65234d0722..efb60e1009 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -34,16 +34,30 @@ and conceptual information in the :doc:`../overview-manual/overview-manual`.
34Supported Linux Distributions 34Supported Linux Distributions
35============================= 35=============================
36 36
37Currently, the Yocto Project is supported on the following 37Currently, the &DISTRO; release ("&DISTRO_NAME;") of the Yocto Project is
38distributions: 38supported on the following distributions:
39 39
40- Ubuntu 16.04 (LTS) 40- Ubuntu 20.04 (LTS)
41
42- Ubuntu 22.04 (LTS)
43
44- Fedora 38
45
46- Debian GNU/Linux 11.x (Bullseye)
47
48- AlmaLinux 8
49
50The following distribution versions are still tested even though the
51organizations publishing them no longer make updates publicly available:
41 52
42- Ubuntu 18.04 (LTS) 53- Ubuntu 18.04 (LTS)
43 54
44- Ubuntu 19.04 55Finally, here are the distribution versions which were previously
56tested on former revisions of "&DISTRO_NAME;", but no longer are:
45 57
46- Ubuntu 20.04 58- Ubuntu 16.04 (LTS)
59
60- Ubuntu 19.04
47 61
48- Fedora 28 62- Fedora 28
49 63
@@ -55,8 +69,20 @@ distributions:
55 69
56- Fedora 32 70- Fedora 32
57 71
72- Fedora 33
73
74- Fedora 34
75
76- Fedora 35
77
78- Fedora 36
79
80- Fedora 37
81
58- CentOS 7.x 82- CentOS 7.x
59 83
84- CentOS 8.x
85
60- Debian GNU/Linux 8.x (Jessie) 86- Debian GNU/Linux 8.x (Jessie)
61 87
62- Debian GNU/Linux 9.x (Stretch) 88- Debian GNU/Linux 9.x (Stretch)
@@ -65,6 +91,9 @@ distributions:
65 91
66- OpenSUSE Leap 15.1 92- OpenSUSE Leap 15.1
67 93
94- OpenSUSE Leap 15.2
95
96- OpenSUSE Leap 15.3
68 97
69.. note:: 98.. note::
70 99
@@ -338,7 +367,7 @@ Downloading a Pre-Built ``buildtools`` Tarball
338Downloading and running a pre-built buildtools installer is the easiest 367Downloading and running a pre-built buildtools installer is the easiest
339of the two methods by which you can get these tools: 368of the two methods by which you can get these tools:
340 369
3411. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ 3701. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/buildtools/`
342 371
3432. Execute the installation script. Here is an example for the 3722. Execute the installation script. Here is an example for the
344 traditional installer: 373 traditional installer:
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 4ed15365f3..2f1959a010 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -331,22 +331,19 @@ file as a patch file:
331 file://file;apply=yes \ 331 file://file;apply=yes \
332 " 332 "
333 333
334Conversely, if you have a directory full of patch files and you want to 334Conversely, if you have a file whose file type is ``.patch`` or ``.diff``
335exclude some so that the ``do_patch`` task does not apply them during 335and you want to exclude it so that the ``do_patch`` task does not apply
336the patch phase, you can use the "apply=no" parameter with the 336it during the patch phase, you can use the "apply=no" parameter with the
337``SRC_URI`` statement: 337:term:`SRC_URI` statement::
338::
339 338
340 SRC_URI = " \ 339 SRC_URI = " \
341 git://path_to_repo/some_package \ 340 git://path_to_repo/some_package \
342 file://path_to_lots_of_patch_files \ 341 file://file1.patch \
343 file://path_to_lots_of_patch_files/patch_file5;apply=no \ 342 file://file2.patch;apply=no \
344 " 343 "
345 344
346In the 345In the previous example ``file1.patch`` would be applied as a patch by default
347previous example, assuming all the files in the directory holding the 346while ``file2.patch`` would not be applied.
348patch files end with either ``.patch`` or ``.diff``, every file would be
349applied as a patch by default except for the ``patch_file5`` patch.
350 347
351You can find out more about the patching process in the 348You can find out more about the patching process in the
352":ref:`patching-dev-environment`" section in 349":ref:`patching-dev-environment`" section in
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index a8375cd37c..227c81fc39 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -3337,9 +3337,18 @@ system and gives an overview of their function and contents.
3337 :term:`INCOMPATIBLE_LICENSE` 3337 :term:`INCOMPATIBLE_LICENSE`
3338 Specifies a space-separated list of license names (as they would 3338 Specifies a space-separated list of license names (as they would
3339 appear in :term:`LICENSE`) that should be excluded 3339 appear in :term:`LICENSE`) that should be excluded
3340 from the build. Recipes that provide no alternatives to listed 3340 from the build (if set globally), or from an image (if set locally
3341 in an image recipe).
3342
3343 When the variable is set globally, recipes that provide no alternatives to listed
3341 incompatible licenses are not built. Packages that are individually 3344 incompatible licenses are not built. Packages that are individually
3342 licensed with the specified incompatible licenses will be deleted. 3345 licensed with the specified incompatible licenses will be deleted.
3346 Most of the time this does not allow a feasible build (because it becomes impossible
3347 to satisfy build time dependencies), so the recommended way to
3348 implement license restrictions is to set the variable in specific
3349 image recipes where the restrictions must apply. That way there
3350 are no build time restrictions, but the license check is still
3351 performed when the image's filesystem is assembled from packages.
3343 3352
3344 .. note:: 3353 .. note::
3345 3354
@@ -3811,6 +3820,15 @@ system and gives an overview of their function and contents.
3811 3820
3812 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3821 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3813 3822
3823 :term:`KERNEL_DTC_FLAGS`
3824 Specifies the ``dtc`` flags that are passed to the Linux kernel build
3825 system when generating the device trees (via ``DTC_FLAGS`` environment
3826 variable).
3827
3828 In order to use this variable, the
3829 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
3830 be inherited.
3831
3814 :term:`KERNEL_EXTRA_ARGS` 3832 :term:`KERNEL_EXTRA_ARGS`
3815 Specifies additional ``make`` command-line arguments the OpenEmbedded 3833 Specifies additional ``make`` command-line arguments the OpenEmbedded
3816 build system passes on when compiling the kernel. 3834 build system passes on when compiling the kernel.
@@ -3837,10 +3855,10 @@ system and gives an overview of their function and contents.
3837 :: 3855 ::
3838 3856
3839 KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc" 3857 KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
3840 KERNEL_FEATURES_append = "${KERNEL_EXTRA_FEATURES}" 3858 KERNEL_FEATURES_append = " ${KERNEL_EXTRA_FEATURES}"
3841 KERNEL_FEATURES_append_qemuall = "cfg/virtio.scc" 3859 KERNEL_FEATURES_append_qemuall = " cfg/virtio.scc"
3842 KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" 3860 KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
3843 KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" 3861 KERNEL_FEATURES_append_qemux86-64 = " cfg/sound.scc"
3844 3862
3845 :term:`KERNEL_FIT_LINK_NAME` 3863 :term:`KERNEL_FIT_LINK_NAME`
3846 The link name of the kernel flattened image tree (FIT) image. This 3864 The link name of the kernel flattened image tree (FIT) image. This
@@ -4039,7 +4057,7 @@ system and gives an overview of their function and contents.
4039 SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711" 4057 SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
4040 KMACHINE_core2-32-intel-common = "intel-core2-32" 4058 KMACHINE_core2-32-intel-common = "intel-core2-32"
4041 KBRANCH_core2-32-intel-common = "standard/base" 4059 KBRANCH_core2-32-intel-common = "standard/base"
4042 KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}" 4060 KERNEL_FEATURES_append_core2-32-intel-common = " ${KERNEL_FEATURES_INTEL_COMMON}"
4043 4061
4044 The ``KMACHINE`` statement says 4062 The ``KMACHINE`` statement says
4045 that the kernel understands the machine name as "intel-core2-32". 4063 that the kernel understands the machine name as "intel-core2-32".
@@ -7138,6 +7156,32 @@ system and gives an overview of their function and contents.
7138 :term:`SSTATE_DIR` 7156 :term:`SSTATE_DIR`
7139 The directory for the shared state cache. 7157 The directory for the shared state cache.
7140 7158
7159 :term:`SSTATE_EXCLUDEDEPS_SYSROOT`
7160 This variable allows to specify indirect dependencies to exclude
7161 from sysroots, for example to avoid the situations when a dependency on
7162 any ``-native`` recipe will pull in all dependencies of that recipe
7163 in the recipe sysroot. This behaviour might not always be wanted,
7164 for example when that ``-native`` recipe depends on build tools
7165 that are not relevant for the current recipe.
7166
7167 This way, irrelevant dependencies are ignored, which could have
7168 prevented the reuse of prebuilt artifacts stored in the Shared
7169 State Cache.
7170
7171 :term:`SSTATE_EXCLUDEDEPS_SYSROOT` is evaluated as two regular
7172 expressions of recipe and dependency to ignore. An example
7173 is the rule in :oe_git:`meta/conf/layer.conf </openembedded-core/tree/meta/conf/layer.conf>`::
7174
7175 # Nothing needs to depend on libc-initial
7176 # base-passwd/shadow-sysroot don't need their dependencies
7177 SSTATE_EXCLUDEDEPS_SYSROOT += "\
7178 .*->.*-initial.* \
7179 .*(base-passwd|shadow-sysroot)->.* \
7180 "
7181
7182 The ``->`` substring represents the dependency between
7183 the two regular expressions.
7184
7141 :term:`SSTATE_MIRROR_ALLOW_NETWORK` 7185 :term:`SSTATE_MIRROR_ALLOW_NETWORK`
7142 If set to "1", allows fetches from mirrors that are specified in 7186 If set to "1", allows fetches from mirrors that are specified in
7143 :term:`SSTATE_MIRRORS` to work even when 7187 :term:`SSTATE_MIRRORS` to work even when
@@ -7533,7 +7577,7 @@ system and gives an overview of their function and contents.
7533 ``SYSTEMD_BOOT_CFG`` as follows: 7577 ``SYSTEMD_BOOT_CFG`` as follows:
7534 :: 7578 ::
7535 7579
7536 SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" 7580 SYSTEMD_BOOT_CFG ?= "${S}/loader.conf"
7537 7581
7538 For information on Systemd-boot, see the `Systemd-boot 7582 For information on Systemd-boot, see the `Systemd-boot
7539 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. 7583 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
@@ -8736,4 +8780,22 @@ system and gives an overview of their function and contents.
8736 8780
8737 The default value of ``XSERVER``, if not specified in the machine 8781 The default value of ``XSERVER``, if not specified in the machine
8738 configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". 8782 configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev".
8739 8783
8784 :term:`XZ_THREADS`
8785 Specifies the number of parallel threads that should be used when
8786 using xz compression.
8787
8788 By default this scales with core count, but is never set less than 2
8789 to ensure that multi-threaded mode is always used so that the output
8790 file contents are deterministic. Builds will work with a value of 1
8791 but the output will differ compared to the output from the compression
8792 generated when more than one thread is used.
8793
8794 On systems where many tasks run in parallel, setting a limit to this
8795 can be helpful in controlling system resource usage.
8796
8797 :term:`XZ_MEMLIMIT`
8798 Specifies the maximum memory the xz compression should use as a percentage
8799 of system memory. If unconstrained the xz compressor can use large amounts of
8800 memory and become problematic with parallelism elsewhere in the build.
8801 "50%" has been found to be a good value.
diff --git a/documentation/releases.rst b/documentation/releases.rst
index 536c3a6d2c..affe63403c 100644
--- a/documentation/releases.rst
+++ b/documentation/releases.rst
@@ -1,32 +1,72 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK 1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2 2
3========================= 3===========================
4 Current Release Manuals 4 Supported Release Manuals
5========================= 5===========================
6
7******************************
8Release Series 3.4 (honister)
9******************************
10
11- :yocto_docs:`3.4 Documentation </3.4>`
12- :yocto_docs:`3.4.1 Documentation </3.4.1>`
13
14******************************
15Release Series 3.3 (hardknott)
16******************************
17
18- :yocto_docs:`3.3 Documentation </3.3>`
19- :yocto_docs:`3.3.1 Documentation </3.3.1>`
20- :yocto_docs:`3.3.2 Documentation </3.3.2>`
21- :yocto_docs:`3.3.3 Documentation </3.3.3>`
22- :yocto_docs:`3.3.4 Documentation </3.3.4>`
6 23
7**************************** 24****************************
83.1 'dunfell' Release Series 25Release Series 3.1 (dunfell)
9**************************** 26****************************
10 27
11- :yocto_docs:`3.1 Documentation </3.1>` 28- :yocto_docs:`3.1 Documentation </3.1>`
12- :yocto_docs:`3.1.1 Documentation </3.1.1>` 29- :yocto_docs:`3.1.1 Documentation </3.1.1>`
13- :yocto_docs:`3.1.2 Documentation </3.1.2>` 30- :yocto_docs:`3.1.2 Documentation </3.1.2>`
31- :yocto_docs:`3.1.3 Documentation </3.1.3>`
32- :yocto_docs:`3.1.4 Documentation </3.1.4>`
33- :yocto_docs:`3.1.5 Documentation </3.1.5>`
34- :yocto_docs:`3.1.6 Documentation </3.1.6>`
35- :yocto_docs:`3.1.7 Documentation </3.1.7>`
36- :yocto_docs:`3.1.8 Documentation </3.1.8>`
37- :yocto_docs:`3.1.9 Documentation </3.1.9>`
38- :yocto_docs:`3.1.10 Documentation </3.1.10>`
39- :yocto_docs:`3.1.11 Documentation </3.1.11>`
40- :yocto_docs:`3.1.12 Documentation </3.1.12>`
41- :yocto_docs:`3.1.13 Documentation </3.1.13>`
42- :yocto_docs:`3.1.14 Documentation </3.1.14>`
14 43
15========================== 44==========================
16 Previous Release Manuals 45 Outdated Release Manuals
17========================== 46==========================
18 47
48*******************************
49Release Series 3.2 (gatesgarth)
50*******************************
51
52- :yocto_docs:`3.2 Documentation </3.2>`
53- :yocto_docs:`3.2.1 Documentation </3.2.1>`
54- :yocto_docs:`3.2.2 Documentation </3.2.2>`
55- :yocto_docs:`3.2.3 Documentation </3.2.3>`
56- :yocto_docs:`3.2.4 Documentation </3.2.4>`
57
19************************* 58*************************
203.0 'zeus' Release Series 59Release Series 3.0 (zeus)
21************************* 60*************************
22 61
23- :yocto_docs:`3.0 Documentation </3.0>` 62- :yocto_docs:`3.0 Documentation </3.0>`
24- :yocto_docs:`3.0.1 Documentation </3.0.1>` 63- :yocto_docs:`3.0.1 Documentation </3.0.1>`
25- :yocto_docs:`3.0.2 Documentation </3.0.2>` 64- :yocto_docs:`3.0.2 Documentation </3.0.2>`
26- :yocto_docs:`3.0.3 Documentation </3.0.3>` 65- :yocto_docs:`3.0.3 Documentation </3.0.3>`
66- :yocto_docs:`3.0.4 Documentation </3.0.4>`
27 67
28**************************** 68****************************
292.7 'warrior' Release Series 69Release Series 2.7 (warrior)
30**************************** 70****************************
31 71
32- :yocto_docs:`2.7 Documentation </2.7>` 72- :yocto_docs:`2.7 Documentation </2.7>`
@@ -36,7 +76,7 @@
36- :yocto_docs:`2.7.4 Documentation </2.7.4>` 76- :yocto_docs:`2.7.4 Documentation </2.7.4>`
37 77
38************************* 78*************************
392.6 'thud' Release Series 79Release Series 2.6 (thud)
40************************* 80*************************
41 81
42- :yocto_docs:`2.6 Documentation </2.6>` 82- :yocto_docs:`2.6 Documentation </2.6>`
@@ -46,16 +86,16 @@
46- :yocto_docs:`2.6.4 Documentation </2.6.4>` 86- :yocto_docs:`2.6.4 Documentation </2.6.4>`
47 87
48************************* 88*************************
492.5 'sumo' Release Series 89Release Series 2.5 (sumo)
50************************* 90*************************
51 91
52- :yocto_docs:`2.5 Documentation </2.5>` 92- :yocto_docs:`2.5 Documentation </2.5>`
53- :yocto_docs:`2.5.1 Documentation </2.5.1>` 93- :yocto_docs:`2.5.1 Documentation </2.5.1>`
54- :yocto_docs:`2.5.2 Documentation </2.5.2>` 94- :yocto_docs:`2.5.2 Documentation </2.5.2>`
55- :yocto_docs:`2.5.3 Documentation </2.5.3>` 95- :yocto_docs:`2.5.3 Documentation </2.5.3>`
56 96
57************************** 97**************************
582.4 'rocko' Release Series 98Release Series 2.4 (rocko)
59************************** 99**************************
60 100
61- :yocto_docs:`2.4 Documentation </2.4>` 101- :yocto_docs:`2.4 Documentation </2.4>`
@@ -65,7 +105,7 @@
65- :yocto_docs:`2.4.4 Documentation </2.4.4>` 105- :yocto_docs:`2.4.4 Documentation </2.4.4>`
66 106
67************************* 107*************************
682.3 'pyro' Release Series 108Release Series 2.3 (pyro)
69************************* 109*************************
70 110
71- :yocto_docs:`2.3 Documentation </2.3>` 111- :yocto_docs:`2.3 Documentation </2.3>`
@@ -75,7 +115,7 @@
75- :yocto_docs:`2.3.4 Documentation </2.3.4>` 115- :yocto_docs:`2.3.4 Documentation </2.3.4>`
76 116
77************************** 117**************************
782.2 'morty' Release Series 118Release Series 2.2 (morty)
79************************** 119**************************
80 120
81- :yocto_docs:`2.2 Documentation </2.2>` 121- :yocto_docs:`2.2 Documentation </2.2>`
@@ -84,7 +124,7 @@
84- :yocto_docs:`2.2.3 Documentation </2.2.3>` 124- :yocto_docs:`2.2.3 Documentation </2.2.3>`
85 125
86**************************** 126****************************
872.1 'krogoth' Release Series 127Release Series 2.1 (krogoth)
88**************************** 128****************************
89 129
90- :yocto_docs:`2.1 Documentation </2.1>` 130- :yocto_docs:`2.1 Documentation </2.1>`
@@ -93,7 +133,7 @@
93- :yocto_docs:`2.1.3 Documentation </2.1.3>` 133- :yocto_docs:`2.1.3 Documentation </2.1.3>`
94 134
95*************************** 135***************************
962.0 'jethro' Release Series 136Release Series 2.0 (jethro)
97*************************** 137***************************
98 138
99- :yocto_docs:`1.9 Documentation </1.9>` 139- :yocto_docs:`1.9 Documentation </1.9>`
@@ -103,7 +143,7 @@
103- :yocto_docs:`2.0.3 Documentation </2.0.3>` 143- :yocto_docs:`2.0.3 Documentation </2.0.3>`
104 144
105************************* 145*************************
1061.8 'fido' Release Series 146Release Series 1.8 (fido)
107************************* 147*************************
108 148
109- :yocto_docs:`1.8 Documentation </1.8>` 149- :yocto_docs:`1.8 Documentation </1.8>`
@@ -111,7 +151,7 @@
111- :yocto_docs:`1.8.2 Documentation </1.8.2>` 151- :yocto_docs:`1.8.2 Documentation </1.8.2>`
112 152
113************************** 153**************************
1141.7 'dizzy' Release Series 154Release Series 1.7 (dizzy)
115************************** 155**************************
116 156
117- :yocto_docs:`1.7 Documentation </1.7>` 157- :yocto_docs:`1.7 Documentation </1.7>`
@@ -120,16 +160,16 @@
120- :yocto_docs:`1.7.3 Documentation </1.7.3>` 160- :yocto_docs:`1.7.3 Documentation </1.7.3>`
121 161
122************************** 162**************************
1231.6 'daisy' Release Series 163Release Series 1.6 (daisy)
124************************** 164**************************
125 165
126- :yocto_docs:`1.6 Documentation </1.6>` 166- :yocto_docs:`1.6 Documentation </1.6>`
127- :yocto_docs:`1.6.1 Documentation </1.6.1>` 167- :yocto_docs:`1.6.1 Documentation </1.6.1>`
128- :yocto_docs:`1.6.2 Documentation </1.6.2>` 168- :yocto_docs:`1.6.2 Documentation </1.6.2>`
129- :yocto_docs:`1.6.3 Documentation </1.6.3>` 169- :yocto_docs:`1.6.3 Documentation </1.6.3>`
130 170
131************************* 171*************************
1321.5 'dora' Release Series 172Release Series 1.5 (dora)
133************************* 173*************************
134 174
135- :yocto_docs:`1.5 Documentation </1.5>` 175- :yocto_docs:`1.5 Documentation </1.5>`
@@ -139,7 +179,7 @@
139- :yocto_docs:`1.5.4 Documentation </1.5.4>` 179- :yocto_docs:`1.5.4 Documentation </1.5.4>`
140 180
141************************** 181**************************
1421.4 'dylan' Release Series 182Release Series 1.4 (dylan)
143************************** 183**************************
144 184
145- :yocto_docs:`1.4 Documentation </1.4>` 185- :yocto_docs:`1.4 Documentation </1.4>`
@@ -148,9 +188,9 @@
148- :yocto_docs:`1.4.3 Documentation </1.4.3>` 188- :yocto_docs:`1.4.3 Documentation </1.4.3>`
149- :yocto_docs:`1.4.4 Documentation </1.4.4>` 189- :yocto_docs:`1.4.4 Documentation </1.4.4>`
150- :yocto_docs:`1.4.5 Documentation </1.4.5>` 190- :yocto_docs:`1.4.5 Documentation </1.4.5>`
151 191
152************************** 192**************************
1531.3 'danny' Release Series 193Release Series 1.3 (danny)
154************************** 194**************************
155 195
156- :yocto_docs:`1.3 Documentation </1.3>` 196- :yocto_docs:`1.3 Documentation </1.3>`
@@ -158,7 +198,7 @@
158- :yocto_docs:`1.3.2 Documentation </1.3.2>` 198- :yocto_docs:`1.3.2 Documentation </1.3.2>`
159 199
160*************************** 200***************************
1611.2 'denzil' Release Series 201Release Series 1.2 (denzil)
162*************************** 202***************************
163 203
164- :yocto_docs:`1.2 Documentation </1.2>` 204- :yocto_docs:`1.2 Documentation </1.2>`
@@ -166,7 +206,7 @@
166- :yocto_docs:`1.2.2 Documentation </1.2.2>` 206- :yocto_docs:`1.2.2 Documentation </1.2.2>`
167 207
168*************************** 208***************************
1691.1 'edison' Release Series 209Release Series 1.1 (edison)
170*************************** 210***************************
171 211
172- :yocto_docs:`1.1 Documentation </1.1>` 212- :yocto_docs:`1.1 Documentation </1.1>`
@@ -174,7 +214,7 @@
174- :yocto_docs:`1.1.2 Documentation </1.1.2>` 214- :yocto_docs:`1.1.2 Documentation </1.1.2>`
175 215
176**************************** 216****************************
1771.0 'bernard' Release Series 217Release Series 1.0 (bernard)
178**************************** 218****************************
179 219
180- :yocto_docs:`1.0 Documentation </1.0>` 220- :yocto_docs:`1.0 Documentation </1.0>`
@@ -182,7 +222,7 @@
182- :yocto_docs:`1.0.2 Documentation </1.0.2>` 222- :yocto_docs:`1.0.2 Documentation </1.0.2>`
183 223
184**************************** 224****************************
1850.9 'laverne' Release Series 225Release Series 0.9 (laverne)
186**************************** 226****************************
187 227
188- :yocto_docs:`0.9 Documentation </0.9>` 228- :yocto_docs:`0.9 Documentation </0.9>`
diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js
index b28d91c080..1d65fa7fae 100644
--- a/documentation/sphinx-static/switchers.js
+++ b/documentation/sphinx-static/switchers.js
@@ -2,8 +2,11 @@
2 'use strict'; 2 'use strict';
3 3
4 var all_versions = { 4 var all_versions = {
5 'dev': 'dev (3.2)', 5 'dev': 'dev (3.5)',
6 '3.1.3': '3.1.3', 6 '3.4.1': '3.4.1',
7 '3.3.4': '3.3.4',
8 '3.2.4': '3.2.4',
9 '3.1.14': '3.1.14',
7 '3.0.4': '3.0.4', 10 '3.0.4': '3.0.4',
8 '2.7.4': '2.7.4', 11 '2.7.4': '2.7.4',
9 }; 12 };
diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst
index e5e3531e83..bd3a060eee 100644
--- a/documentation/toaster-manual/toaster-manual-reference.rst
+++ b/documentation/toaster-manual/toaster-manual-reference.rst
@@ -173,13 +173,13 @@ As shipped, Toaster is configured to work with the following releases:
173- *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* 173- *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":*
174 This release causes your Toaster projects to build against the head 174 This release causes your Toaster projects to build against the head
175 of the &DISTRO_NAME_NO_CAP; branch at 175 of the &DISTRO_NAME_NO_CAP; branch at
176 https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or 176 :yocto_git:`/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP;` or
177 http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;. 177 http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;.
178 178
179- *Yocto Project "Master" or OpenEmbedded "Master":* This release 179- *Yocto Project "Master" or OpenEmbedded "Master":* This release
180 causes your Toaster Projects to build against the head of the master 180 causes your Toaster Projects to build against the head of the master
181 branch, which is where active development takes place, at 181 branch, which is where active development takes place, at
182 https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or 182 :yocto_git:`/cgit/cgit.cgi/poky/log/` or
183 http://git.openembedded.org/openembedded-core/log/. 183 http://git.openembedded.org/openembedded-core/log/.
184 184
185- *Local Yocto Project or Local OpenEmbedded:* This release causes your 185- *Local Yocto Project or Local OpenEmbedded:* This release causes your