[PATCH 0/1] Clarify that _ and not : is used for suffixing the variable name.

[PATCH 0/1] Clarify that _ and not : is used for suffixing the variable name.

[Simon A. Eugster]

Simon A. Eugster (1):
  bitbake: doc: suffix for BBFILE_PRIORITY

 .../bitbake-user-manual-ref-variables.rst                   | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

-- 
2.43.0

[PATCH 1/1] bitbake: doc: suffix for BBFILE_PRIORITY

[Simon A. Eugster]

Signed-off-by: Simon A. Eugster <simon.eu@gmail.com>
---
 .../bitbake-user-manual-ref-variables.rst                   | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 899e584f91..c203531f51 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -766,6 +766,10 @@ overview of their function and contents.
    :term:`BBFILE_PRIORITY`
       Assigns the priority for recipe files in each layer.
 
+      This variable is used in the ``conf/layer.conf`` file and must be
+      suffixed with a `_` followed by the name of the specific layer (e.g.
+      ``BBFILE_PRIORITY_emenlow``). Colon as separator is not supported.
+
       This variable is useful in situations where the same recipe appears
       in more than one layer. Setting this variable allows you to
       prioritize a layer against other layers that contain the same recipe
@@ -780,7 +784,7 @@ overview of their function and contents.
       higher precedence. For example, the value 6 has a higher precedence
       than the value 5. If not specified, the :term:`BBFILE_PRIORITY` variable
       is set based on layer dependencies (see the :term:`LAYERDEPENDS` variable
-      for more information. The default priority, if unspecified for a
+      for more information). The default priority, if unspecified for a
       layer with no dependencies, is the lowest defined priority + 1 (or 1
       if no priorities are defined).
 
-- 
2.43.0

Re: [docs] [PATCH 1/1] bitbake: doc: suffix for BBFILE_PRIORITY

[Quentin Schulz]

Hi Simon,

The patch should have been sent to bitbake-devel mailing list as well 
since it'll be the responsibility of those maintainers and not 
yocto-docs' maintainers to merge it. Can you please resend with both 
mailing lists so that the people in charge receive it and can review it?

c.f. https://git.openembedded.org/bitbake/tree/README#n29

On 9/20/24 1:38 PM, Simon A. Eugster via lists.yoctoproject.org wrote:
> [You don't often get email from simon.eu=gmail.com@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> Signed-off-by: Simon A. Eugster <simon.eu@gmail.com>
> ---
>   .../bitbake-user-manual-ref-variables.rst                   | 6 +++++-
>   1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> index 899e584f91..c203531f51 100644
> --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -766,6 +766,10 @@ overview of their function and contents.
>      :term:`BBFILE_PRIORITY`
>         Assigns the priority for recipe files in each layer.
> 
> +      This variable is used in the ``conf/layer.conf`` file and must be
> +      suffixed with a `_` followed by the name of the specific layer (e.g.
> +      ``BBFILE_PRIORITY_emenlow``). Colon as separator is not supported.
> +
>         This variable is useful in situations where the same recipe appears
>         in more than one layer. Setting this variable allows you to
>         prioritize a layer against other layers that contain the same recipe
> @@ -780,7 +784,7 @@ overview of their function and contents.
>         higher precedence. For example, the value 6 has a higher precedence
>         than the value 5. If not specified, the :term:`BBFILE_PRIORITY` variable
>         is set based on layer dependencies (see the :term:`LAYERDEPENDS` variable
> -      for more information. The default priority, if unspecified for a
> +      for more information). The default priority, if unspecified for a
>         layer with no dependencies, is the lowest defined priority + 1 (or 1
>         if no priorities are defined).
> 

This seems reasonable to me, I'm wondering if we should explain how to 
find out the name of the layer (e.g. it's often not the name of the 
layer on the filesystem, but I think it's the one that's added to 
BBFILE_COLLECTIONS in conf/layer.conf of said layer?

Additionally, since this BBFILE_PRIORITY file is documented in both 
BitBake and YP docs, would you be so nice and send a patch for YP docs 
(https://git.yoctoproject.org/yocto-docs/) to remove the content of the 
variable in the glossary and just point at the BitBake docs instead? See 
https://docs.yoctoproject.org/ref-manual/variables.html#term-BB_BASEHASH_IGNORE_VARS 
and 
https://git.yoctoproject.org/yocto-docs/tree/documentation/ref-manual/variables.rst#n350 
for an example. This would mean we only would have one place to maintain 
instead of two :)

Thanks!
Quentin

[PATCH 1/1] bitbake: doc: suffix for BBFILE_PRIORITY

[Simon A. Eugster]

Signed-off-by: Simon A. Eugster <simon.eu@gmail.com>
---
 .../bitbake-user-manual-ref-variables.rst                   | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 899e584f91..c203531f51 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -766,6 +766,10 @@ overview of their function and contents.
    :term:`BBFILE_PRIORITY`
       Assigns the priority for recipe files in each layer.
 
+      This variable is used in the ``conf/layer.conf`` file and must be
+      suffixed with a `_` followed by the name of the specific layer (e.g.
+      ``BBFILE_PRIORITY_emenlow``). Colon as separator is not supported.
+
       This variable is useful in situations where the same recipe appears
       in more than one layer. Setting this variable allows you to
       prioritize a layer against other layers that contain the same recipe
@@ -780,7 +784,7 @@ overview of their function and contents.
       higher precedence. For example, the value 6 has a higher precedence
       than the value 5. If not specified, the :term:`BBFILE_PRIORITY` variable
       is set based on layer dependencies (see the :term:`LAYERDEPENDS` variable
-      for more information. The default priority, if unspecified for a
+      for more information). The default priority, if unspecified for a
       layer with no dependencies, is the lowest defined priority + 1 (or 1
       if no priorities are defined).
 
-- 
2.43.0