aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-26 14:29:07 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-07-03 13:57:10 +0100
commitf8d31147460e147696b27674a8a567dc321f6965 (patch)
tree35975fd9a591d157337fdc4a04e6d7b8f557b7c5 /documentation
parentc5ca7cd3dc697288be1a7c5db1794793a8ca90dc (diff)
downloadopenembedded-core-contrib-f8d31147460e147696b27674a8a567dc321f6965.tar.gz
ref-manual: Edits to PROVIDES variable.
More detail added. (From yocto-docs rev: 84177a600f84af4cc41b9493b46e2a23bc7ccc19) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml36
1 files changed, 24 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 59d7c0acbc..c34188defb 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6424,19 +6424,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
- <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
- <glossdef>
+ <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
+ <glossdef>
+ <para>
+ 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>
- 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>
+ 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>