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

107 Commits

Author SHA1 Message Date
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
Matthew Dempsky
a6e4aa3ef2 doc: Mention godoc's handling of example functions.
Fixes #4625.

R=iant, adg
CC=golang-dev
https://golang.org/cl/7064052
2013-01-09 07:31:25 -08:00
Oling Cat
bc776f6c58 doc/articles/go_command: remove an extra word.
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/7061051
2013-01-08 09:49:38 -08:00
Dmitriy Vyukov
b2e9ca7f2e doc: add race detector manual
R=minux.ma, franciscossouza, rsc, adg, adg
CC=golang-dev
https://golang.org/cl/6948043
2013-01-02 16:38:47 +04:00
Péter Surányi
be7c0f31c7 doc: fix id attributes in links to godoc
CL6449105 changed godoc id attributes to ensure uniqueness.
This CL updates links to godoc pages in documents that used
the old id attributes.

R=golang-dev, dsymonds
CC=golang-dev, speter.go1
https://golang.org/cl/7015051
2012-12-29 10:41:39 +11:00
Shenghou Ma
fcc5cf639e doc/articles/wiki/test.bash: suppress unnecessary output
R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/7000045
2012-12-24 03:48:17 +08:00
Mikio Hara
23ca24018a doc: clear execute bit
R=golang-dev, dave
CC=golang-dev
https://golang.org/cl/6871057
2012-12-04 20:37:19 +09:00
Oling Cat
c2f9be10d4 doc/articles/godoc_documenting_go_code: fix some format issues.
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/6874056
2012-12-04 17:40:38 +11:00
Brad Fitzpatrick
09f3c2f10f doc/articles/wiki: fix racy test
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/6853069
2012-11-19 12:36:15 -08:00
Dan Callahan
15e50d7c7a encoding/json: clarify correct usage of struct tags in associated article.
Fixes #4297.

R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/6817045
2012-10-31 15:52:27 -07:00
Jimmy Zelinskie
dad1228cc3 doc/articles/wiki: numerous fixes
Fixes #3733
Fixes #2149
Updated Syntax
Added part3.go example program
Added part3-errorhandling.go example program
Improved wording in some places

R=golang-dev, adg, minux.ma
CC=golang-dev
https://golang.org/cl/6636048
2012-10-11 13:07:34 +11:00
Andrew Gerrand
d353d43d36 doc: fix typo in Concurrency Patterns article
Fixes #3178.

R=golang-dev, iant
CC=golang-dev
https://golang.org/cl/6506064
2012-09-04 15:28:09 +10: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
Matthew William Jibson
f83a47cbb9 doc: various "the the" and other typos
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/6355076
2012-07-08 11:57:04 +10:00
Shenghou Ma
5d2cfc2faa doc/articles/slices_usage_and_internals: fix typo
Fixes #3753.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/6304097
2012-06-20 01:22:03 +08:00
David Symonds
4d3db77c69 doc: update wiki article to use html/template properly.
Fixes #3569.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/6116055
2012-04-26 17:50:44 +10:00
Benny Siegert
e03dd509d4 doc/articles/image_draw.html: Change ColorImage to Uniform
Fixes #3474.

R=nigeltao
CC=golang-dev
https://golang.org/cl/6048050
2012-04-19 11:04:42 +10:00
Francisco Souza
18f1a71dc2 doc: added The Go image package article
Orignally published on The Go Programming Language, September 21, 2011.

http://blog.golang.org/2011/09/go-image-package.html

Update #2547

R=adg, nigeltao
CC=golang-dev
https://golang.org/cl/5933049
2012-03-28 14:20:51 +11:00
Andrew Gerrand
14da5298cd doc: use relative links in Laws of Reflection article
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5924050
2012-03-27 20:53:16 +11:00
Andrew Gerrand
cafc2b6a24 doc: use relative links in draw package article
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5924051
2012-03-27 20:52:48 +11:00
Andrew Gerrand
d98507f1c4 doc: update wiki tutorial templates, and template discussion
Fixes #3384.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5915044
2012-03-27 16:07:46 +11:00
Francisco Souza
a786fe8e13 doc: add JSON-RPC: a tale of interfaces article
Originally published on The Go Programming Language Blog, Abril 27, 2010.

http://blog.golang.org/2010/04/json-rpc-tale-of-interfaces.html

