Clarified documentation regarding building the Core_Root. #72560
Conversation
…o generate the Core_Root.
ghost
assigned 
|
Tagging subscribers to this area: @hoyosjs Issue DetailsFixes #36528. Added a note in the tests build instructions, emphasizing that the libraries have to be built in Release mode, regardless of the runtime build's configuration, in order to be able to generate the Core_Root.
|
| @@ -87,8 +87,9 @@ After the build is completed, there should some files placed in `artifacts/bin/c | |||
| Create the Core_Root | |||
| =================== | |||
|
|
|||
| The Core_Root folder will contain the built binaries, generated by `build.sh`, as well as the library packages required to run tests. Note that you need to build | |||
| the libraries subset (`-subset libs`) before this command can be run. | |||
| The Core_Root folder will contain the built binaries, generated by `build.sh`, as well as the library packages required to run tests. It is required that you build | |||
There was a problem hiding this comment.
I just wonder if https://github.com/dotnet/runtime/blob/main/docs/workflow/testing/coreclr/testing.md should be the place that has this information. We keep this info so fragmented, that one place is always wrong.
There was a problem hiding this comment.
I think a bigger overhaul of our docs is long due now. I actually also believe that testing.md would be the better choice to keep all this information. That said, it's not uncommon for people to bump into this section of linux-instructions.md, since they initially will want to know how to build the product. So, I think we should keep these changes and we could maybe file a tracking issue for the documentation reorganization.
| @@ -26,7 +26,9 @@ After the build has completed, there should some files placed in `artifacts/bin/ | |||
| Create the Core_Root | |||
| =================== | |||
|
|
|||
| The Core_Root folder will have the built binaries, from `src/coreclr/build.sh` and it will also include the CoreFX packages required to run tests. | |||
| The Core_Root folder will contain the built binaries, generated by `build.sh`, as well as the library packages required to run tests. It is required that you build | |||
There was a problem hiding this comment.
This isn't true. You can pass the library configuration to the script using /p:LibrariesConfiguration=<LIBS_CONFIG> where <LIB_CONFIG> can be Debug or Release.
Fixes #36528. Added a note in the tests build instructions, emphasizing that the libraries have to be built in Release mode, regardless of the runtime build's configuration, in order to be able to generate the Core_Root.