ref-manual: variables.rst: explicit variables accepting colon separated lists

[YOCTO 15128]

(From yocto-docs rev: af5f4bfd213d2678c0f0463ddff321980d6c9669)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2023-06-07 17:49:52 +02:00
committed by Richard Purdie
parent 2aa3af4de3
commit 00016cecc4

View File

@@ -2200,6 +2200,11 @@ system and gives an overview of their function and contents.
is included in the default value of is included in the default value of
:term:`OVERRIDES`. :term:`OVERRIDES`.
Here is an example from :yocto_git:`meta-poky/conf/distro/poky-tiny.conf
</poky/tree/meta-poky/conf/distro/poky-tiny.conf>`::
DISTROOVERRIDES = "poky:poky-tiny"
:term:`DL_DIR` :term:`DL_DIR`
The central download directory used by the build process to store The central download directory used by the build process to store
downloads. By default, :term:`DL_DIR` gets files suitable for mirroring downloads. By default, :term:`DL_DIR` gets files suitable for mirroring
@@ -2756,12 +2761,11 @@ system and gives an overview of their function and contents.
FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}"
:term:`FILESEXTRAPATHS` :term:`FILESEXTRAPATHS`
Extends the search path the OpenEmbedded build system uses when A colon-separated list to extend the search path the OpenEmbedded build
looking for files and patches as it processes recipes and append system uses when looking for files and patches as it processes recipes
files. The default directories BitBake uses when it processes recipes and append files. The default directories BitBake uses when it processes
are initially defined by the :term:`FILESPATH` recipes are initially defined by the :term:`FILESPATH` variable. You can
variable. You can extend :term:`FILESPATH` variable by using extend :term:`FILESPATH` variable by using :term:`FILESEXTRAPATHS`.
:term:`FILESEXTRAPATHS`.
Best practices dictate that you accomplish this by using Best practices dictate that you accomplish this by using
:term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you
@@ -2822,12 +2826,12 @@ system and gives an overview of their function and contents.
recipe to correctly extend the path. recipe to correctly extend the path.
:term:`FILESOVERRIDES` :term:`FILESOVERRIDES`
A subset of :term:`OVERRIDES` used by the OpenEmbedded build system for A colon-separated list to specify a subset of :term:`OVERRIDES` used by
creating :term:`FILESPATH`. The :term:`FILESOVERRIDES` variable uses the OpenEmbedded build system for creating :term:`FILESPATH`. The
overrides to automatically extend the :term:`FILESPATH` variable. For an :term:`FILESOVERRIDES` variable uses overrides to automatically extend
example of how that works, see the :term:`FILESPATH` variable the :term:`FILESPATH` variable. For an example of how that works, see the
description. Additionally, you find more information on how overrides :term:`FILESPATH` variable description. Additionally, you find more
are handled in the information on how overrides are handled in the
":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
section of the BitBake User Manual. section of the BitBake User Manual.
@@ -2842,8 +2846,8 @@ system and gives an overview of their function and contents.
build system. build system.
:term:`FILESPATH` :term:`FILESPATH`
The default set of directories the OpenEmbedded build system uses A colon-separated list specifying the default set of directories the
when searching for patches and files. OpenEmbedded build system uses when searching for patches and files.
During the build process, BitBake searches each directory in During the build process, BitBake searches each directory in
:term:`FILESPATH` in the specified order when looking for files and :term:`FILESPATH` in the specified order when looking for files and
@@ -7577,9 +7581,10 @@ system and gives an overview of their function and contents.
SKIP_RECIPE[myrecipe] = "Not supported by our organization." SKIP_RECIPE[myrecipe] = "Not supported by our organization."
:term:`SOC_FAMILY` :term:`SOC_FAMILY`
Groups together machines based upon the same family of SOC (System On A colon-separated list grouping together machines based upon the same
Chip). You typically set this variable in a common ``.inc`` file that family of SoC (System On Chip). You typically set this variable in a
you include in the configuration files of all the machines. common ``.inc`` file that you include in the configuration files of all
the machines.
.. note:: .. note::