From f0a85350e74e059a053bd6f16c2ec51a0e664bf5 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Fri, 29 Nov 2013 07:03:02 +1100 Subject: [release-branch.go1.2] doc: update installation instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ««« CL 28700043 / 8b3699321603 doc: update installation instructions Clarify that GOROOT should only be set when using a custom install path. Remove NetBSD from binary install page (we don't provide binaries). Remove "What's next" links from installation instructions. Emphasize "How to Write Go Code" page. Fixes #6613. R=golang-dev, r CC=golang-dev https://golang.org/cl/28700043 »»» R=golang-dev CC=golang-dev https://golang.org/cl/34950043 --- doc/code.html | 26 ++++++- doc/install-source.html | 17 ++++- doc/install.html | 179 ++++++++++++++++++++++-------------------------- 3 files changed, 122 insertions(+), 100 deletions(-) diff --git a/doc/code.html b/doc/code.html index 946585ccd8..0abe6ac748 100644 --- a/doc/code.html +++ b/doc/code.html @@ -580,7 +580,13 @@ For more information on using remote repositories with the go tool,

-

Further reading

+

What's next

+ +

+Subscribe to the +golang-announce +mailing list to be notified when a new stable version of Go is released. +

See Effective Go for tips on writing @@ -596,3 +602,21 @@ proper. Visit the documentation page for a set of in-depth articles about the Go language and its libraries and tools.

+ + +

Getting help

+ +

+For real-time help, ask the helpful gophers in #go-nuts on the +Freenode IRC server. +

+ +

+The official mailing list for discussion of the Go language is +Go Nuts. +

+ +

+Report bugs using the +Go issue tracker. +

diff --git a/doc/install-source.html b/doc/install-source.html index 59d984fd38..b99360c71c 100644 --- a/doc/install-source.html +++ b/doc/install-source.html @@ -216,10 +216,23 @@ If you see the "hello, world" message then Go is installed correctly.

Set up your work environment

-The document How to Write Go Code explains how to -set up a work environment in which to build and test Go code. +You're almost done. +You just need to do a little more setup.

+

+ +How to Write Go Code +Learn how to set up and use the Go tools + +

+ +

+The How to Write Go Code document +provides essential setup instructions for using the Go tools. +

+ +

Install additional tools

diff --git a/doc/install.html b/doc/install.html index 02260fe783..4211ba1947 100644 --- a/doc/install.html +++ b/doc/install.html @@ -13,27 +13,22 @@

-Click the link above to visit the -Go project's downloads page -and select the binary distribution that matches your operating system and -processor architecture. -

- -

-Official binary distributions are available for the FreeBSD, Linux, Mac OS X -(Snow Leopard, Lion, and Mountain Lion), NetBSD, and Windows operating systems -and the 32-bit (386) and 64-bit (amd64) x86 processor -architectures. +Official binary +distributions are available for the FreeBSD, Linux, Mac OS X (Snow Leopard +and above), and Windows operating systems and the 32-bit (386) and +64-bit (amd64) x86 processor architectures.

If a binary distribution is not available for your combination of operating -system and architecture you may want to try +system and architecture, try installing from source or installing gccgo instead of gc.

+

System requirements

+

The gc compiler supports the following operating systems and architectures. Please ensure your system meets these requirements before @@ -53,7 +48,6 @@ proceeding. If your OS or architecture is not on the list, it's possible that Linux 2.6.23 or later with glibc amd64, 386, arm CentOS/RHEL 5.x not supported; no binary distribution for ARM yet Mac OS X 10.6 or later amd64, 386 use the gcc† that comes with Xcode‡ Windows 2000 or later amd64, 386 use mingw gcc†; cygwin or msys is not needed -NetBSD 6 or later amd64, 386

@@ -65,41 +59,20 @@ installed Xcode 4.3+, you can install it from the Components tab of the Downloads preferences panel.

-

Install the Go tools

- -

-The Go binary distributions assume they will be installed in -/usr/local/go (or c:\Go under Windows), -but it is possible to install them in a different -location. If you do this, you will need to set the GOROOT -environment variable to that directory when using the Go tools. -

- -

-For example, if you installed Go to your home directory you should add the -following commands to $HOME/.profile: -

- -
-export GOROOT=$HOME/go
-export PATH=$PATH:$GOROOT/bin
-
- -

-Windows users should read the section about setting -environment variables under Windows. -

-

FreeBSD, Linux, Mac OS X and NetBSD tarballs

+

Install the Go tools

If you are upgrading from an older version of Go you must first remove the existing version. +

+ +

Linux, Mac OS X, and FreeBSD tarballs

-Extract the archive -into /usr/local, creating a Go tree in /usr/local/go. -For example: +Download the archive +and extract it into /usr/local, creating a Go tree in +/usr/local/go. For example: 

@@ -125,11 +98,36 @@ variable. You can do this by adding this line to your /etc/profile
 export PATH=$PATH:/usr/local/go/bin
+

Installing to a custom location

+ +

+The Go binary distributions assume they will be installed in +/usr/local/go (or c:\Go under Windows), +but it is possible to install the Go tools to a different location. +In this case you must set the GOROOT environment variable +to point to the directory in which it was installed. +

+ +

+For example, if you installed Go to your home directory you should add the +following commands to $HOME/.profile: +

+ +
+export GOROOT=$HOME/go
+export PATH=$PATH:$GOROOT/bin
+
+ +

+Note: GOROOT must be set only when installing to a custom +location. +

+

Mac OS X package installer

-Open the package file -and follow the prompts to install the Go tools. +Download the package file, +open it, and follow the prompts to install the Go tools. The package installs the Go distribution to /usr/local/go.

@@ -148,34 +146,33 @@ a zip archive that requires you to set some environment variables and an MSI installer that configures your installation automatically.

-

Zip archive

+

MSI installer

-Extract the zip file -to the directory of your choice (we suggest c:\Go). +Open the MSI file +and follow the prompts to install the Go tools. +By default, the installer puts the Go distribution in c:\Go.

-If you chose a directory other than c:\Go, you must set -the GOROOT environment variable to your chosen path. +The installer should put the c:\Go\bin directory in your +PATH environment variable. You may need to restart any open +command prompts for the change to take effect.

+

Zip archive

+

-Add the bin subdirectory of your Go root (for example, c:\Go\bin) to your PATH environment variable. +Download the zip file and extract it into the directory of your choice (we suggest c:\Go).

-

MSI installer

-

-Open the MSI file -and follow the prompts to install the Go tools. -By default, the installer puts the Go distribution in c:\Go. +If you chose a directory other than c:\Go, +you must set the GOROOT environment variable to your chosen path.

-The installer should put the c:\Go\bin directory in your -PATH environment variable. You may need to restart any open -command prompts for the change to take effect. +Add the bin subdirectory of your Go root (for example, c:\Go\bin) to your PATH environment variable.

Setting environment variables under Windows

@@ -187,6 +184,7 @@ versions of Windows provide this control panel through the "Advanced System Settings" option inside the "System" control panel.

+

Test your installation

@@ -220,55 +218,24 @@ hello, world If you see the "hello, world" message then your Go installation is working.

-

Set up your work environment

- -

-The document How to Write Go Code explains how to -set up a work environment in which to build and test Go code. -

- -

What's next

- -

-Start by taking A Tour of Go. -

- -

-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. -

- -

-Subscribe to the -golang-announce -mailing list to be notified when a new stable version of Go is released. -

- - -

Community resources

+

Set up your work environment

-For real-time help, there may be users or developers on -#go-nuts on the Freenode IRC server. +You're almost done. +You just need to do a little more setup.

-The official mailing list for discussion of the Go language is -Go Nuts. + +How to Write Go Code +Learn how to set up and use the Go tools +

-Bugs should be reported using the -Go issue tracker. +The How to Write Go Code document +provides essential setup instructions for using the Go tools.

@@ -293,3 +260,21 @@ environment variables under Windows.

+

Getting help

+ +

+For real-time help, ask the helpful gophers in #go-nuts on the +Freenode IRC server. +

+ +

+The official mailing list for discussion of the Go language is +Go Nuts. +

+ +

+Report bugs using the +Go issue tracker. +

+ + -- cgit v1.2.3-54-g00ecf