R=adg, r
CC=golang-dev
https://golang.org/cl/5920044
2012-03-27 13:35:40 +11:00
Andrew Gerrand
11441285db doc: add doc/articles/index.html
Fixes #3402.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5923043
2012-03-27 11:40:17 +11:00
Rob Pike
73b5eb38c1 docs/articles/wiki: minor fixes
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/5900046
2012-03-24 10:14:25 +11:00
Rob Pike
76cf6bac07 doc/articles/defer_panic_recover.html: minor tweaks
Delete () from function names and change the reference to some
functions to the correct term, methods.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/5874063
2012-03-23 17:40:27 +11:00
Rob Pike
fc9f65a6a0 doc/articles/image_draw.html: fix circle example
It was showing the same snippet twice instead of the type definition and snippet.

R=golang-dev, iant
CC=golang-dev
https://golang.org/cl/5875045
2012-03-23 17:02:21 +11:00
Ian Lance Taylor
5ac186975c doc/articles/c_go_cgo.html: correct "C" comment to mention #cgo
Also fix invalid apostrophe characters.

R=r, gri, adg
CC=golang-dev
https://golang.org/cl/5874058
2012-03-22 17:44:28 -07:00
Rob Pike
a99e9c5db5 doc/articles: rename concurrency patterns article
The old name, automatically generated, was ludicrously verbose.
Also clean up an example to use time.Second.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/5876051
2012-03-23 07:51:16 +11:00
Rob Pike
2795a15c0c doc/articles/gobs_of_data.html: delete extra word
Putt putt putt our way towards felicity.

R=golang-dev, bsiegert
CC=golang-dev
https://golang.org/cl/5874048
2012-03-22 19:20:03 +11:00
Francisco Souza
289a357104 doc: add JSON and Go article
Originally published on The Go Programming Language Blog, January 25, 2011.

http://blog.golang.org/2011/01/json-and-go.html

R=adg
CC=golang-dev
https://golang.org/cl/5846044
2012-03-22 18:25:40 +11:00
Rob Pike
cec67568e9 doc/articles/go_command.html: nits
Fix some English mistakes and minor inaccuracies.

R=golang-dev, jsing
CC=golang-dev
https://golang.org/cl/5885046
2012-03-22 17:59:06 +11:00
Francisco Souza
2b3d6cb5e6 doc: fix typo in The Laws of Reflection article
R=golang-dev, gri, r
CC=golang-dev
https://golang.org/cl/5876047
2012-03-21 16:42:04 -07:00
Shenghou Ma
d05b386928 doc: update format for "C? Go? Cgo!" article
R=adg
CC=golang-dev
https://golang.org/cl/5841050
2012-03-19 22:54:06 +08:00
Francisco Souza
9e03dcb3fa doc: add Gobs of data article
Originally published on The Go Programming Language Blog, March 24, 2011.

http://blog.golang.org/2011/03/gobs-of-data.html

R=adg
CC=golang-dev
https://golang.org/cl/5834043
2012-03-16 08:21:13 +11:00
Francisco Souza
235863cb12 doc: add "Godoc: documenting Go code" article
Originally published on The Go Programming Language Blog, March 31, 2011.

http://blog.golang.org/2011/03/godoc-documenting-go-code.html

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5830043
2012-03-15 14:51:44 +11:00
Stefan Nilsson
f00872527b doc: add reference to FAQ to explain warning about concrete type
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5820048
2012-03-15 09:15:16 +11:00
Francisco Souza
5659826e43 doc: add Go Concurrency Patterns: Timing out, moving on article
Originally published on The Go Programming Language Blog, September 23, 2010.

http://blog.golang.org/2010/09/go-concurrency-patterns-timing-out-and.html

Update #2547.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5815044
2012-03-14 13:03:11 +11:00
Johan Euphrosine
fef92cbbac doc: add Go image/draw package article and convert code snippets to Go1.
Originally published on The Go Programming Language Blog, September 29, 2011.

http://blog.golang.org/2011/09/go-imagedraw-package.html

Update #2547.

R=golang-dev, adg, rsc
CC=golang-dev
https://golang.org/cl/5755057
2012-03-14 11:27:41 +11:00
Francisco Souza
6033a48b77 doc: add Go's declaration syntax article
Originally published on The Go Programming Language Blog, July 7, 2010.

I did not put any go file in doc/progs. Shoul I include Go files
with those declarations?

http://blog.golang.org/2010/07/gos-declaration-syntax.html

Update #2547.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5795068
2012-03-13 14:46:08 +11:00
Francisco Souza
60b98d6208 doc: add C? Go? Cgo! article
Originally published on The Go Programming Language Blog, March 17, 2011.

http://blog.golang.org/2011/03/c-go-cgo.html

