From d70627e5d0725254baf8c3f133f96afec68518f0 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Tue, 6 Mar 2012 15:16:02 +1100 Subject: [PATCH] doc: update install docs for Windows and Go 1, add golang-announce to /project R=golang-dev, bradfitz, r, rsc CC=golang-dev https://golang.org/cl/5758044 --- doc/contrib.html | 9 ++ doc/install-source.html | 266 ++++++++++++++++++---------------------- doc/install.html | 18 ++- 3 files changed, 144 insertions(+), 149 deletions(-) diff --git a/doc/contrib.html b/doc/contrib.html index 7a96b8db7b..b4bd47e96a 100644 --- a/doc/contrib.html +++ b/doc/contrib.html @@ -17,6 +17,15 @@ Go is an open source project developed by a team at Go is distributed under a BSD-style license.

+

Announcements Mailing List

+

+A low traffic mailing list for important announcements, such as new releases. +

+

+We encourage all Go users to subscribe to +golang-announce. +

+

Developer Resources

Source Code

diff --git a/doc/install-source.html b/doc/install-source.html index 5a17844b29..fe3d4637b6 100644 --- a/doc/install-source.html +++ b/doc/install-source.html @@ -97,7 +97,9 @@ If you want to build 32-bit binaries on a 64-bit system you'll also need the

-TODO: add Windows compiler info +On Windows, install gcc with +MinGW. +(Make sure you add its bin subdirectory to your PATH.)

Install Mercurial, if needed

@@ -105,7 +107,7 @@ If you want to build 32-bit binaries on a 64-bit system you'll also need the

To perform the next step you must have Mercurial installed. (Check that you have an hg command.) This suffices to install Mercurial on most -systems: +Unix systems: 

@@ -113,8 +115,7 @@ sudo easy_install mercurial==2.0

-On Ubuntu/Debian, -the Mercurial in your distribution's +On Ubuntu/Debian, the Mercurial in your distribution's package repository is most likely old and broken. You might try this first:

@@ -122,7 +123,7 @@ You might try this first: 
apt-get install python-setuptools python-dev build-essential

-If that fails, try installing manually from the +If that fails, or if you use Windows, install manually from the Mercurial Download page.

@@ -253,23 +254,14 @@ Bugs can be reported using the Keeping up with releases -

-XXX TODO XXX -

-

The Go project maintains two stable tags in its Mercurial repository: release and weekly. -The weekly tag is updated about once a week, and should be used by -those who want to track the project's development. -The release tag is given, less often, to those weekly releases -that have proven themselves to be robust.

-Most Go users will want to keep their Go installation at the latest -release tag. -New releases are announced on the +The release tag refers to the current stable release of Go. +Most Go users should use this version. New releases are announced on the golang-announce mailing list.

@@ -286,6 +278,8 @@ $ ./all.bash

+The weekly tag is updated about once a week, and should be used +only by those who are actively working on the Go core. To use the weekly tag run hg update weekly instead.

@@ -298,143 +292,123 @@ The Go compilation environment can be customized by environment variables. to override the defaults.

-
-
- $GOROOT -
-
-

- XXX FONT IS WRONG IN THESE ENTRIES XXX - XXX I NEED SOME SPAN THING XXX - The root of the Go tree, often $HOME/go. - 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. -

-
+
-
- $GOROOT_FINAL -
-
-

- The value assumed by installed binaries and scripts when - $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. -

-
+

$GOROOT

+

+The root of the Go tree, often $HOME/go. +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. +

-
-$GOOS and $GOARCH -
-
-

- The name of the target operating system and compilation architecture. - These default to the values of $GOHOSTOS and - $GOHOSTARCH respectively (described below). +

$GOROOT_FINAL

+

+The value assumed by installed binaries and scripts when +$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. +

-

- Choices for $GOOS are - darwin (Mac OS X 10.5 and above), freebsd, - linux, netbsd, openbsd, - plan9, and windows. - Choices for $GOARCH are - amd64 (64-bit x86, the most mature port), - 386 (32-bit x86), and arm (32-bit ARM). - The valid combinations of $GOOS and $GOARCH are: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$GOOS $GOARCH
darwin 386
darwin amd64
freebsd 386
freebsd amd64
linux 386
linux amd64
linux arm
netbsd 386
netbsd amd64
openbsd 386
openbsd amd64
plan9 386
windows 386
windows amd64
-

+

$GOOS and $GOARCH

+

+The name of the target operating system and compilation architecture. +These default to the values of $GOHOSTOS and +$GOHOSTARCH respectively (described below). -

-$GOHOSTOS and $GOHOSTARCH -
-
-

- The name of the host operating system and compilation architecture. - These default to the local system's operating system and - architecture. +

+Choices for $GOOS are +darwin (Mac OS X 10.5 and above), freebsd, +linux, netbsd, openbsd, +plan9, and windows. +Choices for $GOARCH are +amd64 (64-bit x86, the most mature port), +386 (32-bit x86), and arm (32-bit ARM). +The valid combinations of $GOOS and $GOARCH are: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$GOOS $GOARCH
darwin 386
darwin amd64
freebsd 386
freebsd amd64
linux 386
linux amd64
linux arm
netbsd 386
netbsd amd64
openbsd 386
openbsd amd64
plan9 386
windows 386
windows amd64
-

- Valid choices are the same as for $GOOS and - $GOARCH, listed above. - The specified values must be compatible with the local system. - For example, you should not set $GOHOSTARCH to - arm on an x86 system. -

+

$GOHOSTOS and $GOHOSTARCH

+

+The name of the host operating system and compilation architecture. +These default to the local system's operating system and +architecture. +

-
-$GOBIN -
-
-

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

+

+Valid choices are the same as for $GOOS and +$GOARCH, listed above. +The specified values must be compatible with the local system. +For example, you should not set $GOHOSTARCH to +arm on an x86 system. +

-
-$GOARM (arm, default=6) -
-
-

- The ARM architecture version the run-time libraries should target. - Setting $GOARM to 5 causes the linker to emit calls - to a software floating point implementation instead of using - hardware floating point support. -

-
+

$GOBIN +

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

+ +

$GOARM (arm, default=6)

+

+The ARM architecture version the run-time libraries should target. +Setting $GOARM to 5 causes the linker to emit calls +to a software floating point implementation instead of using +hardware floating point support. +

+ +

Note that $GOARCH and $GOOS identify the diff --git a/doc/install.html b/doc/install.html index 4f2bb1c994..eabb5778bd 100644 --- a/doc/install.html +++ b/doc/install.html @@ -114,7 +114,14 @@ Terminal sessions for the change to take effect.

Windows

-TODO: windows installation instructions. +Open the .msi file and follow the prompts to install the Go tools. +By default, the installer puts the Go distribution in c:\Go. +

+ +

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

Testing your installation

@@ -173,8 +180,13 @@ idiomatic Go code.

-For the full story, consult Go's extensive -documentation. +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.