Skip to content

Clarified documentation regarding building the Core_Root. #72560

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

Merged
ivdiazsa merged 2 commits into from
Jul 21, 2022
Merged

Clarified documentation regarding building the Core_Root. #72560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f194ba7
Added a note emphasizing Libraries have to be built in Release mode t…
Jul 20, 2022
e2bd23e
Corrected a statement regarding libraries' configuration.
Jul 21, 2022
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
5 changes: 3 additions & 2 deletions docs/workflow/building/coreclr/linux-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

@hoyosjs hoyosjs Jul 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@ivdiazsa ivdiazsa Jul 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

the libraries subset (`-subset libs`) before this command can be run. Note that this by default searches the libraries in Release mode, regardless of the runtime
configuration you specify. If you built your libs in another configuration, then you have to pass down the appropriate flag `/p:LibrariesConfiguration=<your_config>`.

```
./src/tests/build.sh generatelayoutonly
Expand Down
4 changes: 3 additions & 1 deletion docs/workflow/building/coreclr/osx-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

@AaronRobinsonMSFT AaronRobinsonMSFT Jul 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

the libraries subset (`-subset libs`) before this command can be run. Note that this by default searches the libraries in Release mode, regardless of the runtime
configuration you specify. If you built your libs in another configuration, then you have to pass down the appropriate flag `/p:LibrariesConfiguration=<your_config>`.

```
./src/tests/build.sh generatelayoutonly
Expand Down