Re: RFR: 8251549: Update docs on building for Git [v2]
> 8251549: Update docs on building for Git Joe Darcy has updated the pull request incrementally with one additional commit since the last revision: Update doc/building.md Co-authored-by: Magnus Ihse Bursie - Changes: - all: https://git.openjdk.java.net/jdk/pull/21/files - new: https://git.openjdk.java.net/jdk/pull/21/files/185b04d4..91d91125 Webrevs: - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=21&range=01 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=21&range=00-01 Stats: 15 lines in 1 file changed: 14 ins; 0 del; 1 mod Patch: https://git.openjdk.java.net/jdk/pull/21.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/21/head:pull/21 PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Tue, 3 Nov 2020 13:21:24 GMT, Michael Keck wrote: >> @erikj79 >> >> Ok, here is a completely rewritten portion, which highlights the differences >> between Cygwin git and Git for Windows. >> >> Suggestion: >> >> * You need to install a git client. You have two choices, Cygwin git or >> Git for Windows. Unfortunately there are pros and cons with each >> choice. >> >> * The Cygwin `git` client has no line ending issues and understands >> Cygwin paths (which are used throughout the JDK build system). >> However, it does not currently work well with the Skara CLI >> tooling. >> Please see the [Skara wiki on Git clients]( >> https://wiki.openjdk.java.net/display/SKARA/Skara#Skara-Git) for >> up-to-date information about the Skara git client support. >> >> * The [Git for Windows](https://gitforwindows.org) client has issues >> with line endings, and do not understand Cygwin paths. It does work >> well with the Skara CLI tooling, however. To alleviate the line >> ending >> problems, make sure you set `core.autocrlf` to `false` (this is >> asked >> during installation). >> >> @jddarcy Do you find this acceptable? This PR has been open for almost a >> month, and it's starting getting embarrassing that our build instruction >> does not match the new Github reality. :( > > You should add a `.gitattributes` file which defines the desired line endings > for each file type or for all files. Recommending a specific git client just > because of that (?) is unnecessary. > > Here is a arbitrary example: > https://github.com/alexkaratarakis/gitattributes/blob/f017637f08305dd1402fd025f6b648c45f04f499/Common.gitattributes#L49 I like your proposed text, Magnus. - PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Tue, 3 Nov 2020 11:41:20 GMT, Magnus Ihse Bursie wrote: >> I would recommend putting in a link to the instructions on the Skara wiki >> page. They actually recommend Git for Windows and I have switched too. The >> main reason is to be able to use the token manager. To just clone and build, >> using Cygwin Git is definitely easier though. > > @erikj79 > > Ok, here is a completely rewritten portion, which highlights the differences > between Cygwin git and Git for Windows. > > Suggestion: > > * You need to install a git client. You have two choices, Cygwin git or > Git for Windows. Unfortunately there are pros and cons with each > choice. > > * The Cygwin `git` client has no line ending issues and understands > Cygwin paths (which are used throughout the JDK build system). > However, it does not currently work well with the Skara CLI tooling. > Please see the [Skara wiki on Git clients]( > https://wiki.openjdk.java.net/display/SKARA/Skara#Skara-Git) for > up-to-date information about the Skara git client support. > > * The [Git for Windows](https://gitforwindows.org) client has issues > with line endings, and do not understand Cygwin paths. It does work > well with the Skara CLI tooling, however. To alleviate the line > ending > problems, make sure you set `core.autocrlf` to `false` (this is > asked > during installation). > > @jddarcy Do you find this acceptable? This PR has been open for almost a > month, and it's starting getting embarrassing that our build instruction does > not match the new Github reality. :( You should add a `.gitattributes` file which defines the desired line endings for each file type or for all files. Recommending a specific git client just because of that (?) is unnecessary. Here is a arbitrary example: https://github.com/alexkaratarakis/gitattributes/blob/f017637f08305dd1402fd025f6b648c45f04f499/Common.gitattributes#L49 - PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Mon, 26 Oct 2020 12:50:59 GMT, Erik Joelsson wrote: >> @jddarcy Recommended new wording: >> Suggestion: >> >> * Clone the JDK repository using the Cygwin command line `git` client >> as instructed in this document. >> >> Using the Cygwin `git` client is the recommended way since it >> guarantees that there will be no line ending issues and it works well >> with other Cygwin tools. It is however also possible to use [Git for >> Windows](https://gitforwindows.org). If you chose this path, make >> sure >> to set `core.autocrlf` to `false` (this is asked during >> installation). > > I would recommend putting in a link to the instructions on the Skara wiki > page. They actually recommend Git for Windows and I have switched too. The > main reason is to be able to use the token manager. To just clone and build, > using Cygwin Git is definitely easier though. @erikj79 Ok, here is a completely rewritten portion, which highlights the differences between Cygwin git and Git for Windows. Suggestion: * You need to install a git client. You have two choices, Cygwin git or Git for Windows. Unfortunately there are pros and cons with each choice. * The Cygwin `git` client has no line ending issues and understands Cygwin paths (which are used throughout the JDK build system). However, it does not currently work well with the Skara CLI tooling. Please see the [Skara wiki on Git clients]( https://wiki.openjdk.java.net/display/SKARA/Skara#Skara-Git) for up-to-date information about the Skara git client support. * The [Git for Windows](https://gitforwindows.org) client has issues with line endings, and do not understand Cygwin paths. It does work well with the Skara CLI tooling, however. To alleviate the line ending problems, make sure you set `core.autocrlf` to `false` (this is asked during installation). @jddarcy Do you find this acceptable? This PR has been open for almost a month, and it's starting getting embarrassing that our build instruction does not match the new Github reality. :( - PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Mon, 26 Oct 2020 09:45:16 GMT, Magnus Ihse Bursie wrote: >> BTW the value of coreautolf flag is asked during the installation of Git for >> windows, it is should be mentioned in the docs, since it is quite common >> issue. > > @jddarcy Recommended new wording: > Suggestion: > > * Clone the JDK repository using the Cygwin command line `git` client > as instructed in this document. > > Using the Cygwin `git` client is the recommended way since it > guarantees that there will be no line ending issues and it works well > with other Cygwin tools. It is however also possible to use [Git for > Windows](https://gitforwindows.org). If you chose this path, make sure > to set `core.autocrlf` to `false` (this is asked during installation). I would recommend putting in a link to the instructions on the Skara wiki page. They actually recommend Git for Windows and I have switched too. The main reason is to be able to use the token manager. To just clone and build, using Cygwin Git is definitely easier though. - PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Mon, 7 Sep 2020 10:05:25 GMT, Sergey Bylokhov wrote: >> doc/building.md line 92: >> >>> 90: spaces and/or mixed upper and lower case letters. >>> 91: >>> 92: * Clone the JDK repository using [Git for >>> Windows](https://gitforwindows.org). >> >> I think I said before, this is *not* a recommended way! Instead, git from >> Cygwin is still recommended. >> >> Git for Windows will for instance set the coreautolf flag. Now we have >> pushed a work-around for this, but I object to *recommending* git for >> windows. > > BTW the value of coreautolf flag is asked during the installation of Git for > windows, it is should be mentioned in the docs, since it is quite common > issue. @jddarcy Recommended new wording: * Clone the JDK repository using the Cygwin command line `git` client as instructed in this document. Using the Cygwin `git` client is the recommended way since it guarantees that there will be no line ending issues and it works well with other Cygwin tools. It is however also possible to use [Git for Windows](https://gitforwindows.org). If you chose this path, make sure to set `core.autocrlf` to `false` (this is asked during installation). - PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Mon, 7 Sep 2020 07:20:02 GMT, Magnus Ihse Bursie wrote: >> 8251549: Update docs on building for Git > > doc/building.md line 92: > >> 90: spaces and/or mixed upper and lower case letters. >> 91: >> 92: * Clone the JDK repository using [Git for >> Windows](https://gitforwindows.org). > > I think I said before, this is *not* a recommended way! Instead, git from > Cygwin is still recommended. > > Git for Windows will for instance set the coreautolf flag. Now we have pushed > a work-around for this, but I object > to *recommending* git for windows. BTW the value of coreautolf flag is asked during the installation of Git for windows, it is should be mentioned in the docs, since it is quite common issue. - PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
On Sat, 5 Sep 2020 20:13:18 GMT, Joe Darcy wrote: > 8251549: Update docs on building for Git Overall looks good, but please restore the recommendation to stick with Cygwin tools. doc/building.md line 92: > 90: spaces and/or mixed upper and lower case letters. > 91: > 92: * Clone the JDK repository using [Git for > Windows](https://gitforwindows.org). I think I said before, this is *not* a recommended way! Instead, git from Cygwin is still recommended. Git for Windows will for instance set the coreautolf flag. Now we have pushed a work-around for this, but I object to *recommending* git for windows. - Changes requested by ihse (Reviewer). PR: https://git.openjdk.java.net/jdk/pull/21
Re: RFR: 8251549: Update docs on building for Git
Hello Adrian, On 9/5/2020 2:04 PM, John Paul Adrian Glaubitz wrote: Hi Joe! On 9/5/20 10:21 PM, Joe Darcy wrote: 8251549: Update docs on building for Git (...) PR: https://git.openjdk.java.net/jdk/pull/21 Does that mean that OpenJDK development has officially moved to Github now? And are all OpenJDK members becoming members of the OpenJDK Github project? See the announcements about this transition, with instructions, on jdk-dev: https://mail.openjdk.java.net/pipermail/jdk-dev/2020-August/004588.html https://mail.openjdk.java.net/pipermail/jdk-dev/2020-September/004694.html -Joe
Re: RFR: 8251549: Update docs on building for Git
Hi Joe! On 9/5/20 10:21 PM, Joe Darcy wrote: > 8251549: Update docs on building for Git > (...) > PR: https://git.openjdk.java.net/jdk/pull/21 Does that mean that OpenJDK development has officially moved to Github now? And are all OpenJDK members becoming members of the OpenJDK Github project? Thanks, Adrian -- .''`. John Paul Adrian Glaubitz : :' : Debian Developer - glaub...@debian.org `. `' Freie Universitaet Berlin - glaub...@physik.fu-berlin.de `-GPG: 62FF 8A75 84E0 2956 9546 0006 7426 3B37 F5B5 F913
Re: RFR: 8251549: Update docs on building for Git
On Sat, 5 Sep 2020 20:13:18 GMT, Joe Darcy wrote: > 8251549: Update docs on building for Git Hi Joe, This looks OK.Are similar changes being made to http://openjdk.java.net/guide/producingChangeset.html as well given it refers to mercurial? - Marked as reviewed by lancea (Reviewer). PR: https://git.openjdk.java.net/jdk/pull/21
RFR: 8251549: Update docs on building for Git
8251549: Update docs on building for Git - Commit messages: - Update building docs for git. Changes: https://git.openjdk.java.net/jdk/pull/21/files Webrev: https://webrevs.openjdk.java.net/?repo=jdk&pr=21&range=00 Issue: https://bugs.openjdk.java.net/browse/JDK-8251549 Stats: 56 lines in 1 file changed: 0 ins; 39 del; 17 mod Patch: https://git.openjdk.java.net/jdk/pull/21.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/21/head:pull/21 PR: https://git.openjdk.java.net/jdk/pull/21
