ref-manual/ref-variables: correct and extend DEFAULT_PREFERENCE entry

Rewrote the description to break it up a bit and flow better.

(From yocto-docs rev: 7f0e8cf693b3b0a77537a15f7962f9e0e05fddfa)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton 2013-04-09 14:57:33 +01:00 committed by Richard Purdie
parent fb098b2126
commit 50eb7e4226
1 changed files with 21 additions and 1 deletions

View File

@ -741,7 +741,27 @@ Core layer for images cannot be removed
<glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
<glossdef>
<para>Specifies the priority of recipes.</para>
<para>
Specifies a weak bias for recipe selection priority.
Use this variable when more than one provider/version
satisfies a dependency.
</para>
<para>
The most common usage of this is variable is to set
it to "-1" within a recipe for a development version of a
piece of software.
Using the variable in this way causes the stable version
of the recipe to build by default in the absence of
<filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename>
being used to build the development version.
</para>
<note>
The bias provided by <filename>DEFAULT_PREFERENCE</filename>
is weak and is overridden by
<filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename>
if the selection priority is different between two layers
that contain different versions of the same recipe.
</note>
</glossdef>
</glossentry>