aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2017-10-20 16:42:06 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2017-10-20 16:43:41 +0200
commit9aa7a17926ec853618575da1f2222d216e699767 (patch)
tree6ec8e95217173c92bc18cc61d4576b4cc3a36b8c
parenta0e862ef2e3fcbb0c3936cb6c0c2548aa666e906 (diff)
Update documentation
-rw-r--r--INSTALL.cli11
-rw-r--r--bootstrap.gmake4
2 files changed, 8 insertions, 7 deletions
diff --git a/INSTALL.cli b/INSTALL.cli
index f4f2dfc..d117e28 100644
--- a/INSTALL.cli
+++ b/INSTALL.cli
@@ -21,9 +21,10 @@ system is self-hosted, which means that unless you have obtained a pre-built
binary from somewhere else, you will need to bootstrap it. To accomplish this,
we use the \c{bootstrap.sh} shell script (or equivalent batch files for
Windows) found in the root directory of the \c{build2} distribution. On
-UNIX-like operating systems a GNU \c{make} makefile called \c{bootstrap.gmake}
-can also be used with the major advanage over the script being support for
-parallel bootstrap (see comments inside the makefile for more information).
+UNIX-like operating systems as well as MinGW a GNU \c{make} makefile called
+\c{bootstrap.gmake} can also be used with the major advanage over the script
+being support for parallel compilation and an out of tree build (see comments
+inside the makefile for more information).
The following is the recommended sequence of steps:
@@ -59,7 +60,7 @@ Alternatively, we can use the \c{bootstrap.gmake} makefile:
\
$ cd build2-X.Y.Z
-$ make -f bootstrap.gmake CXX=g++ -j 8
+$ make -f bootstrap.gmake -j 8 CXX=g++
$ build2/b-boot --version
\
@@ -69,7 +70,7 @@ makefile (but not the script):
\
$ mkdir build2-boot
-$ make -C build2-boot -f ../build2-X.Y.Z/bootstrap.gmake CXX=g++ -j 8
+$ make -C build2-boot -f ../build2-X.Y.Z/bootstrap.gmake -j 8 CXX=g++
$ build2-boot/build2/b-boot --version
\
diff --git a/bootstrap.gmake b/bootstrap.gmake
index 055504b..51c6f30 100644
--- a/bootstrap.gmake
+++ b/bootstrap.gmake
@@ -3,8 +3,8 @@
# license : MIT; see accompanying LICENSE file
# This makefile requires GNU make 3.81 or later and can be used to bootstrap
-# the build system similar to the bootstrap.sh script. Its main advantage over
-# the script is support for parallel bootstrap.
+# the build system similar to the bootstrap.sh script. Its main advantages over
+# the script are support for parallel compilation and an out of tree build.
#
# Similar to the script, the makefile expects to find the libbutl/ or
# libbutl-*/ directory either in the current directory (build2 root) or one