diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-09-26 15:06:23 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-10-03 17:53:57 +0100 |
commit | e86a3d2236d7a9fe77483f8db1f07de8be6fab6c (patch) | |
tree | 0ebc388c251421408c83d2e0f6fa8b035d7b1788 /documentation/ref-manual/variables.rst | |
parent | bb64a9adcf222a7b7fc9faf37582b6083c95196b (diff) | |
download | poky-e86a3d2236d7a9fe77483f8db1f07de8be6fab6c.tar.gz |
Add documentation on fragments
- terms.rst: Provide the definitions of a Configuration Fragment and a
Built-in Fragment.
- ref-manual: Add a quick reference guide on bitbake-config-build, and
list the available fragments in OE-Core.
Document the underlying variables related to fragments in the
glossary.
- dev-manual: give instructions on how to create new custom fragments.
(From yocto-docs rev: 0820b71c830cab4151b0219b6d4013c41f461c6e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 2f9f1a9d80..aefe598a56 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -397,6 +397,18 @@ system and gives an overview of their function and contents. | |||
397 | :term:`BB_CHECK_SSL_CERTS` | 397 | :term:`BB_CHECK_SSL_CERTS` |
398 | See :term:`bitbake:BB_CHECK_SSL_CERTS` in the BitBake manual. | 398 | See :term:`bitbake:BB_CHECK_SSL_CERTS` in the BitBake manual. |
399 | 399 | ||
400 | :term:`BB_CONF_FRAGMENT_DESCRIPTION` | ||
401 | The :term:`BB_CONF_FRAGMENT_DESCRIPTION` variable defines the textual | ||
402 | description of a :term:`Configuration Fragment`. For details on how to use | ||
403 | fragments, see the :doc:`/ref-manual/fragments` section of the Yocto | ||
404 | Project Reference Manual. | ||
405 | |||
406 | :term:`BB_CONF_FRAGMENT_SUMMARY` | ||
407 | The :term:`BB_CONF_FRAGMENT_SUMMARY` variable defines the one-line textual | ||
408 | summary of a :term:`Configuration Fragment`. For details on how to use | ||
409 | fragments, see the :doc:`/ref-manual/fragments` section of the Yocto | ||
410 | Project Reference Manual. | ||
411 | |||
400 | :term:`BB_CONSOLELOG` | 412 | :term:`BB_CONSOLELOG` |
401 | See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. | 413 | See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. |
402 | 414 | ||
@@ -6230,6 +6242,33 @@ system and gives an overview of their function and contents. | |||
6230 | :term:`Source Directory` for details on how this class | 6242 | :term:`Source Directory` for details on how this class |
6231 | applies these additional sed command arguments. | 6243 | applies these additional sed command arguments. |
6232 | 6244 | ||
6245 | :term:`OE_FRAGMENTS` | ||
6246 | The :term:`OE_FRAGMENTS` variable holds the list of :term:`Configuration | ||
6247 | Fragments <Configuration Fragment>` currently enabled for the build. For | ||
6248 | details on how to use fragments, see the :doc:`/ref-manual/fragments` | ||
6249 | section of the Yocto Project Reference Manual. | ||
6250 | |||
6251 | :term:`OE_FRAGMENTS_BUILTIN` | ||
6252 | The :term:`OE_FRAGMENTS_BUILTIN` variable holds the list of | ||
6253 | :term:`Built-in Fragments <Built-in Fragment>` available for being set with | ||
6254 | :oe_git:`bitbake-config-build </bitbake/tree/bin/bitbake-config-build>`. | ||
6255 | For details on how to use fragments, see the :doc:`/ref-manual/fragments` | ||
6256 | section of the Yocto Project Reference Manual. | ||
6257 | |||
6258 | :term:`OE_FRAGMENTS_METADATA_VARS` | ||
6259 | The :term:`OE_FRAGMENTS_METADATA_VARS` variable holds the list of | ||
6260 | variables that are required to set in a standard :term:`Configuration | ||
6261 | Fragment` file. In :term:`OpenEmbedded-Core (OE-Core)`, these variables | ||
6262 | are :term:`BB_CONF_FRAGMENT_SUMMARY` and | ||
6263 | :term:`BB_CONF_FRAGMENT_DESCRIPTION`. | ||
6264 | |||
6265 | :term:`OE_FRAGMENTS_PREFIX` | ||
6266 | The :term:`OE_FRAGMENTS_PREFIX` variable defines the prefix where | ||
6267 | :term:`BitBake` tries to locate :term:`Configuration Fragments | ||
6268 | <Configuration Fragment>` in :term:`layers <Layer>`. For details on how to | ||
6269 | use fragments, see the :doc:`/ref-manual/fragments` section of the Yocto | ||
6270 | Project Reference Manual. | ||
6271 | |||
6233 | :term:`OE_INIT_ENV_SCRIPT` | 6272 | :term:`OE_INIT_ENV_SCRIPT` |
6234 | The name of the build environment setup script for the purposes of | 6273 | The name of the build environment setup script for the purposes of |
6235 | setting up the environment within the extensible SDK. The default | 6274 | setting up the environment within the extensible SDK. The default |