From e8c8b41dc58cd0d8c7b0da649d0077645964b617 Mon Sep 17 00:00:00 2001 From: Thomas Petazzoni Date: Tue, 5 Nov 2019 17:46:45 +0100 Subject: [PATCH] docs/manual: document the effect of per-package directory on variables As suggested by Arnout Vandecappelle, this commit adjusts the generic-package documentation to document the effect of per-package directory support on HOST_DIR, STAGING_DIR and TARGET_DIR. Suggested-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Thomas Petazzoni Signed-off-by: Peter Korsgaard --- docs/manual/adding-packages-generic.txt | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt index b2386f2c01..86300e7460 100644 --- a/docs/manual/adding-packages-generic.txt +++ b/docs/manual/adding-packages-generic.txt @@ -586,6 +586,13 @@ In the action definitions, you can use the following variables: * +$(TARGET_CROSS)+ to get the cross-compilation toolchain prefix * Of course the +$(HOST_DIR)+, +$(STAGING_DIR)+ and +$(TARGET_DIR)+ - variables to install the packages properly. + variables to install the packages properly. Those variables point to + the global _host_, _staging_ and _target_ directories, unless + _per-package directory_ support is used, in which case they point to + the current package _host_, _staging_ and _target_ directories. In + both cases, it doesn't make any difference from the package point of + view: it should simply use +HOST_DIR+, +STAGING_DIR+ and + +TARGET_DIR+. See xref:top-level-parallel-build[] for more details + about _per-package directory_ support. Finally, you can also use hooks. See xref:hooks[] for more information.