diff options
| -rw-r--r-- | BOOTSTRAP-MACOSX.cli | 2 | ||||
| -rw-r--r-- | BOOTSTRAP-MINGW.cli | 19 | ||||
| -rw-r--r-- | BOOTSTRAP-MSVC.cli | 17 | ||||
| -rw-r--r-- | BOOTSTRAP-UNIX.cli | 16 | ||||
| -rw-r--r-- | BOOTSTRAP-WINDOWS.cli | 8 | ||||
| -rw-r--r-- | INSTALL.cli | 6 | ||||
| -rw-r--r-- | UPGRADE.cli | 4 |
7 files changed, 37 insertions, 35 deletions
diff --git a/BOOTSTRAP-MACOSX.cli b/BOOTSTRAP-MACOSX.cli index 391aa36..46c6f46 100644 --- a/BOOTSTRAP-MACOSX.cli +++ b/BOOTSTRAP-MACOSX.cli @@ -8,7 +8,7 @@ will also be using the system C++ toolchain that comes with the Xcode Command Line Tools. You should be able to use other/custom C++ toolchains, however, this is the only configuration that is tested and guaranteed to work. -To verify Command Line Tools are installed, run: +To verify that Command Line Tools are installed, run: \ $ clang++ --version diff --git a/BOOTSTRAP-MINGW.cli b/BOOTSTRAP-MINGW.cli index 6b540fd..790ccfc 100644 --- a/BOOTSTRAP-MINGW.cli +++ b/BOOTSTRAP-MINGW.cli @@ -5,7 +5,7 @@ " Continuing from \l{#BOOTSTRAP-WINDOWS Bootstrapping on Windows}, if you are using your own MinGW distribution, then the resulting \c{build2} binaries will -most likely required a number of DLLs in order to run. It is therefore +most likely require a number of DLLs in order to run. It is therefore recommended that you copy the following files from your MinGW \c{bin\\} subdirectory to \c{C:\\build2\\bin\\} (\c{*} in the last name will normally be \c{dw2-1}, \c{seh-1}, or \c{sjlj-1}): @@ -19,7 +19,7 @@ libgcc_s_*.dll To build with MinGW you can either perform the following steps manually or, if after reviewing the steps, you are happy with using the defaults, run the \c{build-mingw.bat} batch file. It performs (and echoes) the same set of steps -as outline below but only allows you to customization the compiler and +as outlined below but only allows you to customize the compiler and installation directory (run \c{build-mingw.bat /?} for usage). You can also specify an alternative package repository with the \c{BUILD2_REPO} environment variable. @@ -38,8 +38,9 @@ use just \c{g++} for the compiler: > .\build-mingw.bat g++ \ -Note also that about half way (\c{bpkg fetch} on step 4 below) the script will -stop and prompt you to verify the authenticity of the repository certificate. +Note also that at about half way through (\c{bpkg fetch} at step 4 below) the +script will stop and prompt you to verify the authenticity of the repository +certificate. The end result of the bootstrap process (performed either with the script or manually) is the installed toolchain as well as the \c{bpkg} configuration in @@ -88,10 +89,10 @@ libraries statically. \li|\n3. Stage\n -On this step the entire toolchain is built and staged: +At this step the entire toolchain is built and staged: \ -> run cd .. # Back to build2-toolchain-X.Y.Z\ +> cd .. # Back to build2-toolchain-X.Y.Z\ > build2\build2\b-boot configure ^ config.cxx=g++ ^ @@ -108,7 +109,7 @@ of wherever \c{config.install.root} points to (so in our case it will be \c{C:\\build2\\stage\\}). This subdirectory is temporary and will be removed in a few steps. -Verify the toolchain binaries can be found and work (this relies on the +Verify that the toolchain binaries can be found and work (this relies on the \c{PATH} environment variable we have set earlier): \ @@ -122,10 +123,10 @@ C:\build2\bin\bpkg-stage.exe > bpkg-stage --version \ -On the next step we will use \c{bpkg} to build and install the \"final\" +At the next step we will use \c{bpkg} to build and install the \"final\" toolchain. If for some reason you prefer not to build from packages (for example, because the machine is offline), then you can convert this step into -the \"final\" installation and skip the rest. For this your will need to +the \"final\" installation and skip the rest. For this you will need to change the \c{configure} command line above along these lines: \ diff --git a/BOOTSTRAP-MSVC.cli b/BOOTSTRAP-MSVC.cli index 5d30836..6dfa964 100644 --- a/BOOTSTRAP-MSVC.cli +++ b/BOOTSTRAP-MSVC.cli @@ -16,7 +16,7 @@ you are on 64-bit Windows or \"x86 Native Tools Command Prompt\" if you are on To build with MSVC you can either perform the following steps manually or, if after reviewing the steps you are happy with using the defaults, run the \c{build-msvc.bat} batch file. It performs (and echoes) the same set of steps -as outline below but only allows you to customization the installation +as outlined below but only allows you to customize the installation directory (run \c{build-msvc.bat /?} for usage). You can also specify an alternative package repository with the \c{BUILD2_REPO} environment variable. @@ -27,8 +27,9 @@ prompt) like this: > .\build-msvc.bat \ -Note also that about half way (\c{bpkg fetch} on step 4 below) the script will -stop and prompt you to verify the authenticity of the repository certificate. +Note also that at about half way through (\c{bpkg fetch} at step 4 below) the +script will stop and prompt you to verify the authenticity of the repository +certificate. The end result of the bootstrap process (performed either with the script or manually) is the installed toolchain as well as the \c{bpkg} configuration in @@ -77,10 +78,10 @@ statically. \li|\n3. Stage\n -On this step the entire toolchain is built and staged: +At this step the entire toolchain is built and staged: \ -> run cd .. # Back to build2-toolchain-X.Y.Z\ +> cd .. # Back to build2-toolchain-X.Y.Z\ > build2\build2\b-boot configure ^ config.cxx=cl ^ @@ -97,7 +98,7 @@ of wherever \c{config.install.root} points to (so in our case it will be \c{C:\\build2\\stage\\}). This subdirectory is temporary and will be removed in a few steps. -Verify the toolchain binaries can be found and work (this relies on the +Verify that the toolchain binaries can be found and work (this relies on the \c{PATH} environment variable we have set earlier): \ @@ -111,10 +112,10 @@ C:\build2\bin\bpkg-stage.exe > bpkg-stage --version \ -On the next step we will use \c{bpkg} to build and install the \"final\" +At the next step we will use \c{bpkg} to build and install the \"final\" toolchain. If for some reason you prefer not to build from packages (for example, because the machine is offline), then you can convert this step into -the \"final\" installation and skip the rest. For this your will need to +the \"final\" installation and skip the rest. For this you will need to change the \c{configure} command line above along these lines: \ diff --git a/BOOTSTRAP-UNIX.cli b/BOOTSTRAP-UNIX.cli index e3a8730..b2edcb9 100644 --- a/BOOTSTRAP-UNIX.cli +++ b/BOOTSTRAP-UNIX.cli @@ -62,7 +62,7 @@ Unpack the archive and change to its directory: Next you can either perform the rest of the steps manually or, if after reviewing the steps, you are happy with using the defaults, run the \c{build.sh} shell script. It performs (and echoes) the same set of steps as -outline below but only allows you to customization the compiler, installation +outlined below but only allows you to customize the compiler, installation directory, and a few other things (run \c{build.sh -h} for usage). You can also specify an alternative package repository with the \c{BUILD2_REPO} environment variable. @@ -80,10 +80,10 @@ While this will use Clang and install into \c{/opt/build2}: $ ./build.sh --install-dir /opt/build2 --sudo sudo clang++ \ -Note also that about half way (\c{bpkg fetch} on step 4 below) the script will -stop and prompt you to verify the authenticity of the repository certificate. -To run the script unattended you can specify the certificate fingerprint with -the \c{--trust} option. +Note also that at about half way through (\c{bpkg fetch} at step 4 below) the +script will stop and prompt you to verify the authenticity of the repository +certificate. To run the script unattended you can specify the certificate +fingerprint with the \c{--trust} option. The end result of the bootstrap process (performed either with the script or manually) is the installed toolchain as well as the \c{bpkg} configuration in @@ -132,7 +132,7 @@ $ build2/b-boot --version \li|\n3. Stage\n -On this step the entire toolchain is built and staged. Here you may want +At this step the entire toolchain is built and staged. Here you may want to adjust a few things, such as the installation directory or the \c{sudo} program (remove the \c{config.install.sudo} line if you don't need one). @@ -143,7 +143,7 @@ in \- if your target doesn't support it, you will get an error and will need to reconfigure without it. \ -$ run cd .. # Back to build2-toolchain-X.Y.Z/ +$ cd .. # Back to build2-toolchain-X.Y.Z/ $ build2/build2/b-boot configure \ config.cxx=g++ \ @@ -191,7 +191,7 @@ the rest of the commands to use absolute paths. This, however, does not make for very readable examples so below we assume the installation's \c{bin/} subdirectory is in \c{PATH}. -On the next step we will use \c{bpkg} to build and install the \"final\" +At the next step we will use \c{bpkg} to build and install the \"final\" toolchain. If for some reason you prefer not to build from packages (for example, because the machine is offline), then you can convert this step into the \"final\" installation and skip the rest. For this your will need to diff --git a/BOOTSTRAP-WINDOWS.cli b/BOOTSTRAP-WINDOWS.cli index 8cbd8f3..13e8793 100644 --- a/BOOTSTRAP-WINDOWS.cli +++ b/BOOTSTRAP-WINDOWS.cli @@ -34,7 +34,7 @@ common steps: Start the standard Windows Command Prompt. If you plan to build with MSVC, then you may go ahead and start the Visual Studio Command Prompt (or wait -until MSVC-specific instructions). +for MSVC-specific instructions). | \li|\n2. Create Build Directory\n @@ -87,8 +87,8 @@ directory. | \li|\n6. Set \c{PATH}\n -Set the \c{PATH} environment variable and verify the utilities are found and -work: +Set the \c{PATH} environment variable and verify that the utilities are found +and work: \ > set PATH=C:\build2\bin;%PATH% @@ -108,7 +108,7 @@ into \c{C:\\build2\\}: --one-top-level=C:\build2 --strip-components=1 \ -Verify the MinGW GCC is found and works: +Verify that the MinGW GCC is found and works: \ > where g++ diff --git a/INSTALL.cli b/INSTALL.cli index e26fcb3..d9ec0ea 100644 --- a/INSTALL.cli +++ b/INSTALL.cli @@ -50,7 +50,7 @@ guaranteed to be able to build the toolchain.| \li|\n3. Stage\n -On this step the entire toolchain is built and staged.| +At this step the entire toolchain is built and staged.| \li|\n4. Install\n @@ -62,8 +62,8 @@ toolchain from the package repository and using the \c{bpkg} package manager.| Finally, the staged toolchain is uninstalled.|| The end result of the bootstrap process is the installed toolchain as well as -the \c{bpkg} configuration (created on step 4) that can be used to upgrade to -newer versions. You can also skip step 4 and instead install on step 3 if for +the \c{bpkg} configuration (created at step 4) that can be used to upgrade to +newer versions. You can also skip step 4 and instead install at step 3 if for some reason you prefer not to use the package manager (for example, because the machine is offline). diff --git a/UPGRADE.cli b/UPGRADE.cli index 15e37e1..4e80586 100644 --- a/UPGRADE.cli +++ b/UPGRADE.cli @@ -123,8 +123,8 @@ $ bpkg-stage --version \li|\n4. Uninstall Old, Install New\n -Once we are satisfied the new toolchain works, we can uninstall the old -one and install the new: +Once we are satisfied that the new toolchain works, we can uninstall the old +one and install the new one: \ $ cd ../build2-toolchain-X.Y |