xref: /OK3568_Linux_fs/buildroot/docs/manual/debugging-buildroot.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1// -*- mode:doc; -*-
2// vim: set syntax=asciidoc:
3
4[[debugging-buildroot]]
5
6== Debugging Buildroot
7
8It is possible to instrument the steps +Buildroot+ does when building
9packages. Define the variable +BR2_INSTRUMENTATION_SCRIPTS+ to contain
10the path of one or more scripts (or other executables), in a
11space-separated list, you want called before and after each step. The
12scripts are called in sequence, with three parameters:
13
14  - +start+ or +end+ to denote the start (resp. the end) of a step;
15  - the name of the step about to be started, or which just ended;
16  - the name of the package.
17
18For example :
19
20----
21make BR2_INSTRUMENTATION_SCRIPTS="/path/to/my/script1 /path/to/my/script2"
22----
23
24The list of steps is:
25
26  - +extract+
27  - +patch+
28  - +configure+
29  - +build+
30  - +install-host+, when a host-package is installed in +$(HOST_DIR)+
31  - +install-target+, when a target-package is installed in +$(TARGET_DIR)+
32  - +install-staging+, when a target-package is installed in +$(STAGING_DIR)+
33  - +install-image+, when a target-package installs files in +$(BINARIES_DIR)+
34
35The script has access to the following variables:
36
37  - +BR2_CONFIG+: the path to the Buildroot .config file
38  - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
39    xref:generic-package-reference[]
40  - +BUILD_DIR+: the directory where packages are extracted and built
41  - +BINARIES_DIR+: the place where all binary files (aka images) are
42    stored
43  - +BASE_DIR+: the base output directory
44