From f0884dc226c8121b4e771b0fe26268d48dd52596 Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Mon, 8 Jul 2024 12:34:11 +0200 Subject: [PATCH] Update VMR codespace READMEs (#42017) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alexander Köplinger --- .devcontainer/vmr/README.md | 22 ++++++++++++------- .../content/.devcontainer/README.md | 10 +++++---- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/.devcontainer/vmr/README.md b/.devcontainer/vmr/README.md index 92d7858e8f..92bc3d8c55 100644 --- a/.devcontainer/vmr/README.md +++ b/.devcontainer/vmr/README.md @@ -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 diff --git a/src/SourceBuild/content/.devcontainer/README.md b/src/SourceBuild/content/.devcontainer/README.md index 58f0361719..7f0a5cd264 100644 --- a/src/SourceBuild/content/.devcontainer/README.md +++ b/src/SourceBuild/content/.devcontainer/README.md @@ -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