Bug 93657 – Recommend the use of https and mention git on building/checkout.html

• Status: RESOLVED
• Resolution: FIXED
• Component: New Bugs

[Ryosuke Niwa]

Recommend the use of https and mention git on building/checkout.html

[Ryosuke Niwa]

Created attachment 157549 [details]
Patch

[Mark Rowe (bdash)]

Comment on attachment 157549 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=157549&action=review

> Websites/webkit.org/building/checkout.html:42
> +<a href="http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.  It is updated every six hours. Note the archived checkout uses http connection. We recommend running the following command to use https instead:</p>

When you're referring to HTTP and HTTPS in the instructions it would be clearer to do so using uppercase since they are initialisms.

> Websites/webkit.org/building/checkout.html:67
> +<h2>Checkout Out with Git</h2>

You have an extra word in here.

> Websites/webkit.org/building/checkout.html:84
> +<p>If you want to be able to commit changes to the Subversion repository, or just want to check out branches that aren't contained in WebKit.git, you will need track the Subversion repository. To do that, inform git-svn of the location of the WebKit SVN repository, and update the branch that git-svn uses to track the Subversion repository so that it will re-use the history that we've already cloned from git.webkit.org rather than trying to fetch it all from Subversion:</p>
> +<p class="code">
> +cd WebKit
> +git svn init --prefix=origin/ -T trunk https://svn.webkit.org/repository/webkit
> +git config --replace svn-remote.svn.fetch trunk:refs/remotes/origin/master
> +</p>
> +<p>This will add the following section to your .git/config:</p>
> +<p class="code">
> +[svn-remote "svn"]
> +    url = https://svn.webkit.org/repository/webkit
> +    fetch = trunk:refs/remotes/origin/master
> +</p>
> +<p>You can then run the following command to have git-svn rebuild its metadata from your local repository, and to pull any recent commits from the WebKit SVN repository.</p>
> +<p class="code">   git svn fetch</p>

Would it make sense to just point people interested in committing from Git to <http://trac.webkit.org/wiki/UsingGitWithWebKit#Checkout> rather than duplicating the instructions here?

[Ryosuke Niwa]

Good points. Uploading a new patch now.

[Ryosuke Niwa]

Created attachment 157556 [details]
Updated per Mark's comment

[Mark Rowe (bdash)]

Comment on attachment 157556 [details]
Updated per Mark's comment

View in context: https://bugs.webkit.org/attachment.cgi?id=157556&action=review

r=me with the described changes.

> Websites/webkit.org/building/checkout.html:11
> +<div id="title">
> +<h1>The WebKit Open Source Project</h1>
> +</div>
> +
> +<div id="icon"></div>
> +
> +<div id="content">

These bits shouldn't be here.

> Websites/webkit.org/building/checkout.html:42
> +<a href="http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.  It is updated every six hours. Note the archived checkout uses HTTP connection. We recommend running the following command to use HTTPS instead:</p>

"the archived checkout uses HTTP connection" should be "the archived checkout uses *an* HTTP connection"

> Websites/webkit.org/building/checkout.html:71
> +<p>If you want to be able to commit changes to the Subversion repository, or just want to check out branches that aren't contained in WebKit.git, you will need track the Subversion repository. To do this and working with other tools on a Git checkout, read <a href="http://trac.webkit.org/wiki/UsingGitWithWebKit">the wiki page</a>.</p>

The last sentence here reads very awkwardly. I'd suggest rephrasing it to something like:
For information about this, and other aspects of using Git with WebKit, read the wiki page.

The wiki link could also point to https://trac.webkit.org/ too.

[Ryosuke Niwa]

Comment on attachment 157556 [details]
Updated per Mark's comment

View in context: https://bugs.webkit.org/attachment.cgi?id=157556&action=review

>> Websites/webkit.org/building/checkout.html:11
>> +<div id="content">
> 
> These bits shouldn't be here.

Oops, removed.

>> Websites/webkit.org/building/checkout.html:42
>> +<a href="http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.  It is updated every six hours. Note the archived checkout uses HTTP connection. We recommend running the following command to use HTTPS instead:</p>
> 
> "the archived checkout uses HTTP connection" should be "the archived checkout uses *an* HTTP connection"

Fixed.

>> Websites/webkit.org/building/checkout.html:71
>> +<p>If you want to be able to commit changes to the Subversion repository, or just want to check out branches that aren't contained in WebKit.git, you will need track the Subversion repository. To do this and working with other tools on a Git checkout, read <a href="http://trac.webkit.org/wiki/UsingGitWithWebKit">the wiki page</a>.</p>
> 
> The last sentence here reads very awkwardly. I'd suggest rephrasing it to something like:
> For information about this, and other aspects of using Git with WebKit, read the wiki page.
> 
> The wiki link could also point to https://trac.webkit.org/ too.

Yeah, I couldn't phrase it right. Thanks for the suggestion. Fixed.

[Ryosuke Niwa]

Committed r125208: <http://trac.webkit.org/changeset/125208>

[Ryosuke Niwa]

(In reply to comment #5)
> The wiki link could also point to https://trac.webkit.org/ too.

Oops, missed this comment. Fixed in http://trac.webkit.org/changeset/125210.

[Ryosuke Niwa]

It seems like this change hasn't been propagated to the live site?

[William Siegrist]

There was a problem with the auto-updating on the new hardware. I fixed it and updated the website.