Skip to content

Commit 776dd5f

Browse files
committed
Fix some minor issues with the bootstrap documentation.
1 parent 7956b20 commit 776dd5f

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

Documentation/boostrap-new-os.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,14 @@ For versions earlier than .NET Core 2.0, following dependencies are also require
4444
### Building the bootstrap CLI
4545
There is a bash script file that automatizes most of the process of building the bootstrap CLI end to end. The bash script is located at `dotnet/source-build/scripts/bootstrap/buildbootstrapcli.sh`. It first creates a folder named by the new target RID, clones the coreclr, corefx and core-setup repos into it and checks out the same commit of each of the repos as the one that was used to build the seed CLI. This first step is skipped if the coreclr, corefx and core-setup folders already exist. This is important so that the sources can be modified to fix possible build issues and to target the new RID.
4646

47-
The script needs to be passed several arguments. The target architecture, the build configuration, the target OS, the new RID and path to the folder with the untared seed CLI. There is also an optional option to specify the version of the Clang compiler to use to compile the native code. There is also an option to pass in a System.Private.CoreLib.dll built elsewhere and an option to crossgen it. This is useful if you are building debug configuration, since the seed CLI that comes from Azure is built for release configuration and the release version of System.Private.CoreLib.dll is not compatible with debug version of libcoreclr.so.
47+
The script needs to be passed several arguments. The target architecture, the build configuration, the target OS, the new RID and path to the folder with the untared seed CLI. There is also an optional option to specify the version of the Clang compiler to use to compile the native code. There is also an option to pass in a System.Private.CoreLib.dll built elsewhere. This is useful if you are building debug configuration, since the seed CLI that comes from Azure is built for release configuration and the release version of System.Private.CoreLib.dll is not compatible with debug version of libcoreclr.so.
4848
Here is the summary of the options that you get from running the script with `--help` option:
4949
```
50-
Usage: buildbootstrapcli.sh [BuildType] --rid <Rid> --seedcli <SeedCli> [--os <OS>] [--clang <Major.Minor>] [--corelib <CoreLib>]
50+
Usage: buildbootstrapcli.sh [BuildType] -rid <Rid> -seedcli <SeedCli> [-os <OS>] [-clang <Major.Minor>] [-corelib <CoreLib>]
5151
5252
Options:
5353
BuildType Type of build (-debug, -release), default: -debug
5454
-clang <Major.Minor> Override of the version of clang compiler to use
55-
-config <Configuration> Build configuration (debug, release), default: debug
5655
-corelib <CoreLib> Path to System.Private.CoreLib.dll, default: use the System.Private.CoreLib.dll from the seed CLI
5756
-os <OS> Operating system (used for corefx build), default: Linux
5857
-rid <Rid> Runtime identifier including the architecture part (e.g. rhel.6-x64)
@@ -61,7 +60,7 @@ Options:
6160
```
6261
So, for example, when we were creating bootstrap CLI for RHEL / CentOS 6, the command was:
6362
```bash
64-
./buildbootstrapcli.sh -rid rhel.6 -release -os Linux -seedcli ~/seed-cli
63+
./buildbootstrapcli.sh -release -rid rhel.6-x64 -os Linux -seedcli ~/seed-cli
6564
```
6665
After running the script, check the console output. If the last line printed is `**** Bootstrap CLI was successfully built ****`, then everything went fine and the bootstrap CLI is ready. You can find it in the `<Rid>-<Architecture>/dotnetcli` subfolder. So for the example command above, it would be `rhel.6-x64/dotnetcli`.
6766
If there were build errors, they need to be looked into and fixed. After that run the `buildbootstrapcli.sh` with the same arguments again. Repeat until everything builds.

scripts/bootstrap/buildbootstrapcli.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ set -o pipefail
55
usage()
66
{
77
echo "Builds a bootstrap CLI from sources"
8-
echo "Usage: $0 [BuildType] --rid <Rid> --seedcli <SeedCli> [--os <OS>] [--clang <Major.Minor>] [--corelib <CoreLib>]"
8+
echo "Usage: $0 [BuildType] -rid <Rid> -seedcli <SeedCli> [-os <OS>] [-clang <Major.Minor>] [-corelib <CoreLib>]"
99
echo ""
1010
echo "Options:"
1111
echo " BuildType Type of build (-debug, -release), default: -debug"
1212
echo " -clang <Major.Minor> Override of the version of clang compiler to use"
13-
echo " -config <Configuration> Build configuration (debug, release), default: debug"
1413
echo " -corelib <CoreLib> Path to System.Private.CoreLib.dll, default: use the System.Private.CoreLib.dll from the seed CLI"
1514
echo " -os <OS> Operating system (used for corefx build), default: Linux"
1615
echo " -rid <Rid> Runtime identifier including the architecture part (e.g. rhel.6-x64)"

0 commit comments

Comments
 (0)