From 157c80f488d6fb90ea27feed26fe6ceee914da48 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Thu, 26 Jun 2014 09:50:26 +0300
Subject: bitbake: bitbake-user-manual-ref-variables.xml: Edits to PROVIDES
 variable.

Added some more detail to help describe the variable.

(Bitbake rev: 4b2019e67324f0f86e1a49d256eddb4f9ca597f4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../bitbake-user-manual-ref-variables.xml          | 32 +++++++++++++++-------
 1 file changed, 22 insertions(+), 10 deletions(-)

(limited to 'bitbake/doc')

diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index b33a457d63..109c601d46 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
@@ -1744,16 +1744,28 @@
         <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
             <glossdef>
                 <para>
-                    A list of aliases that a recipe also provides.
-                    These aliases are useful for satisfying dependencies of
-                    other recipes during the build (as specified by
-                    <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>).
-                    <note>
-                        A recipe's own
-                        <filename><link linkend='var-PN'>PN</link></filename>
-                        is implicitly already in its
-                        <filename>PROVIDES</filename> list.
-                    </note>
+                    A list of aliases by which a particular recipe can be
+                    known.
+                    By default, a recipe's own
+                    <filename><link linkend='var-PN'>PN</link></filename>
+                    is implicitly already in its <filename>PROVIDES</filename>
+                    list.
+                    If a recipe uses <filename>PROVIDES</filename>, the
+                    additional aliases are synonyms for the recipe and can
+                    be useful satisfying dependencies of other recipes during
+                    the build as specified by
+                    <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>.
+                </para>
+
+                <para>
+                    Consider the following example
+                    <filename>PROVIDES</filename> statement from a recipe
+                    file <filename>libav_0.8.11.bb</filename>:
+                    <literallayout class='monospaced'>
+     PROVIDES += "libpostproc"
+                    </literallayout>
+                    The <filename>PROVIDES</filename> statement results in
+                    the "libav" recipe also being known as "libpostproc".
                 </para>
             </glossdef>
         </glossentry>
-- 
cgit v1.2.3-54-g00ecf