From cc45558f1a5a730c8193c30f54fecc2625684361 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Wed, 7 Sep 2016 07:02:12 +0200 Subject: Minor INSTALL changes --- BOOTSTRAP-MINGW.cli | 10 +++++----- BOOTSTRAP-MSVC.cli | 10 +++++----- BOOTSTRAP-UNIX.cli | 14 +++++++------- BOOTSTRAP-WINDOWS.cli | 18 +++++++++--------- INSTALL.cli | 10 +++++----- UPGRADE.cli | 12 ++++++------ 6 files changed, 37 insertions(+), 37 deletions(-) diff --git a/BOOTSTRAP-MINGW.cli b/BOOTSTRAP-MINGW.cli index 764c66b..6e9599c 100644 --- a/BOOTSTRAP-MINGW.cli +++ b/BOOTSTRAP-MINGW.cli @@ -56,7 +56,7 @@ The rest of this section outlines the manual bootstrap process. \dl| -\li|1. Bootstrap, Phase 1\n +\li|\b{1. Bootstrap, Phase 1}\n First, we build a minimal build system with the provided \c{bootstrap-mingw.bat} batch file. Normally, the only argument you will pass @@ -73,7 +73,7 @@ compile options; run \c{bootstrap-mingw.bat /?} and see the | -\li|\n2. Bootstrap, Phase 2\n +\li|\n\b{2. Bootstrap, Phase 2}\n Then, we rebuild the build system with the result of Phase 1 linking libraries statically. @@ -87,7 +87,7 @@ libraries statically. | -\li|\n3. Stage\n +\li|\n\b{3. Stage}\n At this step the entire toolchain is built and staged: @@ -138,7 +138,7 @@ change the \c{configure} command line above along these lines: | -\li|\n4. Install\n +\li|\n\b{4. Install}\n Next, we use the staged toolchain to build and install the \"final\" toolchain from the package repository using the \c{bpkg} package manager. First, we @@ -182,7 +182,7 @@ C:\build2\bin\bpkg.exe | -\li|\n5. Clean\n +\li|\n\b{5. Clean}\n The last thing we need to do is uninstall the staged toolchain: diff --git a/BOOTSTRAP-MSVC.cli b/BOOTSTRAP-MSVC.cli index 6dfa964..56f6185 100644 --- a/BOOTSTRAP-MSVC.cli +++ b/BOOTSTRAP-MSVC.cli @@ -45,7 +45,7 @@ The rest of this section outlines the manual bootstrap process. \dl| -\li|1. Bootstrap, Phase 1\n +\li|\b{1. Bootstrap, Phase 1}\n First, we build a minimal build system with the provided \c{bootstrap-msvc.bat} batch file. Normally, the only argument you will pass @@ -62,7 +62,7 @@ file for details. | -\li|\n2. Bootstrap, Phase 2\n +\li|\n\b{2. Bootstrap, Phase 2}\n Then, we rebuild the build system with the result of Phase 1 linking libraries statically. @@ -76,7 +76,7 @@ statically. | -\li|\n3. Stage\n +\li|\n\b{3. Stage}\n At this step the entire toolchain is built and staged: @@ -127,7 +127,7 @@ change the \c{configure} command line above along these lines: | -\li|\n4. Install\n +\li|\n\b{4. Install}\n Next, we use the staged toolchain to build and install the \"final\" toolchain from the package repository using the \c{bpkg} package manager. First, we @@ -170,7 +170,7 @@ C:\build2\bin\bpkg.exe | -\li|\n5. Clean\n +\li|\n\b{5. Clean}\n The last thing we need to do is uninstall the staged toolchain: diff --git a/BOOTSTRAP-UNIX.cli b/BOOTSTRAP-UNIX.cli index b2edcb9..39f7a5b 100644 --- a/BOOTSTRAP-UNIX.cli +++ b/BOOTSTRAP-UNIX.cli @@ -11,7 +11,7 @@ Cygwin) where you already have a UNIX shell with standard utilities. \dl| -\li|1. Create Build Directory\n +\li|\b{1. Create Build Directory}\n Note that you will want to keep this directory around in order to upgrade to new toolchain versions in the future. In this guide we will use @@ -26,7 +26,7 @@ $ cd build2-build | -\li|\n2. Download, Verify, and Unpack\n +\li|\n\b{2. Download, Verify, and Unpack}\n Download \c{build2-toolchain-X.Y.Z.tar.xz} (or its \c{.tar.gz} variant if you don't have \cb{xz(1)}) as well as its \c{.sha256} checksum from @@ -99,7 +99,7 @@ The rest of this section outlines the manual bootstrap process. \dl| -\li|1. Bootstrap, Phase 1\n +\li|\b{1. Bootstrap, Phase 1}\n First, we build a minimal build system with the provided \c{bootstrap.sh} script. Normally, the only argument you will pass to this script is the @@ -116,7 +116,7 @@ $ build2/b-boot --version | -\li|\n2. Bootstrap, Phase 2\n +\li|\n\b{2. Bootstrap, Phase 2}\n Then, we rebuild the build system with the result of Phase 1 linking libraries statically. @@ -130,7 +130,7 @@ $ build2/b-boot --version | -\li|\n3. Stage\n +\li|\n\b{3. Stage}\n 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} @@ -209,7 +209,7 @@ $ build2/build2/b-boot configure \ | -\li|\n4. Install\n +\li|\n\b{4. Install}\n Next, we use the staged toolchain to build and install the \"final\" toolchain from the package repository using the \c{bpkg} package manager. First, we @@ -254,7 +254,7 @@ $ bpkg --version | -\li|\n5. Clean\n +\li|\n\b{5. Clean}\n The last thing we need to do is uninstall the staged toolchain: diff --git a/BOOTSTRAP-WINDOWS.cli b/BOOTSTRAP-WINDOWS.cli index 13e8793..a45f867 100644 --- a/BOOTSTRAP-WINDOWS.cli +++ b/BOOTSTRAP-WINDOWS.cli @@ -18,7 +18,7 @@ as the utilities in order to produce the combined installation. To build on Windows you will need either MSVC 14 Update 2 or later or MinGW GCC 4.8 or later. Note also that MinGW GCC must be configured with the \c{posix} threading model (this is currently the only configuration that -implements C++11 threads; run \c{g++ --version} to verify). +implements C++11 threads; run \c{g++ -v} to verify). If you don't already have a suitable C++ compiler, then you can use the \c{build2-mingw} package which provides a minimal MinGW-W64 GCC distribution @@ -30,14 +30,14 @@ common steps: \dl| -\li|1. Open Command Prompt\n +\li|\b{1. Open Command Prompt}\n 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 for MSVC-specific instructions). | -\li|\n2. Create Build Directory\n +\li|\n\b{2. Create Build Directory}\n Note that you will want to keep this directory around in order to upgrade to new toolchain versions in the future. In this guide we will use @@ -53,7 +53,7 @@ installation directory but you can use other paths. | -\li|\n3. Download Archives\n +\li|\n\b{3. Download Archives}\n Download the following files as well as their \c{.sha256} checksums from \l{https://download.build2.org}, replacing \i{} with \c{x86_64} for @@ -67,7 +67,7 @@ build2-toolchain-X.Y.Z.tar.xz Place everything into \c{C:\\build2-build\\} (build directory).| -\li|\n4. Verify Archive Checksums\n +\li|\n\b{4. Verify Archive Checksums}\n Verify archive checksums match (compare visually): @@ -78,14 +78,14 @@ Verify archive checksums match (compare visually): | -\li|\n5. Unpack \c{build2-baseutils}\n +\li|\n\b{5. Unpack \c{build2-baseutils}}\n Unpack the \c{build2-baseutils-X.Y.Z--windows.zip} archive into \c{C:\\} using Windows Explorer (for example, copy the archive directory and then paste it). Rename it to \c{C:\\build2\\}. This will be the toolchain installation directory. | -\li|\n6. Set \c{PATH}\n +\li|\n\b{6. Set \c{PATH}}\n Set the \c{PATH} environment variable and verify that the utilities are found and work: @@ -98,7 +98,7 @@ and work: | -\li|\n7. Unpack \c{build2-mingw}\n +\li|\n\b{7. Unpack \c{build2-mingw}}\n If required, unpack the \c{build2-mingw-X.Y.Z--windows.tar.xz} archive into \c{C:\\build2\\}: @@ -117,7 +117,7 @@ Verify that the MinGW GCC is found and works: | -\li|\n8. Unpack \c{build2-toolchain}\n +\li|\n\b{8. Unpack \c{build2-toolchain}}\n Unpack the \c{build2-toolchain-X.Y.Z.tar.xz} archive and change to its directory: diff --git a/INSTALL.cli b/INSTALL.cli index d9ec0ea..9f355cb 100644 --- a/INSTALL.cli +++ b/INSTALL.cli @@ -37,27 +37,27 @@ At the high level, the bootstrap process involves the following 5 steps. \dl| -\li|1. Bootstrap, Phase 1\n +\li|\b{1. Bootstrap, Phase 1}\n First, a minimal build system executable is built using provided shell scripts/batch files. The result is only guaranteed to be able to rebuild the build system itself.| -\li|\n2. Bootstrap, Phase 2\n +\li|\n\b{2. Bootstrap, Phase 2}\n Then, the build system is rebuilt with static libraries. The result is only guaranteed to be able to build the toolchain.| -\li|\n3. Stage\n +\li|\n\b{3. Stage}\n At this step the entire toolchain is built and staged.| -\li|\n4. Install\n +\li|\n\b{4. Install}\n Next, the staged toolchain is used to build and install the \"final\" toolchain from the package repository and using the \c{bpkg} package manager.| -\li|\n5. Clean\n +\li|\n\b{5. Clean}\n Finally, the staged toolchain is uninstalled.|| diff --git a/UPGRADE.cli b/UPGRADE.cli index 4e80586..bcbb873 100644 --- a/UPGRADE.cli +++ b/UPGRADE.cli @@ -56,7 +56,7 @@ The staged upgrade consists of several steps: \dl| -\li|0. Check for Updates\n +\li|\b{0. Check for Updates}\n There is no harm in running \c{bpkg fetch} in the existing configuration so we can use it to determine if any updates are available, whether we can use @@ -72,7 +72,7 @@ $ bpkg status build2 bpkg Let's say the new version is X.Z. | -\li|\n1. Create New Configuration\n +\li|\n\b{1. Create New Configuration}\n First we make a copy of the old configuration. We will need the original later to cleanly uninstall the old toolchain, and, maybe, to rollback the @@ -92,7 +92,7 @@ Or, using Windows command prompt: | -\li|\n2. Build and Install as \c{-stage}\n +\li|\n\b{2. Build and Install as \c{-stage}}\n This step is similar to the dirty upgrade except we use the copied configuration and install the toolchain with the \c{-stage} suffix: @@ -108,7 +108,7 @@ $ bpkg install \ | -\li|\n3. Test Staged\n +\li|\n\b{3. Test Staged}\n Now you can test the new toolchain on your projects, etc. Remember to use the \c{-stage}-suffixed binaries (\c{bpkg-stage} will automatically use @@ -121,7 +121,7 @@ $ bpkg-stage --version | -\li|\n4. Uninstall Old, Install New\n +\li|\n\b{4. Uninstall Old, Install New}\n Once we are satisfied that the new toolchain works, we can uninstall the old one and install the new one: @@ -136,7 +136,7 @@ $ bpkg-stage install build2 bpkg | -\li|\n5. Uninstall Staged\n +\li|\n\b{5. Uninstall Staged}\n Finally, we clean up by removing the staged toolchain (hint: use the command line history to find the corresponding \c{install} command and change it to -- cgit v1.1