From 00016cecc43437415e0414d4f87cd1b90d1a637d Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Wed, 7 Jun 2023 17:49:52 +0200 Subject: ref-manual: variables.rst: explicit variables accepting colon separated lists [YOCTO 15128] (From yocto-docs rev: af5f4bfd213d2678c0f0463ddff321980d6c9669) Signed-off-by: Michael Opdenacker Reviewed-by: Luca Ceresoli Reported-by: Alexandre Belloni Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 39 +++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 17 deletions(-) (limited to 'documentation') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index cba3cf5d07..8ac46f9e73 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2200,6 +2200,11 @@ system and gives an overview of their function and contents. is included in the default value of :term:`OVERRIDES`. + Here is an example from :yocto_git:`meta-poky/conf/distro/poky-tiny.conf + `:: + + DISTROOVERRIDES = "poky:poky-tiny" + :term:`DL_DIR` The central download directory used by the build process to store 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}" :term:`FILESEXTRAPATHS` - Extends the search path the OpenEmbedded build system uses when - looking for files and patches as it processes recipes and append - files. The default directories BitBake uses when it processes recipes - are initially defined by the :term:`FILESPATH` - variable. You can extend :term:`FILESPATH` variable by using - :term:`FILESEXTRAPATHS`. + A colon-separated list to extend the search path the OpenEmbedded build + system uses when looking for files and patches as it processes recipes + and append files. The default directories BitBake uses when it processes + recipes are initially defined by the :term:`FILESPATH` variable. You can + extend :term:`FILESPATH` variable by using :term:`FILESEXTRAPATHS`. Best practices dictate that you accomplish this by using :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you @@ -2822,12 +2826,12 @@ system and gives an overview of their function and contents. recipe to correctly extend the path. :term:`FILESOVERRIDES` - A subset of :term:`OVERRIDES` used by the OpenEmbedded build system for - creating :term:`FILESPATH`. The :term:`FILESOVERRIDES` variable uses - overrides to automatically extend the :term:`FILESPATH` variable. For an - example of how that works, see the :term:`FILESPATH` variable - description. Additionally, you find more information on how overrides - are handled in the + A colon-separated list to specify a subset of :term:`OVERRIDES` used by + the OpenEmbedded build system for creating :term:`FILESPATH`. The + :term:`FILESOVERRIDES` variable uses overrides to automatically extend + the :term:`FILESPATH` variable. For an example of how that works, see the + :term:`FILESPATH` variable description. Additionally, you find more + information on how overrides are handled in the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" section of the BitBake User Manual. @@ -2842,8 +2846,8 @@ system and gives an overview of their function and contents. build system. :term:`FILESPATH` - The default set of directories the OpenEmbedded build system uses - when searching for patches and files. + A colon-separated list specifying the default set of directories the + OpenEmbedded build system uses when searching for patches and files. During the build process, BitBake searches each directory in :term:`FILESPATH` in the specified order when looking for files and @@ -7577,9 +7581,10 @@ system and gives an overview of their function and contents. SKIP_RECIPE[myrecipe] = "Not supported by our organization." :term:`SOC_FAMILY` - Groups together machines based upon the same family of SOC (System On - Chip). You typically set this variable in a common ``.inc`` file that - you include in the configuration files of all the machines. + A colon-separated list grouping together machines based upon the same + family of SoC (System On Chip). You typically set this variable in a + common ``.inc`` file that you include in the configuration files of all + the machines. .. note:: -- cgit v1.2.3-54-g00ecf