Skip to content

Commit 83cd168

Browse files
Update VMR README.md with MAX_PATH limitations (dotnet#46373)
Co-authored-by: Alexander Köplinger <[email protected]>
1 parent 8823927 commit 83cd168

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/SourceBuild/content/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,14 @@ For the latest information about Source-Build support, please watch for announce
7777
The dependencies for building can be found [here](https://github.com/dotnet/runtime/blob/main/docs/workflow/requirements/).
7878
In case you don't want to / cannot prepare your environment per the requirements, consider [using Docker](#building-using-docker).
7979

80+
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).
81+
82+
For some `git` commands and when synchronizing changes via the `darc` CLI, long path support should be enabled in the `git` config as well:
83+
```bash
84+
git config --system core.longpaths true # needs elevated prompt
85+
git config --global core.longpaths true
86+
```
87+
8088
### Building
8189

8290
1. **Clone the repository**

0 commit comments

Comments
 (0)