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

2913 Commits

Author SHA1 Message Date
Rob Pike
b59b42cee8 doc: update Usage section of the FAQ
This is close to a complete rewrite, as the content was pretty old.

The CL includes links to the Wiki for information about companies
using Go, a new section about IDEs and editors¹, and a restatement
of the foreign function interface story. It also modernizes and
expands a little on the use of Go inside Google.

¹ Ed is the standard editor.

Change-Id: I5e54aafa53d00d86297b2691960a376b40f6225b
Reviewed-on: https://go-review.googlesource.com/123922
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-17 10:07:18 +00:00
Rob Pike
c4f30481b3 doc: rewrite run-on sentence in garbage collection discussion
Change-Id: I60cb7010448757ca4c7a2973bee2277b3d5fc439
Reviewed-on: https://go-review.googlesource.com/124175
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-17 09:48:05 +00:00
Filippo Valsorda
c80897b691 doc: populate and add go1.11 notes related to crypto
Change-Id: I8163d06e5099d7ac39b04ccadf7f6533967db2f5
Reviewed-on: https://go-review.googlesource.com/124135
Reviewed-by: Andrew Bonventre <andybons@golang.org>
2018-07-16 20:29:54 +00:00
Brad Fitzpatrick
f49a5c6c57 doc: move the go1.11 "all" section elsewhere, add os/signal.Ignored, GOMIPS64
Change-Id: Ice8f82a6288eeadfb8efd7628444166a447831da
Reviewed-on: https://go-review.googlesource.com/124096
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-07-16 18:38:30 +00:00
Brad Fitzpatrick
6c44036c1f doc: add more to go1.11, sort, remove dups
Change-Id: I20a82f6b47cd3ab4ca22d222e6d8a2c59d57e2a4
Reviewed-on: https://go-review.googlesource.com/124095
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-07-16 18:24:24 +00:00
Brad Fitzpatrick
f4b8a5194e doc: flesh out go1.11 notes
Change-Id: I0152d3c1d980e271fbcdb9d5def094d3c837a4f4
Reviewed-on: https://go-review.googlesource.com/124055
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-07-16 17:49:11 +00:00
Brad Fitzpatrick
e07e9c4fd5 doc: add net/http additions to go1.11 notes
Change-Id: Ib2da2b0ceb33867a41b0b9b7e4dcecb11f964b73
Reviewed-on: https://go-review.googlesource.com/124035
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-07-16 17:48:58 +00:00
Andrew Bonventre
3fcfb1f573 doc/go1.11: update with latest output from x/build/cmd/relnote
Change-Id: I4055ecc39b1b250cce7b32241f13dbc05567361f
Reviewed-on: https://go-review.googlesource.com/124015
Reviewed-by: Bryan C. Mills <bcmills@google.com>
2018-07-16 15:32:40 +00:00
Rob Pike
22e17d0ac7 doc: update Design and Types sections of the FAQ
Update #26107.

Change-Id: I8bfa5b01ce953c53f7fd7a866d0ece61ba04c618
Reviewed-on: https://go-review.googlesource.com/123919
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-15 09:19:41 +00:00
Rob Pike
f7b05a08b8 doc: update Values, Writing Code, and Pointers and Allocation sections of the FAQ
Significant surgery done to the Versioning section, bringing it closer to
modern thinking.

Also add a question about constants.

Update #26107.

Change-Id: Icf70b7228503c6baaeab0b95ee3e6bee921575aa
Reviewed-on: https://go-review.googlesource.com/123918
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-15 09:19:08 +00:00
Rob Pike
12f217459d doc: update Implementation and Performance sections of the FAQ
Changes are mostly about making more about now than about the past,
changing some verb tenses, and mentioning gollvm (which should
be pronounced "gollum" if you ask me).

Update #26107

Change-Id: I6c14f42b9fc2684259d4ba8bc149d7ec9bb83d15
Reviewed-on: https://go-review.googlesource.com/123917
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-15 09:18:16 +00:00
Rob Pike
ca69a916ca doc: rearrange the description of GOMAXPROCS
The old text was written when it was only 1 by default, which
changed a long time ago.

