From 51ae02fc0dc50b3a108c2b05d61592b803c710c5 Mon Sep 17 00:00:00 2001 From: Alexander Kanavin Date: Mon, 6 Oct 2025 15:47:57 +0200 Subject: 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 Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/fragments.rst | 4 ++-- documentation/ref-manual/structure.rst | 15 ++++++++++++--- 2 files changed, 14 insertions(+), 5 deletions(-) (limited to 'documentation/ref-manual') 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 :term:`OE_FRAGMENTS`, and the last value is taken into account: .. code-block:: - :caption: build/conf/auto.conf + :caption: build/conf/toolcfg.conf OE_FRAGMENTS += " ... machine/qemuarm64 machine/qemux86-64" @@ -103,7 +103,7 @@ In the above example, the value of :term:`MACHINE` is thus equal to When a fragment is enabled with :ref:`ref-bitbake-config-build-enable-fragment`, its name is automatically appended to the :term:`OE_FRAGMENTS` variable in -:ref:`structure-build-conf-auto.conf`. +:ref:`structure-build-conf-toolcfg.conf`. .. note:: 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 ` and contains the signatures locked by ``bblock``. By default, it does not exist and will be created upon the first invocation of ``bblock``. -.. _structure-build-conf-auto.conf: +.. _structure-build-conf-toolcfg.conf: -``build/conf/auto.conf`` ------------------------- +``build/conf/toolcfg.conf`` +--------------------------- This file contains configuration variables that are automatically modified by tools such as :oe_git:`bitbake-config-build `. This file should not be modified manually. +.. _structure-build-conf-auto.conf: + +``build/conf/auto.conf`` +------------------------ + +This file is intended for use by continuous integration environments, such as the +Yocto Project's :doc:`Autobuilder `. It +should not be created or modified when running local builds. + .. _structure-build-downloads: ``build/downloads/`` -- cgit v1.2.3-54-g00ecf