summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-02-28 19:07:13 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-03-20 13:16:52 +0000
commit8c49eb57b63bc867296a2853a3d132fed58add26 (patch)
tree4f1ea9cd8c50b52fa4fe989a7e117f01cdb4d27d /documentation/ref-manual/variables.rst
parentf559a61295b36836f35f820c0ba74ffaed4dc13e (diff)
downloadpoky-8c49eb57b63bc867296a2853a3d132fed58add26.tar.gz
ref-manual: clarify explanations about feature backfilling
(From yocto-docs rev: edae43e60230ad5f2384f0a518b42fc08efc699e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Joshua Watt <JPEWhacker@gmail.com> CC: Martin Jansa <martin.jansa@gmail.com> CC: Tom Hochstein <tom.hochstein@nxp.com> CC: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst50
1 files changed, 33 insertions, 17 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 9b581599e3..2e32e264db 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2111,19 +2111,27 @@ system and gives an overview of their function and contents.
2111 provide with this variable, see the ":ref:`ref-features-distro`" section. 2111 provide with this variable, see the ":ref:`ref-features-distro`" section.
2112 2112
2113 :term:`DISTRO_FEATURES_BACKFILL` 2113 :term:`DISTRO_FEATURES_BACKFILL`
2114 Features to be added to :term:`DISTRO_FEATURES` if not also present in 2114 A space-separated list of features to be added to :term:`DISTRO_FEATURES`
2115 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`. 2115 if not also present in :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`.
2116 2116
2117 This variable is set in the ``meta/conf/bitbake.conf`` file. It is 2117 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
2118 not intended to be user-configurable. It is best to just reference 2118 not intended to be user-configurable. It is best to just reference
2119 the variable to see which distro features are being backfilled for 2119 the variable to see which distro features are being
2120 all distro configurations. See the ":ref:`ref-features-backfill`" section 2120 :ref:`backfilled <ref-features-backfill>` for all distro configurations.
2121 for more information.
2122 2121
2123 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` 2122 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
2124 Features from :term:`DISTRO_FEATURES_BACKFILL` that should not be 2123 A space-separated list of features from :term:`DISTRO_FEATURES_BACKFILL`
2125 backfilled (i.e. added to :term:`DISTRO_FEATURES`) during the build. See 2124 that should not be :ref:`backfilled <ref-features-backfill>` (i.e. added
2126 the ":ref:`ref-features-backfill`" section for more information. 2125 to :term:`DISTRO_FEATURES`) during the build.
2126
2127 This corresponds to an opt-out mechanism. When new default distro
2128 features are introduced, distribution maintainers can review (`consider`)
2129 them and decide to exclude them from the
2130 :ref:`backfilled <ref-features-backfill>` features. Therefore, the
2131 combination of :term:`DISTRO_FEATURES_BACKFILL` and
2132 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` makes it possible to
2133 add new default features without breaking existing distributions.
2134
2127 2135
2128 :term:`DISTRO_FEATURES_DEFAULT` 2136 :term:`DISTRO_FEATURES_DEFAULT`
2129 A convenience variable that gives you the default list of distro 2137 A convenience variable that gives you the default list of distro
@@ -5129,19 +5137,27 @@ system and gives an overview of their function and contents.
5129 shipped, see the ":ref:`ref-features-machine`" section. 5137 shipped, see the ":ref:`ref-features-machine`" section.
5130 5138
5131 :term:`MACHINE_FEATURES_BACKFILL` 5139 :term:`MACHINE_FEATURES_BACKFILL`
5132 Features to be added to :term:`MACHINE_FEATURES` if not also present in 5140 A list of space-separated features to be added to
5141 :term:`MACHINE_FEATURES` if not also present in
5133 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. 5142 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
5134 5143
5135 This variable is set in the ``meta/conf/bitbake.conf`` file. It is 5144 This variable is set in the ``meta/conf/bitbake.conf`` file. It is not
5136 not intended to be user-configurable. It is best to just reference 5145 intended to be user-configurable. It is best to just reference the
5137 the variable to see which machine features are being backfilled for 5146 variable to see which machine features are being
5138 all machine configurations. See the ":ref:`ref-features-backfill`" 5147 :ref:`backfilled <ref-features-backfill>` for all machine configurations.
5139 section for more information.
5140 5148
5141 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` 5149 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
5142 Features from :term:`MACHINE_FEATURES_BACKFILL` that should not be 5150 A list of space-separated features from :term:`MACHINE_FEATURES_BACKFILL`
5143 backfilled (i.e. added to :term:`MACHINE_FEATURES`) during the build. See 5151 that should not be :ref:`backfilled <ref-features-backfill>` (i.e. added
5144 the ":ref:`ref-features-backfill`" section for more information. 5152 to :term:`MACHINE_FEATURES`) during the build.
5153
5154 This corresponds to an opt-out mechanism. When new default machine
5155 features are introduced, machine definition maintainers can review
5156 (`consider`) them and decide to exclude them from the
5157 :ref:`backfilled <ref-features-backfill>` features. Therefore, the
5158 combination of :term:`MACHINE_FEATURES_BACKFILL` and
5159 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` makes it possible to
5160 add new default features without breaking existing machine definitions.
5145 5161
5146 :term:`MACHINEOVERRIDES` 5162 :term:`MACHINEOVERRIDES`
5147 A colon-separated list of overrides that apply to the current 5163 A colon-separated list of overrides that apply to the current