Skip to contentSkip to conversation

bitbake-user-manual: document TEMPLATECONF environment variable

PATCH In review [email protected] 2 participants 4 messages Apr 26, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bitbake-user-manual: document TEMPLATECONF environment variable

From: Michael Opdenacker <[email protected]>

---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +16 -0
index af4ff980..80005580 100644
@@ -1483,6 +1483,22 @@ overview of their function and contents.
       consist mostly of task logs and scripts, when building a particular
       recipe.
 
+   :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
+      :yocto_docs:`Creating a Custom Template Configuration Directory
+      </dev-manual/common-tasks.html#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:`TOPDIR`
       Points to the build directory. BitBake automatically sets this
       variable.
Signature · 1 line
2.25.1
#1 lore raw
Quoted 21 lines · Michael Opdenacker via lists.openembedded.org

From: Michael Opdenacker <[email protected]>

---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +6 -0
index af4ff980..80005580 100644
@@ -1483,6 +1483,22 @@ overview of their function and contents.
       consist mostly of task logs and scripts, when building a particular
       recipe.
 
+   :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.
+

doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst overview of their function and contents. · line 1501

Quoted 10 lines
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +10 -0
+      For details, see the
+      :yocto_docs:`Creating a Custom Template Configuration Directory
+      </dev-manual/common-tasks.html#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.
+

I don't think this is a bitbake variable, it is an OE one?

Cheers,

Richard

#2 lore raw
Quoted 26 lines · Richard Purdie
Quoted 24 lines · Michael Opdenacker via lists.openembedded.org

From: Michael Opdenacker <[email protected]>

---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +9 -0
index af4ff980..80005580 100644
@@ -1483,6 +1483,22 @@ overview of their function and contents.
       consist mostly of task logs and scripts, when building a particular
       recipe.
 
+   :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
+      :yocto_docs:`Creating a Custom Template Configuration Directory
+      </dev-manual/common-tasks.html#creating-a-custom-template-configuration-directory>`
Quoted 8 lines

doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst overview of their function and contents. · line 1501

Quoted 7 lines
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +7 -0
+      section in the Yocto Project Development Tasks manual.
+
+      .. note::
+
+         You must set this variable in the external environment in order
+         for it to work.
+

I don't think this is a bitbake variable, it is an OE one?

Actually, it's used in toaster.
But I don't mind adding it in Yocto Docs instead...

Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#3 lore raw
Quoted 37 lines · Michael Opdenacker
Quoted 26 lines · Richard Purdie
Quoted 24 lines · Michael Opdenacker via lists.openembedded.org

From: Michael Opdenacker <[email protected]>

---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +9 -0
index af4ff980..80005580 100644
@@ -1483,6 +1483,22 @@ overview of their function and contents.
       consist mostly of task logs and scripts, when building a particular
       recipe.
 
+   :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
+      :yocto_docs:`Creating a Custom Template Configuration Directory
+      </dev-manual/common-tasks.html#creating-a-custom-template-configuration-directory>`
Quoted 8 lines

doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst overview of their function and contents. · line 1501

Quoted 7 lines
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +7 -0
+      section in the Yocto Project Development Tasks manual.
+
+      .. note::
+
+         You must set this variable in the external environment in order
+         for it to work.
+

I don't think this is a bitbake variable, it is an OE one?

Quoted 2 lines

Actually, it's used in toaster.
But I don't mind adding it in Yocto Docs instead...

I did notice that but toaster breaks a few of the boundaries between bitbake and OE. It is meant to be an OE specific variable.

Cheers,

Richard