1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 05:29:32 +00:00

manuals: improve documentation for TEMPLATECONF

Add it to the variable index
Misc improvements to the documentation for this variable

(From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2022-04-27 18:40:24 +02:00
committed by Richard Purdie
parent 14c7cd24a5
commit 76ae677313
4 changed files with 24 additions and 9 deletions
+4 -4
View File
@@ -261,7 +261,7 @@ OpenEmbedded build system creates it from ``local.conf.sample`` when you
:ref:`structure-core-script`.
The source ``local.conf.sample`` file used depends on the
``$TEMPLATECONF`` script variable, which defaults to ``meta-poky/conf/``
:term:`TEMPLATECONF` script variable, which defaults to ``meta-poky/conf/``
when you are building from the Yocto Project development environment,
and to ``meta/conf/`` when you are building from the OpenEmbedded-Core
environment. Because the script variable points to the source of the
@@ -278,7 +278,7 @@ file, it uses ``sed`` to substitute final
.. note::
You can see how the ``TEMPLATECONF`` variable is used by looking at the
You can see how the :term:`TEMPLATECONF` variable is used by looking at the
``scripts/oe-setup-builddir`` script in the :term:`Source Directory`.
You can find the Yocto Project version of the ``local.conf.sample`` file in
the ``meta-poky/conf`` directory.
@@ -300,7 +300,7 @@ you ``source`` the top-level build environment setup script (i.e.
:ref:`structure-core-script`).
As with the ``local.conf`` file, the source ``bblayers.conf.sample``
file used depends on the ``$TEMPLATECONF`` script variable, which
file used depends on the :term:`TEMPLATECONF` script variable, which
defaults to ``meta-poky/conf/`` when you are building from the Yocto
Project development environment, and to ``meta/conf/`` when you are
building from the OpenEmbedded-Core environment. Because the script
@@ -315,7 +315,7 @@ Once the build process gets the sample file, it uses ``sed`` to substitute final
.. note::
You can see how the ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir``
You can see how the :term:`TEMPLATECONF` variable is defined by the ``scripts/oe-setup-builddir``
script in the :term:`Source Directory`. You can find the Yocto Project
version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/``
directory.
+15
View File
@@ -7899,6 +7899,21 @@ system and gives an overview of their function and contents.
toolchain. You can use ``meta-sourcery`` as a template for adding
support for other external toolchains.
:term:`TEMPLATECONF`
Specifies the directory used by the build system to find templates
from which to build the ``bblayers.conf`` and ``local.conf`` files.
Use this variable if you wish to customize such files, and the default
BitBake targets shown when sourcing the ``oe-init-build-env`` script.
For details, see the
:ref:`dev-manual/common-tasks:creating a custom template configuration directory`
section in the Yocto Project Development Tasks manual.
.. note::
You must set this variable in the external environment in order
for it to work.
:term:`TEST_EXPORT_DIR`
The location the OpenEmbedded build system uses to export tests when
the :term:`TEST_EXPORT_ONLY` variable is set