ref-manual: Updated the PROVIDES variable description.

Added more information about virtual targets to the end of the
description.

Fixes [YOCTO #10011]

(From yocto-docs rev: ce7ae0c6ad4ad3a0c2422b797556563dc48a9a5b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-07-29 10:13:52 -07:00 committed by Richard Purdie
parent 70ccc66126
commit dfd845a126
1 changed files with 28 additions and 0 deletions

View File

@ -9951,6 +9951,34 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The <filename>PROVIDES</filename> statement results in
the "libav" recipe also being known as "libpostproc".
</para>
<para>
In addition to providing recipes under alternate names,
the <filename>PROVIDES</filename> mechanism is also used
to implement virtual targets.
A virtual target is a name that corresponds to some
particular functionality (e.g. a Linux kernel).
Recipes that provide the functionality in question list the
virtual target in <filename>PROVIDES</filename>.
Recipes that depend on the functionality in question can
include the virtual target in
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
to leave the choice of provider open.
</para>
<para>
Conventionally, virtual targets have names on the form
"virtual/function" (e.g. "virtual/kernel").
The slash is simply part of the name and has no
syntactical significance.
</para>
<para>
The
<link linkend='var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></link>
variable is used to select which particular recipe
provides a virtual target.
</para>
</glossdef>
</glossentry>