[oe-commits] [bitbake] 07/09: bitbake-user-manual: Updated the PROVIDES variable

[git at git.openembedded.org]

rpurdie pushed a commit to branch master
in repository bitbake.

commit fc47bb99dbc1972dfb3a83c0f4c479963da64bcc
Author: Scott Rifenbark <srifenbark at gmail.com>
AuthorDate: Fri Jul 29 14:08:25 2016 -0700

    bitbake-user-manual: Updated the PROVIDES variable
    
    Fixes [YOCTO #10011]
    
    Added paragraphs near the end to describe the role of virtual
    targets.
    
    Signed-off-by: Scott Rifenbark <srifenbark at gmail.com>
---
 .../bitbake-user-manual-ref-variables.xml           | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index a152218..dcf3ab3 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
@@ -1976,6 +1976,27 @@
                     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>
             </glossdef>
         </glossentry>
 

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.