summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-26 09:50:26 +0300
committerScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-26 09:50:26 +0300
commit4b2019e67324f0f86e1a49d256eddb4f9ca597f4 (patch)
tree40dcb0116a22b30e7019225fbfec6ad914f0436f /doc
parentee8db0cda1c8716ab0151a4859bfff84b2f3bd58 (diff)
downloadbitbake-4b2019e67324f0f86e1a49d256eddb4f9ca597f4.tar.gz
bitbake-user-manual-ref-variables.xml: Edits to PROVIDES variable.
Added some more detail to help describe the variable. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml32
1 files changed, 22 insertions, 10 deletions
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 b33a457d6..109c601d4 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/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>