diff options
Diffstat (limited to 'documentation/ref-manual/terms.rst')
-rw-r--r-- | documentation/ref-manual/terms.rst | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index f3d3d059d1..e25c714d9b 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
@@ -131,6 +131,53 @@ universal, the list includes them just in case: | |||
131 | A variant of :term:`buildtools`, just providing the required | 131 | A variant of :term:`buildtools`, just providing the required |
132 | version of ``make`` to run the OpenEmbedded build system. | 132 | version of ``make`` to run the OpenEmbedded build system. |
133 | 133 | ||
134 | :term:`Built-in Fragment` | ||
135 | A built-in fragment is a specific kind of :term:`Configuration Fragment` | ||
136 | that affects the value of a single variable globally. :term:`Built-in | ||
137 | Fragments <Built-in Fragment>` do not require a separate configuration | ||
138 | file, but like a standard :term:`Configuration Fragment`, Built-in | ||
139 | Fragments can be enabled or disabled using the :oe_git:`bitbake-config-build | ||
140 | </bitbake/tree/bin/bitbake-config-build>` command-line utility. | ||
141 | |||
142 | When declared, a built-in fragment follows the following naming | ||
143 | convention:: | ||
144 | |||
145 | <fragment>:<variable name> | ||
146 | |||
147 | Where: | ||
148 | |||
149 | - ``<fragment>`` is the name of the built-in fragment. | ||
150 | - ``<variable name>`` is the name of the variable to be modified by this | ||
151 | fragment. | ||
152 | |||
153 | For example:: | ||
154 | |||
155 | machine:MACHINE | ||
156 | |||
157 | Will setup the ``machine`` Built-in Fragment for modifying the value of | ||
158 | the :term:`MACHINE` variable. | ||
159 | |||
160 | Setting the :term:`MACHINE` variable through this fragment must follow | ||
161 | this syntax:: | ||
162 | |||
163 | machine/qemux86-64 | ||
164 | |||
165 | This sets the value of :term:`MACHINE` to ``qemux86-64``. | ||
166 | |||
167 | In :term:`OpenEmbedded-Core (OE-Core)`, the list of available | ||
168 | :term:`Built-in Fragments <Built-in Fragment>` can be obtained from the | ||
169 | :term:`OE_FRAGMENTS_BUILTIN` variable. | ||
170 | |||
171 | For more details on fragments, see: | ||
172 | |||
173 | - The :doc:`/ref-manual/fragments` section of the Yocto Project Reference | ||
174 | Manual for a list of fragments the :term:`OpenEmbedded Build System` | ||
175 | supports, and a quick reference guide on how to manage fragments. | ||
176 | |||
177 | - The :doc:`/dev-manual/creating-fragments` section of the Yocto Project | ||
178 | Development Tasks Manual for details on how to create new fragments | ||
179 | in your build. | ||
180 | |||
134 | :term:`Classes` | 181 | :term:`Classes` |
135 | Files that provide for logic encapsulation and inheritance so that | 182 | Files that provide for logic encapsulation and inheritance so that |
136 | commonly used patterns can be defined once and then easily used in | 183 | commonly used patterns can be defined once and then easily used in |
@@ -154,6 +201,51 @@ universal, the list includes them just in case: | |||
154 | only used when building for that target (e.g. the | 201 | only used when building for that target (e.g. the |
155 | :file:`machine/beaglebone.conf` configuration file defines variables for | 202 | :file:`machine/beaglebone.conf` configuration file defines variables for |
156 | the Texas Instruments ARM Cortex-A8 development board). | 203 | the Texas Instruments ARM Cortex-A8 development board). |
204 | :term:`Configuration Fragments <Configuration Fragment>` such as | ||
205 | :ref:`ref-fragments-core-yocto-sstate-mirror-cdn` define snippets of | ||
206 | configuration that can be enabled from the command-line. | ||
207 | |||
208 | :term:`Configuration Fragment` | ||
209 | A :term:`Configuration Fragment` (also called Standard :term:`Configuration | ||
210 | Fragment`) is a :term:`configuration file` that contains configuration | ||
211 | statements such as variable assignments, affecting the build at a | ||
212 | global-level when the fragment is enabled. By default, configuration | ||
213 | fragments are located in the :file:`conf/fragments/` directory of a | ||
214 | :term:`Layer`. | ||
215 | |||
216 | .. note:: | ||
217 | |||
218 | Another form of fragment not to be confounded with Standard | ||
219 | :term:`Configuration Fragments <Configuration Fragment>` are | ||
220 | :term:`Built-in Fragments <Built-in Fragment>` which are used to assign | ||
221 | a single variable value globally. | ||
222 | |||
223 | A fragment :term:`configuration file` must contain a summary | ||
224 | (:term:`BB_CONF_FRAGMENT_SUMMARY`) and a description | ||
225 | (:term:`BB_CONF_FRAGMENT_DESCRIPTION`) explaining the purpose of the | ||
226 | fragment. | ||
227 | |||
228 | In :term:`OpenEmbedded-Core (OE-Core)`, the location of fragments and what | ||
229 | variables are required in a fragment is specified in :oe_git:`bitbake.conf | ||
230 | </openembedded-core/tree/meta/conf/bitbake.conf>` thanks to the | ||
231 | :ref:`addfragments <bitbake-user-manual/bitbake-user-manual-metadata:\`\`addfragments\`\` | ||
232 | directive>` directive and the :term:`OE_FRAGMENTS`, | ||
233 | :term:`OE_FRAGMENTS_METADATA_VARS` and :term:`OE_FRAGMENTS_BUILTIN` | ||
234 | variables. | ||
235 | |||
236 | Fragments can be listed, enabled and disabled with the | ||
237 | :oe_git:`bitbake-config-build </bitbake/tree/bin/bitbake-config-build>` | ||
238 | command-line utility. | ||
239 | |||
240 | For more details on fragments, see: | ||
241 | |||
242 | - The :doc:`/ref-manual/fragments` section of the Yocto Project Reference | ||
243 | Manual for a list of fragments the :term:`OpenEmbedded Build System` | ||
244 | supports, and a quick reference guide on how to manage fragments. | ||
245 | |||
246 | - The :doc:`/dev-manual/creating-fragments` section of the Yocto Project | ||
247 | Development Tasks Manual for details on how to create new fragments | ||
248 | in your build. | ||
157 | 249 | ||
158 | :term:`Container Layer` | 250 | :term:`Container Layer` |
159 | A flexible definition that typically refers to a single Git checkout | 251 | A flexible definition that typically refers to a single Git checkout |