Also add a note that GOMAXPROCS does not limit the total
number of threads.

Change-Id: I104ccd7266d11335320a4d7f5671fb09ed641f88
Reviewed-on: https://go-review.googlesource.com/123916
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-15 09:12:39 +00:00
Rob Pike
489a2632f4 doc: update Concurrency, Functions and Methods, and Control Flow sections
Many parts of the FAQ are dusty and need cleaning up.
This is the first of a series of changes to bring it up to date.
Since it was first written at the time of release, some of the
ideas and background have changed, and some historical
remarks are largely irrelevant now.

Update #26107.

Change-Id: I1f36df7d8ecc8a1a033d5ac4fa1edeece25ed6b4
Reviewed-on: https://go-review.googlesource.com/123496
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-12 22:49:31 +00:00
Rob Pike
d87f635626 doc: clarify a sentence about *_js.go
Change "have to" to "need to" for clarity and to avoid a
peculiar English idiom.

Change-Id: Iec2b1f841d0353dd7925f8f934fe82d4ed059d7d
Reviewed-on: https://go-review.googlesource.com/123495
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-12 04:33:03 +00:00
Brad Fitzpatrick
40bc0a7709 doc: mention that *_js.go files are now ignored and treated like a GOOS
Fixes #26329

Change-Id: Id87fd106e69d3d9682653eb753b1de616adeed2b
Reviewed-on: https://go-review.googlesource.com/123416
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-07-11 22:09:15 +00:00
Brad Fitzpatrick
4b74506da1 doc: update the minimum support Windows version
Also, remove some test code that was trying to work on XP and fix up
some comments referencing XP.

Fixes #26191
Updates #23380

Change-Id: I0b7319fe1954afddb22d396e5ec91d8c960268d8
Reviewed-on: https://go-review.googlesource.com/123415
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Alex Brainman <alex.brainman@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
2018-07-11 22:05:38 +00:00
Russ Cox
eb9356b7a2 doc/go1.11: mention import path restriction
Change-Id: I18a6915614a317adb4da710a01268b574300f0e0
Reviewed-on: https://go-review.googlesource.com/123096
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Bryan C. Mills <bcmills@google.com>
2018-07-10 21:18:10 +00:00
Russ Cox
be1dfb0e1a doc: describe modules in Go 1.11 release notes and Go FAQ
Fixes #25517.

Change-Id: I801eebe17eaed9be09f290e8f219a808dc98f837
Reviewed-on: https://go-review.googlesource.com/122408
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-by: Andrew Bonventre <andybons@golang.org>
2018-07-06 18:42:08 +00:00
Andrew Bonventre
4f172e7a75 doc/go1.11: add note about package versioning
It will not be present in go1.11beta1 but will be present
in subsequent releases.

Change-Id: I298fb682945345bb4a34ec83802fd644f75bdd98
Reviewed-on: https://go-review.googlesource.com/120756
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-25 18:17:49 +00:00
Alberto Donizetti
291e57f057 doc/contribute: fix typo and reword a few sentences
This change fixes a typo in doc/contribute.html (afects -> affects)
and rewords a few slightly akward sentences.

Change-Id: I6bfbacba0de29464fce134b0fdaf3898a97b8d57
Reviewed-on: https://go-review.googlesource.com/120105
Reviewed-by: Rob Pike <r@golang.org>
2018-06-24 16:01:45 +00:00
Dmitri Shuralyov
82d1c2a8aa doc/go1.11: clarify GOOS/GOARCH pair of WebAssembly port
It's more common to specify GOOS/GOARCH values in that order,
rather than the inverse. Fix the order.

Updates #18892.

Change-Id: I8551508599e019f6617dc007397b562c9926418d
Reviewed-on: https://go-review.googlesource.com/120057
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-22 16:16:26 +00:00
Stephen Lewis
ee9c9392b8 doc: fix spelling of G Suite
'G Suite' seems to be the preferred spelling according to
https://gsuite.google.com/

