[PATCH] bitbake-user-manual: document TEMPLATECONF environment variable

[PATCH] bitbake-user-manual: document TEMPLATECONF environment variable

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index af4ff980..80005580 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -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.
-- 
2.25.1

Re: [bitbake-devel] [PATCH] bitbake-user-manual: document TEMPLATECONF environment variable

[Richard Purdie]

On Tue, 2022-04-26 at 23:49 +0200, Michael Opdenacker via lists.openembedded.org
wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> index af4ff980..80005580 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -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.
> +

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

Cheers,

Richard

Re: [docs] [bitbake-devel] [PATCH] bitbake-user-manual: document TEMPLATECONF environment variable

[Michael Opdenacker]

On 4/26/22 23:51, Richard Purdie wrote:
> On Tue, 2022-04-26 at 23:49 +0200, Michael Opdenacker via lists.openembedded.org
> wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> ---
>>  .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
>>  1 file changed, 16 insertions(+)
>>
>> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
>> index af4ff980..80005580 100644
>> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
>> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
>> @@ -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.
>> +
> 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.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [bitbake-devel] [PATCH] bitbake-user-manual: document TEMPLATECONF environment variable

[Richard Purdie]

On Tue, 2022-04-26 at 23:53 +0200, Michael Opdenacker wrote:
> On 4/26/22 23:51, Richard Purdie wrote:
> > On Tue, 2022-04-26 at 23:49 +0200, Michael Opdenacker via lists.openembedded.org
> > wrote:
> > > From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > > 
> > > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > > ---
> > >  .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++++++++++
> > >  1 file changed, 16 insertions(+)
> > > 
> > > diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> > > index af4ff980..80005580 100644
> > > --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> > > +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> > > @@ -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.
> > > +
> > 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...

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