[Buildroot] [git commit] manual: switch BR2_EXTERNAL examples to use absolute paths
Peter Korsgaard
peter at korsgaard.com
Sat Feb 22 20:56:57 UTC 2014
commit: http://git.buildroot.net/buildroot/commit/?id=1de64ec8c08f6e954f1f1b616ebb3be7f9cef3e7
branch: http://git.buildroot.net/buildroot/commit/?id=refs/heads/master
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" <yann.morin.1998 at free.fr>
Cc: Samuel Martin <s.martin49 at gmail.com>
Signed-off-by: Peter Korsgaard <peter at korsgaard.com>
---
docs/manual/customize-outside-br.txt | 10 +++++-----
1 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
index 585eedf..7498940 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:
More information about the buildroot
mailing list