From e86a3d2236d7a9fe77483f8db1f07de8be6fab6c Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Fri, 26 Sep 2025 15:06:23 +0200 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 39 ++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) (limited to 'documentation/ref-manual/variables.rst') 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. :term:`BB_CHECK_SSL_CERTS` See :term:`bitbake:BB_CHECK_SSL_CERTS` in the BitBake manual. + :term:`BB_CONF_FRAGMENT_DESCRIPTION` + The :term:`BB_CONF_FRAGMENT_DESCRIPTION` variable defines the textual + description of a :term:`Configuration Fragment`. For details on how to use + fragments, see the :doc:`/ref-manual/fragments` section of the Yocto + Project Reference Manual. + + :term:`BB_CONF_FRAGMENT_SUMMARY` + The :term:`BB_CONF_FRAGMENT_SUMMARY` variable defines the one-line textual + summary of a :term:`Configuration Fragment`. For details on how to use + fragments, see the :doc:`/ref-manual/fragments` section of the Yocto + Project Reference Manual. + :term:`BB_CONSOLELOG` See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. @@ -6230,6 +6242,33 @@ system and gives an overview of their function and contents. :term:`Source Directory` for details on how this class applies these additional sed command arguments. + :term:`OE_FRAGMENTS` + The :term:`OE_FRAGMENTS` variable holds the list of :term:`Configuration + Fragments ` currently enabled for the build. For + details on how to use fragments, see the :doc:`/ref-manual/fragments` + section of the Yocto Project Reference Manual. + + :term:`OE_FRAGMENTS_BUILTIN` + The :term:`OE_FRAGMENTS_BUILTIN` variable holds the list of + :term:`Built-in Fragments ` available for being set with + :oe_git:`bitbake-config-build `. + For details on how to use fragments, see the :doc:`/ref-manual/fragments` + section of the Yocto Project Reference Manual. + + :term:`OE_FRAGMENTS_METADATA_VARS` + The :term:`OE_FRAGMENTS_METADATA_VARS` variable holds the list of + variables that are required to set in a standard :term:`Configuration + Fragment` file. In :term:`OpenEmbedded-Core (OE-Core)`, these variables + are :term:`BB_CONF_FRAGMENT_SUMMARY` and + :term:`BB_CONF_FRAGMENT_DESCRIPTION`. + + :term:`OE_FRAGMENTS_PREFIX` + The :term:`OE_FRAGMENTS_PREFIX` variable defines the prefix where + :term:`BitBake` tries to locate :term:`Configuration Fragments + ` in :term:`layers `. For details on how to + use fragments, see the :doc:`/ref-manual/fragments` section of the Yocto + Project Reference Manual. + :term:`OE_INIT_ENV_SCRIPT` The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK. The default -- cgit v1.2.3-54-g00ecf