Change-Id: Ica60938cf942594157bba84ef205e1cdcb8c1b08
Reviewed-on: https://go-review.googlesource.com/120132
Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
2018-06-20 18:43:22 +00:00
Wayne Ashley Berry
dd0e7a9534 doc: change git clone url
The git clone url should be a Gerrit host and not Github, otherwise the
codereview command will fail.

	git-codereview: failed to load Gerrit origin: git origin must be a Gerrit host, not GitHub: https://github.com/golang/go

Change-Id: I62f62c86ee6dce0720a844fc56340135dfae8405
Reviewed-on: https://go-review.googlesource.com/117178
Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-20 17:17:37 +00:00
Dmitri Shuralyov
500293d8dc doc: update "Mac OS X", "OS X" to macOS; bump up to 10.10
The name was "Mac OS X" during versions 10.0 to 10.7.
It was renamed to "OS X" starting from 10.8 until 10.11.
The current name is "macOS" starting with 10.12. [1]

Previous changes (e.g., CL 47252) updated "Mac OS X" to macOS
in some places, but not everywhere. This CL updates remaining
instances for consistency.

Only the pages that display current information were updated;
historical pages such as release notes for older Go releases,
past articles, blog posts, etc., were left in original form.

Rename the "#osx" anchor to "#macos" on /doc/install page,
along with the single reference to it on the same page.
Add an empty div with id="osx" to not break old links.

Update minimum macOS version from 10.8 to 10.10 per #23122.

[1]: https://en.wikipedia.org/wiki/macOS#History

Updates #23122.

Change-Id: I69fe4b85e83265b9d99f447e3cc5230dde094869
Reviewed-on: https://go-review.googlesource.com/119855
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-19 21:36:56 +00:00
Mostyn Bramley-Moore
187c3a65a6 doc: update more stale pprof links
Related to #25477.

Change-Id: I11261c6055b446ceca1b3acc538ab00fec4b47ca
Reviewed-on: https://go-review.googlesource.com/119321
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-17 21:35:39 +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
Dave Russell
930185f26d doc/contribute.html: add whitespace after <code> blocks, where missing
Change-Id: Iea5c705dd58f9b83fbeb0500defcc08c34716169
GitHub-Last-Rev: 35702c784e
GitHub-Pull-Request: golang/go#25858
Reviewed-on: https://go-review.googlesource.com/118536
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-13 04:46:06 +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
Andrew Bonventre
dda7985a7b doc/go1.11: first draft of release notes
Updates golang/go#23122

