docs/manual/debugging-buildroot.txt

   1 // -*- mode:doc; -*-
   2 // vim: set syntax=asciidoc:
   3
   4 [[debugging-buildroot]]
   5
   6 == Debugging Buildroot
   7
   8 It is possible to instrument the steps +Buildroot+ does when building
   9 packages. Define the variable +BR2_INSTRUMENTATION_SCRIPTS+ to contain
  10 the path of one or more scripts (or other executables), in a
  11 space-separated list, you want called before and after each step. The
  12 scripts 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
  18 For example :
  19
  20 ----
  21 make BR2_INSTRUMENTATION_SCRIPTS="/path/to/my/script1 /path/to/my/script2"
  22 ----
  23
  24 That script has access to the following variables:
  25
  26   - +BR2_CONFIG+: the path to the Buildroot .config file
  27   - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
  28     xref:generic-package-reference[]
  29   - +BUILD_DIR+: the directory where packages are extracted and built
  30   - +BINARIES_DIR+: the place where all binary files (aka images) are
  31     stored
  32   - +BASE_DIR+: the base output directory