From bb8e0a4d8b3c4cb41011408d913283ebcaa37b47 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Fri, 7 Jun 2013 15:23:04 +0300
Subject: ref-manual: Updates to the RDEPENDS variable entry.

Re-wrote some stuff to be clearer.

(From yocto-docs rev: b4c117fe17aaf2385be192fc6cd6d634331828a0)

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

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index b56b43fdf4..a7635e07d4 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3050,20 +3050,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                 </para>
 
                 <para>
-                    The names of the variables you list with
+                    The names of the packages you list within
                     <filename>RDEPENDS</filename> must be the names of other
-                    packages as listed in the
+                    packages - they cannot be recipe names.
+                    <note>
+                        Although package names and recipe names usually match,
+                        the important point here is that you are
+                        providing package names within the
+                        <filename>RDEPENDS</filename> variable.
+                    </note>
+                    For an example of the default list of packages created from
+                    a recipe, see the
                     <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
                     variable.
-                    You should not list recipe names
-                    (<link linkend='var-PN'><filename>PN</filename></link>).
                 </para>
 
                 <para>
                     Because the <filename>RDEPENDS</filename> variable applies
-                    to packages being built, you should
-                    always attach a package name to the variable to specify the
-                    particular run-time package that has the dependency.
+                    to packages being built, you should always use the variable
+                    in a form with an attached package name.
                     For example, suppose you are building a development package
                     that depends on the <filename>perl</filename> package.
                     In this case, you would use the following
@@ -3071,17 +3076,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <literallayout class='monospaced'>
      RDEPENDS_${PN}-dev += "perl"
                     </literallayout>
-                    In the example, the package name
-                    (<filename>${PN}-dev</filename>) must appear as it would
-                    in the
+                    In the example, the development package depends on
+                    the <filename>perl</filename> package.
+                    Thus, the <filename>RDEPENDS</filename> variable has the
+                    <filename>${PN}-dev</filename> package name as part of the
+                    variable.
+                </para>
+
+                <para>
+                    If the package with the dependency is one of the default
+                    packages as listed in the
                     <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
+                    variable, the package name you attach to the
+                    <filename>RDEPENDS</filename> variable must appear
+                    as it would in the <filename>PACKAGES</filename>
                     namespace before any renaming of the output package by
                     classes like <filename>debian.bbclass</filename>.
                 </para>
 
                 <para>
-                    In many cases you do not need to explicitly add dependencies
-                    to <filename>RDEPENDS</filename> since some automatic
+                    In many cases you do not need to explicitly add
+                    run-time dependencies using
+                    <filename>RDEPENDS</filename> since some automatic
                     handling occurs:
                     <itemizedlist>
                         <listitem><para><emphasis><filename>shlibdeps</filename></emphasis>:  If
-- 
cgit v1.2.3-54-g00ecf