Skip to content

Commit 91d9112

Browse files
jddarcymagicus
andauthored
Update doc/building.md
Co-authored-by: Magnus Ihse Bursie <mag@icus.se>
1 parent 185b04d commit 91d9112

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

doc/building.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,21 @@ on where and how to check out the source code.
8989
directory. This is especially important if your user name contains
9090
spaces and/or mixed upper and lower case letters.
9191

92-
* Clone the JDK repository using [Git for Windows](https://gitforwindows.org).
92+
* You need to install a git client. You have two choices, Cygwin git or
93+
Git for Windows. Unfortunately there are pros and cons with each choice.
94+
95+
* The Cygwin `git` client has no line ending issues and understands
96+
Cygwin paths (which are used throughout the JDK build system).
97+
However, it does not currently work well with the Skara CLI tooling.
98+
Please see the [Skara wiki on Git clients](
99+
https://wiki.openjdk.java.net/display/SKARA/Skara#Skara-Git) for
100+
up-to-date information about the Skara git client support.
101+
102+
* The [Git for Windows](https://gitforwindows.org) client has issues
103+
with line endings, and do not understand Cygwin paths. It does work
104+
well with the Skara CLI tooling, however. To alleviate the line ending
105+
problems, make sure you set `core.autocrlf` to `false` (this is asked
106+
during installation).
93107

94108
Failure to follow this procedure might result in hard-to-debug build
95109
problems.

0 commit comments

Comments
 (0)