diff options
| author | Antonin Godard <antonin.godard@bootlin.com> | 2025-10-30 15:13:02 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-11-07 13:15:33 +0000 |
| commit | 4a433280ab82c46ce2e9152ef392c3b06399d6f9 (patch) | |
| tree | 0263847a0f91d4d17fa8cce7aa8212a188dc7138 /documentation/ref-manual/structure.rst | |
| parent | ef4ac510f6da2b6f34256159b57887f4c2117b2a (diff) | |
| download | poky-4a433280ab82c46ce2e9152ef392c3b06399d6f9.tar.gz | |
ref-manual/structure.rst: update the description of local.conf and bblayers.conf
The local.conf file is now mostly empty with the default way of setting
up the environment (with bitbake-setup), and this file is meant to hold
local user configurations, rather than an extensive list of variables.
Adjust the description to reflect the intended way of using this
configuration file.
Also, for both local.conf and bblayers.conf, rephrase the current
usage of the template files (.sample files) to _not_ imply that it is
the default way the OpenEmbedded build system sets things up.
(From yocto-docs rev: 24f24d07fd688825b2ec39dcf0daf8203577f87a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/structure.rst')
| -rw-r--r-- | documentation/ref-manual/structure.rst | 36 |
1 files changed, 16 insertions, 20 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 2640f461d6..a2f2fd4507 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -269,22 +269,19 @@ This directory should not be shared between builds. | |||
| 269 | ``build/conf/local.conf`` | 269 | ``build/conf/local.conf`` |
| 270 | ------------------------- | 270 | ------------------------- |
| 271 | 271 | ||
| 272 | This configuration file contains all the local user configurations for | 272 | This configuration file contains the local user configurations for the build |
| 273 | your build environment. The ``local.conf`` file contains documentation | 273 | environment. |
| 274 | on the various configuration options. Any variable set here overrides | 274 | |
| 275 | any variable set elsewhere within the environment unless that variable | 275 | You could for example experiment with setting (or adding to) |
| 276 | is hard-coded within a file (e.g. by using '=' instead of '?='). Some | 276 | :term:`DISTRO_FEATURES` or :term:`IMAGE_FEATURES`, or adjust build |
| 277 | variables are hard-coded for various reasons but such variables are | 277 | configurations for specific recipes by setting the :term:`PACKAGECONFIG` |
| 278 | relatively rare. | 278 | variables for them. If you would like to publish and share changes made to this |
| 279 | 279 | file, it is recommended to put them into a distro :term:`configuration file`, or | |
| 280 | At a minimum, you would normally edit this file to select the target | 280 | to create layer :term:`configuration fragments <Configuration Fragment>` from |
| 281 | :term:`MACHINE`, which package types you wish to use | 281 | changes made here. |
| 282 | (:term:`PACKAGE_CLASSES`), and the location from | 282 | |
| 283 | which you want to access downloaded files (:term:`DL_DIR`). | 283 | The :term:`OpenEmbedded Build System` can create it from a ``local.conf.sample`` |
| 284 | 284 | file when you ``source`` the top-level build environment setup script | |
| 285 | If ``local.conf`` is not present when you start the build, the | ||
| 286 | OpenEmbedded build system creates it from ``local.conf.sample`` when you | ||
| 287 | ``source`` the top-level build environment setup script | ||
| 288 | :ref:`structure-core-script`. | 285 | :ref:`structure-core-script`. |
| 289 | 286 | ||
| 290 | The source ``local.conf.sample`` file used depends on the | 287 | The source ``local.conf.sample`` file used depends on the |
| @@ -321,12 +318,11 @@ which are directory trees, traversed (or walked) by BitBake. The | |||
| 321 | ``bblayers.conf`` file uses the :term:`BBLAYERS` | 318 | ``bblayers.conf`` file uses the :term:`BBLAYERS` |
| 322 | variable to list the layers BitBake tries to find. | 319 | variable to list the layers BitBake tries to find. |
| 323 | 320 | ||
| 324 | If ``bblayers.conf`` is not present when you start the build, the | 321 | The OpenEmbedded build system can create it from a ``bblayers.conf.sample`` file |
| 325 | OpenEmbedded build system creates it from ``bblayers.conf.sample`` when | 322 | when you ``source`` the top-level build environment setup script (i.e. |
| 326 | you ``source`` the top-level build environment setup script (i.e. | ||
| 327 | :ref:`structure-core-script`). | 323 | :ref:`structure-core-script`). |
| 328 | 324 | ||
| 329 | As with the ``local.conf`` file, the source ``bblayers.conf.sample`` | 325 | As with the :ref:`structure-build-conf-local.conf` file, the source ``bblayers.conf.sample`` |
| 330 | file used depends on the :term:`TEMPLATECONF` script variable, which | 326 | file used depends on the :term:`TEMPLATECONF` script variable, which |
| 331 | defaults to ``meta-poky/conf/templates/default`` when you are building from the Yocto | 327 | defaults to ``meta-poky/conf/templates/default`` when you are building from the Yocto |
| 332 | Project development environment, and to ``meta/conf/templates/default`` when you are | 328 | Project development environment, and to ``meta/conf/templates/default`` when you are |
