repo: upgrade 2.25 -> 2.26

(From OE-Core rev: 18a0c31b3386aa5a04eb8ee8e804c2415a61eaaf)

Signed-off-by: Wang Mingyu <wangmy@fujitsu.com>
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

MAINTAINERS.md

@@ -53,7 +53,6 @@ Maintainers needed
 * wic
 * Patchwork
 * Patchtest
-* Prelink-cross
 * Matchbox
 * Sato
 * Autobuilder

SECURITY.md

@@ -1,24 +0,0 @@
-How to Report a Potential Vulnerability?
-========================================
-
-If you would like to report a public issue (for example, one with a released
-CVE number), please report it using the
-[https://bugzilla.yoctoproject.org/enter_bug.cgi?product=Security Security Bugzilla].
-If you have a patch ready, submit it following the same procedure as any other
-patch as described in README.md.
-
-If you are dealing with a not-yet released or urgent issue, 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.
-
-Branches maintained with security fixes
----------------------------------------
-
-See [https://wiki.yoctoproject.org/wiki/Stable_Release_and_LTS Stable release and LTS]
-for detailed info regarding the policies and maintenance of Stable branches.
-
-The [https://wiki.yoctoproject.org/wiki/Releases Release page] contains a list of all
-releases of the Yocto Project. Versions in grey are no longer actively maintained with
-security patches, but well-tested patches may still be accepted for them for
-significant issues.

bitbake/SECURITY.md

@@ -1,24 +0,0 @@
-How to Report a Potential Vulnerability?
-========================================
-
-If you would like to report a public issue (for example, one with a released
-CVE number), please report it using the
-[https://bugzilla.yoctoproject.org/enter_bug.cgi?product=Security Security Bugzilla].
-If you have a patch ready, submit it following the same procedure as any other
-patch as described in README.md.
-
-If you are dealing with a not-yet released or urgent issue, 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.
-
-Branches maintained with security fixes
----------------------------------------
-
-See [https://wiki.yoctoproject.org/wiki/Stable_Release_and_LTS Stable release and LTS]
-for detailed info regarding the policies and maintenance of Stable branches.
-
-The [https://wiki.yoctoproject.org/wiki/Releases Release page] contains a list of all
-releases of the Yocto Project. Versions in grey are no longer actively maintained with
-security patches, but well-tested patches may still be accepted for them for
-significant issues.

bitbake/bin/bitbake

@@ -25,7 +25,8 @@ except RuntimeError as exc:
 from bb import cookerdata
 from bb.main import bitbake_main, BitBakeConfigParameters, BBMainException
 
-bb.utils.check_system_locale()
+if sys.getfilesystemencoding() != "utf-8":
+    sys.exit("Please use a locale setting which supports UTF-8 (such as LANG=en_US.UTF-8).\nPython can't change the filesystem locale after loading so we need a UTF-8 when Python starts or things won't work.")
 
 __version__ = "2.0.0"
 

bitbake/bin/bitbake-getvar

@@ -25,7 +25,6 @@ if __name__ == "__main__":
     parser.add_argument('-u', '--unexpand', help='Do not expand the value (with --value)', action="store_true")
     parser.add_argument('-f', '--flag', help='Specify a variable flag to query (with --value)', default=None)
     parser.add_argument('--value', help='Only report the value, no history and no variable name', action="store_true")
-    parser.add_argument('-q', '--quiet', help='Silence bitbake server logging', action="store_true")
     args = parser.parse_args()
 
     if args.unexpand and not args.value:
@@ -36,10 +35,9 @@ if __name__ == "__main__":
         print("--flag only makes sense with --value")
         sys.exit(1)
 
-    quiet = args.quiet
-    with bb.tinfoil.Tinfoil(tracking=True, setup_logging=not quiet) as tinfoil:
+    with bb.tinfoil.Tinfoil(tracking=True) as tinfoil:
         if args.recipe:
-            tinfoil.prepare(quiet=3 if quiet else 2)
+            tinfoil.prepare(quiet=2)
             d = tinfoil.parse_recipe(args.recipe)
         else:
             tinfoil.prepare(quiet=2, config_only=True)

bitbake/bin/bitbake-hashclient

@@ -56,24 +56,25 @@ def main():
             nonlocal missed_hashes
             nonlocal max_time
 
-            with hashserv.create_client(args.address) as client:
-                for i in range(args.requests):
-                    taskhash = hashlib.sha256()
-                    taskhash.update(args.taskhash_seed.encode('utf-8'))
-                    taskhash.update(str(i).encode('utf-8'))
+            client = hashserv.create_client(args.address)
 
-                    start_time = time.perf_counter()
-                    l = client.get_unihash(METHOD, taskhash.hexdigest())
-                    elapsed = time.perf_counter() - start_time
+            for i in range(args.requests):
+                taskhash = hashlib.sha256()
+                taskhash.update(args.taskhash_seed.encode('utf-8'))
+                taskhash.update(str(i).encode('utf-8'))
 
-                    with lock:
-                        if l:
-                            found_hashes += 1
-                        else:
-                            missed_hashes += 1
+                start_time = time.perf_counter()
+                l = client.get_unihash(METHOD, taskhash.hexdigest())
+                elapsed = time.perf_counter() - start_time
 
-                        max_time = max(elapsed, max_time)
-                        pbar.update()
+                with lock:
+                    if l:
+                        found_hashes += 1
+                    else:
+                        missed_hashes += 1
+
+                    max_time = max(elapsed, max_time)
+                    pbar.update()
 
         max_time = 0
         found_hashes = 0
@@ -151,8 +152,9 @@ def main():
 
     func = getattr(args, 'func', None)
     if func:
-        with hashserv.create_client(args.address) as client:
-            return func(args, client)
+        client = hashserv.create_client(args.address)
+
+        return func(args, client)
 
     return 0
 

bitbake/bin/bitbake-layers

@@ -68,11 +68,11 @@ def main():
 
         registered = False
         for plugin in plugins:
-            if hasattr(plugin, 'tinfoil_init'):
-                plugin.tinfoil_init(tinfoil)
             if hasattr(plugin, 'register_commands'):
                 registered = True
                 plugin.register_commands(subparsers)
+            if hasattr(plugin, 'tinfoil_init'):
+                plugin.tinfoil_init(tinfoil)
 
         if not registered:
             logger.error("No commands registered - missing plugins?")

bitbake/bin/bitbake-prserv

@@ -1,7 +1,5 @@
 #!/usr/bin/env python3
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/bin/bitbake-server

@@ -12,9 +12,8 @@ warnings.simplefilter("default")
 import logging
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(sys.argv[0])), 'lib'))
 
-import bb
-
-bb.utils.check_system_locale()
+if sys.getfilesystemencoding() != "utf-8":
+    sys.exit("Please use a locale setting which supports UTF-8 (such as LANG=en_US.UTF-8).\nPython can't change the filesystem locale after loading so we need a UTF-8 when Python starts or things won't work.")
 
 # Users shouldn't be running this code directly
 if len(sys.argv) != 10 or not sys.argv[1].startswith("decafbad"):

bitbake/bin/bitbake-worker

@@ -1,7 +1,5 @@
 #!/usr/bin/env python3
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 
@@ -24,7 +22,8 @@ import subprocess
 from multiprocessing import Lock
 from threading import Thread
 
-bb.utils.check_system_locale()
+if sys.getfilesystemencoding() != "utf-8":
+    sys.exit("Please use a locale setting which supports UTF-8 (such as LANG=en_US.UTF-8).\nPython can't change the filesystem locale after loading so we need a UTF-8 when Python starts or things won't work.")
 
 # Users shouldn't be running this code directly
 if len(sys.argv) != 2 or not sys.argv[1].startswith("decafbad"):
@@ -91,19 +90,19 @@ def worker_fire_prepickled(event):
 worker_thread_exit = False
 
 def worker_flush(worker_queue):
-    worker_queue_int = bytearray()
+    worker_queue_int = b""
     global worker_pipe, worker_thread_exit
 
     while True:
         try:
-            worker_queue_int.extend(worker_queue.get(True, 1))
+            worker_queue_int = worker_queue_int + worker_queue.get(True, 1)
         except queue.Empty:
             pass
         while (worker_queue_int or not worker_queue.empty()):
             try:
                 (_, ready, _) = select.select([], [worker_pipe], [], 1)
                 if not worker_queue.empty():
-                    worker_queue_int.extend(worker_queue.get())
+                    worker_queue_int = worker_queue_int + worker_queue.get()
                 written = os.write(worker_pipe, worker_queue_int)
                 worker_queue_int = worker_queue_int[written:]
             except (IOError, OSError) as e:
@@ -338,12 +337,12 @@ class runQueueWorkerPipe():
         if pipeout:
             pipeout.close()
         bb.utils.nonblockingfd(self.input)
-        self.queue = bytearray()
+        self.queue = b""
 
     def read(self):
         start = len(self.queue)
         try:
-            self.queue.extend(self.input.read(102400) or b"")
+            self.queue = self.queue + (self.input.read(102400) or b"")
         except (OSError, IOError) as e:
             if e.errno != errno.EAGAIN:
                 raise
@@ -371,7 +370,7 @@ class BitbakeWorker(object):
     def __init__(self, din):
         self.input = din
         bb.utils.nonblockingfd(self.input)
-        self.queue = bytearray()
+        self.queue = b""
         self.cookercfg = None
         self.databuilder = None
         self.data = None
@@ -405,7 +404,7 @@ class BitbakeWorker(object):
                     if len(r) == 0:
                         # EOF on pipe, server must have terminated
                         self.sigterm_exception(signal.SIGTERM, None)
-                    self.queue.extend(r)
+                    self.queue = self.queue + r
                 except (OSError, IOError):
                     pass
             if len(self.queue):

bitbake/bin/git-make-shallow

@@ -1,7 +1,5 @@
 #!/usr/bin/env python3
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst

@@ -424,8 +424,8 @@ This fetcher supports the following parameters:
 
 -  *"nobranch":* Tells the fetcher to not check the SHA validation for
    the branch when set to "1". The default is "0". Set this option for
-   the recipe that refers to the commit that is valid for any namespace
-   (branch, tag, ...) instead of the branch.
+   the recipe that refers to the commit that is valid for a tag instead
+   of the branch.
 
 -  *"bareclone":* Tells the fetcher to clone a bare clone into the
    destination directory without checking out a working tree. Only the
@@ -688,8 +688,6 @@ Here is an example URL::
 
 It can also be used when setting mirrors definitions using the :term:`PREMIRRORS` variable.
 
-.. _crate-fetcher:
-
 Crate Fetcher (``crate://``)
 ----------------------------
 
@@ -706,80 +704,6 @@ Here is an example URL::
 
    SRC_URI = "crate://crates.io/glob/0.2.11"
 
-.. _npm-fetcher:
-
-NPM Fetcher (``npm://``)
-------------------------
-
-This submodule fetches source code from an
-`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__
-Javascript package registry.
-
-The format for the :term:`SRC_URI` setting must be::
-
-   SRC_URI = "npm://some.registry.url;ParameterA=xxx;ParameterB=xxx;..."
-
-This fetcher supports the following parameters:
-
--  *"package":* The NPM package name. This is a mandatory parameter.
-
--  *"version":* The NPM package version. This is a mandatory parameter.
-
--  *"downloadfilename":* Specifies the filename used when storing the downloaded file.
-
--  *"destsuffix":* Specifies the directory to use to unpack the package (default: ``npm``).
-
-Note that NPM fetcher only fetches the package source itself. The dependencies
-can be fetched through the `npmsw-fetcher`_.
-
-Here is an example URL with both fetchers::
-
-   SRC_URI = " \
-       npm://registry.npmjs.org/;package=cute-files;version=${PV} \
-       npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \
-       "
-
-See :yocto_docs:`Creating Node Package Manager (NPM) Packages
-</dev-manual/common-tasks.html#creating-node-package-manager-npm-packages>`
-in the Yocto Project manual for details about using
-:yocto_docs:`devtool <https://docs.yoctoproject.org/ref-manual/devtool-reference.html>`
-to automatically create a recipe from an NPM URL.
-
-.. _npmsw-fetcher:
-
-NPM shrinkwrap Fetcher (``npmsw://``)
--------------------------------------
-
-This submodule fetches source code from an
-`NPM shrinkwrap <https://docs.npmjs.com/cli/v8/commands/npm-shrinkwrap>`__
-description file, which lists the dependencies
-of an NPM package while locking their versions.
-
-The format for the :term:`SRC_URI` setting must be::
-
-   SRC_URI = "npmsw://some.registry.url;ParameterA=xxx;ParameterB=xxx;..."
-
-This fetcher supports the following parameters:
-
--  *"dev":* Set this parameter to ``1`` to install "devDependencies".
-
--  *"destsuffix":* Specifies the directory to use to unpack the dependencies
-   (``${S}`` by default).
-
-Note that the shrinkwrap file can also be provided by the recipe for
-the package which has such dependencies, for example::
-
-   SRC_URI = " \
-       npm://registry.npmjs.org/;package=cute-files;version=${PV} \
-       npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \
-       "
-
-Such a file can automatically be generated using
-:yocto_docs:`devtool <https://docs.yoctoproject.org/ref-manual/devtool-reference.html>`
-as described in the :yocto_docs:`Creating Node Package Manager (NPM) Packages
-</dev-manual/common-tasks.html#creating-node-package-manager-npm-packages>`
-section of the Yocto Project.
-
 Other Fetchers
 --------------
 
@@ -789,6 +713,8 @@ Fetch submodules also exist for the following:
 
 -  Mercurial (``hg://``)
 
+-  npm (``npm://``)
+
 -  OSC (``osc://``)
 
 -  Secure FTP (``sftp://``)

bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst

@@ -195,45 +195,22 @@ value. However, if ``A`` is not set, the variable is set to "aval".
 Setting a weak default value (??=)
 ----------------------------------
 
-The weak default value of a variable is the value which that variable
-will expand to if no value has been assigned to it via any of the other
-assignment operators. The "??=" operator takes effect immediately, replacing
-any previously defined weak default value. Here is an example::
+It is possible to use a "weaker" assignment than in the previous section
+by using the "??=" operator. This assignment behaves identical to "?="
+except that the assignment is made at the end of the parsing process
+rather than immediately. Consequently, when multiple "??=" assignments
+exist, the last one is used. Also, any "=" or "?=" assignment will
+override the value set with "??=". Here is an example::
 
-   W ??= "x"
-   A := "${W}" # Immediate variable expansion
-   W ??= "y"
-   B := "${W}" # Immediate variable expansion
-   W ??= "z"
-   C = "${W}"
-   W ?= "i"
+   A ??= "somevalue"
+   A ??= "someothervalue"
 
-After parsing we will have::
+If ``A`` is set before the above statements are
+parsed, the variable retains its value. If ``A`` is not set, the
+variable is set to "someothervalue".
 
-   A = "x"
-   B = "y"
-   C = "i"
-   W = "i"
-
-Appending and prepending non-override style will not substitute the weak
-default value, which means that after parsing::
-
-   W ??= "x"
-   W += "y"
-
-we will have::
-
-   W = " y"
-
-On the other hand, override-style appends/prepends/removes are applied after
-any active weak default value has been substituted::
-
-   W ??= "x"
-   W:append = "y"
-
-After parsing we will have::
-
-   W = "xy"
+Again, this assignment is a "lazy" or "weak" assignment because it does
+not occur until the end of the parsing process.
 
 Immediate variable expansion (:=)
 ---------------------------------

bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst

@@ -401,7 +401,7 @@ overview of their function and contents.
 
       Example usage::
 
-         BB_HASHSERVE_UPSTREAM = "hashserv.yoctoproject.org:8686"
+         BB_HASHSERVE_UPSTREAM = "typhoon.yocto.io:8687"
 
    :term:`BB_INVALIDCONF`
       Used in combination with the ``ConfigParsed`` event to trigger

bitbake/lib/bb/COW.py

@@ -3,8 +3,6 @@
 #
 # Copyright (C) 2006 Tim Ansell
 #
-# SPDX-License-Identifier: GPL-2.0-only
-#
 # Please Note:
 # Be careful when using mutable types (ie Dict and Lists) - operations involving these are SLOW.
 # Assign a file to __warn__ to get warnings about slow operations.

bitbake/lib/bb/__init__.py

@@ -15,13 +15,6 @@ import sys
 if sys.version_info < (3, 6, 0):
     raise RuntimeError("Sorry, python 3.6.0 or later is required for this version of bitbake")
 
-if sys.version_info < (3, 10, 0):
-    # With python 3.8 and 3.9, we see errors of "libgcc_s.so.1 must be installed for pthread_cancel to work"
-    # https://stackoverflow.com/questions/64797838/libgcc-s-so-1-must-be-installed-for-pthread-cancel-to-work
-    # https://bugs.ams1.psf.io/issue42888
-    # so ensure libgcc_s is loaded early on
-    import ctypes
-    libgcc_s = ctypes.CDLL('libgcc_s.so.1')
 
 class BBHandledException(Exception):
     """

bitbake/lib/bb/asyncrpc/__init__.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/asyncrpc/client.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 
@@ -31,17 +29,7 @@ class AsyncClient(object):
 
     async def connect_unix(self, path):
         async def connect_sock():
-            # AF_UNIX has path length issues so chdir here to workaround
-            cwd = os.getcwd()
-            try:
-                os.chdir(os.path.dirname(path))
-                # The socket must be opened synchronously so that CWD doesn't get
-                # changed out from underneath us so we pass as a sock into asyncio
-                sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM, 0)
-                sock.connect(os.path.basename(path))
-            finally:
-               os.chdir(cwd)
-            return await asyncio.open_unix_connection(sock=sock)
+            return await asyncio.open_unix_connection(path)
 
         self._connect_sock = connect_sock
 
@@ -126,12 +114,6 @@ class AsyncClient(object):
             {'ping': {}}
         )
 
-    async def __aenter__(self):
-        return self
-
-    async def __aexit__(self, exc_type, exc_value, traceback):
-        await self.close()
-
 
 class Client(object):
     def __init__(self):
@@ -166,8 +148,14 @@ class Client(object):
             setattr(self, m, self._get_downcall_wrapper(downcall))
 
     def connect_unix(self, path):
-        self.loop.run_until_complete(self.client.connect_unix(path))
-        self.loop.run_until_complete(self.client.connect())
+        # AF_UNIX has path length issues so chdir here to workaround
+        cwd = os.getcwd()
+        try:
+            os.chdir(os.path.dirname(path))
+            self.loop.run_until_complete(self.client.connect_unix(os.path.basename(path)))
+            self.loop.run_until_complete(self.client.connect())
+        finally:
+            os.chdir(cwd)
 
     @property
     def max_chunk(self):
@@ -182,10 +170,3 @@ class Client(object):
         if sys.version_info >= (3, 6):
             self.loop.run_until_complete(self.loop.shutdown_asyncgens())
         self.loop.close()
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        self.close()
-        return False

bitbake/lib/bb/asyncrpc/serv.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/codeparser.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 
@@ -201,22 +199,6 @@ class DummyLogger():
     def flush(self):
         return
 
-
-# Starting with Python 3.8, the ast module exposes all string nodes as a
-# Constant. While earlier versions of the module also have the Constant type
-# those use the Str type to encapsulate strings.
-if sys.version_info < (3, 8):
-    def node_str_value(node):
-        if isinstance(node, ast.Str):
-            return node.s
-        return None
-else:
-    def node_str_value(node):
-        if isinstance(node, ast.Constant) and isinstance(node.value, str):
-            return node.value
-        return None
-
-
 class PythonParser():
     getvars = (".getVar", ".appendVar", ".prependVar", "oe.utils.conditional")
     getvarflags = (".getVarFlag", ".appendVarFlag", ".prependVarFlag")
@@ -241,22 +223,19 @@ class PythonParser():
     def visit_Call(self, node):
         name = self.called_node_name(node.func)
         if name and (name.endswith(self.getvars) or name.endswith(self.getvarflags) or name in self.containsfuncs or name in self.containsanyfuncs):
-            varname = node_str_value(node.args[0])
-            if varname is not None:
-                arg_str_value = None
-                if len(node.args) >= 2:
-                    arg_str_value = node_str_value(node.args[1])
-                if name in self.containsfuncs and arg_str_value is not None:
+            if isinstance(node.args[0], ast.Str):
+                varname = node.args[0].s
+                if name in self.containsfuncs and isinstance(node.args[1], ast.Str):
                     if varname not in self.contains:
                         self.contains[varname] = set()
-                    self.contains[varname].add(arg_str_value)
-                elif name in self.containsanyfuncs and arg_str_value is not None:
+                    self.contains[varname].add(node.args[1].s)
+                elif name in self.containsanyfuncs and isinstance(node.args[1], ast.Str):
                     if varname not in self.contains:
                         self.contains[varname] = set()
-                    self.contains[varname].update(arg_str_value.split())
+                    self.contains[varname].update(node.args[1].s.split())
                 elif name.endswith(self.getvarflags):
-                    if arg_str_value is not None:
-                        self.references.add('%s[%s]' % (varname, arg_str_value))
+                    if isinstance(node.args[1], ast.Str):
+                        self.references.add('%s[%s]' % (varname, node.args[1].s))
                     else:
                         self.warn(node.func, node.args[1])
                 else:
@@ -264,10 +243,10 @@ class PythonParser():
             else:
                 self.warn(node.func, node.args[0])
         elif name and name.endswith(".expand"):
-            arg_str_value = node_str_value(node.args[0])
-            if arg_str_value is not None:
+            if isinstance(node.args[0], ast.Str):
+                value = node.args[0].s
                 d = bb.data.init()
-                parser = d.expandWithRefs(arg_str_value, self.name)
+                parser = d.expandWithRefs(value, self.name)
                 self.references |= parser.references
                 self.execs |= parser.execs
                 for varname in parser.contains:
@@ -275,9 +254,8 @@ class PythonParser():
                         self.contains[varname] = set()
                     self.contains[varname] |= parser.contains[varname]
         elif name in self.execfuncs:
-            arg_str_value = node_str_value(node.args[0])
-            if arg_str_value is not None:
-                self.var_execs.add(arg_str_value)
+            if isinstance(node.args[0], ast.Str):
+                self.var_execs.add(node.args[0].s)
             else:
                 self.warn(node.func, node.args[0])
         elif name and isinstance(node.func, (ast.Name, ast.Attribute)):

bitbake/lib/bb/compress/_pipecompress.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 # Helper library to implement streaming compression and decompression using an

bitbake/lib/bb/compress/lz4.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/compress/zstd.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/cooker.py

@@ -13,6 +13,7 @@ import sys, os, glob, os.path, re, time
 import itertools
 import logging
 import multiprocessing
+import sre_constants
 import threading
 from io import StringIO, UnsupportedOperation
 from contextlib import closing
@@ -1906,7 +1907,7 @@ class CookerCollectFiles(object):
                 try:
                     re.compile(mask)
                     bbmasks.append(mask)
-                except re.error:
+                except sre_constants.error:
                     collectlog.critical("BBMASK contains an invalid regular expression, ignoring: %s" % mask)
 
             # Then validate the combined regular expressions. This should never
@@ -1914,7 +1915,7 @@ class CookerCollectFiles(object):
             bbmask = "|".join(bbmasks)
             try:
                 bbmask_compiled = re.compile(bbmask)
-            except re.error:
+            except sre_constants.error:
                 collectlog.critical("BBMASK is not a valid regular expression, ignoring: %s" % bbmask)
                 bbmask = None
 

bitbake/lib/bb/cookerdata.py

@@ -160,7 +160,12 @@ def catch_parse_error(func):
     def wrapped(fn, *args):
         try:
             return func(fn, *args)
-        except Exception as exc:
+        except IOError as exc:
+            import traceback
+            parselog.critical(traceback.format_exc())
+            parselog.critical("Unable to parse %s: %s" % (fn, exc))
+            raise bb.BBHandledException()
+        except bb.data_smart.ExpansionError as exc:
             import traceback
 
             bbdir = os.path.dirname(__file__) + os.sep
@@ -172,6 +177,9 @@ def catch_parse_error(func):
                     break
             parselog.critical("Unable to parse %s" % fn, exc_info=(exc_class, exc, tb))
             raise bb.BBHandledException()
+        except bb.parse.ParseError as exc:
+            parselog.critical(str(exc))
+            raise bb.BBHandledException()
     return wrapped
 
 @catch_parse_error
@@ -240,7 +248,7 @@ class CookerDataBuilder(object):
         for k in cookercfg.env:
             self.savedenv.setVar(k, cookercfg.env[k])
             if k in bb.data_smart.bitbake_renamed_vars:
-                bb.error('Variable %s from the shell environment has been renamed to %s' % (k, bb.data_smart.bitbake_renamed_vars[k]))
+                bb.error('Shell environment variable %s has been renamed to %s' % (k, bb.data_smart.bitbake_renamed_vars[k]))
                 bb.fatal("Exiting to allow enviroment variables to be corrected")
 
         filtered_keys = bb.utils.approved_variables()
@@ -293,9 +301,14 @@ class CookerDataBuilder(object):
                 bb.event.fire(bb.event.MultiConfigParsed(self.mcdata), self.data)
 
             self.data_hash = data_hash.hexdigest()
+        except (SyntaxError, bb.BBHandledException):
+            raise bb.BBHandledException()
         except bb.data_smart.ExpansionError as e:
             logger.error(str(e))
             raise bb.BBHandledException()
+        except Exception:
+            logger.exception("Error parsing configuration files")
+            raise bb.BBHandledException()
 
 
         # Handle obsolete variable names
@@ -422,7 +435,7 @@ class CookerDataBuilder(object):
                 msg += (" and bitbake did not find a conf/bblayers.conf file in"
                         " the expected location.\nMaybe you accidentally"
                         " invoked bitbake from the wrong directory?")
-            bb.fatal(msg)
+            raise SystemExit(msg)
 
         if not data.getVar("TOPDIR"):
             data.setVar("TOPDIR", os.path.abspath(os.getcwd()))

bitbake/lib/bb/daemonize.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/data.py

@@ -310,7 +310,6 @@ def build_dependencies(key, keys, shelldeps, varflagsexcl, ignored_vars, d):
                 value += "\n_remove of %s" % r
                 deps |= r2.references
                 deps = deps | (keys & r2.execs)
-                value = handle_contains(value, r2.contains, exclusions, d)
             return value
 
         if "vardepvalue" in varflags:

bitbake/lib/bb/data_smart.py

@@ -261,9 +261,12 @@ class VariableHistory(object):
             return
         if 'op' not in loginfo or not loginfo['op']:
             loginfo['op'] = 'set'
+        if 'detail' in loginfo:
+            loginfo['detail'] = str(loginfo['detail'])
         if 'variable' not in loginfo or 'file' not in loginfo:
             raise ValueError("record() missing variable or file.")
         var = loginfo['variable']
+
         if var not in self.variables:
             self.variables[var] = []
         if not isinstance(self.variables[var], list):
@@ -322,8 +325,7 @@ class VariableHistory(object):
                     flag = '[%s] ' % (event['flag'])
                 else:
                     flag = ''
-                o.write("#   %s %s:%s%s\n#     %s\"%s\"\n" % \
-                    (event['op'], event['file'], event['line'], display_func, flag, re.sub('\n', '\n#     ', str(event['detail']))))
+                o.write("#   %s %s:%s%s\n#     %s\"%s\"\n" % (event['op'], event['file'], event['line'], display_func, flag, re.sub('\n', '\n#     ', event['detail'])))
             if len(history) > 1:
                 o.write("# pre-expansion value:\n")
                 o.write('#   "%s"\n' % (commentVal))
@@ -377,7 +379,7 @@ class VariableHistory(object):
             if isset and event['op'] == 'set?':
                 continue
             isset = True
-            items = d.expand(str(event['detail'])).split()
+            items = d.expand(event['detail']).split()
             for item in items:
                 # This is a little crude but is belt-and-braces to avoid us
                 # having to handle every possible operation type specifically

bitbake/lib/bb/event.py

@@ -132,14 +132,8 @@ def print_ui_queue():
     if not _uiready:
         from bb.msg import BBLogFormatter
         # Flush any existing buffered content
-        try:
-            sys.stdout.flush()
-        except:
-            pass
-        try:
-            sys.stderr.flush()
-        except:
-            pass
+        sys.stdout.flush()
+        sys.stderr.flush()
         stdout = logging.StreamHandler(sys.stdout)
         stderr = logging.StreamHandler(sys.stderr)
         formatter = BBLogFormatter("%(levelname)s: %(message)s")

bitbake/lib/bb/exceptions.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/fetch2/__init__.py

@@ -498,30 +498,30 @@ def fetcher_init(d):
     Calls before this must not hit the cache.
     """
 
-    with bb.persist_data.persist('BB_URI_HEADREVS', d) as revs:
-        try:
-            # fetcher_init is called multiple times, so make sure we only save the
-            # revs the first time it is called.
-            if not bb.fetch2.saved_headrevs:
-                bb.fetch2.saved_headrevs = dict(revs)
-        except:
-            pass
+    revs = bb.persist_data.persist('BB_URI_HEADREVS', d)
+    try:
+        # fetcher_init is called multiple times, so make sure we only save the
+        # revs the first time it is called.
+        if not bb.fetch2.saved_headrevs:
+            bb.fetch2.saved_headrevs = dict(revs)
+    except:
+        pass
 
-        # When to drop SCM head revisions controlled by user policy
-        srcrev_policy = d.getVar('BB_SRCREV_POLICY') or "clear"
-        if srcrev_policy == "cache":
-            logger.debug("Keeping SRCREV cache due to cache policy of: %s", srcrev_policy)
-        elif srcrev_policy == "clear":
-            logger.debug("Clearing SRCREV cache due to cache policy of: %s", srcrev_policy)
-            revs.clear()
-        else:
-            raise FetchError("Invalid SRCREV cache policy of: %s" % srcrev_policy)
+    # When to drop SCM head revisions controlled by user policy
+    srcrev_policy = d.getVar('BB_SRCREV_POLICY') or "clear"
+    if srcrev_policy == "cache":
+        logger.debug("Keeping SRCREV cache due to cache policy of: %s", srcrev_policy)
+    elif srcrev_policy == "clear":
+        logger.debug("Clearing SRCREV cache due to cache policy of: %s", srcrev_policy)
+        revs.clear()
+    else:
+        raise FetchError("Invalid SRCREV cache policy of: %s" % srcrev_policy)
 
-        _checksum_cache.init_cache(d)
+    _checksum_cache.init_cache(d)
 
-        for m in methods:
-            if hasattr(m, "init"):
-                m.init(d)
+    for m in methods:
+        if hasattr(m, "init"):
+            m.init(d)
 
 def fetcher_parse_save():
     _checksum_cache.save_extras()
@@ -535,8 +535,8 @@ def fetcher_compare_revisions(d):
     when bitbake was started and return true if they have changed.
     """
 
-    with dict(bb.persist_data.persist('BB_URI_HEADREVS', d)) as headrevs:
-        return headrevs != bb.fetch2.saved_headrevs
+    headrevs = dict(bb.persist_data.persist('BB_URI_HEADREVS', d))
+    return headrevs != bb.fetch2.saved_headrevs
 
 def mirror_from_string(data):
     mirrors = (data or "").replace('\\n',' ').split()
@@ -1097,8 +1097,6 @@ def try_mirror_url(fetch, origud, ud, ld, check = False):
 
 def ensure_symlink(target, link_name):
     if not os.path.exists(link_name):
-        dirname = os.path.dirname(link_name)
-        bb.utils.mkdirhier(dirname)
         if os.path.islink(link_name):
             # Broken symbolic link
             os.unlink(link_name)
@@ -1618,13 +1616,13 @@ class FetchMethod(object):
         if not hasattr(self, "_latest_revision"):
             raise ParameterError("The fetcher for this URL does not support _latest_revision", ud.url)
 
-        with bb.persist_data.persist('BB_URI_HEADREVS', d) as revs:
-            key = self.generate_revision_key(ud, d, name)
-            try:
-                return revs[key]
-            except KeyError:
-                revs[key] = rev = self._latest_revision(ud, d, name)
-                return rev
+        revs = bb.persist_data.persist('BB_URI_HEADREVS', d)
+        key = self.generate_revision_key(ud, d, name)
+        try:
+            return revs[key]
+        except KeyError:
+            revs[key] = rev = self._latest_revision(ud, d, name)
+            return rev
 
     def sortable_revision(self, ud, d, name):
         latest_rev = self._build_revision(ud, d, name)

bitbake/lib/bb/fetch2/git.py

@@ -44,8 +44,7 @@ Supported SRC_URI options are:
 
 - nobranch
    Don't check the SHA validation for branch. set this option for the recipe
-   referring to commit which is valid in any namespace (branch, tag, ...)
-   instead of branch.
+   referring to commit which is valid in tag instead of branch.
    The default is "0", set nobranch=1 if needed.
 
 - usehead
@@ -75,6 +74,9 @@ from   bb.fetch2 import runfetchcmd
 from   bb.fetch2 import logger
 
 
+sha1_re = re.compile(r'^[0-9a-f]{40}$')
+slash_re = re.compile(r"/+")
+
 class GitProgressHandler(bb.progress.LineFilterProgressHandler):
     """Extract progress information from git output"""
     def __init__(self, d):
@@ -250,8 +252,8 @@ class Git(FetchMethod):
         ud.setup_revisions(d)
 
         for name in ud.names:
-            # Ensure anything that doesn't look like a sha256 checksum/revision is translated into one
-            if not ud.revisions[name] or len(ud.revisions[name]) != 40  or (False in [c in "abcdef0123456789" for c in ud.revisions[name]]):
+            # Ensure any revision that doesn't look like a SHA-1 is translated into one
+            if not sha1_re.match(ud.revisions[name] or ''):
                 if ud.revisions[name]:
                     ud.unresolvedrev[name] = ud.revisions[name]
                 ud.revisions[name] = self.latest_revision(ud, d, name)
@@ -260,10 +262,10 @@ class Git(FetchMethod):
         if gitsrcname.startswith('.'):
             gitsrcname = gitsrcname[1:]
 
-        # for rebaseable git repo, it is necessary to keep mirror tar ball
-        # per revision, so that even the revision disappears from the
+        # For a rebaseable git repo, it is necessary to keep a mirror tar ball
+        # per revision, so that even if the revision disappears from the
         # upstream repo in the future, the mirror will remain intact and still
-        # contains the revision
+        # contain the revision
         if ud.rebaseable:
             for name in ud.names:
                 gitsrcname = gitsrcname + '_' + ud.revisions[name]
@@ -307,10 +309,7 @@ class Git(FetchMethod):
         return ud.clonedir
 
     def need_update(self, ud, d):
-        return self.clonedir_need_update(ud, d) \
-                or self.shallow_tarball_need_update(ud) \
-                or self.tarball_need_update(ud) \
-                or self.lfs_need_update(ud, d)
+        return self.clonedir_need_update(ud, d) or self.shallow_tarball_need_update(ud) or self.tarball_need_update(ud)
 
     def clonedir_need_update(self, ud, d):
         if not os.path.exists(ud.clonedir):
@@ -322,15 +321,6 @@ class Git(FetchMethod):
                 return True
         return False
 
-    def lfs_need_update(self, ud, d):
-        if self.clonedir_need_update(ud, d):
-            return True
-
-        for name in ud.names:
-            if not self._lfs_objects_downloaded(ud, d, name, ud.clonedir):
-                return True
-        return False
-
     def clonedir_need_shallow_revs(self, ud, d):
         for rev in ud.shallow_revs:
             try:
@@ -371,13 +361,9 @@ class Git(FetchMethod):
 
         # If the repo still doesn't exist, fallback to cloning it
         if not os.path.exists(ud.clonedir):
-            # We do this since git will use a "-l" option automatically for local urls where possible,
-            # but it doesn't work when git/objects is a symlink, only works when it is a directory.
+            # We do this since git will use a "-l" option automatically for local urls where possible
             if repourl.startswith("file://"):
-                repourl_path = repourl[7:]
-                objects = os.path.join(repourl_path, 'objects')
-                if os.path.isdir(objects) and not os.path.islink(objects):
-                    repourl = repourl_path
+                repourl = repourl[7:]
             clone_cmd = "LANG=C %s clone --bare --mirror %s %s --progress" % (ud.basecmd, shlex.quote(repourl), ud.clonedir)
             if ud.proto.lower() != 'file':
                 bb.fetch2.check_network_access(d, clone_cmd, ud.url)
@@ -391,11 +377,7 @@ class Git(FetchMethod):
               runfetchcmd("%s remote rm origin" % ud.basecmd, d, workdir=ud.clonedir)
 
             runfetchcmd("%s remote add --mirror=fetch origin %s" % (ud.basecmd, shlex.quote(repourl)), d, workdir=ud.clonedir)
-
-            if ud.nobranch:
-                fetch_cmd = "LANG=C %s fetch -f --progress %s refs/*:refs/*" % (ud.basecmd, shlex.quote(repourl))
-            else:
-                fetch_cmd = "LANG=C %s fetch -f --progress %s refs/heads/*:refs/heads/* refs/tags/*:refs/tags/*" % (ud.basecmd, shlex.quote(repourl))
+            fetch_cmd = "LANG=C %s fetch -f --progress %s refs/*:refs/*" % (ud.basecmd, shlex.quote(repourl))
             if ud.proto.lower() != 'file':
                 bb.fetch2.check_network_access(d, fetch_cmd, ud.url)
             progresshandler = GitProgressHandler(d)
@@ -418,7 +400,7 @@ class Git(FetchMethod):
             if missing_rev:
                 raise bb.fetch2.FetchError("Unable to find revision %s even from upstream" % missing_rev)
 
-        if self.lfs_need_update(ud, d):
+        if self._contains_lfs(ud, d, ud.clonedir) and self._need_lfs(ud):
             # Unpack temporary working copy, use it to run 'git checkout' to force pre-fetching
             # of all LFS blobs needed at the srcrev.
             #
@@ -661,35 +643,6 @@ class Git(FetchMethod):
             raise bb.fetch2.FetchError("The command '%s' gave output with more then 1 line unexpectedly, output: '%s'" % (cmd, output))
         return output.split()[0] != "0"
 
-    def _lfs_objects_downloaded(self, ud, d, name, wd):
-        """
-        Verifies whether the LFS objects for requested revisions have already been downloaded
-        """
-        # Bail out early if this repository doesn't use LFS
-        if not self._need_lfs(ud) or not self._contains_lfs(ud, d, wd):
-            return True
-
-        # The Git LFS specification specifies ([1]) the LFS folder layout so it should be safe to check for file
-        # existence.
-        # [1] https://github.com/git-lfs/git-lfs/blob/main/docs/spec.md#intercepting-git
-        cmd = "%s lfs ls-files -l %s" \
-                % (ud.basecmd, ud.revisions[name])
-        output = runfetchcmd(cmd, d, quiet=True, workdir=wd).rstrip()
-        # Do not do any further matching if no objects are managed by LFS
-        if not output:
-            return True
-
-        # Match all lines beginning with the hexadecimal OID
-        oid_regex = re.compile("^(([a-fA-F0-9]{2})([a-fA-F0-9]{2})[A-Fa-f0-9]+)")
-        for line in output.split("\n"):
-            oid = re.search(oid_regex, line)
-            if not oid:
-                bb.warn("git lfs ls-files output '%s' did not match expected format." % line)
-            if not os.path.exists(os.path.join(wd, "lfs", "objects", oid.group(2), oid.group(3), oid.group(1))):
-                return False
-
-        return True
-
     def _need_lfs(self, ud):
         return ud.parm.get("lfs", "1") == "1"
 
@@ -747,7 +700,6 @@ class Git(FetchMethod):
         Return a unique key for the url
         """
         # Collapse adjacent slashes
-        slash_re = re.compile(r"/+")
         return "git:" + ud.host + slash_re.sub(".", ud.path) + ud.unresolvedrev[name]
 
     def _lsremote(self, ud, d, search):
@@ -781,7 +733,7 @@ class Git(FetchMethod):
         Compute the HEAD revision for the url
         """
         if not d.getVar("__BBSEENSRCREV"):
-            raise bb.fetch2.FetchError("Recipe uses a floating tag/branch '%s' for repo '%s' without a fixed SRCREV yet doesn't call bb.fetch2.get_srcrev() (use SRCPV in PV for OE)." % (ud.unresolvedrev[name], ud.host+ud.path))
+            raise bb.fetch2.FetchError("Recipe uses a floating tag/branch without a fixed SRCREV yet doesn't call bb.fetch2.get_srcrev() (use SRCPV in PV for OE).")
 
         # Ensure we mark as not cached
         bb.fetch2.get_autorev(d)
@@ -861,8 +813,9 @@ class Git(FetchMethod):
             commits = None
         else:
             if not os.path.exists(rev_file) or not os.path.getsize(rev_file):
+                from pipes import quote
                 commits = bb.fetch2.runfetchcmd(
-                        "git rev-list %s -- | wc -l" % shlex.quote(rev),
+                        "git rev-list %s -- | wc -l" % quote(rev),
                         d, quiet=True).strip().lstrip('0')
                 if commits:
                     open(rev_file, "w").write("%d\n" % int(commits))

bitbake/lib/bb/fetch2/gitsm.py

@@ -88,7 +88,7 @@ class GitSM(Git):
                 subrevision[m] = module_hash.split()[2]
 
                 # Convert relative to absolute uri based on parent uri
-                if  uris[m].startswith('..') or uris[m].startswith('./'):
+                if uris[m].startswith('..'):
                     newud = copy.copy(ud)
                     newud.path = os.path.realpath(os.path.join(newud.path, uris[m]))
                     uris[m] = Git._get_repo_url(self, newud)
@@ -115,9 +115,6 @@ class GitSM(Git):
                     # This has to be a file reference
                     proto = "file"
                     url = "gitsm://" + uris[module]
-            if url.endswith("{}{}".format(ud.host, ud.path)):
-                raise bb.fetch2.FetchError("Submodule refers to the parent repository. This will cause deadlock situation in current version of Bitbake." \
-                                           "Consider using git fetcher instead.")
 
             url += ';protocol=%s' % proto
             url += ";name=%s" % module
@@ -139,19 +136,6 @@ class GitSM(Git):
 
         return submodules != []
 
-    def call_process_submodules(self, ud, d, extra_check, subfunc):
-        # If we're using a shallow mirror tarball it needs to be
-        # unpacked temporarily so that we can examine the .gitmodules file
-        if ud.shallow and os.path.exists(ud.fullshallow) and extra_check:
-            tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR"))
-            try:
-                runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir)
-                self.process_submodules(ud, tmpdir, subfunc, d)
-            finally:
-                shutil.rmtree(tmpdir)
-        else:
-            self.process_submodules(ud, ud.clonedir, subfunc, d)
-
     def need_update(self, ud, d):
         if Git.need_update(self, ud, d):
             return True
@@ -169,7 +153,15 @@ class GitSM(Git):
                 logger.error('gitsm: submodule update check failed: %s %s' % (type(e).__name__, str(e)))
                 need_update_result = True
 
-        self.call_process_submodules(ud, d, not os.path.exists(ud.clonedir), need_update_submodule)
+        # If we're using a shallow mirror tarball it needs to be unpacked
+        # temporarily so that we can examine the .gitmodules file
+        if ud.shallow and os.path.exists(ud.fullshallow) and not os.path.exists(ud.clonedir):
+            tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR"))
+            runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir)
+            self.process_submodules(ud, tmpdir, need_update_submodule, d)
+            shutil.rmtree(tmpdir)
+        else:
+            self.process_submodules(ud, ud.clonedir, need_update_submodule, d)
 
         if need_update_list:
             logger.debug('gitsm: Submodules requiring update: %s' % (' '.join(need_update_list)))
@@ -192,7 +184,16 @@ class GitSM(Git):
                 raise
 
         Git.download(self, ud, d)
-        self.call_process_submodules(ud, d, self.need_update(ud, d), download_submodule)
+
+        # If we're using a shallow mirror tarball it needs to be unpacked
+        # temporarily so that we can examine the .gitmodules file
+        if ud.shallow and os.path.exists(ud.fullshallow) and self.need_update(ud, d):
+            tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR"))
+            runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir)
+            self.process_submodules(ud, tmpdir, download_submodule, d)
+            shutil.rmtree(tmpdir)
+        else:
+            self.process_submodules(ud, ud.clonedir, download_submodule, d)
 
     def unpack(self, ud, destdir, d):
         def unpack_submodules(ud, url, module, modpath, workdir, d):
@@ -245,6 +246,14 @@ class GitSM(Git):
             newfetch = Fetch([url], d, cache=False)
             urldata.extend(newfetch.expanded_urldata())
 
-        self.call_process_submodules(ud, d, ud.method.need_update(ud, d), add_submodule)
+        # If we're using a shallow mirror tarball it needs to be unpacked
+        # temporarily so that we can examine the .gitmodules file
+        if ud.shallow and os.path.exists(ud.fullshallow) and ud.method.need_update(ud, d):
+            tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR"))
+            subprocess.check_call("tar -xzf %s" % ud.fullshallow, cwd=tmpdir, shell=True)
+            self.process_submodules(ud, tmpdir, add_submodule, d)
+            shutil.rmtree(tmpdir)
+        else:
+            self.process_submodules(ud, ud.clonedir, add_submodule, d)
 
         return urldata

bitbake/lib/bb/fetch2/npm.py

@@ -156,7 +156,7 @@ class Npm(FetchMethod):
             raise ParameterError("Invalid 'version' parameter", ud.url)
 
         # Extract the 'registry' part of the url
-        ud.registry = re.sub(r"^npm://", "https://", ud.url.split(";")[0])
+        ud.registry = re.sub(r"^npm://", "http://", ud.url.split(";")[0])
 
         # Using the 'downloadfilename' parameter as local filename
         # or the npm package name.

bitbake/lib/bb/fetch2/osc.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 """
@@ -11,6 +9,7 @@ Based on the svn "Fetch" implementation.
 
 import logging
 import os
+import re
 import  bb
 from    bb.fetch2 import FetchMethod
 from    bb.fetch2 import FetchError
@@ -62,26 +61,49 @@ class Osc(FetchMethod):
 
         basecmd = d.getVar("FETCHCMD_osc") or "/usr/bin/env osc"
 
-        proto = ud.parm.get('protocol', 'ocs')
+        proto = ud.parm.get('protocol', 'https')
 
         options = []
 
         config = "-c %s" % self.generate_config(ud, d)
 
-        if ud.revision:
+        if getattr(ud, 'revision', ''):
             options.append("-r %s" % ud.revision)
 
         coroot = self._strip_leading_slashes(ud.path)
 
         if command == "fetch":
-            osccmd = "%s %s co %s/%s %s" % (basecmd, config, coroot, ud.module, " ".join(options))
+            osccmd = "%s %s -A %s://%s co %s/%s %s" % (basecmd, config, proto, ud.host, coroot, ud.module, " ".join(options))
         elif command == "update":
-            osccmd = "%s %s up %s" % (basecmd, config, " ".join(options))
+            osccmd = "%s %s -A %s://%s up %s" % (basecmd, config, proto, ud.host, " ".join(options))
+        elif command == "api_source":
+            osccmd = "%s %s -A %s://%s api source/%s/%s" % (basecmd, config, proto, ud.host, coroot, ud.module)
         else:
             raise FetchError("Invalid osc command %s" % command, ud.url)
 
         return osccmd
 
+    def _latest_revision(self, ud, d, name):
+        """
+        Fetch latest revision for the given package
+        """
+        api_source_cmd = self._buildosccommand(ud, d, "api_source")
+
+        output = runfetchcmd(api_source_cmd, d)
+        match = re.match(r'<directory ?.* rev="(\d+)".*>', output)
+        if match is None:
+            raise FetchError("Unable to parse osc response", ud.url)
+        return match.groups()[0]
+
+    def _revision_key(self, ud, d, name):
+        """
+        Return a unique key for the url
+        """
+        # Collapse adjacent slashes
+        slash_re = re.compile(r"/+")
+        rev = getattr(ud, 'revision', "latest")
+        return "osc:%s%s.%s.%s" % (ud.host, slash_re.sub(".", ud.path), name, rev)
+
     def download(self, ud, d):
         """
         Fetch url
@@ -125,7 +147,7 @@ class Osc(FetchMethod):
             os.remove(config_path)
 
         f = open(config_path, 'w')
-        proto = ud.parm.get('proto', 'https')
+        proto = ud.parm.get('protocol', 'https')
         f.write("[general]\n")
         f.write("apiurl = %s://%s\n" % (proto, ud.host))
         f.write("su-wrapper = su -c\n")

bitbake/lib/bb/fetch2/wget.py

@@ -88,10 +88,7 @@ class Wget(FetchMethod):
         if not ud.localfile:
             ud.localfile = d.expand(urllib.parse.unquote(ud.host + ud.path).replace("/", "."))
 
-        self.basecmd = d.getVar("FETCHCMD_wget") or "/usr/bin/env wget -t 2 -T 100"
-
-        if ud.type == 'ftp' or ud.type == 'ftps':
-            self.basecmd += " --passive-ftp"
+        self.basecmd = d.getVar("FETCHCMD_wget") or "/usr/bin/env wget -t 2 -T 30 --passive-ftp"
 
         if not self.check_certs(d):
             self.basecmd += " --no-check-certificate"
@@ -109,10 +106,10 @@ class Wget(FetchMethod):
 
         fetchcmd = self.basecmd
 
-        dldir = os.path.realpath(d.getVar("DL_DIR"))
-        localpath = os.path.join(dldir, ud.localfile) + ".tmp"
-        bb.utils.mkdirhier(os.path.dirname(localpath))
-        fetchcmd += " -O %s" % shlex.quote(localpath)
+        if 'downloadfilename' in ud.parm:
+            localpath = os.path.join(d.getVar("DL_DIR"), ud.localfile)
+            bb.utils.mkdirhier(os.path.dirname(localpath))
+            fetchcmd += " -O %s" % shlex.quote(localpath)
 
         if ud.user and ud.pswd:
             fetchcmd += " --auth-no-challenge"
@@ -130,16 +127,12 @@ class Wget(FetchMethod):
         uri = ud.url.split(";")[0]
         if os.path.exists(ud.localpath):
             # file exists, but we didnt complete it.. trying again..
-            fetchcmd += " -c -P " + dldir + " '" + uri + "'"
+            fetchcmd += d.expand(" -c -P ${DL_DIR} '%s'" % uri)
         else:
-            fetchcmd += " -P " + dldir + " '" + uri + "'"
+            fetchcmd += d.expand(" -P ${DL_DIR} '%s'" % uri)
 
         self._runwget(ud, d, fetchcmd, False)
 
-        # Remove the ".tmp" and move the file into position atomically
-        # Our lock prevents multiple writers but mirroring code may grab incomplete files
-        os.rename(localpath, localpath[:-4])
-
         # Sanity check since wget can pretend it succeed when it didn't
         # Also, this used to happen if sourceforge sent us to the mirror page
         if not os.path.exists(ud.localpath):
@@ -365,7 +358,7 @@ class Wget(FetchMethod):
                 except (TypeError, ImportError, IOError, netrc.NetrcParseError):
                     pass
 
-                with opener.open(r, timeout=100) as response:
+                with opener.open(r, timeout=30) as response:
                     pass
             except urllib.error.URLError as e:
                 if try_again:

bitbake/lib/bb/monitordisk.py

@@ -234,10 +234,9 @@ class diskMonitor:
                 freeInode = st.f_favail
 
                 if minInode and freeInode < minInode:
-                    # Some filesystems use dynamic inodes so can't run out.
-                    # This is reported by the inode count being 0 (btrfs) or the free
-                    # inode count being -1 (cephfs).
-                    if st.f_files == 0 or st.f_favail == -1:
+                    # Some filesystems use dynamic inodes so can't run out
+                    # (e.g. btrfs). This is reported by the inode count being 0.
+                    if st.f_files == 0:
                         self.devDict[k][2] = None
                         continue
                     # Always show warning, the self.checked would always be False if the action is WARN

bitbake/lib/bb/parse/__init__.py

@@ -49,23 +49,20 @@ class SkipPackage(SkipRecipe):
 __mtime_cache = {}
 def cached_mtime(f):
     if f not in __mtime_cache:
-        res = os.stat(f)
-        __mtime_cache[f] = (res.st_mtime_ns, res.st_size, res.st_ino)
+        __mtime_cache[f] = os.stat(f)[stat.ST_MTIME]
     return __mtime_cache[f]
 
 def cached_mtime_noerror(f):
     if f not in __mtime_cache:
         try:
-            res = os.stat(f)
-            __mtime_cache[f] = (res.st_mtime_ns, res.st_size, res.st_ino)
+            __mtime_cache[f] = os.stat(f)[stat.ST_MTIME]
         except OSError:
             return 0
     return __mtime_cache[f]
 
 def update_mtime(f):
     try:
-        res = os.stat(f)
-        __mtime_cache[f] = (res.st_mtime_ns, res.st_size, res.st_ino)
+        __mtime_cache[f] = os.stat(f)[stat.ST_MTIME]
     except OSError:
         if f in __mtime_cache:
             del __mtime_cache[f]

bitbake/lib/bb/parse/parse_py/BBHandler.py

@@ -178,10 +178,10 @@ def feeder(lineno, s, fn, root, statements, eof=False):
 
     if s and s[0] == '#':
         if len(__residue__) != 0 and __residue__[0][0] != "#":
-            bb.fatal("There is a comment on line %s of file %s:\n'''\n%s\n'''\nwhich is in the middle of a multiline expression. This syntax is invalid, please correct it." % (lineno, fn, s))
+            bb.fatal("There is a comment on line %s of file %s (%s) which is in the middle of a multiline expression.\nBitbake used to ignore these but no longer does so, please fix your metadata as errors are likely as a result of this change." % (lineno, fn, s))
 
     if len(__residue__) != 0 and __residue__[0][0] == "#" and (not s or s[0] != "#"):
-        bb.fatal("There is a confusing multiline partially commented expression on line %s of file %s:\n%s\nPlease clarify whether this is all a comment or should be parsed." % (lineno - len(__residue__), fn, "\n".join(__residue__)))
+        bb.fatal("There is a confusing multiline, partially commented expression on line %s of file %s (%s).\nPlease clarify whether this is all a comment or should be parsed." % (lineno, fn, s))
 
     if s and s[-1] == '\\':
         __residue__.append(s[:-1])

bitbake/lib/bb/parse/parse_py/ConfHandler.py

@@ -125,21 +125,16 @@ def handle(fn, data, include):
             s = f.readline()
             if not s:
                 break
-            origlineno = lineno
-            origline = s
             w = s.strip()
             # skip empty lines
             if not w:
                 continue
             s = s.rstrip()
             while s[-1] == '\\':
-                line = f.readline()
-                origline += line
-                s2 = line.rstrip()
+                s2 = f.readline().rstrip()
                 lineno = lineno + 1
                 if (not s2 or s2 and s2[0] != "#") and s[0] == "#" :
-                    bb.fatal("There is a confusing multiline, partially commented expression starting on line %s of file %s:\n%s\nPlease clarify whether this is all a comment or should be parsed." % (origlineno, fn, origline))
-
+                    bb.fatal("There is a confusing multiline, partially commented expression on line %s of file %s (%s).\nPlease clarify whether this is all a comment or should be parsed." % (lineno, fn, s))
                 s = s[:-1] + s2
             # skip comments
             if s[0] == '#':
@@ -152,6 +147,8 @@ def handle(fn, data, include):
     if oldfile:
         data.setVar('FILE', oldfile)
 
+    f.close()
+
     for f in confFilters:
         f(fn, data)
 

bitbake/lib/bb/persist_data.py

@@ -154,7 +154,6 @@ class SQLTable(collections.abc.MutableMapping):
 
     def __exit__(self, *excinfo):
         self.connection.__exit__(*excinfo)
-        self.connection.close()
 
     @_Decorators.retry()
     @_Decorators.transaction

bitbake/lib/bb/process.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/runqueue.py

@@ -24,7 +24,6 @@ import pickle
 from multiprocessing import Process
 import shlex
 import pprint
-import time
 
 bblogger = logging.getLogger("BitBake")
 logger = logging.getLogger("BitBake.RunQueue")
@@ -160,67 +159,6 @@ class RunQueueScheduler(object):
                 self.buildable.append(tid)
 
         self.rev_prio_map = None
-        self.is_pressure_usable()
-
-    def is_pressure_usable(self):
-        """
-        If monitoring pressure, return True if pressure files can be open and read. For example
-        openSUSE /proc/pressure/* files have readable file permissions but when read the error EOPNOTSUPP (Operation not supported)
-        is returned.
-        """
-        if self.rq.max_cpu_pressure or self.rq.max_io_pressure or self.rq.max_memory_pressure:
-            try:
-                with open("/proc/pressure/cpu") as cpu_pressure_fds, \
-                    open("/proc/pressure/io") as io_pressure_fds, \
-                    open("/proc/pressure/memory") as memory_pressure_fds:
-
-                    self.prev_cpu_pressure = cpu_pressure_fds.readline().split()[4].split("=")[1]
-                    self.prev_io_pressure = io_pressure_fds.readline().split()[4].split("=")[1]
-                    self.prev_memory_pressure = memory_pressure_fds.readline().split()[4].split("=")[1]
-                    self.prev_pressure_time = time.time()
-                self.check_pressure = True
-            except:
-                bb.note("The /proc/pressure files can't be read. Continuing build without monitoring pressure")
-                self.check_pressure = False
-        else:
-            self.check_pressure = False
-
-    def exceeds_max_pressure(self):
-        """
-        Monitor the difference in total pressure at least once per second, if
-        BB_PRESSURE_MAX_{CPU|IO|MEMORY} are set, return True if above threshold.
-        """
-        if self.check_pressure:
-            with open("/proc/pressure/cpu") as cpu_pressure_fds, \
-                open("/proc/pressure/io") as io_pressure_fds, \
-                open("/proc/pressure/memory") as memory_pressure_fds:
-                # extract "total" from /proc/pressure/{cpu|io}
-                curr_cpu_pressure = cpu_pressure_fds.readline().split()[4].split("=")[1]
-                curr_io_pressure = io_pressure_fds.readline().split()[4].split("=")[1]
-                curr_memory_pressure = memory_pressure_fds.readline().split()[4].split("=")[1]
-                now = time.time()
-                tdiff = now - self.prev_pressure_time
-                psi_accumulation_interval = 1.0
-                cpu_pressure = (float(curr_cpu_pressure) - float(self.prev_cpu_pressure)) / tdiff
-                io_pressure = (float(curr_io_pressure) - float(self.prev_io_pressure)) / tdiff
-                memory_pressure = (float(curr_memory_pressure) - float(self.prev_memory_pressure)) / tdiff
-                exceeds_cpu_pressure =  self.rq.max_cpu_pressure and cpu_pressure > self.rq.max_cpu_pressure
-                exceeds_io_pressure =  self.rq.max_io_pressure and io_pressure > self.rq.max_io_pressure
-                exceeds_memory_pressure =  self.rq.max_memory_pressure and memory_pressure > self.rq.max_memory_pressure
-
-                if tdiff > psi_accumulation_interval:
-                    self.prev_cpu_pressure = curr_cpu_pressure
-                    self.prev_io_pressure = curr_io_pressure
-                    self.prev_memory_pressure = curr_memory_pressure
-                    self.prev_pressure_time = now
-
-            pressure_state = (exceeds_cpu_pressure, exceeds_io_pressure, exceeds_memory_pressure)
-            pressure_values = (round(cpu_pressure,1), self.rq.max_cpu_pressure, round(io_pressure,1), self.rq.max_io_pressure, round(memory_pressure,1), self.rq.max_memory_pressure)
-            if hasattr(self, "pressure_state") and pressure_state != self.pressure_state:
-                bb.note("Pressure status changed to CPU: %s, IO: %s, Mem: %s (CPU: %s/%s, IO: %s/%s, Mem: %s/%s) - using %s/%s bitbake threads" % (pressure_state + pressure_values + (len(self.rq.runq_running.difference(self.rq.runq_complete)), self.rq.number_tasks)))
-            self.pressure_state = pressure_state
-            return (exceeds_cpu_pressure or exceeds_io_pressure or exceeds_memory_pressure)
-        return False
 
     def next_buildable_task(self):
         """
@@ -234,12 +172,6 @@ class RunQueueScheduler(object):
         if not buildable:
             return None
 
-        # Bitbake requires that at least one task be active. Only check for pressure if
-        # this is the case, otherwise the pressure limitation could result in no tasks
-        # being active and no new tasks started thereby, at times, breaking the scheduler.
-        if self.rq.stats.active and self.exceeds_max_pressure():
-            return None
-
         # Filter out tasks that have a max number of threads that have been exceeded
         skip_buildable = {}
         for running in self.rq.runq_running.difference(self.rq.runq_complete):
@@ -1767,9 +1699,6 @@ class RunQueueExecute:
 
         self.number_tasks = int(self.cfgData.getVar("BB_NUMBER_THREADS") or 1)
         self.scheduler = self.cfgData.getVar("BB_SCHEDULER") or "speed"
-        self.max_cpu_pressure = self.cfgData.getVar("BB_PRESSURE_MAX_CPU")
-        self.max_io_pressure = self.cfgData.getVar("BB_PRESSURE_MAX_IO")
-        self.max_memory_pressure = self.cfgData.getVar("BB_PRESSURE_MAX_MEMORY")
 
         self.sq_buildable = set()
         self.sq_running = set()
@@ -1804,29 +1733,6 @@ class RunQueueExecute:
         if self.number_tasks <= 0:
              bb.fatal("Invalid BB_NUMBER_THREADS %s" % self.number_tasks)
 
-        lower_limit = 1.0
-        upper_limit = 1000000.0
-        if self.max_cpu_pressure:
-            self.max_cpu_pressure = float(self.max_cpu_pressure)
-            if self.max_cpu_pressure < lower_limit:
-                bb.fatal("Invalid BB_PRESSURE_MAX_CPU %s, minimum value is %s." % (self.max_cpu_pressure, lower_limit))
-            if self.max_cpu_pressure > upper_limit:
-                bb.warn("Your build will be largely unregulated since BB_PRESSURE_MAX_CPU is set to %s. It is very unlikely that such high pressure will be experienced." % (self.max_cpu_pressure))
-
-        if self.max_io_pressure:
-            self.max_io_pressure = float(self.max_io_pressure)
-            if self.max_io_pressure < lower_limit:
-                bb.fatal("Invalid BB_PRESSURE_MAX_IO %s, minimum value is %s." % (self.max_io_pressure, lower_limit))
-            if self.max_io_pressure > upper_limit:
-                bb.warn("Your build will be largely unregulated since BB_PRESSURE_MAX_IO is set to %s. It is very unlikely that such high pressure will be experienced." % (self.max_io_pressure))
-
-        if self.max_memory_pressure:
-            self.max_memory_pressure = float(self.max_memory_pressure)
-            if self.max_memory_pressure < lower_limit:
-                bb.fatal("Invalid BB_PRESSURE_MAX_MEMORY %s, minimum value is %s." % (self.max_memory_pressure, lower_limit))
-            if self.max_memory_pressure > upper_limit:
-                bb.warn("Your build will be largely unregulated since BB_PRESSURE_MAX_MEMORY is set to %s. It is very unlikely that such high pressure will be experienced." % (self.max_io_pressure))
-            
         # List of setscene tasks which we've covered
         self.scenequeue_covered = set()
         # List of tasks which are covered (including setscene ones)
@@ -1986,19 +1892,11 @@ class RunQueueExecute:
                 self.setbuildable(revdep)
                 logger.debug("Marking task %s as buildable", revdep)
 
-        found = None
-        for t in sorted(self.sq_deferred.copy()):
+        for t in self.sq_deferred.copy():
             if self.sq_deferred[t] == task:
-                # Allow the next deferred task to run. Any other deferred tasks should be deferred after that task.
-                # We shouldn't allow all to run at once as it is prone to races.
-                if not found:
-                    bb.debug(1, "Deferred task %s now buildable" % t)
-                    del self.sq_deferred[t]
-                    update_scenequeue_data([t], self.sqdata, self.rqdata, self.rq, self.cooker, self.stampcache, self, summary=False)
-                    found = t
-                else:
-                    bb.debug(1, "Deferring %s after %s" % (t, found))
-                    self.sq_deferred[t] = found
+                logger.debug2("Deferred task %s now buildable" % t)
+                del self.sq_deferred[t]
+                update_scenequeue_data([t], self.sqdata, self.rqdata, self.rq, self.cooker, self.stampcache, self, summary=False)
 
     def task_complete(self, task):
         self.stats.taskCompleted()
@@ -2274,9 +2172,10 @@ class RunQueueExecute:
 
         # No more tasks can be run. If we have deferred setscene tasks we should run them.
         if self.sq_deferred:
-            deferred_tid = list(self.sq_deferred.keys())[0]
-            blocking_tid = self.sq_deferred.pop(deferred_tid)
-            logger.warning("Runqeueue deadlocked on deferred tasks, forcing task %s blocked by %s" % (deferred_tid, blocking_tid))
+            tid = self.sq_deferred.pop(list(self.sq_deferred.keys())[0])
+            logger.warning("Runqeueue deadlocked on deferred tasks, forcing task %s" % tid)
+            if tid not in self.runq_complete:
+                self.sq_task_failoutright(tid)
             return True
 
         if self.failed_tids:
@@ -2400,9 +2299,6 @@ class RunQueueExecute:
                     self.rqdata.runtaskentries[hashtid].unihash = unihash
                     bb.parse.siggen.set_unihash(hashtid, unihash)
                     toprocess.add(hashtid)
-                if torehash:
-                    # Need to save after set_unihash above
-                    bb.parse.siggen.save_unitaskhashes()
 
         # Work out all tasks which depend upon these
         total = set()
@@ -2509,6 +2405,17 @@ class RunQueueExecute:
                 self.sq_buildable.remove(tid)
             if tid in self.sq_running:
                 self.sq_running.remove(tid)
+            harddepfail = False
+            for t in self.sqdata.sq_harddeps:
+                if tid in self.sqdata.sq_harddeps[t] and t in self.scenequeue_notcovered:
+                    harddepfail = True
+                    break
+            if not harddepfail and self.sqdata.sq_revdeps[tid].issubset(self.scenequeue_covered | self.scenequeue_notcovered):
+                if tid not in self.sq_buildable:
+                    self.sq_buildable.add(tid)
+            if not self.sqdata.sq_revdeps[tid]:
+                self.sq_buildable.add(tid)
+
             if tid in self.sqdata.outrightfail:
                 self.sqdata.outrightfail.remove(tid)
             if tid in self.scenequeue_notcovered:
@@ -2527,36 +2434,18 @@ class RunQueueExecute:
             if tid in self.build_stamps:
                 del self.build_stamps[tid]
 
-            update_tasks.append(tid)
+            update_tasks.append((tid, harddepfail, tid in self.sqdata.valid))
 
-        update_tasks2 = []
-        for tid in update_tasks:
-            harddepfail = False
-            for t in self.sqdata.sq_harddeps:
-                if tid in self.sqdata.sq_harddeps[t] and t in self.scenequeue_notcovered:
-                    harddepfail = True
-                    break
-            if not harddepfail and self.sqdata.sq_revdeps[tid].issubset(self.scenequeue_covered | self.scenequeue_notcovered):
-                if tid not in self.sq_buildable:
-                    self.sq_buildable.add(tid)
-            if not self.sqdata.sq_revdeps[tid]:
-                self.sq_buildable.add(tid)
-
-            update_tasks2.append((tid, harddepfail, tid in self.sqdata.valid))
-
-        if update_tasks2:
+        if update_tasks:
             self.sqdone = False
-            for mc in sorted(self.sqdata.multiconfigs):
-                for tid in sorted([t[0] for t in update_tasks2]):
-                    if mc_from_tid(tid) != mc:
-                        continue
-                    h = pending_hash_index(tid, self.rqdata)
-                    if h in self.sqdata.hashes and tid != self.sqdata.hashes[h]:
-                        self.sq_deferred[tid] = self.sqdata.hashes[h]
-                        bb.note("Deferring %s after %s" % (tid, self.sqdata.hashes[h]))
-            update_scenequeue_data([t[0] for t in update_tasks2], self.sqdata, self.rqdata, self.rq, self.cooker, self.stampcache, self, summary=False)
+            for tid in [t[0] for t in update_tasks]:
+                h = pending_hash_index(tid, self.rqdata)
+                if h in self.sqdata.hashes and tid != self.sqdata.hashes[h]:
+                    self.sq_deferred[tid] = self.sqdata.hashes[h]
+                    bb.note("Deferring %s after %s" % (tid, self.sqdata.hashes[h]))
+            update_scenequeue_data([t[0] for t in update_tasks], self.sqdata, self.rqdata, self.rq, self.cooker, self.stampcache, self, summary=False)
 
-        for (tid, harddepfail, origvalid) in update_tasks2:
+        for (tid, harddepfail, origvalid) in update_tasks:
             if tid in self.sqdata.valid and not origvalid:
                 hashequiv_logger.verbose("Setscene task %s became valid" % tid)
             if harddepfail:
@@ -2904,7 +2793,7 @@ def build_scenequeue_data(sqdata, rqdata, rq, cooker, stampcache, sqrq):
                 sqdata.hashes[h] = tid
             else:
                 sqrq.sq_deferred[tid] = sqdata.hashes[h]
-                bb.debug(1, "Deferring %s after %s" % (tid, sqdata.hashes[h]))
+                bb.note("Deferring %s after %s" % (tid, sqdata.hashes[h]))
 
     update_scenequeue_data(sqdata.sq_revdeps, sqdata, rqdata, rq, cooker, stampcache, sqrq, summary=True)
 
@@ -3113,7 +3002,7 @@ class runQueuePipe():
         if pipeout:
             pipeout.close()
         bb.utils.nonblockingfd(self.input)
-        self.queue = bytearray()
+        self.queue = b""
         self.d = d
         self.rq = rq
         self.rqexec = rqexec
@@ -3132,7 +3021,7 @@ class runQueuePipe():
 
         start = len(self.queue)
         try:
-            self.queue.extend(self.input.read(102400) or b"")
+            self.queue = self.queue + (self.input.read(102400) or b"")
         except (OSError, IOError) as e:
             if e.errno != errno.EAGAIN:
                 raise

bitbake/lib/bb/server/process.py

@@ -757,11 +757,8 @@ class ConnectionWriter(object):
                 process.queue_signals = True
                 self._send(obj)
                 process.queue_signals = False
-                try:
-                    for sig in process.signal_received.pop():
-                        process.handle_sig(sig, None)
-                except IndexError:
-                    pass
+                for sig in process.signal_received.pop():
+                    process.handle_sig(sig, None)
         else:
             self._send(obj)
 

bitbake/lib/bb/siggen.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 
@@ -329,19 +327,19 @@ class SignatureGeneratorBasic(SignatureGenerator):
 
         data = self.basehash[tid]
         for dep in self.runtaskdeps[tid]:
-            data += self.get_unihash(dep)
+            data = data + self.get_unihash(dep)
 
         for (f, cs) in self.file_checksum_values[tid]:
             if cs:
                 if "/./" in f:
-                    data += "./" + f.split("/./")[1]
-                data += cs
+                    data = data + "./" + f.split("/./")[1]
+                data = data + cs
 
         if tid in self.taints:
             if self.taints[tid].startswith("nostamp:"):
-                data += self.taints[tid][8:]
+                data = data + self.taints[tid][8:]
             else:
-                data += self.taints[tid]
+                data = data + self.taints[tid]
 
         h = hashlib.sha256(data.encode("utf-8")).hexdigest()
         self.taskhash[tid] = h
@@ -421,7 +419,7 @@ class SignatureGeneratorBasic(SignatureGenerator):
                 bb.error("Taskhash mismatch %s versus %s for %s" % (computed_taskhash, self.taskhash[tid], tid))
                 sigfile = sigfile.replace(self.taskhash[tid], computed_taskhash)
 
-        fd, tmpfile = bb.utils.mkstemp(dir=os.path.dirname(sigfile), prefix="sigtask.")
+        fd, tmpfile = tempfile.mkstemp(dir=os.path.dirname(sigfile), prefix="sigtask.")
         try:
             with bb.compress.zstd.open(fd, "wt", encoding="utf-8", num_threads=1) as f:
                 json.dump(data, f, sort_keys=True, separators=(",", ":"), cls=SetEncoder)

bitbake/lib/bb/tests/codeparser.py

@@ -430,32 +430,6 @@ esac
         self.assertEqual(deps, set(["TESTVAR2"]))
         self.assertEqual(self.d.getVar('ANOTHERVAR').split(), ['testval3', 'anothervalue'])
 
-    def test_contains_vardeps_override_operators(self):
-        # Check override operators handle dependencies correctly with the contains functionality
-        expr_plain = 'testval'
-        expr_prepend = '${@bb.utils.filter("TESTVAR1", "testval1", d)} '
-        expr_append = ' ${@bb.utils.filter("TESTVAR2", "testval2", d)}'
-        expr_remove = '${@bb.utils.contains("TESTVAR3", "no-testval", "testval", "", d)}'
-        # Check dependencies
-        self.d.setVar('ANOTHERVAR', expr_plain)
-        self.d.prependVar('ANOTHERVAR', expr_prepend)
-        self.d.appendVar('ANOTHERVAR', expr_append)
-        self.d.setVar('ANOTHERVAR:remove', expr_remove)
-        self.d.setVar('TESTVAR1', 'blah')
-        self.d.setVar('TESTVAR2', 'testval2')
-        self.d.setVar('TESTVAR3', 'no-testval')
-        deps, values = bb.data.build_dependencies("ANOTHERVAR", set(self.d.keys()), set(), set(), set(), self.d)
-        self.assertEqual(sorted(values.splitlines()),
-                         sorted([
-                          expr_prepend + expr_plain + expr_append,
-                          '_remove of ' + expr_remove,
-                          'TESTVAR1{testval1} = Unset',
-                          'TESTVAR2{testval2} = Set',
-                          'TESTVAR3{no-testval} = Set',
-                          ]))
-        # Check final value
-        self.assertEqual(self.d.getVar('ANOTHERVAR').split(), ['testval2'])
-
     #Currently no wildcard support
     #def test_vardeps_wildcards(self):
     #    self.d.setVar("oe_libinstall", "echo test")

bitbake/lib/bb/tests/compression.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/tests/cooker.py

@@ -1,8 +1,6 @@
 #
 # BitBake Tests for cooker.py
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bb/tests/fetch.py

@@ -6,7 +6,6 @@
 # SPDX-License-Identifier: GPL-2.0-only
 #
 
-import contextlib
 import unittest
 import hashlib
 import tempfile
@@ -1333,12 +1332,12 @@ class FetchLatestVersionTest(FetcherTest):
         ("dtc", "git://git.yoctoproject.org/bbfetchtests-dtc.git;branch=master", "65cc4d2748a2c2e6f27f1cf39e07a5dbabd80ebf", "")
             : "1.4.0",
         # combination version pattern
-        ("sysprof", "git://git.yoctoproject.org/sysprof.git;protocol=https;branch=master", "cd44ee6644c3641507fb53b8a2a69137f2971219", "")
+        ("sysprof", "git://gitlab.gnome.org/GNOME/sysprof.git;protocol=https;branch=master", "cd44ee6644c3641507fb53b8a2a69137f2971219", "")
             : "1.2.0",
-        ("u-boot-mkimage", "git://source.denx.de/u-boot/u-boot.git;branch=master;protocol=https", "62c175fbb8a0f9a926c88294ea9f7e88eb898f6c", "")
+        ("u-boot-mkimage", "git://git.denx.de/u-boot.git;branch=master;protocol=git", "62c175fbb8a0f9a926c88294ea9f7e88eb898f6c", "")
             : "2014.01",
         # version pattern "yyyymmdd"
-        ("mobile-broadband-provider-info", "git://git.yoctoproject.org/mobile-broadband-provider-info.git;protocol=https;branch=master", "4ed19e11c2975105b71b956440acdb25d46a347d", "")
+        ("mobile-broadband-provider-info", "git://gitlab.gnome.org/GNOME/mobile-broadband-provider-info.git;protocol=https;branch=master", "4ed19e11c2975105b71b956440acdb25d46a347d", "")
             : "20120614",
         # packages with a valid UPSTREAM_CHECK_GITTAGREGEX
                 # mirror of git://anongit.freedesktop.org/xorg/driver/xf86-video-omap since network issues interfered with testing
@@ -1417,7 +1416,7 @@ class FetchLatestVersionTest(FetcherTest):
 
     def test_wget_latest_versionstring(self):
         testdata = os.path.dirname(os.path.abspath(__file__)) + "/fetch-testdata"
-        server = HTTPService(testdata, host="127.0.0.1")
+        server = HTTPService(testdata)
         server.start()
         port = server.port
         try:
@@ -1425,10 +1424,10 @@ class FetchLatestVersionTest(FetcherTest):
                 self.d.setVar("PN", k[0])
                 checkuri = ""
                 if k[2]:
-                    checkuri = "http://127.0.0.1:%s/" % port + k[2]
+                    checkuri = "http://localhost:%s/" % port + k[2]
                 self.d.setVar("UPSTREAM_CHECK_URI", checkuri)
                 self.d.setVar("UPSTREAM_CHECK_REGEX", k[3])
-                url = "http://127.0.0.1:%s/" % port + k[1]
+                url = "http://localhost:%s/" % port + k[1]
                 ud = bb.fetch2.FetchData(url, self.d)
                 pupver = ud.method.latest_versionstring(ud, self.d)
                 verstring = pupver[0]
@@ -1835,7 +1834,7 @@ class GitShallowTest(FetcherTest):
         self.add_empty_file('bsub', cwd=smdir)
 
         self.git('submodule init', cwd=self.srcdir)
-        self.git('-c protocol.file.allow=always submodule add file://%s' % smdir, cwd=self.srcdir)
+        self.git('submodule add file://%s' % smdir, cwd=self.srcdir)
         self.git('submodule update', cwd=self.srcdir)
         self.git('commit -m submodule -a', cwd=self.srcdir)
 
@@ -1865,7 +1864,7 @@ class GitShallowTest(FetcherTest):
         self.add_empty_file('bsub', cwd=smdir)
 
         self.git('submodule init', cwd=self.srcdir)
-        self.git('-c protocol.file.allow=always submodule add file://%s' % smdir, cwd=self.srcdir)
+        self.git('submodule add file://%s' % smdir, cwd=self.srcdir)
         self.git('submodule update', cwd=self.srcdir)
         self.git('commit -m submodule -a', cwd=self.srcdir)
 
@@ -2160,12 +2159,6 @@ class GitShallowTest(FetcherTest):
         self.assertIn("fstests.doap", dir)
 
 class GitLfsTest(FetcherTest):
-    def skipIfNoGitLFS():
-        import shutil
-        if not shutil.which('git-lfs'):
-            return unittest.skip('git-lfs not installed')
-        return lambda f: f
-
     def setUp(self):
         FetcherTest.setUp(self)
 
@@ -2183,14 +2176,10 @@ class GitLfsTest(FetcherTest):
 
         bb.utils.mkdirhier(self.srcdir)
         self.git_init(cwd=self.srcdir)
-        self.commit_file('.gitattributes', '*.mp3 filter=lfs -text')
-
-    def commit_file(self, filename, content):
-        with open(os.path.join(self.srcdir, filename), "w") as f:
-            f.write(content)
-        self.git(["add", filename], cwd=self.srcdir)
-        self.git(["commit", "-m", "Change"], cwd=self.srcdir)
-        return self.git(["rev-parse", "HEAD"], cwd=self.srcdir).strip()
+        with open(os.path.join(self.srcdir, '.gitattributes'), 'wt') as attrs:
+            attrs.write('*.mp3 filter=lfs -text')
+        self.git(['add', '.gitattributes'], cwd=self.srcdir)
+        self.git(['commit', '-m', "attributes", '.gitattributes'], cwd=self.srcdir)
 
     def fetch(self, uri=None, download=True):
         uris = self.d.getVar('SRC_URI').split()
@@ -2203,82 +2192,6 @@ class GitLfsTest(FetcherTest):
         ud = fetcher.ud[uri]
         return fetcher, ud
 
-    def get_real_git_lfs_file(self):
-        self.d.setVar('PATH', os.environ.get('PATH'))
-        fetcher, ud = self.fetch()
-        fetcher.unpack(self.d.getVar('WORKDIR'))
-        unpacked_lfs_file = os.path.join(self.d.getVar('WORKDIR'), 'git', "Cat_poster_1.jpg")
-        return unpacked_lfs_file
-
-    @skipIfNoGitLFS()
-    def test_fetch_lfs_on_srcrev_change(self):
-        """Test if fetch downloads missing LFS objects when a different revision within an existing repository is requested"""
-        self.git(["lfs", "install", "--local"], cwd=self.srcdir)
-
-        @contextlib.contextmanager
-        def hide_upstream_repository():
-            """Hide the upstream repository to make sure that git lfs cannot pull from it"""
-            temp_name = self.srcdir + ".bak"
-            os.rename(self.srcdir, temp_name)
-            try:
-                yield
-            finally:
-                os.rename(temp_name, self.srcdir)
-
-        def fetch_and_verify(revision, filename, content):
-            self.d.setVar('SRCREV', revision)
-            fetcher, ud = self.fetch()
-
-            with hide_upstream_repository():
-                workdir = self.d.getVar('WORKDIR')
-                fetcher.unpack(workdir)
-
-                with open(os.path.join(workdir, "git", filename)) as f:
-                    self.assertEqual(f.read(), content)
-
-        commit_1 = self.commit_file("a.mp3", "version 1")
-        commit_2 = self.commit_file("a.mp3", "version 2")
-
-        self.d.setVar('SRC_URI', "git://%s;protocol=file;lfs=1;branch=master" % self.srcdir)
-
-        # Seed the local download folder by fetching the latest commit and verifying that the LFS contents are
-        # available even when the upstream repository disappears.
-        fetch_and_verify(commit_2, "a.mp3", "version 2")
-        # Verify that even when an older revision is fetched, the needed LFS objects are fetched into the download
-        # folder.
-        fetch_and_verify(commit_1, "a.mp3", "version 1")
-
-    @skipIfNoGitLFS()
-    @skipIfNoNetwork()
-    def test_real_git_lfs_repo_succeeds_without_lfs_param(self):
-        self.d.setVar('SRC_URI', "git://gitlab.com/gitlab-examples/lfs.git;protocol=https;branch=master")
-        f = self.get_real_git_lfs_file()
-        self.assertTrue(os.path.exists(f))
-        self.assertEqual("c0baab607a97839c9a328b4310713307", bb.utils.md5_file(f))
-
-    @skipIfNoGitLFS()
-    @skipIfNoNetwork()
-    def test_real_git_lfs_repo_succeeds(self):
-        self.d.setVar('SRC_URI', "git://gitlab.com/gitlab-examples/lfs.git;protocol=https;branch=master;lfs=1")
-        f = self.get_real_git_lfs_file()
-        self.assertTrue(os.path.exists(f))
-        self.assertEqual("c0baab607a97839c9a328b4310713307", bb.utils.md5_file(f))
-
-    @skipIfNoGitLFS()
-    @skipIfNoNetwork()
-    def test_real_git_lfs_repo_succeeds(self):
-        self.d.setVar('SRC_URI', "git://gitlab.com/gitlab-examples/lfs.git;protocol=https;branch=master;lfs=0")
-        f = self.get_real_git_lfs_file()
-        # This is the actual non-smudged placeholder file on the repo if git-lfs does not run
-        lfs_file = (
-                   'version https://git-lfs.github.com/spec/v1\n'
-                   'oid sha256:34be66b1a39a1955b46a12588df9d5f6fc1da790e05cf01f3c7422f4bbbdc26b\n'
-                   'size 11423554\n'
-        )
-
-        with open(f) as fh:
-            self.assertEqual(lfs_file, fh.read())
-
     def test_lfs_enabled(self):
         import shutil
 
@@ -2297,16 +2210,12 @@ class GitLfsTest(FetcherTest):
             shutil.rmtree(self.gitdir, ignore_errors=True)
             fetcher.unpack(self.d.getVar('WORKDIR'))
 
-        old_find_git_lfs = ud.method._find_git_lfs
-        try:
-            # If git-lfs cannot be found, the unpack should throw an error
-            with self.assertRaises(bb.fetch2.FetchError):
-                fetcher.download()
-                ud.method._find_git_lfs = lambda d: False
-                shutil.rmtree(self.gitdir, ignore_errors=True)
-                fetcher.unpack(self.d.getVar('WORKDIR'))
-        finally:
-            ud.method._find_git_lfs = old_find_git_lfs
+        # If git-lfs cannot be found, the unpack should throw an error
+        with self.assertRaises(bb.fetch2.FetchError):
+            fetcher.download()
+            ud.method._find_git_lfs = lambda d: False
+            shutil.rmtree(self.gitdir, ignore_errors=True)
+            fetcher.unpack(self.d.getVar('WORKDIR'))
 
     def test_lfs_disabled(self):
         import shutil
@@ -2321,21 +2230,17 @@ class GitLfsTest(FetcherTest):
         fetcher, ud = self.fetch()
         self.assertIsNotNone(ud.method._find_git_lfs)
 
-        old_find_git_lfs = ud.method._find_git_lfs
-        try:
-            # If git-lfs can be found, the unpack should be successful. A
-            # live copy of git-lfs is not required for this case, so
-            # unconditionally forge its presence.
-            ud.method._find_git_lfs = lambda d: True
-            shutil.rmtree(self.gitdir, ignore_errors=True)
-            fetcher.unpack(self.d.getVar('WORKDIR'))
-            # If git-lfs cannot be found, the unpack should be successful
+        # If git-lfs can be found, the unpack should be successful. A
+        # live copy of git-lfs is not required for this case, so
+        # unconditionally forge its presence.
+        ud.method._find_git_lfs = lambda d: True
+        shutil.rmtree(self.gitdir, ignore_errors=True)
+        fetcher.unpack(self.d.getVar('WORKDIR'))
 
-            ud.method._find_git_lfs = lambda d: False
-            shutil.rmtree(self.gitdir, ignore_errors=True)
-            fetcher.unpack(self.d.getVar('WORKDIR'))
-        finally:
-            ud.method._find_git_lfs = old_find_git_lfs
+        # If git-lfs cannot be found, the unpack should be successful
+        ud.method._find_git_lfs = lambda d: False
+        shutil.rmtree(self.gitdir, ignore_errors=True)
+        fetcher.unpack(self.d.getVar('WORKDIR'))
 
 class GitURLWithSpacesTest(FetcherTest):
     test_git_urls = {

bitbake/lib/bb/tests/parse.py

@@ -194,26 +194,3 @@ deltask ${EMPTYVAR}
         self.assertTrue('addtask ignored: " do_patch"' in stdout)
         #self.assertTrue('dependent task do_foo for do_patch does not exist' in stdout)
 
-    broken_multiline_comment = """
-# First line of comment \\
-# Second line of comment \\
-
-"""
-    def test_parse_broken_multiline_comment(self):
-        f = self.parsehelper(self.broken_multiline_comment)
-        with self.assertRaises(bb.BBHandledException):
-            d = bb.parse.handle(f.name, self.d)['']
-
-
-    comment_in_var = """
-VAR = " \\
-    SOMEVAL \\
-#   some comment \\
-    SOMEOTHERVAL \\
-"
-"""
-    def test_parse_comment_in_var(self):
-        f = self.parsehelper(self.comment_in_var)
-        with self.assertRaises(bb.BBHandledException):
-            d = bb.parse.handle(f.name, self.d)['']
-

bitbake/lib/bb/tinfoil.py

@@ -324,11 +324,11 @@ class Tinfoil:
         self.recipes_parsed = False
         self.quiet = 0
         self.oldhandlers = self.logger.handlers[:]
-        self.localhandlers = []
         if setup_logging:
             # This is the *client-side* logger, nothing to do with
             # logging messages from the server
             bb.msg.logger_create('BitBake', output)
+            self.localhandlers = []
             for handler in self.logger.handlers:
                 if handler not in self.oldhandlers:
                     self.localhandlers.append(handler)

bitbake/lib/bb/utils.py

@@ -13,7 +13,6 @@ import errno
 import logging
 import bb
 import bb.msg
-import locale
 import multiprocessing
 import fcntl
 import importlib
@@ -29,8 +28,6 @@ import signal
 import collections
 import copy
 import ctypes
-import random
-import tempfile
 from subprocess import getstatusoutput
 from contextlib import contextmanager
 from ctypes import cdll
@@ -432,14 +429,12 @@ def better_eval(source, locals, extraglobals = None):
     return eval(source, ctx, locals)
 
 @contextmanager
-def fileslocked(files, *args, **kwargs):
+def fileslocked(files):
     """Context manager for locking and unlocking file locks."""
     locks = []
     if files:
         for lockfile in files:
-            l = bb.utils.lockfile(lockfile, *args, **kwargs)
-            if l is not None:
-                locks.append(l)
+            locks.append(bb.utils.lockfile(lockfile))
 
     try:
         yield
@@ -546,12 +541,7 @@ def md5_file(filename):
     Return the hex string representation of the MD5 checksum of filename.
     """
     import hashlib
-    try:
-        sig = hashlib.new('MD5', usedforsecurity=False)
-    except TypeError:
-        # Some configurations don't appear to support two arguments
-        sig = hashlib.new('MD5')
-    return _hasher(sig, filename)
+    return _hasher(hashlib.new('MD5', usedforsecurity=False), filename)
 
 def sha256_file(filename):
     """
@@ -607,21 +597,6 @@ def preserved_envvars():
     ]
     return v + preserved_envvars_exported()
 
-def check_system_locale():
-    """Make sure the required system locale are available and configured"""
-    default_locale = locale.getlocale(locale.LC_CTYPE)
-
-    try:
-        locale.setlocale(locale.LC_CTYPE, ("en_US", "UTF-8"))
-    except:
-        sys.exit("Please make sure locale 'en_US.UTF-8' is available on your system")
-    else:
-        locale.setlocale(locale.LC_CTYPE, default_locale)
-
-    if sys.getfilesystemencoding() != "utf-8":
-        sys.exit("Please use a locale setting which supports UTF-8 (such as LANG=en_US.UTF-8).\n"
-                 "Python can't change the filesystem locale after loading so we need a UTF-8 when Python starts or things won't work.")
-
 def filter_environment(good_vars):
     """
     Create a pristine environment for bitbake. This will remove variables that
@@ -717,8 +692,8 @@ def remove(path, recurse=False, ionice=False):
         return
     if recurse:
         for name in glob.glob(path):
-            if _check_unsafe_delete_path(name):
-                raise Exception('bb.utils.remove: called with dangerous path "%s" and recurse=True, refusing to delete!' % name)
+            if _check_unsafe_delete_path(path):
+                raise Exception('bb.utils.remove: called with dangerous path "%s" and recurse=True, refusing to delete!' % path)
         # shutil.rmtree(name) would be ideal but its too slow
         cmd = []
         if ionice:
@@ -776,7 +751,7 @@ def movefile(src, dest, newmtime = None, sstat = None):
         if not sstat:
             sstat = os.lstat(src)
     except Exception as e:
-        logger.warning("movefile: Stating source file failed...", e)
+        print("movefile: Stating source file failed...", e)
         return None
 
     destexists = 1
@@ -804,7 +779,7 @@ def movefile(src, dest, newmtime = None, sstat = None):
             os.unlink(src)
             return os.lstat(dest)
         except Exception as e:
-            logger.warning("movefile: failed to properly create symlink:", dest, "->", target, e)
+            print("movefile: failed to properly create symlink:", dest, "->", target, e)
             return None
 
     renamefailed = 1
@@ -821,7 +796,7 @@ def movefile(src, dest, newmtime = None, sstat = None):
         except Exception as e:
             if e.errno != errno.EXDEV:
                 # Some random error.
-                logger.warning("movefile: Failed to move", src, "to", dest, e)
+                print("movefile: Failed to move", src, "to", dest, e)
                 return None
             # Invalid cross-device-link 'bind' mounted or actually Cross-Device
 
@@ -833,13 +808,13 @@ def movefile(src, dest, newmtime = None, sstat = None):
                 bb.utils.rename(destpath + "#new", destpath)
                 didcopy = 1
             except Exception as e:
-                logger.warning('movefile: copy', src, '->', dest, 'failed.', e)
+                print('movefile: copy', src, '->', dest, 'failed.', e)
                 return None
         else:
             #we don't yet handle special, so we need to fall back to /bin/mv
             a = getstatusoutput("/bin/mv -f " + "'" + src + "' '" + dest + "'")
             if a[0] != 0:
-                logger.warning("movefile: Failed to move special file:" + src + "' to '" + dest + "'", a)
+                print("movefile: Failed to move special file:" + src + "' to '" + dest + "'", a)
                 return None # failure
         try:
             if didcopy:
@@ -847,7 +822,7 @@ def movefile(src, dest, newmtime = None, sstat = None):
                 os.chmod(destpath, stat.S_IMODE(sstat[stat.ST_MODE])) # Sticky is reset on chown
                 os.unlink(src)
         except Exception as e:
-            logger.warning("movefile: Failed to chown/chmod/unlink", dest, e)
+            print("movefile: Failed to chown/chmod/unlink", dest, e)
             return None
 
     if newmtime:
@@ -1006,9 +981,6 @@ def to_boolean(string, default=None):
     if not string:
         return default
 
-    if isinstance(string, int):
-        return string != 0
-
     normalized = string.lower()
     if normalized in ("y", "yes", "1", "true"):
         return True
@@ -1659,20 +1631,23 @@ def disable_network(uid=None, gid=None):
 
 def export_proxies(d):
     """ export common proxies variables from datastore to environment """
+    import os
 
     variables = ['http_proxy', 'HTTP_PROXY', 'https_proxy', 'HTTPS_PROXY',
                     'ftp_proxy', 'FTP_PROXY', 'no_proxy', 'NO_PROXY',
-                    'GIT_PROXY_COMMAND', 'SSL_CERT_FILE', 'SSL_CERT_DIR']
+                    'GIT_PROXY_COMMAND']
+    exported = False
 
-    origenv = d.getVar("BB_ORIGENV")
-
-    for name in variables:
-        value = d.getVar(name)
-        if not value and origenv:
-            value = origenv.getVar(name)
-        if value:
-            os.environ[name] = value
+    for v in variables:
+        if v in os.environ.keys():
+            exported = True
+        else:
+            v_proxy = d.getVar(v)
+            if v_proxy is not None:
+                os.environ[v] = v_proxy
+                exported = True
 
+    return exported
 
 
 def load_plugins(logger, plugins, pluginpath):
@@ -1779,22 +1754,3 @@ def is_local_uid(uid=''):
             if str(uid) == line_split[2]:
                 return True
     return False
-
-def mkstemp(suffix=None, prefix=None, dir=None, text=False):
-    """
-    Generates a unique filename, independent of time.
-
-    mkstemp() in glibc (at least) generates unique file names based on the
-    current system time. When combined with highly parallel builds, and
-    operating over NFS (e.g. shared sstate/downloads) this can result in
-    conflicts and race conditions.
-
-    This function adds additional entropy to the file name so that a collision
-    is independent of time and thus extremely unlikely.
-    """
-    entropy = "".join(random.choices("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890", k=20))
-    if prefix:
-        prefix = prefix + entropy
-    else:
-        prefix = tempfile.gettempprefix() + entropy
-    return tempfile.mkstemp(suffix=suffix, prefix=prefix, dir=dir, text=text)

bitbake/lib/bblayers/__init__.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bblayers/action.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bblayers/common.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bblayers/layerindex.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bblayers/query.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/bs4/tests/test_tree.py

@@ -585,7 +585,7 @@ class SiblingTest(TreeTest):
                     </html>'''
         # All that whitespace looks good but makes the tests more
         # difficult. Get rid of it.
-        markup = re.compile(r"\n\s*").sub("", markup)
+        markup = re.compile("\n\s*").sub("", markup)
         self.tree = self.soup(markup)
 
 

bitbake/lib/hashserv/tests.py

@@ -30,7 +30,7 @@ class HashEquivalenceTestSetup(object):
 
     server_index = 0
 
-    def start_server(self, dbpath=None, upstream=None, read_only=False, prefunc=server_prefunc, need_client=True):
+    def start_server(self, dbpath=None, upstream=None, read_only=False, prefunc=server_prefunc):
         self.server_index += 1
         if dbpath is None:
             dbpath = os.path.join(self.temp_dir.name, "db%d.sqlite" % self.server_index)
@@ -54,11 +54,8 @@ class HashEquivalenceTestSetup(object):
         def cleanup_client(client):
             client.close()
 
-        if need_client:
-            client = create_client(server.address)
-            self.addCleanup(cleanup_client, client)
-        else:
-            client = None
+        client = create_client(server.address)
+        self.addCleanup(cleanup_client, client)
 
         return (client, server)
 
@@ -344,7 +341,7 @@ class HashEquivalenceCommonTests(object):
         old_signal = signal.signal(signal.SIGTERM, do_nothing)
         self.addCleanup(signal.signal, signal.SIGTERM, old_signal)
 
-        _, server = self.start_server(prefunc=prefunc, need_client=False)
+        _, server = self.start_server(prefunc=prefunc)
         server.process.terminate()
         time.sleep(30)
         event.set()

bitbake/lib/ply/yacc.py

@@ -2798,14 +2798,7 @@ class ParserReflect(object):
     def signature(self):
         try:
             import hashlib
-        except ImportError:
-            raise RuntimeError("Unable to import hashlib")
-        try:
             sig = hashlib.new('MD5', usedforsecurity=False)
-        except TypeError:
-            # Some configurations don't appear to support two arguments
-            sig = hashlib.new('MD5')
-        try:
             if self.start:
                 sig.update(self.start.encode('latin-1'))
             if self.prec:

bitbake/lib/prserv/__init__.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/prserv/client.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/prserv/db.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/prserv/serv.py

@@ -1,6 +1,4 @@
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 
@@ -344,9 +342,9 @@ def auto_shutdown():
 def ping(host, port):
     from . import client
 
-    with client.PRClient() as conn:
-        conn.connect_tcp(host, port)
-        return conn.ping()
+    conn = client.PRClient()
+    conn.connect_tcp(host, port)
+    return conn.ping()
 
 def connect(host, port):
     from . import client

bitbake/lib/toaster/manage.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python3
 #
-# Copyright BitBake Contributors
-#
 # SPDX-License-Identifier: GPL-2.0-only
 #
 

bitbake/lib/toaster/orm/fixtures/poky.xml

@@ -42,7 +42,7 @@
   <!-- Releases available -->
   <object model="orm.release" pk="1">
     <field type="CharField" name="name">kirkstone</field>
-    <field type="CharField" name="description">Yocto Project 4.0 "Kirkstone"</field>
+    <field type="CharField" name="description">Yocto Project 3.5 "Kirkstone"</field>
     <field rel="ManyToOneRel" to="orm.bitbakeversion" name="bitbake_version">1</field>
     <field type="CharField" name="branch_name">kirkstone</field>
     <field type="TextField" name="helptext">Toaster will run your builds using the tip of the &lt;a href="https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=kirkstone"&gt;Yocto Project Kirkstone branch&lt;/a&gt;.</field>

bitbake/lib/toaster/toastergui/api.py

@@ -11,7 +11,7 @@ import os
 import re
 import logging
 import json
-import glob
+import subprocess
 from collections import Counter
 
 from orm.models import Project, ProjectTarget, Build, Layer_Version
@@ -227,18 +227,20 @@ class XhrSetDefaultImageUrl(View):
 #    same logical name
 #  * Each project that uses a layer will have its own
 #    LayerVersion and Project Layer for it
-#  * During the Project delete process, when the last
+#  * During the Paroject delete process, when the last
 #    LayerVersion for a 'local_source_dir' layer is deleted
 #    then the Layer record is deleted to remove orphans
 #
 
 def scan_layer_content(layer,layer_version):
     # if this is a local layer directory, we can immediately scan its content
-    if os.path.isdir(layer.local_source_dir):
+    if layer.local_source_dir:
         try:
             # recipes-*/*/*.bb
-            recipes_list = glob.glob(os.path.join(layer.local_source_dir, 'recipes-*/*/*.bb'))
-            for recipe in recipes_list:
+            cmd = '%s %s' % ('ls', os.path.join(layer.local_source_dir,'recipes-*/*/*.bb'))
+            recipes_list = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,stderr=subprocess.STDOUT).stdout.read()
+            recipes_list = recipes_list.decode("utf-8").strip()
+            if recipes_list and 'No such' not in recipes_list:
                 for recipe in recipes_list.split('\n'):
                     recipe_path = recipe[recipe.rfind('recipes-'):]
                     recipe_name = recipe[recipe.rfind('/')+1:].replace('.bb','')
@@ -258,9 +260,6 @@ def scan_layer_content(layer,layer_version):
 
         except Exception as e:
             logger.warning("ERROR:scan_layer_content: %s" % e)
-    else:
-        logger.warning("ERROR: wrong path given")
-        raise KeyError("local_source_dir")
 
 class XhrLayer(View):
     """ Delete, Get, Add and Update Layer information
@@ -457,18 +456,15 @@ class XhrLayer(View):
                              'layerdetailurl':
                              layer_dep.get_detailspage_url(project.pk)})
 
-            # Only scan_layer_content if layer is local
-            if layer_data.get('local_source_dir', None):
-                # Scan the layer's content and update components
-                scan_layer_content(layer,layer_version)
+            # Scan the layer's content and update components
+            scan_layer_content(layer,layer_version)
 
         except Layer_Version.DoesNotExist:
             return error_response("layer-dep-not-found")
         except Project.DoesNotExist:
             return error_response("project-not-found")
-        except KeyError as e:
-            _log("KeyError: %s" % e)
-            return error_response(f"incorrect-parameters")
+        except KeyError:
+            return error_response("incorrect-parameters")
 
         return JsonResponse({'error': "ok",
                              'imported_layer': {

documentation/.gitignore

@@ -5,5 +5,3 @@ sphinx-static/switchers.js
 .vscode/
 */svg/*.png
 */svg/*.pdf
-styles/*
-!styles/config

documentation/.vale.ini

@@ -1,7 +0,0 @@
-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
-

documentation/Makefile

@@ -3,18 +3,14 @@
 
 # You can set these variables from the command line, and also
 # 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'
-SOURCEDIR      = .
-VALEDOCS       ?= $(SOURCEDIR)
-SPHINXLINTDOCS ?= $(SOURCEDIR)
-IMAGEDIRS      = */svg
-BUILDDIR       = _build
-DESTDIR        = final
-SVG2PNG        = inkscape
-SVG2PDF        = inkscape
+SPHINXOPTS    ?= -W --keep-going -j auto
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+IMAGEDIRS     = */svg
+BUILDDIR      = _build
+DESTDIR       = final
+SVG2PNG       = inkscape
+SVG2PDF       = inkscape
 
 ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0)
 $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
@@ -24,7 +20,7 @@ endif
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: all help Makefile clean stylecheck publish epub latexpdf
+.PHONY: all help Makefile clean publish epub latexpdf
 
 publish: Makefile html singlehtml
 	rm -rf $(BUILDDIR)/$(DESTDIR)/
@@ -50,13 +46,6 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED
 clean:
 	@rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js
 
-stylecheck:
-	vale sync
-	vale $(VALEOPTS) $(VALEDOCS)
-
-sphinx-lint:
-	sphinx-lint $(SPHINXLINTDOCS)
-
 epub: $(PNGs)
 	$(SOURCEDIR)/set_versions.py
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

documentation/README

@@ -34,18 +34,16 @@ Manual Organization
 
 Here the folders corresponding to individual manuals:
 
-* brief-yoctoprojectqs - Yocto Project Quick Start
 * overview-manual      - Yocto Project Overview and Concepts Manual
-* contributor-guide    - Yocto Project and OpenEmbedded Contributor Guide
-* ref-manual           - Yocto Project Reference Manual
+* sdk-manual           - Yocto Project Software Development Kit (SDK) Developer's Guide.
 * 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.
 
@@ -131,10 +129,6 @@ 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
@@ -151,50 +145,6 @@ 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
-
-Style checking the whole documentation might take some time and generate a
-lot of warnings/errors, thus one can run Vale on a subset of files or
-directories:
-
-  $ make stylecheck VALEDOCS=<file>
-  $ make stylecheck VALEDOCS="<file1> <file2>"
-  $ make stylecheck VALEDOCS=<dir>
-
-Lint 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
-
-Lint checking the whole documentation might take some time and generate a
-lot of warnings/errors, thus one can run sphinx-lint on a subset of files
-or directories:
-
-  $ make sphinx-lint SPHINXLINTDOCS=<file>
-  $ make sphinx-lint SPHINXLINTDOCS="<file1> <file2>"
-  $ make sphinx-lint SPHINXLINTDOCS=<dir>
-
 Sphinx theme and CSS customization
 ==================================
 
@@ -321,19 +271,6 @@ 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.
 
@@ -403,16 +340,13 @@ 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 directly be done:
+References to the BitBake manual can be done:
  - With a specific description instead of the section name:
-  :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
+  :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
  - With the section name:
-  :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
+  :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>`
 
 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.
@@ -421,11 +355,6 @@ 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
 ================================
 

documentation/brief-yoctoprojectqs/index.rst

@@ -25,11 +25,18 @@ build a reference embedded OS called Poky.
       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.
+   -  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.
 
 If you want more conceptual or background information on the Yocto
 Project, see the :doc:`/overview-manual/index`.
@@ -40,13 +47,7 @@ Compatible Linux Distribution
 Make sure your :term:`Build Host` meets the
 following requirements:
 
--  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.
+-  50 Gbytes of free disk space
 
 -  Runs a supported Linux distribution (i.e. recent releases of Fedora,
    openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux
@@ -63,12 +64,11 @@ 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, make and gcc versions`
+:ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`
 section in the Yocto Project Reference Manual for information.
 
 Build Host Packages
@@ -76,9 +76,11 @@ 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::
+distribution:
 
-   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
+.. code-block:: shell
+
+  $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
 
 .. note::
 
@@ -251,10 +253,15 @@ an entire Linux distribution, including the toolchain, from source.
       To use such mirrors, uncomment the below lines in your ``conf/local.conf``
       file in the :term:`Build Directory`::
 
-         BB_HASHSERVE_UPSTREAM = "hashserv.yoctoproject.org:8686"
-         SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH"
-         BB_HASHSERVE = "auto"
          BB_SIGNATURE_HANDLER = "OEEquivHash"
+         BB_HASHSERVE = "auto"
+         BB_HASHSERVE_UPSTREAM = "typhoon.yocto.io:8687"
+         SSTATE_MIRRORS ?= "file://.* https://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://.* https://sstate.yoctoproject.org/dev/PATH;downloadfilename=PATH"
 
 #. **Start the Build:** Continue with the following command to build an OS
    image for the target, which is ``core-image-sato`` in this example:
@@ -367,7 +374,7 @@ Follow these steps to add a hardware layer:
 
    You can find
    more information on adding layers in the
-   :ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script`
+   :ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`
    section.
 
 Completing these steps has added the ``meta-altera`` layer to your Yocto
@@ -402,7 +409,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/layers:creating a general layer using the \`\`bitbake-layers\`\` script`
+:ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`
 section in the Yocto Project Development Tasks Manual.
 
 Where To Go Next
@@ -417,9 +424,9 @@ 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.
 
--  **Video Seminar:** The `Introduction to the Yocto Project and Bitbake, Part 1
+-  **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
+   `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.

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
@@ -128,7 +128,7 @@ you want to work with, such as::
 and so on.
 
 For more information on layers, see the
-":ref:`dev-manual/layers:understanding and creating layers`"
+":ref:`dev-manual/common-tasks:understanding and creating layers`"
 section of the Yocto Project Development Tasks Manual.
 
 Preparing Your Build Host to Work With BSP Layers
@@ -464,7 +464,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/licenses:maintaining open source license compliance during your product's lifecycle`"
+the ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
 section in the Yocto Project Development Tasks Manual.
 
 README File
@@ -590,7 +590,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/new-recipe:using virtual providers>`),
+:ref:`virtual/kernel <dev-manual/common-tasks: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.
@@ -725,6 +725,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`"
@@ -757,7 +758,7 @@ 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/layers:understanding and creating layers`"
+   reference the ":ref:`dev-manual/common-tasks: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.
@@ -774,6 +775,20 @@ workflow.
 
          -  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.
+
    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`"
    section. In the standard layout, notice
@@ -802,7 +817,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/layers:enabling your layer`"
+   ":ref:`dev-manual/common-tasks: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.
 
@@ -831,7 +846,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/layers:understanding and creating layers`"
+   ":ref:`dev-manual/common-tasks:understanding and creating layers`"
    section in the Yocto Project Development Tasks Manual.
 
 -  The requirements in this section apply regardless of how you package
@@ -853,7 +868,8 @@ Before looking at BSP requirements, you should consider the following:
    dictating that a specific kernel or kernel version be used in a given
    BSP.
 
-The requirements for a released BSP that conform to the Yocto Project are:
+Following are the requirements for a released BSP that conform to the
+Yocto Project:
 
 -  *Layer Name:* The BSP must have a layer name that follows the Yocto
    Project standards. For information on BSP layer names, see the
@@ -878,8 +894,8 @@ The requirements for a released BSP that conform to the Yocto Project are:
    ``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 found in the ":doc:`../contributor-guide/recipe-style-guide`"
-   in the Yocto Project and OpenEmbedded Contributor Guide.
+   recipes used in the Yocto Project found in the ":oe_wiki:`OpenEmbedded
+   Style Guide </Styleguide>`".
 
 -  *License File:* You must include a license file in the
    ``meta-bsp_root_name`` directory. This license covers the BSP
@@ -912,8 +928,8 @@ The requirements for a released BSP that conform to the Yocto Project are:
    -  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
-      :doc:`../contributor-guide/submit-changes` section in the Yocto Project and
-      OpenEmbedded Contributor Guide.
+      ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
+      section in the Yocto Project Development Tasks Manual.
 
    -  Instructions on how to build the BSP using the BSP layer.
 
@@ -957,7 +973,7 @@ The requirements for a released BSP that conform to the Yocto Project are:
 Released BSP Recommendations
 ----------------------------
 
-Here are recommendations for released BSPs that conform to the
+Following are recommendations for released BSPs that conform to the
 Yocto Project:
 
 -  *Bootable Images:* Released BSPs can contain one or more bootable
@@ -998,7 +1014,7 @@ the following:
 
 -  Create a ``*.bbappend`` file for the modified recipe. For information on using
    append files, see the
-   ":ref:`dev-manual/layers:appending other layers metadata with your layer`"
+   ":ref:`dev-manual/common-tasks: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
@@ -1019,7 +1035,7 @@ the following:
    that additional hierarchy and the files would obviously not be able
    to reside in a machine-specific directory.
 
-Here is a specific example to help you better understand the
+Following 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
@@ -1102,7 +1118,7 @@ list describes them in order of preference:
    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/licenses:enabling commercially licensed recipes`"
+   ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
    section in the Yocto Project Development Tasks Manual for details on
    how to use these variables.
 
@@ -1154,7 +1170,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/layers:creating a general layer using the \`\`bitbake-layers\`\` script`"
+   ":ref:`dev-manual/common-tasks: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
@@ -1164,14 +1180,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/meta-ti-bsp/conf/layer.conf>`
+   :yocto_git:`local.conf </meta-ti/tree/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/meta-ti-bsp/conf/machine>`
+   :yocto_git:`meta-ti </meta-ti/tree/conf/machine>`
    and
    :yocto_git:`meta-freescale </meta-freescale/tree/conf/machine>`
    from other vendors that have more specific machine and tuning
@@ -1179,7 +1195,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. ``linux-yocto_4.12.bb``). The BSP
+   new custom kernel recipe file (e.g. ``yocto-linux_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
@@ -1194,7 +1210,7 @@ BSP Layer Configuration Example
 -------------------------------
 
 The layer's ``conf`` directory contains the ``layer.conf`` configuration
-file. In this example, the ``conf/layer.conf`` file is the following::
+file. In this example, the ``conf/layer.conf`` is the following::
 
    # We have a conf and classes directory, add to BBPATH
    BBPATH .= ":${LAYERDIR}"
@@ -1214,7 +1230,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/layers:creating your own layer>`"
+see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`"
 in the discussion that describes how to create layers in the Yocto
 Project Development Tasks Manual.
 
@@ -1434,39 +1450,39 @@ 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.15%"
+   PREFERRED_VERSION_linux-yocto ?= "5.0%"
 
 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.15.bbappend``) is used to override an established
-kernel recipe (i.e. ``linux-yocto_5.15.bb``), which is located in
-:yocto_git:`/poky/tree/meta-yocto-bsp/recipes-kernel/linux`.
+(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
+:yocto_git:`/poky/tree/meta/recipes-kernel/linux`.
 
-The contents of the append file are::
+Following is the contents of the append file::
 
-   KBRANCH:genericx86  = "v5.15/standard/base"
-   KBRANCH:genericx86-64  = "v5.15/standard/base"
-   KBRANCH:edgerouter = "v5.15/standard/edgerouter"
-   KBRANCH:beaglebone-yocto = "v5.15/standard/beaglebone"
+   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"
 
    KMACHINE:genericx86 ?= "common-pc"
    KMACHINE:genericx86-64 ?= "common-pc-64"
    KMACHINE:beaglebone-yocto ?= "beaglebone"
 
-   SRCREV_machine:genericx86 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c"
-   SRCREV_machine:genericx86-64 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c"
-   SRCREV_machine:edgerouter ?= "90f1ee6589264545f548d731c2480b08a007230f"
-   SRCREV_machine:beaglebone-yocto ?= "9aabbaa89fcb21af7028e814c1f5b61171314d5a"
+   SRCREV_machine:genericx86 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d"
+   SRCREV_machine:genericx86-64 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d"
+   SRCREV_machine:edgerouter ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d"
+   SRCREV_machine:beaglebone-yocto ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d"
 
    COMPATIBLE_MACHINE:genericx86 = "genericx86"
    COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64"
    COMPATIBLE_MACHINE:edgerouter = "edgerouter"
    COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto"
 
-   LINUX_VERSION:genericx86 = "5.15.72"
-   LINUX_VERSION:genericx86-64 = "5.15.72"
-   LINUX_VERSION:edgerouter = "5.15.54"
-   LINUX_VERSION:beaglebone-yocto = "5.15.54"
+   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"
 
 This particular append file works for all the machines that are
 part of the ``meta-yocto-bsp`` layer. The relevant statements are

documentation/conf.py

@@ -19,7 +19,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)
 
 # current_version = "dev"
@@ -90,9 +90,7 @@ rst_prolog = """
 
 # external links and substitutions
 extlinks = {
-    'bitbake_git': ('https://git.openembedded.org/bitbake%s', None),
-    'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'),
-    'cve_nist': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'),
+    'cve': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-'),
     '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),
@@ -108,10 +106,9 @@ 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)
 }
@@ -132,7 +129,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'
@@ -160,8 +157,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

documentation/contributor-guide/identify-component.rst

@@ -1,31 +0,0 @@
-.. 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.
-

documentation/contributor-guide/index.rst

@@ -1,26 +0,0 @@
-.. 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

documentation/contributor-guide/recipe-style-guide.rst

@@ -1,411 +0,0 @@
-.. 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_nist:`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>

documentation/contributor-guide/report-defect.rst

@@ -1,67 +0,0 @@
-.. 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!

documentation/contributor-guide/submit-changes.rst

@@ -1,793 +0,0 @@
-.. 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"
-
-By default, Git adds a signature line at the end of patches containing the Git
-version. We suggest to remove it as it doesn't add useful information.
-
-Remove it with the following command::
-
-   git config --global format.signature ""
-
-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`".
-
-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
-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.
-

documentation/dev-manual/bmaptool.rst

@@ -1,59 +0,0 @@
-.. 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 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:
-
-#. *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 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
-

documentation/dev-manual/build-quality.rst

@@ -1,409 +0,0 @@
-.. 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%
-

documentation/dev-manual/building.rst

@@ -1,942 +0,0 @@
-.. 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.
-

documentation/dev-manual/custom-distribution.rst

@@ -1,135 +0,0 @@
-.. 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.

documentation/dev-manual/custom-template-configuration-directory.rst

@@ -1,72 +0,0 @@
-.. 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 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.
-

documentation/dev-manual/customizing-images.rst

@@ -1,223 +0,0 @@
-.. 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/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.
-

documentation/dev-manual/development-shell.rst

@@ -1,82 +0,0 @@
-.. 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.
-

documentation/dev-manual/device-manager.rst

@@ -1,74 +0,0 @@
-.. 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"
-

documentation/dev-manual/disk-space.rst

@@ -1,61 +0,0 @@
-.. 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.sh --remove-duplicated --cache-dir=build/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.

documentation/dev-manual/efficiently-fetching-sources.rst

@@ -1,68 +0,0 @@
-.. 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.
-

documentation/dev-manual/error-reporting-tool.rst

@@ -1,84 +0,0 @@
-.. 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.
-

documentation/dev-manual/external-scm.rst

@@ -1,67 +0,0 @@
-.. 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.
-

documentation/dev-manual/external-toolchain.rst

@@ -1,40 +0,0 @@
-.. 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.

documentation/dev-manual/gobject-introspection.rst

@@ -1,155 +0,0 @@
-.. 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.
-

documentation/dev-manual/index.rst

@@ -4,48 +4,15 @@
 Yocto Project Development Tasks Manual
 ======================================
 
+|
+
 .. toctree::
    :caption: Table of Contents
    :numbered:
 
    intro
    start
-   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
-   debugging
-   licenses
-   security-subjects
-   vulnerabilities
-   sbom
-   error-reporting-tool
-   wayland
+   common-tasks
    qemu
 
 .. include:: /boilerplate.rst

documentation/dev-manual/init-manager.rst

@@ -1,162 +0,0 @@
-.. 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.

documentation/dev-manual/layers.rst

@@ -1,943 +0,0 @@
-.. 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.
-
-Providing Global-level Configurations With Your Layer
------------------------------------------------------
-
-When creating a layer, you may need to define configurations that should take
-effect globally in your build environment when the layer is part of the build.
-The ``layer.conf`` file is a :term:`configuration file` that affects the build
-system globally, so it is a candidate for this use-case.
-
-.. warning::
-
-   Providing unconditional global level configuration from the ``layer.conf``
-   file is *not* a good practice, and should be avoided. For this reason, the
-   section :ref:`ref-conditional-layer-confs` below shows how the ``layer.conf``
-   file can be used to provide configurations only if a certain condition is
-   met.
-
-For example, if your layer provides a Linux kernel recipe named
-``linux-custom``, you may want to make :term:`PREFERRED_PROVIDER_virtual/kernel
-<PREFERRED_PROVIDER>` point to ``linux-custom``::
-
-   PREFERRED_PROVIDER_virtual/kernel = "linux-custom"
-
-This can be defined in the ``layer.conf`` file. If your layer is at the last
-position in the :term:`BBLAYERS` list, it will take precedence over previous
-``PREFERRED_PROVIDER_virtual/kernel`` assignments (unless one is set from a
-:term:`configuration file` that is parsed later, such as machine or distro
-configuration files).
-
-.. _ref-conditional-layer-confs:
-
-Conditionally Provide Global-level Configurations With Your Layer
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-In some cases, your layer may provide global configurations only if some
-features it provides are enabled. Since the ``layer.conf`` file is parsed at an
-earlier stage in the parsing process, the :term:`DISTRO_FEATURES` and
-:term:`MACHINE_FEATURES` variables are not yet available to ``layer.conf``, and
-declaring conditional assignments based on these variables is not possible. The
-following technique shows a way to bypass this limitation by using the
-:term:`USER_CLASSES` variable and a conditional ``require`` command.
-
-In the following steps, let's assume our layer is named ``meta-mylayer`` and
-that this layer defines a custom :ref:`distro feature <ref-features-distro>`
-named ``mylayer-kernel``. We will set the :term:`PREFERRED_PROVIDER` variable
-for the kernel only if our feature ``mylayer-kernel`` is part of the
-:term:`DISTRO_FEATURES`:
-
-#. Create an include file in the directory
-   ``meta-mylayer/conf/distro/include/``, for example a file named
-   ``mylayer-kernel-provider.inc`` that sets the kernel provider to
-   ``linux-custom``::
-
-      PREFERRED_PROVIDER_virtual/kernel = "linux-custom"
-
-#. Provide a path to this include file in your ``layer.conf``::
-
-      META_MYLAYER_KERNEL_PROVIDER_PATH = "${LAYERDIR}/conf/distro/include/mylayer-kernel-provider.inc"
-
-#. Create a new class in ``meta-mylayer/classes-global/``, for example a class
-   ``meta-mylayer-cfg.bbclass``. Make it conditionally require the file
-   ``mylayer-kernel-provider.inc`` defined above, using the variable
-   ``META_MYLAYER_KERNEL_PROVIDER_PATH`` defined in ``layer.conf``::
-
-      require ${@bb.utils.contains('DISTRO_FEATURES', 'mylayer-kernel', '${META_MYLAYER_KERNEL_PROVIDER_PATH}', '', d)}
-
-   For details on the ``bb.utils.contains`` function, see its definition in
-   :bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`.
-
-   .. note::
-
-      The ``require`` command is designed to not fail if the function
-      ``bb.utils.contains`` returns an empty string.
-
-#. Back to your ``layer.conf`` file, add the class ``meta-mylayer-cfg`` class to
-   the :term:`USER_CLASSES` variable::
-
-      USER_CLASSES:append = " meta-mylayer-cfg"
-
-   This will add the class ``meta-mylayer-cfg`` to the list of classes to
-   globally inherit. Since the ``require`` command is conditional in
-   ``meta-mylayer-cfg.bbclass``, even though inherited the class will have no
-   effect unless the feature ``mylayer-kernel`` is enabled through
-   :term:`DISTRO_FEATURES`.
-
-This technique can also be used for :ref:`Machine features
-<ref-features-machine>` by following the same steps. Though not mandatory, it is
-recommended to put include files for :term:`DISTRO_FEATURES` in your layer's
-``conf/distro/include`` and the ones for :term:`MACHINE_FEATURES` in your
-layer's ``conf/machine/include``.
-
-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.
-
--  ``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/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.
-

documentation/dev-manual/libraries.rst

@@ -1,267 +0,0 @@
-.. 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"
-

documentation/dev-manual/licenses.rst

@@ -1,539 +0,0 @@
-.. 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}"
-
-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.
-
--  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 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/<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/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"
-