Skip to content

Commit f0884dc

Browse files
Update VMR codespace READMEs (#42017)
Co-authored-by: Alexander Köplinger <[email protected]>
1 parent e44f16d commit f0884dc

File tree

2 files changed

+20
-12
lines changed

2 files changed

+20
-12
lines changed

Diff for: .devcontainer/vmr/README.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,25 @@
88
## ## ######## ## ## ######## ## ## ## #### ######
99
-->
1010

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

1818
## Build the SDK
1919

20-
To build the VMR, run following:
20+
To build the repository, run one of the following:
2121
```bash
22-
cd /workspaces/dotnet
23-
./build.sh --online
22+
# Microsoft based build
23+
./build.sh
24+
```
25+
or
26+
27+
```bash
28+
# Building from source only
29+
./prep-source-build.sh && ./build.sh -sb
2430
```
2531

2632
> Please note that, at this time, the build modifies some of the checked-in sources so it might

Diff for: src/SourceBuild/content/.devcontainer/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@
88
## ## ######## ## ## ######## ## ## ## #### ######
99
-->
1010

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

1618
## Build the SDK
1719

0 commit comments

Comments
 (0)