Commit 8548238e authored by Yann E. MORIN's avatar Yann E. MORIN Committed by Thomas Petazzoni
Browse files

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: default avatar"Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Arnout Vandecappelle <arnout@mind.be>
Reviewed-by: default avatarArnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: default avatarThomas Petazzoni <thomas.petazzoni@free-electrons.com>
parent 808c3fb8

docs/manual/debugging-buildroot.txt

+14 −3
Original line number Diff line number Diff line
@@ -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