Update #2547.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5777054
2012-03-13 09:07:37 +11:00
Russ Cox
a40065ac68 cmd/godoc: add support for serving templates
doc: convert to use godoc built-in templates

tmpltohtml is gone, to avoid having a second copy of the code.
Instead, godoc -url /doc/go1.html will print the actual HTML
served for that URL.  "make" will generate files named go1.rawhtml
etc, which can be fed through tidy.

It can be hard to tell from the codereview diffs, but all the
tmpl files have been renamed to be html files and then
have "Template": true added.

R=golang-dev, adg, r, gri
CC=golang-dev
https://golang.org/cl/5782046
2012-03-08 08:39:20 -05:00
Shenghou Ma
d56e0e7e94 doc: fix freebsd build
Also rename it to test.bash, for naming consistency.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5784045
2012-03-08 12:04:49 +09:00
Johan Euphrosine
26dc17ce78 doc: fix typos in laws_of_reflection article, add copyright notice.
Update #2547.

R=golang-dev, minux.ma, r, r, adg
CC=golang-dev
https://golang.org/cl/5755051
2012-03-07 11:24:00 +11:00
Andrew Gerrand
73b8ccb0b0 doc: add "The go command" article based on Russ' mail
This is a philosophical document. We can soup it up at a later stage,
but for now it's nice to have a URL to point to that isn't a mailing
list post.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5676061
2012-03-07 07:40:21 +11:00
Andrew Gerrand
f78d50c6e5 doc: clean up docs page, refer to wiki, change install doc paths
R=golang-dev, minux.ma, r
CC=golang-dev
https://golang.org/cl/5728051
2012-03-05 14:31:27 +11:00
Francisco Souza
54875a7a7f doc: fix another typo in article on defer, panic and recover
Fixes #3177

R=adg
CC=golang-dev
https://golang.org/cl/5728057
2012-03-04 14:40:14 +11:00
Francisco Souza
b1b0b73738 doc: fixed minor typo in article on defer
Fixes #3176.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5737043
2012-03-04 11:34:21 +11:00
Johan Euphrosine
6652b0b866 doc: add The Laws of Reflection article
Originally published on The Go Programming Language Blog, September 6, 2011.

http://blog.golang.org/2011/09/laws-of-reflection.html

Update #2547

R=golang-dev, r, adg
CC=golang-dev
https://golang.org/cl/5689054
2012-03-01 10:05:51 +11:00
Andrew Gerrand
cd1a2f7e74 doc: move wiki tutorial into articles directory, rmdir doc/codelab
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/5701050
2012-02-27 11:25:43 +11:00
Russ Cox
ae7497bda6 doc: remove overuse of simply
Specifically, remove simply where it is claiming that the
code or the action to be carried out is simple, since the
reader might disagree.

R=golang-dev, bradfitz, gri
CC=golang-dev
https://golang.org/cl/5637048
2012-02-06 13:34:35 -05: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
468e692e38 doc: only trim newlines in tmpltohtml, gofmt progs
R=golang-dev, r, r
CC=golang-dev
https://golang.org/cl/5530048
2012-01-09 20:05:34 +11:00
Andrew Gerrand
9443949207 doc: add Slices: usage and internals article
Originally published on the Go blog on 5 Jan 2011:
http://blog.golang.org/2011/01/go-slices-usage-and-internals.html

R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/5516046
2012-01-06 09:21:43 +11:00
Andrew Gerrand
5353e1ef96 doc: trim spaces from code snippets
gofmt likes to put lines like
  // STOP OMIT
two blank lines from a closing brace, creating an ugly space inside
<pre> blocks in some of these files. This change resolves this issue.

R=golang-dev, iant
CC=golang-dev
https://golang.org/cl/5520044
2012-01-06 09:20:31 +11:00
Olivier Duperray
e4d624b04d doc/articles: add {{donotedit}} to templates
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5502088
2012-01-03 11:40:58 +11:00
Andrew Gerrand
c400a0b7db doc: add Error Handling article
Originally published on The Go Programming Language Blog, July 12, 2011.

http://blog.golang.org/2011/07/error-handling-and-go.html

Update #2547

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5475060
2011-12-13 09:44:06 +11:00
Andrew Gerrand
49d82b4ca1 doc: add Defer, Panic, and Recover article
Originally published on The Go Programming Language Blog, August 4 2010.

http://blog.golang.org/2010/08/defer-panic-and-recover.html

Update #2547

R=golang-dev, r, r
CC=golang-dev
https://golang.org/cl/5479053
2011-12-12 13:15:29 +11:00