summaryrefslogtreecommitdiff
path: root/doc/articles
Commit message (Collapse)AuthorAgeFilesLines
* doc: remove all docs not tied to distributionRuss Cox2021-02-1624-2403/+0
| | | | | | | | | | | | | | | | | | They have moved to x/website in CL 291693. The docs that are left are the ones that are edited at the same time as development in this repository and are tied to the specific version of Go being developed. Those are: - the language spec - the memory model - the assembler manual - the current release's release notes Change-Id: I437c4d33ada1b1716b1919c3c939c2cacf407e83 Reviewed-on: https://go-review.googlesource.com/c/go/+/291711 Trust: Russ Cox <rsc@golang.org> Trust: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
* doc/articles/race_detector.html: add darwin/arm64Cherry Zhang2020-11-091-1/+1
| | | | | | | | | | Updates #38485. Change-Id: I46f515973c0a31d7c3e0e05ce006121c60c4041e Reviewed-on: https://go-review.googlesource.com/c/go/+/268497 Trust: Cherry Zhang <cherryyz@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
* doc/articles/wiki: add missing log import to net/http tutorialChirag Sukhala2020-08-161-0/+1
| | | | | | | | | | The log package is used with the net/http but was not in the import clause. Change-Id: Ic45b987633adf0ee15defd4d136b5d37027e22b0 GitHub-Last-Rev: e74aff53370569864b7ec8c18617a5d992d34bf2 GitHub-Pull-Request: golang/go#36674 Reviewed-on: https://go-review.googlesource.com/c/go/+/215618 Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
* doc/articles/wiki: use correct variable name in closures guideHowJMay2020-03-201-1/+1
| | | | | | | | | | | | | Fixes non-existent variable TitleValidator to be validPath in the closures, functions literal section. Fixes #36779 Change-Id: I59762c358c3e00d1cc03d9d1e2aace03f145321d GitHub-Last-Rev: a5e9b17a3707fc48c6d87bab3a4968f2ef63ab65 GitHub-Pull-Request: golang/go#36783 Reviewed-on: https://go-review.googlesource.com/c/go/+/216479 Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
* doc: race condition in unsynchronized send/closeChangkun Ou2020-03-021-0/+32
| | | | | | | | | | | This CL documents that unsynchronized send and close operations on a channel are detected as a race condition. Fixes #27769 Change-Id: I7495a2d0dd834c3f3b6339f8ca18ea21ae979aa8 Reviewed-on: https://go-review.googlesource.com/c/go/+/219637 Reviewed-by: Rob Pike <r@golang.org>
* doc/articles/race_detector: mention memory leak potentialKevin Burke2020-02-251-0/+11
| | | | | | | | | | | | | | | | As far as I can tell, there is no public documentation on this topic, which cost me several days of debugging. I am possibly unusual in that I run binaries in production with the race detector turned on, but I think that others who do the same may want to be aware of the risk. Updates #26813. Updates #37233. Change-Id: I1f8111bd01d0000596e6057b7cb5ed017d5dc655 Reviewed-on: https://go-review.googlesource.com/c/go/+/220586 Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
* doc: document atexit_sleep_ms flag in race_detectorDaniel Martí2020-01-031-0/+5
| | | | | | | | | | | | | | | It was pointed out to me that the thread sanitizer library has many more flags than the ones documented in this doc page. In particular, I was able to make use of GORACE=atexit_sleep_ms=10 to reduce the amount that 'go test -race' will sleep before finishing. I'm sure that this flag will be useful to others in the future, so add it here. This is still not a complete list, but we can simply add useful flags that work when we think they deserve a mention. Change-Id: If199d36fd80a0945af90055d110519e5dba27361 Reviewed-on: https://go-review.googlesource.com/c/go/+/200863 Reviewed-by: Heschi Kreinick <heschi@google.com>
* all: fix a number of misuses of the word "an"Daniel Martí2019-12-101-1/+1
| | | | | | | | | | | | | | | | | | | | After golang.org/cl/210124, I wondered if the same error had gone unnoticed elsewhere. I quickly spotted another dozen mistakes after reading through the output of: git grep '\<[Aa]n [bcdfgjklmnpqrtvwyz][a-z]' Many results are false positives for acronyms like "an mtime", since it's pronounced "an em-time". However, the total amount of output isn't that large given how simple the grep pattern is. Change-Id: Iaa2ca69e42f4587a9e3137d6c5ed758887906ca6 Reviewed-on: https://go-review.googlesource.com/c/go/+/210678 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: Zach Jones <zachj1@gmail.com> Reviewed-by: Robert Griesemer <gri@golang.org> Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
* doc: convert remaining bash tests to GoBryan C. Mills2019-11-1418-148/+216
| | | | | | | | | | Updates #28387 Updates #30316 Fixes #35574 Change-Id: I21c9e18573909e092ed8dcec91b8542bb97e9f5a Reviewed-on: https://go-review.googlesource.com/c/go/+/207263 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
* doc/articles: format error string as per go styleAditya Harindar2019-10-281-1/+1
| | | | | | | | | | First letter of an error string should not be capitalized, as prescribed in the [wiki](https://github.com/golang/go/wiki/Errors). Change-Id: Iea1413f19b5240d3bef79f216094d210b54bdb62 GitHub-Last-Rev: d8e167107122b603c4f647d722537668ad1c680d GitHub-Pull-Request: golang/go#35203 Reviewed-on: https://go-review.googlesource.com/c/go/+/203797 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
* all: remove trailing whitespace from HTML filesDaniel Martí2019-09-181-1/+1
| | | | | | | | | | | | I noticed lots of trailing whitespace in one of cmd/trace's HTML files. While at it, remove a few others from still-maintained files. Leave old documents alone, such as doc/devel/weekly.html. Change-Id: I7de7bbb6dd3fe6403bbb1f1178a8d3640c1e537b Reviewed-on: https://go-review.googlesource.com/c/go/+/196178 Run-TryBot: Daniel Martí <mvdan@mvdan.cc> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
* doc: update list of archs supporting -raceAlberto Donizetti2019-08-081-2/+5
| | | | | | Change-Id: Id0a55674a16671aaee99182d9096a9263f7a80b3 Reviewed-on: https://go-review.googlesource.com/c/go/+/189357 Reviewed-by: Ian Lance Taylor <iant@golang.org>
* doc/articles/wiki: highlight the use of _ warningAgniva De Sarker2018-02-141-6/+6
| | | | | | | | | | | | This moves the paragraph mentioning the use of _ higher up to emphasize the warning and thereby reducing chances of getting stuck. Fixes #22617 Change-Id: I64352a3e966a22d86fc9d381332bade49d74714a Reviewed-on: https://go-review.googlesource.com/87375 Reviewed-by: Ian Lance Taylor <iant@golang.org>
* doc: s/tool chain/toolchain/Russ Cox2018-01-091-1/+1
| | | | | | | | | | | We were not being consistent. Standardize on toolchain. Change-Id: Id0e756b5214ce4a1341f733634ed95263f03a61c Reviewed-on: https://go-review.googlesource.com/87017 Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
* doc: fix minor capitalization typoAgniva De Sarker2017-09-281-1/+1
| | | | | | | | | | Updated page to Page to match with the sample code Fixes #21773 Change-Id: Ia884a22fd587860c7a6148103b2b474425e45284 Reviewed-on: https://go-review.googlesource.com/66790 Reviewed-by: Ian Lance Taylor <iant@golang.org>
* doc/articles/wiki: fix final-test.patchMatthew Dempsky2017-08-311-36/+27
| | | | | | | | | | Fixes test regression introduced by golang.org/cl/53071. Change-Id: Ibb085cf6d6be7b91b7c90b7bc6237c10f3097703 Reviewed-on: https://go-review.googlesource.com/60775 Run-TryBot: Matthew Dempsky <mdempsky@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Matthew Dempsky <mdempsky@google.com>
* doc: add error handling on http.ListenAndServeFrancesc Campoy Flores2017-08-3112-11/+27
| | | | | | | | Fixes #19511 Change-Id: I5585726773b822dba0be0196961132323ebbe084 Reviewed-on: https://go-review.googlesource.com/53071 Reviewed-by: Chris Broadfoot <cbro@golang.org>
* *.bash: always use the same string equality operatorDaniel Martí2017-03-141-1/+1
| | | | | | | | | | | | | POSIX Shell only supports = to compare variables inside '[' tests. But this is Bash, where == is an alias for =. In practice they're the same, but the current form is inconsisnent and breaks POSIX for no good reason. Change-Id: I38fa7a5a90658dc51acc2acd143049e510424ed8 Reviewed-on: https://go-review.googlesource.com/38031 Reviewed-by: Ian Lance Taylor <iant@golang.org> Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
* doc, cmd/go: adjust documentation for default GOPATHRuss Cox2016-11-301-32/+16
| | | | | | | | | | | 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>
* doc: replace code.google.com/p/sitesearch with its new destinationJaana Burcu Dogan2016-10-311-23/+23
| | | | | | | | | | Fixes #16910. Change-Id: I0e97e88bee0361cd3621cacd1d4b84e6e42af718 Reviewed-on: https://go-review.googlesource.com/32424 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
* cmd/yacc: remove go tool yaccBrad Fitzpatrick2016-08-181-2/+1
| | | | | | | | | | | | | | It is no longer used by Go. It's now moved to golang.org/x/tools/cmd/goyacc for anybody who needs it. Fixes #11229 Change-Id: Ia431d5a380c7ff784a2050dee2f5bc8acee015da Reviewed-on: https://go-review.googlesource.com/27325 Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Matthew Dempsky <mdempsky@google.com>
* doc/articles/wiki: remove generated final-test.go after testAlex Brainman2015-06-171-1/+1
| | | | | | Change-Id: If6dc3acdc023ac78f63e257974cd2d2e9f1cca10 Reviewed-on: https://go-review.googlesource.com/11161 Reviewed-by: Andrew Gerrand <adg@golang.org>
* doc/articles/wiki: don't run tests when 'patch' command unavailableAndrew Gerrand2015-06-151-0/+6
| | | | | | | | Change-Id: I21cfea3eadb37904252900324c23e2664b121bbb Reviewed-on: https://go-review.googlesource.com/11099 Run-TryBot: Andrew Gerrand <adg@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Andrew Gerrand <adg@golang.org>
* wiki article: remove "flag" import from the codeAlex Schroeder2015-06-143-28/+44
| | | | | | | | | | | | | | | | When reading along the article, the extra code added in the final version is not explained. The main function calls flag.Parse(), for example, which will cause an error, unless the readers looks at the entirety of final.go to see the import added. The file shown to the users no longer has the extra flags. The testing code is now in a patch that gets applied to final.go in order to create final-test.go. This is the file that will be used to test the code, matching final.go as much as possible. Change-Id: I022f5f6c88e107c8ba5623661d74a8d260d05266 Reviewed-on: https://go-review.googlesource.com/11061 Reviewed-by: Andrew Gerrand <adg@golang.org>
* doc/articles/go_command.html: mention go generateRob Pike2015-04-171-4/+9
| | | | | | | | | | Fix some out-of-date remarks. Fixes #10489. Change-Id: I8f0cce2588828052a5d013e7bac6bcfeb220579d Reviewed-on: https://go-review.googlesource.com/9008 Reviewed-by: Russ Cox <rsc@golang.org>
* all: use golang.org/x/... import pathsAndrew Gerrand2014-11-101-6/+7
| | | | | | | LGTM=rsc, r R=r, rsc CC=golang-codereview, golang-codereviews https://golang.org/cl/168050043
* build: adjustments for move from src/pkg to srcRuss Cox2014-09-082-13/+13
| | | | | | | | | | | | | | | | | | | This CL adjusts code referring to src/pkg to refer to src. Immediately after submitting this CL, I will submit a change doing 'hg mv src/pkg/* src'. That change will be too large to review with Rietveld but will contain only the 'hg mv'. This CL will break the build. The followup 'hg mv' will fix it. For more about the move, see golang.org/s/go14nopkg. LGTM=r R=r CC=golang-codereviews https://golang.org/cl/134570043
* doc: say that race detector is supported on freebsdDmitriy Vyukov2014-06-211-1/+2
| | | | | | | LGTM=ruiu R=golang-codereviews, ruiu CC=golang-codereviews https://golang.org/cl/109100046
* all: fix "the the" typos.Shenghou Ma2014-05-201-1/+1
| | | | | | | LGTM=bradfitz R=golang-codereviews, bradfitz CC=golang-codereviews https://golang.org/cl/93470043
* build: remove depdenency on GNU makeAndrew Gerrand2014-04-072-10/+2
| | | | | | | LGTM=bradfitz R=bradfitz CC=golang-codereviews https://golang.org/cl/84920043
* build: fix race in doc/articles/wiki testRick Arnold2014-03-183-7/+42
| | | | | | | | | | | | | | | | | The original test would open a local port and then immediately close it and use the port number in subsequent tests. Between the port being closed and reused by the later process, it could be opened by some other program on the machine. Changed the test to run the server process directly and have it save the assigned port to a text file to be used by client processes. Fixes #5564. LGTM=adg R=golang-codereviews, gobot, adg CC=golang-codereviews https://golang.org/cl/72290043
* doc: restore race detector manualAndrew Gerrand2014-02-111-0/+388
| | | | | | | | | | | This got deleted mistakenly during the content re-org. Fixes #7275. LGTM=dvyukov R=golang-codereviews, minux.ma, dvyukov CC=golang-codereviews https://golang.org/cl/60850043
* doc/articles/wiki: remove GNU make dependencyAram Hăvărneanu2013-12-151-1/+1
| | | | | | R=golang-dev, adg, minux.ma CC=golang-dev https://golang.org/cl/38410043
* doc/articles/wiki: fix path handling and clean up test processAndrew Gerrand2013-10-0814-162/+51
| | | | | | | | Fixes #6525. R=r CC=golang-dev https://golang.org/cl/14383043
* doc: move spec and memory model back to /ref/Andrew Gerrand2013-10-041-2/+2
| | | | | | R=golang-dev, r CC=golang-dev https://golang.org/cl/14364043
* doc: update links to spec and memory modelAndrew Gerrand2013-09-271-2/+2
| | | | | | | | Fixes #6488. R=golang-dev, r CC=golang-dev https://golang.org/cl/14004043
* doc: re-organize golang.org site contentAndrew Gerrand2013-09-1632-4026/+2
| | | | | | | | | | | | | | | | | | | | Remove "References" section. Remove most articles and redirect to blog.golang.org. Move /ref/spec and /ref/mem to /doc/spec and /doc/mem. Remove duplicate links from the remaining "Documents", "The Project", and "Help" pages. Defer to the wiki for more links and community content. Update command reference and mention cover tool. Add "Pop-out" text to the front page. Pick one of four videos at random to feature on the front page. Fixes #2547. Fixes #5561. Fixes #6321. R=r, dominik.honnef CC=golang-dev https://golang.org/cl/13724043
* doc: describe halt_on_error race detector parameterDmitriy Vyukov2013-08-161-0/+5
| | | | | | R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/13067043
* doc/articles/laws_of_reflection.html: fix name of variableRob Pike2013-08-071-1/+1
| | | | | | | | Thanks to c.emil.hessman@gmail.com for pointing out the error. R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/12572043
* doc/articles: state that slices/arrays start at the 0th elementAndrew Gerrand2013-07-291-1/+1
| | | | | | | | Fixes #5881. R=golang-dev, r CC=golang-dev https://golang.org/cl/11892043
* doc: fix wiki content errorAndrew Gerrand2013-07-221-5/+4
| | | | | | | | Fixes #5898. R=golang-dev, r CC=golang-dev https://golang.org/cl/11556043
* doc/articles: use C90 standard functions in the cgo article.Shenghou Ma2013-06-041-6/+6
| | | | | | R=golang-dev, iant CC=golang-dev https://golang.org/cl/9953043
* all: fix typosShenghou Ma2013-04-241-2/+2
| | | | | | R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/8896045
* doc: fix typo in race_detector.htmlJeremy Jackins2013-04-231-1/+1
| | | | | | R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/8625044
* doc: fix another broken linkBrad Fitzpatrick2013-04-191-2/+5
| | | | | | | | Fixes #5316 R=golang-dev, r, minux.ma CC=golang-dev https://golang.org/cl/8871043
* doc: fix another broken linkBrad Fitzpatrick2013-04-181-1/+1
| | | | | | R=golang-dev, r CC=golang-dev https://golang.org/cl/8763045
* doc: link the race detector document into the release notesRob Pike2013-04-031-19/+33
| | | | | | | | | | | | Also: - put GORACE into the go env command - do minor housekeeping on the race detector article Fixes #4995. R=golang-dev, adg CC=golang-dev https://golang.org/cl/8319044
* doc/articles: update reference to obsolete "package documentation".David Symonds2013-03-261-4/+3
| | | | | | R=golang-dev, r CC=golang-dev https://golang.org/cl/7475048
* doc/articles/image_package.html: fix x/y mistakeRob Pike2013-02-281-1/+1
| | | | | | | | Fixes #4942. R=golang-dev, adg CC=golang-dev https://golang.org/cl/7444047
* doc: fix wiki codelab description of template parsingAndrew Gerrand2013-02-261-4/+5
| | | | | | R=golang-dev, r CC=golang-dev https://golang.org/cl/7372048