[PATCH] documentation.conf: document PREFERRED_VERSION wildcard limitations

[PATCH] documentation.conf: document PREFERRED_VERSION wildcard limitations

[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

Signed-off-by: Andre McCurdy <armccurdy@gmail.com>
---
 meta/conf/documentation.conf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
index 845559a..c31c217 100644
--- a/meta/conf/documentation.conf
+++ b/meta/conf/documentation.conf
@@ -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'."
-- 
1.9.1

Re: [PATCH] documentation.conf: document PREFERRED_VERSION wildcard limitations

[Martin Jansa]

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

On Thu, Dec 10, 2015 at 10:33:27AM -0800, Andre McCurdy wrote:
> 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

Acked-by: Martin Jansa <Martin.Jansa@gmail.com>

> 
> Signed-off-by: Andre McCurdy <armccurdy@gmail.com>
> ---
>  meta/conf/documentation.conf | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
> index 845559a..c31c217 100644
> --- a/meta/conf/documentation.conf
> +++ b/meta/conf/documentation.conf
> @@ -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'."
> -- 
> 1.9.1
> 
> -- 
> _______________________________________________
> Openembedded-core mailing list
> Openembedded-core@lists.openembedded.org
> http://lists.openembedded.org/mailman/listinfo/openembedded-core

-- 
Martin 'JaMa' Jansa     jabber: Martin.Jansa@gmail.com

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 188 bytes --]

Re: [PATCH] documentation.conf: document PREFERRED_VERSION wildcard limitations

[Paul Eggleton]

On Thu, 10 Dec 2015 19:37:20 Martin Jansa wrote:
> On Thu, Dec 10, 2015 at 10:33:27AM -0800, Andre McCurdy wrote:
> > 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

-- 

Paul Eggleton
Intel Open Source Technology Centre