Skip to content

Commit

Permalink
Update VMR codespace READMEs (#42017)
Browse files Browse the repository at this point in the history
Co-authored-by: Alexander Köplinger <[email protected]>
  • Loading branch information
ViktorHofer and akoeplinger authored Jul 8, 2024
1 parent e44f16d commit f0884dc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
22 changes: 14 additions & 8 deletions .devcontainer/vmr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,25 @@
## ## ######## ## ## ######## ## ## ## #### ######
-->

This Codespace can help you debug the source build of .NET. In case you have run this from a
`dotnet/sdk` PR branch, it will contain the VMR (`dotnet/dotnet`) checked out into
`/workspaces/dotnet` with the PR changes pulled into it. You can then attempt to source-build
the VMR which is what the VMR leg in the sdk PR build doing. This build takes about 45
minutes and, after completion, produces an archived .NET SDK located in
This Codespace allows you to debug or make changes to the .NET SDK product. In case you ran this
from a `dotnet/sdk` PR branch, the directory tree contains the VMR (`dotnet/dotnet`) checked out into
`/workspaces/dotnet` with the PR changes pulled into it. Building the VMR from the codespace mimics
what the VMR pipelines in an sdk PR are doing. The build takes about 45-75 minutes
(depending on the machine spec and target OS) and, after completion, produces an archived .NET SDK located in
`/workspaces/dotnet/artifacts/assets/Release`.

## Build the SDK

To build the VMR, run following:
To build the repository, run one of the following:
```bash
cd /workspaces/dotnet
./build.sh --online
# Microsoft based build
./build.sh
```
or

```bash
# Building from source only
./prep-source-build.sh && ./build.sh -sb
```

> Please note that, at this time, the build modifies some of the checked-in sources so it might
Expand Down
10 changes: 6 additions & 4 deletions src/SourceBuild/content/.devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@
## ## ######## ## ## ######## ## ## ## #### ######
-->

This Codespace can help you debug the source build of .NET. This build takes about
45 minutes and, after completion, produces an archived .NET SDK located in
`/workspaces/dotnet/artifacts/assets/Release`. In case you selected the `prebuilt-sdk`
Codespace, the built-from-source SDK will already be there.
This Codespace allows you to debug or make changes to the .NET SDK product. The build takes about
45 up to 75 minutes (depending on the machine and OS) and, after completion, produces an archived
.NET SDK located in `/workspaces/dotnet/artifacts/assets/Release`.

In case you selected the prebuilt-sdk Codespace configuration (which is only useful when building
from source), the built-from-source SDK will already be there.

## Build the SDK

Expand Down

0 comments on commit f0884dc

Please sign in to comment.