From 968f0df5d84956502e865ec04f529c3b921369b7 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Fri, 12 Dec 2014 13:53:29 +1100 Subject: [PATCH] doc: update source install instructions Change-Id: I794a5773ed47d470ff91fcdd82f9747a91424eb4 Reviewed-on: https://go-review.googlesource.com/1402 Reviewed-by: Rob Pike --- doc/contribute.html | 13 ++------- doc/install-source.html | 61 +++++++++++++++-------------------------- 2 files changed, 24 insertions(+), 50 deletions(-) diff --git a/doc/contribute.html b/doc/contribute.html index 6a20816345..883196a0ba 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -6,19 +6,10 @@

This document explains how to contribute changes to the Go project. -It assumes you have installed Go from source: -

- -

-$ git clone https://go.googlesource.com/go
-$ cd go/src
-$ ./all.bash
-
- +

(Note that the gccgo frontend lives elsewhere; diff --git a/doc/install-source.html b/doc/install-source.html index f53deb404c..15cb624df2 100644 --- a/doc/install-source.html +++ b/doc/install-source.html @@ -81,38 +81,21 @@ The full set of supported combinations is listed in the discussion of

The Go tool chain is written in C. To build it, you need a C compiler installed. -Please refer to the InstallFromSource +Please refer to the InstallFromSource page on the Go community Wiki for operating system specific instructions.

-

Install Mercurial, if needed

+

Install Git, if needed

-To perform the next step you must have Mercurial installed. (Check that you -have an hg command.) +To perform the next step you must have Git installed. (Check that you +have a git command before proceeding.)

-If you do not have a working Mercurial installation, +If you do not have a working Git installation, follow the instructions on the -Mercurial downloads page. -

- -

-Mercurial versions 1.7.x and up require the configuration of -Certification Authorities -(CAs). Error messages of the form: -

- -
-warning: code.google.com certificate with fingerprint b1:af: ... bc not verified (check hostfingerprints or web.cacerts config setting)
-
- -

-when using Mercurial indicate that the CAs are missing. -Check your Mercurial version (hg --version) and -configure the CAs -if necessary. +Git downloads page.

@@ -121,22 +104,24 @@ if necessary.

Go will install to a directory named go. Change to the directory that will be its parent and make sure the go directory does not exist. -Then check out the repository:

+Then clone the repository and check out the latest release tag:

-$ hg clone -u release https://code.google.com/p/go
+$ git clone https://go.googlesource.com/go
+$ cd go
+$ git checkout go1.4
 
- +

If you intend to modify the go source code, and contribute your changes to the project, then move your repository -off the release branch, and onto the default (development) branch. +off the release branch, and onto the master (development) branch. Otherwise, skip this step.

-$ hg update default
+$ git checkout master
 

Install Go

@@ -259,7 +244,7 @@ $ go get golang.org/x/tools/cmd/godoc

To install these tools, the go get command requires -that Mercurial be installed locally. +that Git be installed locally.

@@ -292,22 +277,18 @@ that receives a message summarizing each checkin to the Go repository.

-Bugs can be reported using the Go issue tracker. +Bugs can be reported using the Go issue tracker.

Keeping up with releases

-The Go project maintains a stable tag in its Mercurial repository: -release. -

- -

-The release tag refers to the current stable release of Go. -Most Go users should use this version. New releases are announced on the +New releases are announced on the golang-announce mailing list. +Each announcement mentions the latest release tag, for instance, +go1.4.

@@ -316,11 +297,13 @@ To update an existing tree to the latest release, you can run:

 $ cd go/src
-$ hg pull
-$ hg update release
+$ git fetch
+$ git checkout <tag>
 $ ./all.bash
 
+Where <tag> is the version string of the release. +

Optional environment variables

-- 2.50.0