Skip to contentSkip to conversation

bitbake-user-manual: explicit variables taking a colon separated list

PATCH In review [email protected] 2 participants 3 messages Jun 19, 2023 – Jun 20, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bitbake-user-manual: explicit variables taking a colon separated list

From: Michael Opdenacker <[email protected]>

[YOCTO #15128]

---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +8 -8
index 01d4f8d1..ee5d7ba8 100644
@@ -920,9 +920,9 @@ overview of their function and contents.
       section.
 
    :term:`BBPATH`
-      Used by BitBake to locate class (``.bbclass``) and configuration
-      (``.conf``) files. This variable is analogous to the ``PATH``
-      variable.
+      A colon-separated list used by BitBake to locate class (``.bbclass``)
+      and configuration (``.conf``) files. This variable is analogous to the
+      ``PATH`` variable.
 
       If you run BitBake from a directory outside of the build directory,
       you must be sure to set :term:`BBPATH` to point to the build directory.
@@ -1165,8 +1165,8 @@ overview of their function and contents.
       order.
 
    :term:`OVERRIDES`
-      BitBake uses :term:`OVERRIDES` to control what variables are overridden
-      after BitBake parses recipes and configuration files.
+      A colon-separated list that BitBake uses to control what variables are
+      overridden after BitBake parses recipes and configuration files.
 
       Following is a simple example that uses an overrides list based on
       machine architectures: OVERRIDES = "arm:x86:mips:powerpc" You can
@@ -1225,9 +1225,9 @@ overview of their function and contents.
          PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
 
    :term:`PREFERRED_PROVIDERS`
-      Determines which recipe should be given preference for cases where
-      multiple recipes provide the same item. Functionally,
-      :term:`PREFERRED_PROVIDERS` is identical to
+      A colon-separated list to determine which recipe should be given
+      preference for cases where multiple recipes provide the same item.
+      Functionally, :term:`PREFERRED_PROVIDERS` is identical to
       :term:`PREFERRED_PROVIDER`. However, the :term:`PREFERRED_PROVIDERS` variable
       lets you define preferences for multiple situations using the following
       form::
Signature · 1 line
2.34.1
#1 lore raw

Hi Mike,

Quoted 40 lines · On Mon, 19 Jun 2023 18:06:14 +0200 "Michael Opdenacker via…

From: Michael Opdenacker <[email protected]>

[YOCTO #15128]

---
 .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +5 -5
index 01d4f8d1..ee5d7ba8 100644
@@ -920,9 +920,9 @@ overview of their function and contents.
       section.
 
    :term:`BBPATH`
-      Used by BitBake to locate class (``.bbclass``) and configuration
-      (``.conf``) files. This variable is analogous to the ``PATH``
-      variable.
+      A colon-separated list used by BitBake to locate class (``.bbclass``)
+      and configuration (``.conf``) files. This variable is analogous to the
+      ``PATH`` variable.
 
       If you run BitBake from a directory outside of the build directory,
       you must be sure to set :term:`BBPATH` to point to the build directory.
@@ -1165,8 +1165,8 @@ overview of their function and contents.
       order.
 
    :term:`OVERRIDES`
-      BitBake uses :term:`OVERRIDES` to control what variables are overridden
-      after BitBake parses recipes and configuration files.
+      A colon-separated list that BitBake uses to control what variables are
+      overridden after BitBake parses recipes and configuration files.
 
       Following is a simple example that uses an overrides list based on
       machine architectures: OVERRIDES = "arm:x86:mips:powerpc" You can
@@ -1225,9 +1225,9 @@ overview of their function and contents.
          PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
 

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

Quoted 10 lines
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +3 -3
    :term:`PREFERRED_PROVIDERS`
-      Determines which recipe should be given preference for cases where
-      multiple recipes provide the same item. Functionally,
-      :term:`PREFERRED_PROVIDERS` is identical to
+      A colon-separated list to determine which recipe should be given
+      preference for cases where multiple recipes provide the same item.
+      Functionally, :term:`PREFERRED_PROVIDERS` is identical to
       :term:`PREFERRED_PROVIDER`. However, the :term:`PREFERRED_PROVIDERS` variable
       lets you define preferences for multiple situations using the following
       form::

If I read the docs correctly, PREFERRED_PROVIDERS is not a colon-separated list but rather a space-separated list [of colon-separated pairs].

Otherwise looks good, and useful -- thanks!

Luca

Signature · 3 lines
Luca Ceresoli, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#2 lore raw

Hi Luca,

Thanks a lot for the review!

Quoted 46 lines · Luca Ceresoli

Hi Mike,

Quoted 40 lines · On Mon, 19 Jun 2023 18:06:14 +0200 "Michael Opdenacker via…

From: Michael Opdenacker <[email protected]>

[YOCTO #15128]

---
  .../bitbake-user-manual-ref-variables.rst        | 16 ++++++++--------
  1 file changed, 8 insertions(+), 8 deletions(-)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +5 -5
index 01d4f8d1..ee5d7ba8 100644
@@ -920,9 +920,9 @@ overview of their function and contents.
        section.
 
     :term:`BBPATH`
-      Used by BitBake to locate class (``.bbclass``) and configuration
-      (``.conf``) files. This variable is analogous to the ``PATH``
-      variable.
+      A colon-separated list used by BitBake to locate class (``.bbclass``)
+      and configuration (``.conf``) files. This variable is analogous to the
+      ``PATH`` variable.
 
        If you run BitBake from a directory outside of the build directory,
        you must be sure to set :term:`BBPATH` to point to the build directory.
@@ -1165,8 +1165,8 @@ overview of their function and contents.
        order.
 
     :term:`OVERRIDES`
-      BitBake uses :term:`OVERRIDES` to control what variables are overridden
-      after BitBake parses recipes and configuration files.
+      A colon-separated list that BitBake uses to control what variables are
+      overridden after BitBake parses recipes and configuration files.
 
        Following is a simple example that uses an overrides list based on
        machine architectures: OVERRIDES = "arm:x86:mips:powerpc" You can
@@ -1225,9 +1225,9 @@ overview of their function and contents.
           PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
 
Quoted 13 lines

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

Quoted 10 lines
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +3 -3
     :term:`PREFERRED_PROVIDERS`
-      Determines which recipe should be given preference for cases where
-      multiple recipes provide the same item. Functionally,
-      :term:`PREFERRED_PROVIDERS` is identical to
+      A colon-separated list to determine which recipe should be given
+      preference for cases where multiple recipes provide the same item.
+      Functionally, :term:`PREFERRED_PROVIDERS` is identical to
        :term:`PREFERRED_PROVIDER`. However, the :term:`PREFERRED_PROVIDERS` variable
        lets you define preferences for multiple situations using the following
        form::

If I read the docs correctly, PREFERRED_PROVIDERS is not a colon-separated list but rather a space-separated list [of colon-separated pairs].

Oops, you're right. bitbake/lib/bb/cooker.py confirms this. I'm sending an update.
Thanks again
Mike.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com