From: Yann E. MORIN Date: Fri, 21 Feb 2014 22:17:53 +0000 (+0100) Subject: manual: switch BR2_EXTERNAL examples to use absolute paths X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=1de64ec8c08f6e954f1f1b616ebb3be7f9cef3e7;p=buildroot.git manual: switch BR2_EXTERNAL examples to use absolute paths Although it is possible to use relative paths, there are a few pitfalls when doing so. To avoid confusion for a (newcoming) user, use absolute paths in the manual (as is done in examples for $(O)), since it is guaranteed to be working without corner cases. [Peter: s/relatively/relative/ as suggested by Thomas] Signed-off-by: "Yann E. MORIN" Cc: Samuel Martin Signed-off-by: Peter Korsgaard --- diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt index 585eedffef..7498940948 100644 --- a/docs/manual/customize-outside-br.txt +++ b/docs/manual/customize-outside-br.txt @@ -30,18 +30,18 @@ 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. -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 relatively to the main Buildroot source directory, not +is interpreted relative to the main Buildroot source directory, *not* the Buildroot output directory. Some examples: ----- - buildroot/ $ make BR2_EXTERNAL=../foobar menuconfig + buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig ----- -Starting from now on, external definitions from the +../foobar+ +Starting from now on, external definitions from the +/path/to/foobar+ directory will be used: ----- @@ -52,7 +52,7 @@ directory will be used: We can switch to another external definitions directory at any time: ----- - buildroot/ $ make BR2_EXTERNAL=../barfoo xconfig + buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig ----- Or disable the usage of external definitions: