summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-14 12:31:38 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-07-19 15:04:51 +0100
commitacdfb5f3cc90e747f06ba655fa1b07e8d878e96e (patch)
tree24d215e89ac10a0b995c42169481d47cfe3594bd /documentation/ref-manual
parentb09a3adb642a729c0bde1734d203fc3cfa53a7b9 (diff)
downloadpoky-acdfb5f3cc90e747f06ba655fa1b07e8d878e96e.tar.gz
ref-manual: Added notes to the DEPENDS variable description.
Fixes [YOCTO #9933] Added two notes to help clarify how DEPENDS works with pre-compiled objects. There are some details that trip people up. (From yocto-docs rev: 06917e97adf24816b0aee6fdfdd14aa79d4c6ab2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml33
1 files changed, 33 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index b876bc3115..e265aa94bd 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2791,6 +2791,39 @@
2791 task of recipe "b". 2791 task of recipe "b".
2792 This means anything that recipe "b" puts into sysroot 2792 This means anything that recipe "b" puts into sysroot
2793 is available when recipe "a" is configuring itself. 2793 is available when recipe "a" is configuring itself.
2794 <note>
2795 <title>Notes</title>
2796 <itemizedlist>
2797 <listitem><para>
2798 <filename>DEPENDS</filename> is a list of
2799 recipe names.
2800 Or, to be more precise, it is a list of
2801 <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
2802 names, which usually match recipe names.
2803 Putting a package name such as "foo-dev" in
2804 <filename>DEPENDS</filename> does not make
2805 sense.
2806 Use "foo" instead, as this will put files
2807 from all the packages that make up "foo" -
2808 including those from "foo-dev" - into the
2809 sysroot.
2810 </para></listitem>
2811 <listitem><para>
2812 Counter intuitively,
2813 <filename>DEPENDS</filename> is often necessary
2814 even for recipes that install precompiled
2815 components.
2816 For example, if "libfoo" is a precompiled
2817 library that links against "libbar", then
2818 linking against "libfoo" requires both "libfoo"
2819 and "libbar" to be available in the sysroot.
2820 Without a <filename>DEPENDS</filename> from the
2821 recipe that installs "libfoo" to the recipe
2822 that installs "libbar", other recipes might
2823 fail to link against "libfoo".
2824 </para></listitem>
2825 </itemizedlist>
2826 </note>
2794 </para> 2827 </para>
2795 2828
2796 <para> 2829 <para>