Skip to content

Commit 4df87ae

Browse files
authored
Document Important Note About the Host and the CLR for Testing (#108162)
1 parent 4621bb6 commit 4df87ae

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/workflow/building/coreclr/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Once you have both subsets built, you can generate the *Core_Root*, which as men
5555

5656
Since this is more related to testing, you can find the full details and instructions in the CoreCLR testing doc [over here](/docs/workflow/testing/coreclr/testing.md).
5757

58+
**WARNING:** When building CoreCLR, the `apphost` will also get constructed as part of the build. However, `apphost` belongs to the `host` subset. This means that if you only pass the `runtimeConfiguration` and/or the `librariesConfiguration` flag to your builds, then the `apphost` will get built in `Debug`. This will result in issues when trying to build the tests. Because of this, it is highly recommended to always also include the `-c` or `-hc` flags when building `clr` to ensure all of its related components are constructed in the same configuration.
59+
5860
#### The Dev Shipping Packs
5961

6062
It is also possible to generate the full runtime NuGet packages and installer that you can use to test in a more production-esque scenario. To generate these shipping artifacts, you have to build the `clr`, `libs`, `host`, and `packs` subsets:

docs/workflow/testing/coreclr/testing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Building the tests can be as simple as calling the build script without any argu
4444

4545
Note that for the libraries configuration, we are passing the argument directly to MSBuild instead of the build script, hence the `/p:LibrariesConfiguration` flag. Also, make sure you use the correct syntax depending on our platform. The _cmd_ script takes the arguments by placing, while the _sh_ script requires them to be with a hyphen.
4646

47+
In the case you are working with a different build configuration for the host, you can specify it here via the `/p:HostConfiguration` flag.
48+
4749
**NOTE**: Building the whole test suite is a very lengthy process, so it is highly recommended you build individual tests, and/or test subtrees as you need them, to make your workflow more efficient. This is explained in detail later on in this doc.
4850

4951
## Building the Core_Root

0 commit comments

Comments
 (0)