diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-04-27 18:40:24 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-05-10 12:52:35 +0100 |
| commit | 76ae67731364a8e77fadab500b845545d7776dfc (patch) | |
| tree | c11b3d992cd852e1263b69e586cabb354b2d4051 /documentation/ref-manual | |
| parent | 14c7cd24a579c00e18ad20e367e479389107da26 (diff) | |
| download | poky-76ae67731364a8e77fadab500b845545d7776dfc.tar.gz | |
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>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/structure.rst | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 15 |
2 files changed, 19 insertions, 4 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 262b041ea6..12a085552f 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -261,7 +261,7 @@ OpenEmbedded build system creates it from ``local.conf.sample`` when you | |||
| 261 | :ref:`structure-core-script`. | 261 | :ref:`structure-core-script`. |
| 262 | 262 | ||
| 263 | The source ``local.conf.sample`` file used depends on the | 263 | The source ``local.conf.sample`` file used depends on the |
| 264 | ``$TEMPLATECONF`` script variable, which defaults to ``meta-poky/conf/`` | 264 | :term:`TEMPLATECONF` script variable, which defaults to ``meta-poky/conf/`` |
| 265 | when you are building from the Yocto Project development environment, | 265 | when you are building from the Yocto Project development environment, |
| 266 | and to ``meta/conf/`` when you are building from the OpenEmbedded-Core | 266 | and to ``meta/conf/`` when you are building from the OpenEmbedded-Core |
| 267 | environment. Because the script variable points to the source of the | 267 | environment. Because the script variable points to the source of the |
| @@ -278,7 +278,7 @@ file, it uses ``sed`` to substitute final | |||
| 278 | 278 | ||
| 279 | .. note:: | 279 | .. note:: |
| 280 | 280 | ||
| 281 | You can see how the ``TEMPLATECONF`` variable is used by looking at the | 281 | You can see how the :term:`TEMPLATECONF` variable is used by looking at the |
| 282 | ``scripts/oe-setup-builddir`` script in the :term:`Source Directory`. | 282 | ``scripts/oe-setup-builddir`` script in the :term:`Source Directory`. |
| 283 | You can find the Yocto Project version of the ``local.conf.sample`` file in | 283 | You can find the Yocto Project version of the ``local.conf.sample`` file in |
| 284 | the ``meta-poky/conf`` directory. | 284 | the ``meta-poky/conf`` directory. |
| @@ -300,7 +300,7 @@ you ``source`` the top-level build environment setup script (i.e. | |||
| 300 | :ref:`structure-core-script`). | 300 | :ref:`structure-core-script`). |
| 301 | 301 | ||
| 302 | As with the ``local.conf`` file, the source ``bblayers.conf.sample`` | 302 | As with the ``local.conf`` file, the source ``bblayers.conf.sample`` |
| 303 | file used depends on the ``$TEMPLATECONF`` script variable, which | 303 | file used depends on the :term:`TEMPLATECONF` script variable, which |
| 304 | defaults to ``meta-poky/conf/`` when you are building from the Yocto | 304 | defaults to ``meta-poky/conf/`` when you are building from the Yocto |
| 305 | Project development environment, and to ``meta/conf/`` when you are | 305 | Project development environment, and to ``meta/conf/`` when you are |
| 306 | building from the OpenEmbedded-Core environment. Because the script | 306 | 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 | |||
| 315 | 315 | ||
| 316 | .. note:: | 316 | .. note:: |
| 317 | 317 | ||
| 318 | You can see how the ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir`` | 318 | You can see how the :term:`TEMPLATECONF` variable is defined by the ``scripts/oe-setup-builddir`` |
| 319 | script in the :term:`Source Directory`. You can find the Yocto Project | 319 | script in the :term:`Source Directory`. You can find the Yocto Project |
| 320 | version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/`` | 320 | version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/`` |
| 321 | directory. | 321 | directory. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index f164b7317a..a947caddf6 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -7899,6 +7899,21 @@ system and gives an overview of their function and contents. | |||
| 7899 | toolchain. You can use ``meta-sourcery`` as a template for adding | 7899 | toolchain. You can use ``meta-sourcery`` as a template for adding |
| 7900 | support for other external toolchains. | 7900 | support for other external toolchains. |
| 7901 | 7901 | ||
| 7902 | :term:`TEMPLATECONF` | ||
| 7903 | Specifies the directory used by the build system to find templates | ||
| 7904 | from which to build the ``bblayers.conf`` and ``local.conf`` files. | ||
| 7905 | Use this variable if you wish to customize such files, and the default | ||
| 7906 | BitBake targets shown when sourcing the ``oe-init-build-env`` script. | ||
| 7907 | |||
| 7908 | For details, see the | ||
| 7909 | :ref:`dev-manual/common-tasks:creating a custom template configuration directory` | ||
| 7910 | section in the Yocto Project Development Tasks manual. | ||
| 7911 | |||
| 7912 | .. note:: | ||
| 7913 | |||
| 7914 | You must set this variable in the external environment in order | ||
| 7915 | for it to work. | ||
| 7916 | |||
| 7902 | :term:`TEST_EXPORT_DIR` | 7917 | :term:`TEST_EXPORT_DIR` |
| 7903 | The location the OpenEmbedded build system uses to export tests when | 7918 | The location the OpenEmbedded build system uses to export tests when |
| 7904 | the :term:`TEST_EXPORT_ONLY` variable is set | 7919 | the :term:`TEST_EXPORT_ONLY` variable is set |
