Browse Source

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>
Yann E. MORIN 10 years ago
parent
commit
162290e1f3
1 changed files with 6 additions and 2 deletions
  1. 6 2
      docs/manual/customize-outside-br.txt

+ 6 - 2
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
 can however be changed at any time by passing a new value, and can be
 removed by passing an empty value.
 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
 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*
 is interpreted relative to the main Buildroot source directory, *not*
 to the Buildroot output directory.
 to the Buildroot output directory.
@@ -75,7 +76,10 @@ buildroot/ $ make BR2_EXTERNAL= xconfig
    logic. Buildroot automatically includes +$(BR2_EXTERNAL)/Config.in+ to
    logic. Buildroot automatically includes +$(BR2_EXTERNAL)/Config.in+ to
    make it appear in the top-level configuration menu, and includes
    make it appear in the top-level configuration menu, and includes
    +$(BR2_EXTERNAL)/external.mk+ with the rest of the makefile logic.
    +$(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
 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
    way to do this is to write a +$(BR2_EXTERNAL)/Config.in+ file that