Skip to contentSkip to conversation

documentation.conf: document PREFERRED_VERSION wildcard limitations

PATCH In review Andre McCurdy 3 participants 3 messages Dec 10, 2015

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 documentation.conf: document PREFERRED_VERSION wildcard limitations

PREFERRED_VERSION values containing the '%' wildcard should only be used when the wildcard pattern is known to only match one available recipe. See longer explanation in:

http://comments.gmane.org/gmane.comp.sysutils.bitbake.devel/1038

---
 meta/conf/documentation.conf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
meta/conf/documentation.conf +1 -1
index 845559a..c31c217 100644
@@ -332,7 +332,7 @@ PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenE
 PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build."
 PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'."
 PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference."
-PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference."
+PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference. The '%' wildcard is supported but should be used with care, results are unpredictable if it matches more than one available version."
 PREMIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code."
 PRINC[doc] = "Causes the PR variable of .bbappend files to dynamically increment. This increment minimizes the impact of layer ordering. This variable defaults to '0'."
 PRIORITY[doc] = "Indicates the importance of a package.  The default value is 'optional'.  Other standard values are 'required', 'standard' and 'extra'."
Signature · 1 line
1.9.1
Acked-by on v1 1/1
#1 lore raw
Quoted 5 lines · Andre McCurdy

PREFERRED_VERSION values containing the '%' wildcard should only be used when the wildcard pattern is known to only match one available recipe. See longer explanation in:

http://comments.gmane.org/gmane.comp.sysutils.bitbake.devel/1038

Thanks

Quoted 27 lines
---
 meta/conf/documentation.conf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
meta/conf/documentation.conf +1 -1
index 845559a..c31c217 100644
@@ -332,7 +332,7 @@ PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenE
 PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build."
 PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'."
 PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference."
-PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference."
+PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference. The '%' wildcard is supported but should be used with care, results are unpredictable if it matches more than one available version."
 PREMIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code."
 PRINC[doc] = "Causes the PR variable of .bbappend files to dynamically increment. This increment minimizes the impact of layer ordering. This variable defaults to '0'."
 PRIORITY[doc] = "Indicates the importance of a package.  The default value is 'optional'.  Other standard values are 'required', 'standard' and 'extra'."
Signature · 7 lines
1.9.1

-- 
_______________________________________________
Openembedded-core mailing list
[email protected]
http://lists.openembedded.org/mailman/listinfo/openembedded-core
Signature · 1 line
Martin 'JaMa' Jansa     jabber: [email protected]
#2 lore raw
Quoted 8 lines · On Thu, 10 Dec 2015 19:37:20 Martin Jansa wrote:
Quoted 5 lines · Andre McCurdy

PREFERRED_VERSION values containing the '%' wildcard should only be used when the wildcard pattern is known to only match one available

recipe. See longer explanation in:
http://comments.gmane.org/gmane.comp.sysutils.bitbake.devel/1038

Thanks

Note that documentation.conf is not intended for notes like this. There are far too many caveats to using our variables than can be reasonably covered by the short descriptions that go into this file - we have a reference manual with a detailed variable glossary for that sort of thing. We need to update the manual instead.

Cheers,
Paul

Signature · 2 lines
Paul Eggleton
Intel Open Source Technology Centre