Update long path instructions in developer guide#53846
Update long path instructions in developer guide#53846
Conversation
Added instructions to enable long paths in Git for build issues.
There was a problem hiding this comment.
Pull request overview
Updates the Windows build section of the developer guide to include Git configuration guidance for long path-related build failures.
Changes:
- Expands the existing long-path troubleshooting note to mention enabling long paths in Windows.
- Adds a Git setting suggestion (
core.longpaths) as part of the workaround.
| The build script will output a `dotnet` installation to `artifacts\bin\redist\Debug\dotnet` that will include any local changes to the .NET Core CLI. | ||
|
|
||
| As part of the build, some intermediate files will get generated which may run into long-path issues. If you encounter a build failure with an error message similar to `Resource file [filename].resx cannot be found.`, [enable long paths](https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=cmd#enable-long-paths-in-windows-10-version-1607-and-later) and try again. | ||
| As part of the build, some intermediate files will get generated which may run into long-path issues. If you encounter a build failure with an error message similar to `Resource file [filename].resx cannot be found.`, [enable long paths in Windows](https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=cmd#enable-long-paths-in-windows-10-version-1607-and-later) and in Git (`git config core.longpaths true`), then try again. |
There was a problem hiding this comment.
I am not sure about this suggestion. First, I encountered the issue when switching between branches (main to one of the release branches specifically; the latter had some extra files). No build was involved. And second, whether the Git setting is applied to this repo only or as a global setting, is a matter of personal preference.
My main point with this change is to help people who encounter "path too long" errors a more complete set of workarounds. Under which circumstances these errors might occur is less important, and there is value in keeping the developer guide as concise as possible.
Added instructions to enable long paths in Git for build issues.