From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH] ref-manual: variables.rst: explicit variables accepting colon separated lists
Date: Mon, 19 Jun 2023 18:17:19 +0200 [thread overview]
Message-ID: <20230619161719.910423-1-michael.opdenacker@bootlin.com> (raw)
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
[YOCTO 15128]
---
documentation/ref-manual/variables.rst | 32 +++++++++++++++-----------
1 file changed, 18 insertions(+), 14 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index cba3cf5d07..3dc6a5e7f3 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
+ </poky/tree/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
--
2.34.1
next reply other threads:[~2023-06-19 16:17 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-19 16:17 michael.opdenacker [this message]
2023-06-20 7:56 ` [docs] [PATCH] ref-manual: variables.rst: explicit variables accepting colon separated lists Luca Ceresoli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230619161719.910423-1-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox