From cd2a26c0184c80ba5878ff631bfe0204017a26f1 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 22 Sep 2016 09:07:59 -0700 Subject: [PATCH] ref-manual: Updated the DEPENDS variable description Fixes [YOCTO #10298] Added a better front part description to the variable. (From yocto-docs rev: ce8a093235aa78761fde66f345f993ab7cfac6c6) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 57 ++++++++++++++++------ 1 file changed, 42 insertions(+), 15 deletions(-) diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 9d53fea0f3..99f3e03446 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -2787,28 +2787,55 @@ - Lists a recipe's build-time dependencies - (i.e. other recipe files). - The system ensures that all the dependencies listed - have been built and have their contents in the appropriate - sysroots before the recipe's configure task is executed. + Lists a recipe's build-time dependencies. + These dependencies are on other recipes whose + contents (e.g. headers and shared libraries) are needed + by the recipe at build time. - Consider this simple example for two recipes named "a" and - "b" that produce similarly named packages. - In this example, the DEPENDS - statement appears in the "a" recipe: + As an example, consider a recipe foo + that contains the following assignment: - DEPENDS = "b" + DEPENDS = "bar" - Here, the dependency is such that the + The practical effect of the previous assignment is that + all files installed by bar will be + available in the appropriate staging sysroot (i.e. + STAGING_DIR* + variables) by the time the do_configure - task for recipe "a" depends on the + task for foo runs. + This mechanism is implemented by having + do_configure depend on the do_populate_sysroot - task of recipe "b". - This means anything that recipe "b" puts into sysroot - is available when recipe "a" is configuring itself. + task of each recipe listed in DEPENDS + through a + [deptask] + declaration in the + base + class. + + It seldom is necessary to reference, for example, + STAGING_DIR_HOST explicitly. + The standard classes and build-related variables are + configured to automatically use the appropriate staging + sysroots. + + As another example, DEPENDS can also + be used to add utilities that run on the build machine + during the build. + For example, a recipe that makes use of a code generator + built by the recipe codegen might have + the following: + + DEPENDS = "codegen-native" + + For more information, see the + native + class and the + EXTRANATIVEPATH + variable. Notes