Change-Id: I2d6769101cdd580901cb08a3027d787fa438d4bc
Reviewed-on: https://go-review.googlesource.com/117975
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-12 17:39:28 +00:00
Suriyaa Sundararuban
43a3cdf8c7 doc: use HTTPS for man.openbsd.org link in go1.7.html
Change-Id: I88855dfa3166e90386c90bf6220be0596dab3c0d
Reviewed-on: https://go-review.googlesource.com/118175
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-12 15:03:46 +00:00
Suriyaa Sundararuban
33d058308f doc: use HTTPS for clang.llvm.org link in go1.6.html
Change-Id: I67aac387359378cf7aa8f7cafa6557ebf1338baf
Reviewed-on: https://go-review.googlesource.com/118176
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-12 15:03:24 +00:00
Joe Cortopassi
6b3e343408 doc: remove GOROOT custom install instruction
Setting GOROOT is no longer necessary for custom installation as of 1.10 (reference: https://go-review.googlesource.com/c/go/+/42533). Fixes #25002

Change-Id: Ic3980833ac437b7a20b951df33805ad1071a40ce
GitHub-Last-Rev: 156bf6510a
GitHub-Pull-Request: golang/go#25190
Reviewed-on: https://go-review.googlesource.com/110435
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-06-12 03:42:37 +00:00
Filippo Valsorda
b0951aff8f doc: document Go 1.10.3
Change-Id: Ifc774bb9267baa773e91c617204329d3e04bd4b7
Reviewed-on: https://go-review.googlesource.com/116363
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
2018-06-06 00:03:55 +00:00
Filippo Valsorda
bbf4a3024b doc: document Go 1.9.7
Change-Id: I10dededb41162a99dbc42792a9d314c6dabddcca
Reviewed-on: https://go-review.googlesource.com/116362
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
2018-06-06 00:03:32 +00:00
Jonathan Chen
16de91d351 doc: clarify sentence
Change-Id: I6eb182968a8e00fe359d812f1eefc9bda896395b
GitHub-Last-Rev: a354b4d216
GitHub-Pull-Request: golang/go#25540
Reviewed-on: https://go-review.googlesource.com/114318
Reviewed-by: Rob Pike <r@golang.org>
2018-05-24 21:37:42 +00:00
Andrew Bonventre
723f4286b9 doc: update Code of Conduct
Change-Id: I82c03dd026bb797a49b7361389373924acf6366c
Reviewed-on: https://go-review.googlesource.com/114085
Reviewed-by: Russ Cox <rsc@golang.org>
2018-05-23 20:16:46 +00:00
Tobias Klauser
a0b7051772 doc/contribute.html: remove superfluous article
After CL 113016 the "a" article is no longer necessary.

Change-Id: I5a80a210bd2b9eedd73d5f9f3f338d7f22c29ea6
Reviewed-on: https://go-review.googlesource.com/113355
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-05-16 12:26:53 +00:00
Rob Pike
3868a371a8 doc/contribute.html: English cleanups
Fixes #24487

Change-Id: Ic523e469f7f67f376edd2fca6e07d35bb11b2db9
Reviewed-on: https://go-review.googlesource.com/113016
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-05-15 20:47:43 +00:00
Rob Pike
a023f3c8f3 doc/contribute.html: clean up HTML and formatting
Mostly just formatting and minor cleanup:

- regularize HTML (add </p> etc.)
- remove all errors caught by tidy
- start all sentences on new line for easy editing

Some wording changes, but there will be more to come.
It seemed there were already enough edits to send it out.

Update #24487

Change-Id: I613ce206b1e8e3e522ecb0bbcd2acb11c4ff5bae
Reviewed-on: https://go-review.googlesource.com/113015
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-05-14 04:21:05 +00:00
Bryan C. Mills
df48003618 spec: clarify “Constant expressions” for untyped operands
This change addresses the grammatical complexity described in
https://groups.google.com/forum/#!topic/golang-dev/RmP-LMC3g58.

Change-Id: Ib292b4ca9c880c7c1c8c992e7c033a0f8f951f2c
Reviewed-on: https://go-review.googlesource.com/106855
Reviewed-by: Robert Griesemer <gri@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
2018-05-09 20:36:22 +00:00
Rob Pike
cd1976dbef doc/faq: tidy up a couple of nits
The phrase "couple X" is considered colloquial, so make that "a couple of X".
Also move the start of a sentence to a new line in a couple of places
for easier editing, in one place thereby removing two spaces after a period.

Change-Id: If5ef05eb496afc235f8f0134c4e7346375a65181
Reviewed-on: https://go-review.googlesource.com/112176
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-05-08 19:57:49 +00:00
jimmyfrasche
d96221f206 doc: make front page video respond to layout changes (1/2)
The videos on the front page are always the same width, regardless of
the viewport width. These changes let the video fill the space given
to its container regardless of layout. It uses the standard hack for
making iframes responsive, but the videos are loaded at random and do
not have uniform aspect ratios so that information is injected into the
DOM using custom properties. If these are not supported, it falls back
to the same layout present before this change.

Note: this change also requires CL 108678 to complete the fix,
though either CL without the other is harmless.

Updates #24997.

Change-Id: I2f93dc21ffe01d99ce0e175e9dd0e3d486fddc9f
Reviewed-on: https://go-review.googlesource.com/108677
Run-TryBot: Andrew Bonventre <andybons@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Andrew Bonventre <andybons@golang.org>
2018-05-08 19:21:12 +00:00
Andrew Bonventre
4bced5e946 doc: document Go 1.10.2
Change-Id: I84334dfd02ad9a27b3fb6d46a6b1c015a3f03511
Reviewed-on: https://go-review.googlesource.com/110335
Reviewed-by: Filippo Valsorda <filippo@golang.org>
2018-04-30 18:01:00 +00:00
Andrew Bonventre
587416c161 doc: document Go 1.9.6
Change-Id: I9699b22d3a308cda685aa684b32dcde99333df46
Reviewed-on: https://go-review.googlesource.com/110315
Reviewed-by: Filippo Valsorda <filippo@golang.org>
2018-04-30 18:00:51 +00:00
Alberto Donizetti
0cdf2ec81a doc: update FAQ on binary sizes
In the binary sizes FAQ, the approximate size of a Go hello world
binary was said to be 1.5MB (it was about 1.6MB on go1.7 on
linux/amd64). Sadly, this is no longer true. A Go1.10 hello world is
2.0MB, and in 1.11 it'll be about 2.5MB.

Just say "a couple megabytes" to stop this dance.

Change-Id: Ib4dc13a47ccd51327c1a9d90d4116f79597513a4
Reviewed-on: https://go-review.googlesource.com/110069
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-04-30 16:11:15 +00:00
Milan Knezevic
2959128dc5 cmd/compile: add softfloat support to mips64{,le}
mips64 softfloat support is based on mips implementation and introduces
new enviroment variable GOMIPS64.

GOMIPS64 is a GOARCH=mips64{,le} specific option, for a choice between
hard-float and soft-float. Valid values are 'hardfloat' (default) and
'softfloat'. It is passed to the assembler as
'GOMIPS64_{hardfloat,softfloat}'.

Change-Id: I7f73078627f7cb37c588a38fb5c997fe09c56134
Reviewed-on: https://go-review.googlesource.com/108475
Reviewed-by: Cherry Zhang <cherryyz@google.com>
Run-TryBot: Cherry Zhang <cherryyz@google.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
2018-04-27 14:50:17 +00:00
Alberto Donizetti
a3bafcf8cc doc: make chart.apis.google.com link not clickable
The example in the 'A web server' section of the effective Go document
uses Google's image charts API (at chart.apis.google.com).

The service is now deprecated (see developers.google.com/chart/image),
and visiting http://chart.apis.google.com gives a 404. The endpoint is
still active, so the Go code in the example still works, but there's
no point in making the link clickable by the user if the page returns
a 404.

Change the element to `<code>`.

Change-Id: Ie67f4723cfa636e3dc1460507055b6bbb2b0970c
Reviewed-on: https://go-review.googlesource.com/109576
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-04-26 18:26:06 +00:00
Russ Cox
09d36a819e doc: update "go get" HTTPS answer to mention .netrc
The existing text makes it seem like there's no way
to use GitHub over HTTPS. There is. Explain that.

Also, the existing text suggests explicit checkout into $GOPATH,
which is not going to work in the new module world.
Drop that alternative.

Also, the existing text uses pushInsteadOf instead of insteadOf,
which would have the effect of being able to push to a private
repo but not clone it in the first place. That seems not helpful,
so suggest insteadOf instead.

Fixes #18927.

Change-Id: Ic358b66f88064b53067d174a2a1591ac8bf96c88
Reviewed-on: https://go-review.googlesource.com/107775
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-04-25 02:49:10 +00:00
Rodolfo Carvalho
c0769741f5 doc: correct statement in go1.10 release notes
The language spec requires the RHS operand of shift expressions to be unsigned integers.

The changes in CL 60230 and the related CL 81277 refer to a variable s of type uint.
The "untyped constant" here refers to 1.0, not s.

Change-Id: Id2b884816af7f79f453afcb8c34ade2d34e18bc2
GitHub-Last-Rev: b26c853cae
GitHub-Pull-Request: golang/go#24989
Reviewed-on: https://go-review.googlesource.com/108676
Reviewed-by: Robert Griesemer <gri@golang.org>
2018-04-23 22:21:48 +00:00