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

[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

[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,

On 9/20/24 2:40 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 ]
> 

Please try to always have some commit log to explain what's going on in 
the commit. It is useful if one does `git log` without `-p`/`--patch` or 
if additional "metadata"/context to the code is important. E.g. here, 
you could have said that you were confused by the use of the underscore 
instead of the colon so you are now making this explicit.

I don't think it's warranted to send a v2 just for that, just think 
about it for your next contribution!

> Signed-off-by: Simon A. Eugster <simon.eu@gmail.com>

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin

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

[Simon Eugster]

[-- Attachment #1: Type: text/plain, Size: 1061 bytes --]

Hi Quentin,

thanks for the feedback. Will do that for the next patch!

Simon

On Mon, Sep 23, 2024 at 11:32 AM Quentin Schulz <quentin.schulz@cherry.de>
wrote:

> Hi Simon,
>
> On 9/20/24 2:40 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 ]
> >
>
> Please try to always have some commit log to explain what's going on in
> the commit. It is useful if one does `git log` without `-p`/`--patch` or
> if additional "metadata"/context to the code is important. E.g. here,
> you could have said that you were confused by the use of the underscore
> instead of the colon so you are now making this explicit.
>
> I don't think it's warranted to send a v2 just for that, just think
> about it for your next contribution!
>
> > Signed-off-by: Simon A. Eugster <simon.eu@gmail.com>
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> Thanks!
> Quentin
>

[-- Attachment #2: Type: text/html, Size: 1911 bytes --]

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

[Quentin Schulz]

Re-adding the docs mailing list.

On 12/3/24 3:09 PM, Simon A. Eugster via lists.openembedded.org wrote:
> You don't often get email from simon.eu=gmail.com@lists.openembedded.org. Learn why this is important<https://aka.ms/LearnAboutSenderIdentification>
> PS: Is this patch going to be merged?
> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#16857): https://lists.openembedded.org/g/bitbake-devel/message/16857
> Mute This Topic: https://lists.openembedded.org/mt/108604612/6293953
> Group Owner: bitbake-devel+owner@lists.openembedded.org
> Unsubscribe: https://lists.openembedded.org/g/bitbake-devel/unsub [quentin.schulz@cherry.de]
> -=-=-=-=-=-=-=-=-=-=-=-
>