1
0
mirror of https://github.com/golang/go synced 2024-11-23 06:00:08 -07:00
Commit Graph

55 Commits

Author SHA1 Message Date
Shulhan
c2f7dd182e doc: use consistent path in example code
Previous section of documentation said that if GOPATH is not set then
it will be default to "$HOME/go", not "$HOME/work".

This change fix the path in example code to "$HOME/go", and while at it
fix the output of git command after commit.

Change-Id: Ifedca6c3997efd07e865c27b7321d755acad0254
Reviewed-on: https://go-review.googlesource.com/c/go/+/175258
Reviewed-by: Andrew Bonventre <andybons@golang.org>
2019-05-13 16:34:24 +00:00
Russ Cox
3e0f5f934e doc/code: drop mentions of GOPATH/pkg directory
It's already half gone and later will be all gone.
It's not worth explaining in an introduction doc.

Fixes #24506
Updates #4719

Change-Id: Ie48128b3aa090d84e0e734aa45f14a4480292913
Reviewed-on: https://go-review.googlesource.com/129679
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-08-17 15:52:33 +00:00
Tim Cooper
a7d89572be doc: fix fmt usage in code.html
Fixes #25876

Change-Id: I149dbb2afef13cc13fb5722d930377ed918d7e3c
Reviewed-on: https://go-review.googlesource.com/118717
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-13 22:00:24 +00:00
Suriyaa Sundararuban
1041ac8781 doc: use HTTPS for links
Change-Id: I9d2d25df067ca573589db5ff18296a5ec33866be
Reviewed-on: https://go-review.googlesource.com/118595
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-06-13 13:45:01 +00:00
Nathan Cantelmo
4f6b9ed5ad doc: document the lack of support for symlinks under GOPATH
In an effort to help others avoid the issues I've hit due to lack of
symlink support under GOPATH, I've added a note of warning to the
Workspaces section.

I have not changed the contents of go help gopath, because on reflection
it seems this change alone may be sufficient.

Fixes #21320

Change-Id: Ib8969bf12cecad878e89ff66b5864bbf3caaf219
Reviewed-on: https://go-review.googlesource.com/61930
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-06-12 23:52:02 +00:00
Gabriel Nicolas Avellaneda
1a56a27c58 doc: Proper default value for the $GOPATH.
It should be $HOME/go instead of $HOME/work

Change-Id: I22e0a89deff30f935c3e25a237d6c0c161103339
Reviewed-on: https://go-review.googlesource.com/46890
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-06-28 05:47:47 +00:00
Jaana Burcu Dogan
29be580395 doc: add link to the setting GOPATH guide
Change-Id: I4718c82540ef214728393824b89c8c7f6656823b
Reviewed-on: https://go-review.googlesource.com/36210
Reviewed-by: Russ Cox <rsc@golang.org>
2017-03-07 00:59:54 +00:00
Jaana Burcu Dogan
1fbdae5c3a cmd/go: add link to env varible guide to set custom GOPATH
Also moves the GOPATH env variable guide to
golang.org/wiki/SettingGOPATH.

Fixes #18294.

Change-Id: I88a2ce550df7466f8d2388d86bc8476dcf3c2ad6
Reviewed-on: https://go-review.googlesource.com/34918
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-01-07 00:53:18 +00:00
Jaana Burcu Dogan
a37b9e8e70 doc: explain how to set GOPATH to a custom value
Updates #18294.

Change-Id: Ib6b84243a15ed921cc8960e5fa355fd7594181e6
Reviewed-on: https://go-review.googlesource.com/34821
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-01-06 19:34:22 +00:00
Russ Cox
74628a8b9f doc, cmd/go: adjust documentation for default GOPATH
Replaces CL 33356.

Fixes #17262.

