diff options
Diffstat (limited to 'docs/manual')
| -rw-r--r-- | docs/manual/customize-outside-br.txt | 18 | ||||
| -rw-r--r-- | docs/manual/debugging-buildroot.txt | 17 |
2 files changed, 25 insertions, 10 deletions
diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt index aac9a4313d..9ad177d006 100644 --- a/docs/manual/customize-outside-br.txt +++ b/docs/manual/customize-outside-br.txt @@ -25,7 +25,8 @@ there is no need to pass +BR2_EXTERNAL+ at every +make+ invocation. It can however be changed at any time by passing a new value, and can be removed by passing an empty value. -*Note:* the +BR2_EXTERNAL+ path can be either an absolute or a relative path, +.Note +The +BR2_EXTERNAL+ path can be either an absolute or a relative path, but if it's passed as a relative path, it is important to note that it is interpreted relative to the main Buildroot source directory, *not* to the Buildroot output directory. @@ -33,27 +34,27 @@ to the Buildroot output directory. Some examples: ----- - buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig +buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig ----- From now on, external definitions from the +/path/to/foobar+ directory will be used: ----- - buildroot/ $ make - buildroot/ $ make legal-info +buildroot/ $ make +buildroot/ $ make legal-info ----- We can switch to another external definitions directory at any time: ----- - buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig +buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig ----- Or disable the usage of external definitions: ----- - buildroot/ $ make BR2_EXTERNAL= xconfig +buildroot/ $ make BR2_EXTERNAL= xconfig ----- +BR2_EXTERNAL+ allows three different things: @@ -75,7 +76,10 @@ Or disable the usage of external definitions: logic. Buildroot automatically includes +$(BR2_EXTERNAL)/Config.in+ to make it appear in the top-level configuration menu, and includes +$(BR2_EXTERNAL)/external.mk+ with the rest of the makefile logic. - Providing those two files is mandatory, but they can be empty. ++ +.Note +Providing +Config.in+ and +external.mk+ is mandatory, but they can be + empty. + The main usage of this is to store package recipes. The recommended way to do this is to write a +$(BR2_EXTERNAL)/Config.in+ file that 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 |
