aboutsummaryrefslogtreecommitdiff
path: root/docs/manual
diff options
context:
space:
mode:
authorGravatar Yann E. MORIN <yann.morin.1998@free.fr>2015-05-24 23:49:56 +0200
committerGravatar Peter Korsgaard <peter@korsgaard.com>2015-05-25 22:35:10 +0200
commit162290e1f383cc0aa95c43364fcd4888f2bfae4f (patch)
tree25ca374c33deda89ad210e222e14fe6bd1715b51 /docs/manual
parent188025e69195476f3fc07cee32e20660ffe0c8c2 (diff)
downloadbuildroot-162290e1f383cc0aa95c43364fcd4888f2bfae4f.tar.gz
buildroot-162290e1f383cc0aa95c43364fcd4888f2bfae4f.tar.bz2
docs/manual/br2-external: use proper .Note sections
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/customize-outside-br.txt8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
index 99a942c804..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.
@@ -75,7 +76,10 @@ buildroot/ $ make BR2_EXTERNAL= xconfig
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