From 95d7d3d658989cb2af98f753b9731a4af3e363be Mon Sep 17 00:00:00 2001 From: Rob Pike Date: Sat, 3 Mar 2012 09:36:09 +1100 Subject: [PATCH] doc/install-source.html: update for go tool Make some updates, get rid of mentions of make. There remain a number of open questions. R=golang-dev, gri CC=golang-dev https://golang.org/cl/5720057 --- doc/install-source.html | 104 +++++++++++++++++++--------------------- 1 file changed, 48 insertions(+), 56 deletions(-) diff --git a/doc/install-source.html b/doc/install-source.html index ecb386f597..21cda8a65b 100644 --- a/doc/install-source.html +++ b/doc/install-source.html @@ -5,21 +5,31 @@

Introduction

-

Go is an open source project, distributed under a +

+Go is an open source project, distributed under a BSD-style license. This document explains how to check out the sources, build them on your own machine, and run them.

+

+Most users don't need to do this, and will instead install +from precompiled binary packages as described in +Getting Started, +a much simpler process. +If you want to help develop what goes into those precompiled +packages, though, read on. +

+

There are two official Go compiler tool chains. This document focuses on the gc Go compiler and tools (6g, 8g etc.). -For information on how to use gccgo, a more traditional +For information on how to work on gccgo, a more traditional compiler using the GCC back end, see -Setting up and using gccgo. +Setting up and using gccgo.

@@ -33,7 +43,7 @@ architectures. amd64 (a.k.a. x86-64); 6g,6l,6c,6a

- The most mature implementation. The compiler has an effective + A mature implementation. The compiler has an effective optimizer (registerizer) and generates good code (although gccgo can do noticeably better sometimes).
@@ -47,7 +57,8 @@ architectures. arm (a.k.a. ARM); 5g,5l,5c,5a
- Supports only Linux binaries. Less tested than the other ports. + Supports only Linux binaries. Less widely used than the other ports and therefore + not as thoroughly tested.
@@ -113,7 +124,7 @@ You might try this first:

If that fails, try installing manually from the Mercurial Download -page.

+page.

@@ -136,7 +147,6 @@ if necessary.

Fetch the repository

-

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. @@ -222,58 +232,31 @@ If you see the "hello, world" message then Go is installed correctly.

-

What's next

- -

-Start by taking A Tour of Go. -

- -

-For more detail about the process of building and testing Go programs -read How to Write Go Code. -

- -

-Build a web application by following the Wiki -Tutorial. -

- -

-Read Effective Go to learn about writing -idiomatic Go code. -

- -

-For the full story, consult Go's extensive -documentation. -

- -

Community resources

-For real-time help, there may be users or developers on -#go-nuts on the Freenode IRC server. -

- -

-The official mailing list for discussion of the Go language is -Go Nuts. +The usual community resources such as +#go-nuts on the Freenode IRC server +and the +Go Nuts +mailing list have active developers that can help you with problems +with your installation or your development work. +For those who wish to keep up to date, +there is another mailing list, golang-checkins, +that receives a message summarizing each checkin to the Go repository.

Bugs can be reported using the Go issue tracker.

-

-For those who wish to keep up with development, -there is another mailing list, golang-checkins, -that receives a message summarizing each checkin to the Go repository. -

-

Keeping up with releases

+

+XXX TODO XXX +

+

The Go project maintains two stable tags in its Mercurial repository: release and weekly. @@ -311,7 +294,7 @@ To use the weekly tag run hg update weekly instead.

The Go compilation environment can be customized by environment variables. -None are required by the build, but you may wish to set them +None is required by the build, but you may wish to set some to override the defaults.

@@ -321,11 +304,14 @@ to override the defaults.

+ XXX FONT IS WRONG IN THESE ENTRIES XXX + XXX I NEED SOME SPAN THING XXX The root of the Go tree, often $HOME/go. - This defaults to the parent of the directory where all.bash is run. - If you choose not to set $GOROOT, you must - run gomake instead of make or gmake - when developing Go programs using the conventional makefiles. + Its value is built into the tree when it is compiled, and + defaults to the parent of the directory where all.bash was run. + There is no need to set this unless you want to switch between multiple + local copies of the repository. +

@@ -334,11 +320,12 @@ to override the defaults.

The value assumed by installed binaries and scripts when - $GOROOT is not set. - It defaults to the value used for $GOROOT. + $GOROOT is not set explicitly. + It defaults to the value of $GOROOT. If you want to build the Go tree in one location but move it elsewhere after the build, set $GOROOT_FINAL to the eventual location. +

@@ -406,7 +393,6 @@ to override the defaults. windows amd64 -

@@ -431,7 +417,8 @@ to override the defaults.

- The location where binaries will be installed. + The location where binaries from the main repository will be installed. + XXX THIS MAY CHANGE TO BE AN OVERRIDE EVEN FOR GOPATH ENTRIES XXX The default is $GOROOT/bin. After installing, you will want to arrange to add this directory to your $PATH, so you can use the tools. @@ -472,3 +459,8 @@ export GOROOT=$HOME/go export GOARCH=amd64 export GOOS=linux + +

+although, to reiterate, none of these variables needs to be set to build, +install, and develop the Go tree. +

-- 2.48.1