]> Cypherpunks repositories - gostls13.git/commitdiff
doc: document installation of go.tools commands
authorAndrew Gerrand <adg@golang.org>
Wed, 25 Sep 2013 04:10:49 +0000 (14:10 +1000)
committerAndrew Gerrand <adg@golang.org>
Wed, 25 Sep 2013 04:10:49 +0000 (14:10 +1000)
Fixes #5663.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/13891043

doc/install-source.html

index eae75e0bda511acbc5d22865d6f188c52eda6e60..3181cd7c9f030ee627fbee7388cb3a761a9b94c8 100644 (file)
@@ -220,6 +220,36 @@ The document <a href="/doc/code.html">How to Write Go Code</a> explains how to
 set up a work environment in which to build and test Go code.
 </p>
 
+<h2 id="tools">Install additional tools</h2>
+
+<p>
+The source code for seeral Go tools (including <a href="/cmd/godoc/">godoc</a>)
+is kept in <a href="https://code.google.com/p/go.tools">the go.tools repository</a>.
+To install all of them, run the <code>go</code> <code>get</code> command:
+</p>
+
+<pre>
+$ go get code.google.com/p/go.tools/cmd/...
+</pre>
+
+<p>
+Or if you just want to install a specific command (<code>godoc</code> in this case):
+</p>
+
+<pre>
+$ go get code.google.com/p/go.tools/cmd/godoc
+</pre>
+
+<p>
+To install these tools, the <code>go</code> <code>get</code> command requires 
+that <a href="#mercurial">Mercurial</a> be installed locally.
+</p>
+
+<p>
+You must also have a workspace (<code>GOPATH</code>) set up;
+see <a href="/doc/code.html">How to Write Go Code</a> for the details.
+</p>
+
 <h2 id="community">Community resources</h2>
 
 <p>