dotnet / runtime

.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
https://docs.microsoft.com/dotnet/core/
MIT License
15.17k stars 4.72k forks source link

Documentation should cover CRLF values #47290

Open directhex opened 3 years ago

directhex commented 3 years ago

The Windows install instructions mention PATH values and required software, but no mention of the AutoCRLF config value. It seems the libs subset cannot be built if the user sets the wrong AutoCRLF value during installation of Git, and it's not obvious to the user why it's failing.

https://github.com/dotnet/runtime/blob/master/docs/workflow/requirements/windows-requirements.md

dotnet-issue-labeler[bot] commented 3 years ago

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

ghost commented 3 years ago

Tagging subscribers to this area: @ViktorHofer See info in area-owners.md if you want to be subscribed.

Issue Details
The Windows install instructions mention PATH values and required software, but no mention of the AutoCRLF config value. It seems the libs subset cannot be built if the user sets the wrong AutoCRLF value during installation of Git, and it's not obvious to the user _why_ it's failing. https://github.com/dotnet/runtime/blob/master/docs/workflow/requirements/windows-requirements.md
Author: directhex
Assignees: -
Labels: `area-Infrastructure`, `documentation`, `untriaged`
Milestone: -
directhex commented 3 years ago

There are seemingly other gaps in the Windows doc requirements. I installed what the docs told me to, but the libs subset is failing:

C:\source\repos\dotnet\runtime\src\libraries\shims\manual\System.forwards.cs(8,88): error CS0234: The type or namespace name 'ZLibException' does not exist in the namespace 'System.IO.Compression' (are you missing an assembly reference?) [C:\source\repos\dotnet\runtime\src\libraries\shims\manual\System.csproj]
C:\source\repos\dotnet\runtime\src\libraries\shims\manual\System.forwards.cs(9,77): error CS0234: The type or namespace name 'CookieVariant' does not exist in the namespace 'System.Net' (are you missing an assembly reference?) [C:\source\repos\dotnet\runtime\src\libraries\shims\manual\System.csproj]
C:\source\repos\dotnet\runtime\src\libraries\shims\manual\System.forwards.cs(10,77): error CS0234: The type or namespace name 'PathList' does not exist in the namespace 'System.Net' (are you missing an assembly reference?) [C:\source\repos\dotnet\runtime\src\libraries\shims\manual\System.csproj]
C:\source\repos\dotnet\runtime\src\libraries\src.proj(45,5): error MSB4181: The "MSBuild" task returned false but did not log an error.
    0 Warning(s)
    4 Error(s)
bekir-ozturk commented 3 years ago

I'm getting the same errors regarding ZLibException, CookieVariant and PathList. @directhex have you found a fix?