[PATCH] doc: Document FILE_LAYERNAME

[PATCH] doc: Document FILE_LAYERNAME

[Richard Purdie]

Document the new variable.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../bitbake-user-manual-ref-variables.rst                    | 5 +++++
 1 file changed, 5 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 ee5d7ba8d4..337cfa3ed5 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1072,6 +1072,11 @@ overview of their function and contents.
       environment variable. The value is a colon-separated list of
       directories that are searched left-to-right in order.
 
+   :term:`FILE_LAYERNAME`
+      During parsing and task execution, this is set to the name of the
+      layer containing the recipe file. Code can use this to identify which
+      layer a recipe is from.
+
    :term:`GITDIR`
       The directory in which a local copy of a Git repository is stored
       when it is cloned.
-- 
2.39.2

Re: [docs] [PATCH] doc: Document FILE_LAYERNAME

[Michael Opdenacker]

Hi Richard

On 20.06.23 at 15:58, Richard Purdie wrote:
> Document the new variable.
>
> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> ---
>   .../bitbake-user-manual-ref-variables.rst                    | 5 +++++
>   1 file changed, 5 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 ee5d7ba8d4..337cfa3ed5 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -1072,6 +1072,11 @@ overview of their function and contents.
>         environment variable. The value is a colon-separated list of
>         directories that are searched left-to-right in order.
>   
> +   :term:`FILE_LAYERNAME`
> +      During parsing and task execution, this is set to the name of the
> +      layer containing the recipe file. Code can use this to identify which
> +      layer a recipe is from.
> +
>      :term:`GITDIR`
>         The directory in which a local copy of a Git repository is stored
>         when it is cloned.


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

If you can merge this commit quickly, I'll be able to include the Yocto 
Manual one you submitted, referring to it.
Thanks!
Michael.

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

Re: [docs] [PATCH] doc: Document FILE_LAYERNAME

[Richard Purdie]

On Tue, 2023-06-20 at 22:16 +0200, Michael Opdenacker wrote:
> Hi Richard
> 
> On 20.06.23 at 15:58, Richard Purdie wrote:
> > Document the new variable.
> > 
> > Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> > ---
> >   .../bitbake-user-manual-ref-variables.rst                    | 5 +++++
> >   1 file changed, 5 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 ee5d7ba8d4..337cfa3ed5 100644
> > --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> > +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> > @@ -1072,6 +1072,11 @@ overview of their function and contents.
> >         environment variable. The value is a colon-separated list of
> >         directories that are searched left-to-right in order.
> >   
> > +   :term:`FILE_LAYERNAME`
> > +      During parsing and task execution, this is set to the name of the
> > +      layer containing the recipe file. Code can use this to identify which
> > +      layer a recipe is from.
> > +
> >      :term:`GITDIR`
> >         The directory in which a local copy of a Git repository is stored
> >         when it is cloned.
> 
> 
> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> If you can merge this commit quickly, I'll be able to include the Yocto 
> Manual one you submitted, referring to it.

Merged!

We may need to expand some of the documentation on this but I wanted to
at least have the basics.

Cheers,

Richard