diff options
| author | Alexander Kanavin <alex.kanavin@gmail.com> | 2025-10-06 15:47:57 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-10-14 11:36:58 +0100 |
| commit | 51ae02fc0dc50b3a108c2b05d61592b803c710c5 (patch) | |
| tree | a1481f12618815cb2847d81e0cf58fdc34e8703a /documentation/ref-manual | |
| parent | 5e956ddfc56019d0f2ecde1e06bd39fa8475fc9b (diff) | |
| download | poky-51ae02fc0dc50b3a108c2b05d61592b803c710c5.tar.gz | |
ref-manual: correctly document the difference between auto.conf and newly added toolcfg.conf
[AG: Add reference to YP Autobuilder]
(From yocto-docs rev: f23b93594dbe7e5df9ec55371e4aab4b7b8c50b9)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/fragments.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/structure.rst | 15 |
2 files changed, 14 insertions, 5 deletions
diff --git a/documentation/ref-manual/fragments.rst b/documentation/ref-manual/fragments.rst index c0118876c8..7fd08656d6 100644 --- a/documentation/ref-manual/fragments.rst +++ b/documentation/ref-manual/fragments.rst | |||
| @@ -94,7 +94,7 @@ Note that in this case, the fragment will be defined twice in | |||
| 94 | :term:`OE_FRAGMENTS`, and the last value is taken into account: | 94 | :term:`OE_FRAGMENTS`, and the last value is taken into account: |
| 95 | 95 | ||
| 96 | .. code-block:: | 96 | .. code-block:: |
| 97 | :caption: build/conf/auto.conf | 97 | :caption: build/conf/toolcfg.conf |
| 98 | 98 | ||
| 99 | OE_FRAGMENTS += " ... machine/qemuarm64 machine/qemux86-64" | 99 | OE_FRAGMENTS += " ... machine/qemuarm64 machine/qemux86-64" |
| 100 | 100 | ||
| @@ -103,7 +103,7 @@ In the above example, the value of :term:`MACHINE` is thus equal to | |||
| 103 | 103 | ||
| 104 | When a fragment is enabled with :ref:`ref-bitbake-config-build-enable-fragment`, | 104 | When a fragment is enabled with :ref:`ref-bitbake-config-build-enable-fragment`, |
| 105 | its name is automatically appended to the :term:`OE_FRAGMENTS` variable in | 105 | its name is automatically appended to the :term:`OE_FRAGMENTS` variable in |
| 106 | :ref:`structure-build-conf-auto.conf`. | 106 | :ref:`structure-build-conf-toolcfg.conf`. |
| 107 | 107 | ||
| 108 | .. note:: | 108 | .. note:: |
| 109 | 109 | ||
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 1aaafcf79b..2640f461d6 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -356,15 +356,24 @@ This configuration file is generated by :doc:`bblock </dev-manual/bblock>` and | |||
| 356 | contains the signatures locked by ``bblock``. By default, it does not exist | 356 | contains the signatures locked by ``bblock``. By default, it does not exist |
| 357 | and will be created upon the first invocation of ``bblock``. | 357 | and will be created upon the first invocation of ``bblock``. |
| 358 | 358 | ||
| 359 | .. _structure-build-conf-auto.conf: | 359 | .. _structure-build-conf-toolcfg.conf: |
| 360 | 360 | ||
| 361 | ``build/conf/auto.conf`` | 361 | ``build/conf/toolcfg.conf`` |
| 362 | ------------------------ | 362 | --------------------------- |
| 363 | 363 | ||
| 364 | This file contains configuration variables that are automatically modified by | 364 | This file contains configuration variables that are automatically modified by |
| 365 | tools such as :oe_git:`bitbake-config-build </bitbake/tree/bin/bitbake-config-build>`. | 365 | tools such as :oe_git:`bitbake-config-build </bitbake/tree/bin/bitbake-config-build>`. |
| 366 | This file should not be modified manually. | 366 | This file should not be modified manually. |
| 367 | 367 | ||
| 368 | .. _structure-build-conf-auto.conf: | ||
| 369 | |||
| 370 | ``build/conf/auto.conf`` | ||
| 371 | ------------------------ | ||
| 372 | |||
| 373 | This file is intended for use by continuous integration environments, such as the | ||
| 374 | Yocto Project's :doc:`Autobuilder </test-manual/understand-autobuilder>`. It | ||
| 375 | should not be created or modified when running local builds. | ||
| 376 | |||
| 368 | .. _structure-build-downloads: | 377 | .. _structure-build-downloads: |
| 369 | 378 | ||
| 370 | ``build/downloads/`` | 379 | ``build/downloads/`` |