Change-Id: Idfb2343e90771775e51a66c63760f458737a288c
Reviewed-on: https://go-review.googlesource.com/33730
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2016-11-30 21:40:00 +00:00
Edward Muller
81dfcba331 go/build: add help info for unset $GOPATH
We relay this info in a few places, in a few different ways, but not
consistently everywhere.  This led one of our users to start googling
and not find https://golang.org/doc/code.html#Workspaces, of which `go
help gopath` is the most equivalent.

Change-Id: I28a94375739f3aa4f200e145293ca2a5f65101e1
Reviewed-on: https://go-review.googlesource.com/28690
Run-TryBot: Rob Pike <r@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
2016-09-10 00:27:43 +00:00
Andrew Gerrand
1abb863d83 doc: add Overview and other small edits to How To Write Go Code
Fixes #9228

Change-Id: Ic4df4a39f6f363bdd6eb9228c8164e6e9dccee1b
Reviewed-on: https://go-review.googlesource.com/5561
Reviewed-by: Rob Pike <r@golang.org>
Reviewed-by: Austin Clements <austin@google.com>
2016-01-12 01:56:04 +00:00
Christopher Guiney
ae266aaa9d doc: Added link to 'go help gopath'
The existing go code document did not link to the GOPATH documentation.
This will link to it, in hopes of making it more discoverable.

Change-Id: Ie4ded2fdce08f412e4acbcc93acdd76f5791b84a
Reviewed-on: https://go-review.googlesource.com/2265
Reviewed-by: Andrew Gerrand <adg@golang.org>
2015-01-05 21:24:39 +00:00
Andrew Gerrand
8655f04d8e doc: propose $GOPATH as $HOME/work, not $HOME/go
Related to issue #9228

Change-Id: I0819e657f6393788754d1412f9c2126a170d4cf1
Reviewed-on: https://go-review.googlesource.com/1577
Reviewed-by: Rob Pike <r@golang.org>
2014-12-16 04:35:09 +00:00
Andrew Gerrand
eb91b5f224 [release-branch.go1.4] doc: scrub references to code.google.com
These are the references that affect current Go users.
I left intact references in older release notes;
we can figure out what to do with them later.

LGTM=rsc
R=rsc
CC=golang-codereviews
https://golang.org/cl/186140043

Conflicts:
	doc/go1.4.html

Change-Id: I1032686f2b3ac6dacaf8f114b8c35cdf221330ca
2014-12-12 14:00:48 +11:00
Andrew Gerrand
7f0be1f781 all: use golang.org/x/... import paths
LGTM=rsc, r
R=r, rsc
CC=golang-codereview, golang-codereviews
https://golang.org/cl/168050043
2014-11-10 09:15:57 +11:00
Andrew Gerrand
43ad89d627 doc: drop scheme from links that are known to support HTTPS
golang.org now serves HTTPS with a valid cert, so it's reasonable
that users should click through to the HTTPS versions of *.golang.org
and other known sites.

LGTM=bradfitz
R=golang-codereviews, bradfitz
CC=golang-codereviews
https://golang.org/cl/112650043
2014-07-25 10:28:39 +10:00
Andrew Gerrand
c497c9ea4b 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
2013-11-21 07:55:29 +11:00
Shenghou Ma
26f43a089e doc: fix small HTML problems
R=golang-dev, dave
CC=golang-dev
https://golang.org/cl/14629043
2013-10-12 18:40:41 -04:00
Andrew Gerrand
cf694aac34 doc: fix a few broken links
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/14494044
2013-10-09 07:05:43 +11:00
Katrina Owen
605da0e2a2 doc: Fix typo in approximation of square root
See https://en.wikipedia.org/wiki/Newton%27s_method#Square_root_of_a_number

R=golang-dev, minux.ma, adg
CC=golang-dev
https://golang.org/cl/9145044
2013-05-29 13:49:51 +10:00
Oling Cat
e680710d0e doc/code.html: remove doubled word; modify the tab to space.
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/8919043
2013-04-23 13:13:51 -07:00
Andriy Lytvynov
a854535556 doc/code.html: fix typos
Fixed example program's output to match program's code.
Fixes #5204.

R=golang-dev, minux.ma
CC=golang-dev
https://golang.org/cl/8365043
2013-04-04 11:11:54 -07:00
Duncan Holm
52700d24bc doc: use the already defined GOPATH in PATH
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/8248044
2013-04-04 16:36:10 +11:00
Alexei Sholik
5977e34741 doc: fix typos and trailing spaces
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/8285044
2013-04-03 16:44:03 -07:00
Andrew Gerrand
e798cd857c doc: mention godoc.org in "How to Write Go Code"
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/8344043
2013-04-04 08:56:11 +11:00
Andrew Gerrand
ee923e3f90 doc: simplify How to write Go code article
This version just tells you what to do, rather
than trying to teach you how it all works.
Should be much better for newcomers.

R=dave, gary.burd, alcosholik, r
CC=golang-dev
https://golang.org/cl/8247044
2013-04-04 08:19:24 +11:00
Greg Ward
74e1577645 doc: link to wiki Projects page instead of old Project Dashboard.
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/7308079
2013-02-11 09:18:31 +11:00
Andrew Gerrand
399a36a634 doc: fix various fragment links
R=dsymonds
CC=golang-dev
https://golang.org/cl/7094058
2013-01-15 19:25:16 +11:00
Andrew Gerrand
6f9609ab3b doc: link to Go coding screencast
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/6849046
2012-11-13 16:50:44 +01:00
Shenghou Ma
edc7b4739d doc: fix some HTML syntax errors
R=adg
CC=golang-dev
https://golang.org/cl/6458043
2012-08-07 11:12:54 +08:00
Shenghou Ma
50d5cf6bc9 doc/code: mention $GOBIN
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5989045
2012-04-17 02:41:27 +10:00
Shenghou Ma
25e02d519d doc/code: update newmath.Sqrt test case to make sure test succeed
Fixes #3445.

R=golang-dev, rsc, mtj
CC=golang-dev
https://golang.org/cl/5975061
2012-04-10 01:55:51 +08:00
Andrew Gerrand
b16ec46c2f doc: shorten project dashboard link
Fixes #3420.
(which was already fixed)

R=golang-dev, bradfitz, dsymonds
CC=golang-dev
https://golang.org/cl/5987043
2012-04-05 11:17:18 +10:00
Peter Weinberger
a978ead6e1 doc/code.html: change 'affect' to 'effect'.
Fixes #3429.

R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/5966047
2012-04-02 13:05:09 -04:00
Shenghou Ma
2a3dbb01d7 doc/code.html: fix broken dashboard link
Fixes #3420.
        Part of issue 3424.

R=golang-dev, cldorian, adg, r
CC=golang-dev
https://golang.org/cl/5958046
2012-03-30 14:07:40 +08:00
Jeremy Jackins
7e054266c9 doc: various typos, remove apostrophes from ordinals
R=golang-dev, r, r
CC=golang-dev
https://golang.org/cl/5845059
2012-03-19 08:26:36 +11:00
Sanjay Menakuru
4d7d3f5328 doc: fix some HTML errors in code.html
R=golang-dev, rsc
CC=adg, golang-dev
https://golang.org/cl/5720050
2012-03-02 11:29:09 -05:00
Andrew Gerrand
718de6f4c6 doc: expand code.html to discuss the go tool in more depth
R=golang-dev, balasanjay, r
CC=golang-dev
https://golang.org/cl/5640045
2012-03-02 15:35:36 +11:00
Stefan Nilsson
c50074e510 doc: add a bunch of missing <p> tags
R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/5707065
2012-02-29 15:07:52 -08:00
Shenghou Ma
f18b0b0c16 doc: various updates to doc/code.html
R=golang-dev, adg, r
CC=golang-dev
https://golang.org/cl/5649068
2012-02-18 16:13:02 +11:00
Andrew Gerrand
7cb21a79a4 godoc: specify HTML page metadata with a JSON blob
This allows HTML pages to specify arbitrary data in a header:

<!--{
        "Title": "The page title",
        ...
}-->

replacing the old style comments:

<!-- title The page title -->

R=gri, rsc, r, bradfitz, dsymonds
CC=golang-dev
https://golang.org/cl/5532093
2012-01-19 11:24:54 +11:00
Andrew Gerrand
d9b82baac1 doc: update "How to Write Go Code" to use the go tool
R=golang-dev, r, kevlar, rsc
CC=golang-dev
https://golang.org/cl/5534045
2012-01-12 08:25:49 +11:00
Andrew Gerrand
89f890f266 doc: there's no such thing as a .cgo file
R=rsc
CC=golang-dev
https://golang.org/cl/4264043
2011-03-04 16:28:27 +11:00
Andrew Gerrand
ee1cb829ac doc: describe platform-specific conventions in code.html
R=r, rsc, gri
CC=golang-dev
https://golang.org/cl/4257049
2011-03-04 12:28:08 +11:00
Kyle Consalus
07cc8b9ad2 Make.pkg, doc: Replace references to "-benchmarks" and "-match" with "-test.bench" and "-test.run".
R=r
CC=golang-dev
https://golang.org/cl/4197041
2011-02-22 20:23:21 -08:00
Rob Pike
bab5536af6 code.html: update to reflect that package names need not be unique
Fixes #1507.

R=golang-dev, ehog.hedge, rsc
CC=golang-dev
https://golang.org/cl/4160049
2011-02-12 18:03:16 -08:00
Anschel Schaffer-Cohen
93f97ca235 doc/code.html: fix reference to "gomake build"
R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/3288042
2010-11-29 09:17:28 -08:00
Yves Junqueira
52c23f3009 Documentation: how to write Makefiles for commands.
Fixes #1282.

R=adg
CC=golang-dev
https://golang.org/cl/3152041
2010-11-23 10:42:04 +11:00
Russ Cox
da392d9136 build: no required environment variables
R=adg, r, PeterGo
CC=golang-dev
https://golang.org/cl/1942044
2010-08-18 10:08:49 -04:00