aboutsummaryrefslogtreecommitdiff
path: root/docs/manual
diff options
context:
space:
mode:
authorGravatar Yann E. MORIN <yann.morin.1998@free.fr>2015-05-03 17:42:44 +0200
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2015-05-05 22:47:32 +0200
commit8548238e95491b98c2b6565c9bf31ee07cae13f3 (patch)
tree064f48cab501d0aefce9d785143d404203560a9b /docs/manual
parent808c3fb8d2271642afca9a82a51d24fa03a235f6 (diff)
downloadbuildroot-8548238e95491b98c2b6565c9bf31ee07cae13f3.tar.gz
buildroot-8548238e95491b98c2b6565c9bf31ee07cae13f3.tar.bz2
docs/manual: add list of instrumentation steps
The names of steps are not obvious, so add this list to the manual. Small formatting fix at the same time. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/debugging-buildroot.txt17
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/manual/debugging-buildroot.txt b/docs/manual/debugging-buildroot.txt
index b97f633bef..f575fc48ee 100644
--- a/docs/manual/debugging-buildroot.txt
+++ b/docs/manual/debugging-buildroot.txt
@@ -12,8 +12,8 @@ space-separated list, you want called before and after each step. The
scripts are called in sequence, with three parameters:
- +start+ or +end+ to denote the start (resp. the end) of a step;
- - the name of the step about to be started, or which just ended.
- - the name of the package
+ - the name of the step about to be started, or which just ended;
+ - the name of the package.
For example :
@@ -21,7 +21,18 @@ For example :
make BR2_INSTRUMENTATION_SCRIPTS="/path/to/my/script1 /path/to/my/script2"
----
-That script has access to the following variables:
+The list of steps is:
+
+ - +extract+
+ - +patch+
+ - +configure+
+ - +build+
+ - +install-host+, when a host-package is installed in +$(HOST_DIR)+
+ - +install-target+, when a target-package is installed in +$(TARGET_DIR)+
+ - +install-staging+, when a target-package is installed in +$(STAGING_DIR)+
+ - +install-image+, when a target-package installs files in +$(BINARIES_DIR)+
+
+The script has access to the following variables:
- +BR2_CONFIG+: the path to the Buildroot .config file
- +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see