Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make it clear the subset flag can be omitted #47691

Merged
merged 2 commits into from
Feb 23, 2021
Merged

Make it clear the subset flag can be omitted #47691

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4da10a
Make it clear the subset flag can be omitted
SingleAccretion Jan 31, 2021
0db47f7
Just mention that the subset flag can be implicit
SingleAccretion Feb 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/workflow/building/coreclr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Building

To build just CoreCLR, use the `-subset` flag to the `build.sh` (or `build.cmd`) script at the repo root:
To build just CoreCLR, use the implicit `-subset` flag to the `build.sh` (or `build.cmd`) script at the repo root:

For Linux:
```
./build.sh -subset clr
./build.sh clr
```

For Windows:
```
build.cmd -subset clr
build.cmd clr
```

By default, build generates a 'debug' build type, that includes asserts and is easier for some people to debug. If you want to make performance measurements, or just want tests to execute more quickly, you can also build the 'release' version (which does not have these checks) by adding the flag `-configuration release` (or `-c release`), for example:
```
./build.sh -subset clr -configuration release
./build.sh clr -configuration release
```

CoreCLR also supports a 'checked' build type which has asserts enabled like 'debug', but is built with the native compiler optimizer enabled, so it runs much faster. This is the usual mode used for running tests in the CI system. You can build that using, for example:
```
./build.sh -subset clr -configuration checked
./build.sh clr -configuration checked
```

If you want to use Ninja to drive the native build instead of Visual Studio MSBuild (on Windows) or Make (on non-Windows), you can pass the `-ninja` flag to the build script as follows:
```
./build.cmd -subset clr -ninja
./build.cmd clr -ninja
```

We recommend using Ninja for building the project on Windows since it more efficiently uses the build machine's resources for the native runtime build in comparison to Visual Studio's MSBuild.
Expand Down