aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
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
parentb09a3adb642a729c0bde1734d203fc3cfa53a7b9 (diff)
downloadopenembedded-core-contrib-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')
-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 @@
task of recipe "b".
This means anything that recipe "b" puts into sysroot
is available when recipe "a" is configuring itself.
+ <note>
+ <title>Notes</title>
+ <itemizedlist>
+ <listitem><para>
+ <filename>DEPENDS</filename> is a list of
+ recipe names.
+ Or, to be more precise, it is a list of
+ <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
+ names, which usually match recipe names.
+ Putting a package name such as "foo-dev" in
+ <filename>DEPENDS</filename> does not make
+ sense.
+ Use "foo" instead, as this will put files
+ from all the packages that make up "foo" -
+ including those from "foo-dev" - into the
+ sysroot.
+ </para></listitem>
+ <listitem><para>
+ Counter intuitively,
+ <filename>DEPENDS</filename> is often necessary
+ even for recipes that install precompiled
+ components.
+ For example, if "libfoo" is a precompiled
+ library that links against "libbar", then
+ linking against "libfoo" requires both "libfoo"
+ and "libbar" to be available in the sysroot.
+ Without a <filename>DEPENDS</filename> from the
+ recipe that installs "libfoo" to the recipe
+ that installs "libbar", other recipes might
+ fail to link against "libfoo".
+ </para></listitem>
+ </itemizedlist>
+ </note>
</para>
<para>