From 83cd16879b618615ff6bc945aeed7c7662c25acf Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Tue, 28 Jan 2025 23:10:29 +0100 Subject: [PATCH] Update VMR README.md with MAX_PATH limitations (#46373) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alexander Köplinger --- src/SourceBuild/content/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/SourceBuild/content/README.md b/src/SourceBuild/content/README.md index ec2db00153e6..36f39876cfaa 100644 --- a/src/SourceBuild/content/README.md +++ b/src/SourceBuild/content/README.md @@ -77,6 +77,14 @@ For the latest information about Source-Build support, please watch for announce The dependencies for building can be found [here](https://github.com/dotnet/runtime/blob/main/docs/workflow/requirements/). In case you don't want to / cannot prepare your environment per the requirements, consider [using Docker](#building-using-docker). +For building the VMR on Windows, it is recommended to put the repo under a short path, i.e. `C:\dotnet`. Also, [long path support must be enabled](https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#enable-long-paths-in-windows-10-version-1607-and-later). This is necessary as some of the tools used don't support long paths (WiX Toolset v3 and cl.exe). + +For some `git` commands and when synchronizing changes via the `darc` CLI, long path support should be enabled in the `git` config as well: +```bash +git config --system core.longpaths true # needs elevated prompt +git config --global core.longpaths true +``` + ### Building 1. **Clone the repository**