1
0
mirror of https://github.com/golang/go synced 2024-11-20 05:14:41 -07:00
Commit Graph

1044 Commits

Author SHA1 Message Date
Andrew Gerrand
af1ae438b9 go/doc, godoc, gotest: support for reading example documentation
This CL introduces the go.Example type and go.Examples functions that
are used to represent and extract code samples from Go source.

They should be of the form:

// Output of this function.
func ExampleFoo() {
        fmt.Println("Output of this function.")
}

It also modifies godoc to read example code from _test.go files,
and include them in the HTML output with JavaScript-driven toggles.

It also implements testing of example functions with gotest.
The stdout/stderr is compared against the output comment on the
function.

This CL includes examples for the sort.Ints function and the
sort.SortInts type. After patching this CL in and re-building go/doc
and godoc, try
        godoc -http=localhost:6060
and visit http://localhost:6060/pkg/sort/

R=gri, r, rsc
CC=golang-dev
https://golang.org/cl/5137041
2011-10-06 11:56:17 -07:00
Rob Pike
029c9bcb8b Effective Go: IntArray -> IntSlice
Fixes #2336.

R=golang-dev, dsymonds, rsc
CC=golang-dev
https://golang.org/cl/5222042
2011-10-06 10:46:18 -07:00
Andrew Gerrand
a0b2d154e6 doc: document r60.2
R=rsc, dsymonds
CC=golang-dev
https://golang.org/cl/5204041
2011-10-05 13:59:39 -07:00
Andrew Gerrand
5d51b0ae53 doc: link to Czech translation of The Laws of Reflection
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5190045
2011-10-05 12:45:56 -07:00
Andrew Gerrand
f03b37b8df doc: link to A Tour of Go
R=golang-dev, rsc, r
CC=golang-dev
https://golang.org/cl/5181045
2011-10-05 11:12:07 -07:00
Luuk van Dijk
3e26862c1a documentation: Debugging Go code with GDB tutorial.
R=adg, cw, lvd
CC=golang-dev
https://golang.org/cl/5168046
2011-10-05 10:49:23 -07:00
Rob Pike
934c768019 doc: update tutorial.
Fix for new regexp library ($ isn't end of line any more).
Don't assume . is in PATH.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/5175052
2011-10-03 16:18:47 -07:00
Nigel Tao
585294db73 doc: link to image/draw blog post.
R=adg
TBR=adg
CC=golang-dev
https://golang.org/cl/5154046
2011-09-30 13:11:20 +10:00
Ian Lance Taylor
807eb29f9f go spec: remove notes about gccgo limitations, now fixed
R=gri
CC=golang-dev
https://golang.org/cl/5164041
2011-09-29 14:50:55 -07:00
Russ Cox
44d13e3cfe doc: fix memory model read visibility bug
Fixes #2277.

R=dvyukov, r
CC=golang-dev
https://golang.org/cl/5083044
2011-09-26 12:54:30 -04:00
Andrew Gerrand
76d82dbc4c doc: link to image blog post
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5086048
2011-09-23 07:22:28 +10:00
Andrew Gerrand
e4ac43b7f0 weekly.2011-09-21
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/5075050
2011-09-22 15:06:10 +10:00
Ian Lance Taylor
5d1d040e3a doc: when configuring gold for gccgo, use --enable-gold=default
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/5030057
2011-09-19 11:54:07 -07:00
Andrew Gerrand
cecddc4dd3 doc: link to golang-france
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/5059046
2011-09-19 15:36:06 +10:00
Andrew Gerrand
a66ae1d39e doc: update release.r60.1 notes
R=dsymonds
CC=golang-dev
https://golang.org/cl/5045045
2011-09-19 12:16:08 +10:00
Andrew Gerrand
b0e3edab0e weekly.2011-09-16
R=golang-dev, dsymonds, r
CC=golang-dev
https://golang.org/cl/5040042
2011-09-16 17:18:36 +10:00
Andrew Gerrand
f41ab6c7c8 doc: release.r60.1
R=r
CC=golang-dev
https://golang.org/cl/5002041
2011-09-15 19:26:12 +10:00
Andrew Gerrand
3bc2d0f20b doc: link to notable blog posts
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4996041
2011-09-10 09:35:25 +10:00
Andrew Gerrand
2544d30973 doc: release.r60
R=dsymonds, r, rsc
CC=golang-dev
https://golang.org/cl/4981047
2011-09-08 12:08:07 +10:00
Andrew Gerrand
ede613ac22 doc: fix date in weekly snapshot history
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4978057
2011-09-08 10:03:27 +10:00
Andrew Gerrand
c5c656aee3 weekly.2011-09-07
R=dsymonds, rsc, r
CC=golang-dev
https://golang.org/cl/4968070
2011-09-08 09:43:35 +10:00
David Symonds
e85fb2137b weekly.html: remove note about exp/template -> template move.
It actually occurred with the previous weekly snapshot.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/4961066
2011-09-07 14:10:14 +10:00
Nigel Tao
ca64a37d9d weekly.2011-09-01
R=r, adg
CC=golang-dev
https://golang.org/cl/4975046
2011-09-01 17:08:53 +10:00
Robert Griesemer
ffe70eaa3c go spec: update section on Implementation Differences
R=rsc, r
CC=golang-dev
https://golang.org/cl/4977046
2011-08-31 15:16:51 -07:00
Jaroslavas Počepko
2afc46f2b2 doc/progs: fix windows/amd64
R=rsc
CC=alex.brainman, golang-dev, vcc.163
https://golang.org/cl/4965050
2011-08-29 15:38:12 -04:00
Russ Cox
0b12223fbe doc/codelab/wiki: fix Makefile
R=adg
CC=golang-dev
https://golang.org/cl/4971043
2011-08-29 09:24:24 -04:00
Russ Cox
dd0b8e7975 doc: emphasize that environment variables are optional
Also update $GOARM description.

R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/4972041
2011-08-25 16:53:54 -04:00
Rob Pike
6731d47f99 effective go: fix erroneous quoting of ampersands that cropped up
R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/4937047
2011-08-23 13:54:29 +10:00
Robert Griesemer
d883f29309 godoc: add dummy playground.js to silence godoc warning at start-up
Fixes #2173.

R=r, rsc
CC=golang-dev
https://golang.org/cl/4941044
2011-08-22 14:06:07 -07:00
Rob Pike
18b21c720e effective go: extract and test a couple more examples.
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/4937045
2011-08-22 22:46:59 +10:00
Rob Pike
ebf2b92e9a effective_go: fix brace quotes.
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4932044
2011-08-22 08:18:03 +10:00
Rob Pike
d1a3edaee7 effective_go: convert to use tmpltohtml.
Also update the big example to the new template system.
There are a number of other examples that should be
extracted; this CL serves as an introduction to the
approach.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/4923043
2011-08-21 09:46:19 +10:00
Rob Pike
1446ffc265 doc/tmpltohtml: update to new template package.
Trivial change: just fix the import.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/4937043
2011-08-21 09:04:21 +10:00
Andrew Gerrand
1491a20540 weekly.2011-08-17
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4914042
2011-08-18 14:27:08 +10:00
Andrew Gerrand
b67b72da43 doc/codelab: use new template package
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4897048
2011-08-18 10:38:08 +10:00
Andrew Gerrand
2a189845b6 doc/codewalk: new Markov chain codewalk
R=gri, r, rsc
CC=golang-dev
https://golang.org/cl/4891041
2011-08-17 15:53:17 +10:00
Rob Pike
73b7afbebd template: delete old template code.
It's already in old/template; make that build.
Update a couple of references to point to the old template.
They can be updated later.
Update goplay to use exp/template.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4902046
2011-08-17 14:34:48 +10:00
Rob Pike
ff0240da6d misc: fix a couple of template uses preparatory to the big switch.
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4876057
2011-08-17 13:57:06 +10:00
Nigel Tao
da7e1ba00b weekly.2011-08-10
R=r
CC=golang-dev
https://golang.org/cl/4830069
2011-08-10 16:00:22 +10:00
Rob Pike
7d87f3d233 FAQ: variant types, unions
Fixes #1935.

R=rsc, bradfitz
CC=golang-dev
https://golang.org/cl/4850044
2011-08-06 11:21:59 +10:00
Rob Pike
93c4a246a4 FAQ: lots of small tweaks plus a couple of new discussions.
Expand the conversations about pointers, memory, and
garbage collection.
Describe the lack of co/contravariant typing.

Fixes #1929.
Fixes #1930.

R=dsymonds, r, mirtchovski, edsrzf, hanwen, rsc
CC=golang-dev
https://golang.org/cl/4852041
2011-08-06 07:41:55 +10:00
Andrew Gerrand
4d2766e994 doc: document release.r59
R=golang-dev, dsymonds, r, r
CC=golang-dev
https://golang.org/cl/4835044
2011-07-31 15:29:10 -07:00
Andrew Gerrand
70f6133b84 doc: fix typo in Effective Go
Fixes #2120.

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/4810061
2011-07-31 15:25:26 -07:00
David Symonds
be96fa5a2e go_faq: drop a dramatic comma.
R=r
CC=golang-dev
https://golang.org/cl/4809064
2011-07-31 12:59:58 +10:00
Andrew Gerrand
b583108436 weekly.2011-07-29
R=rsc
CC=golang-dev
https://golang.org/cl/4801062
2011-07-29 15:11:48 -07:00
Andrew Gerrand
50ddb98b24 weekly.2011-07-19
R=golang-dev, nigeltao, dsymonds, r
CC=golang-dev
https://golang.org/cl/4801042
2011-07-20 15:45:55 +10:00
Andrew Gerrand
894222f9de doc/talks/io2010: handle the errors
R=golang-dev, dsymonds, dsymonds, r
CC=golang-dev
https://golang.org/cl/4771041
2011-07-19 14:10:12 +10:00
Andrew Gerrand
ab55133ca9 doc: fix padding on h1 tags
See /doc/codewalk/sharemem/ for an example of how it's broken.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4742044
2011-07-18 17:30:00 +10:00
Robert Griesemer
38a53c7ecb go spec: (up-)date
R=rsc, bradfitz, r
CC=golang-dev
https://golang.org/cl/4738042
2011-07-14 15:58:37 -07:00
Russ Cox
58e19aa4cb go: require { } around else block
R=gri, ken, r
CC=golang-dev
https://golang.org/cl/4721044
2011-07-14 17:15:52 -04:00
Rob Pike
c1c8d46d20 go_tutorial: change the way it's generated.
No longer do we generate HTML from it; instead the input
file is already in HTML but has template invocations to
extract programs from other files.
Delete htmlgen, which is no longer needed.
Add tmpltohtml, which runs the templating code.

R=golang-dev, dsymonds, adg
CC=golang-dev
https://golang.org/cl/4699041
2011-07-13 13:20:05 +10:00
Andrew Gerrand
ba91dac3a9 doc: gofix io2010 demo programs
R=golang-dev, gri, r, agl
CC=golang-dev
https://golang.org/cl/4696046
2011-07-13 09:40:49 +10:00
Rob Pike
4c63129545 effective go: tweak the words about semicolons, parens in control structures,
and make and new.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/4699043
2011-07-12 23:45:10 +10:00
Russ Cox
1002e82fff doc: document r58.1
R=adg, dsymonds
CC=golang-dev
https://golang.org/cl/4700041
2011-07-12 01:39:09 -04:00
Yasuhiro Matsumoto
34bac8bcd4 doc: don't specify make target for working on windwos.
makehtml does not work on windows.

R=golang-dev, adg, rsc
CC=golang-dev
https://golang.org/cl/4675041
2011-07-11 20:02:32 -04:00
Rob Pike
c17347eea9 tutorial: remove all line numbers and references to them.
R=golang-dev, mikioh.mikioh, dsymonds
CC=golang-dev
https://golang.org/cl/4675070
2011-07-09 23:17:38 +10:00
Mikio Hara
ab3365d34e doc/progs: gofmt -w
R=r, gri, r
CC=golang-dev
https://golang.org/cl/4662085
2011-07-09 20:16:45 +10:00
Andrew Gerrand
4f03ef7993 weekly.2011-07-07
R=golang-dev, dsymonds, r
CC=golang-dev
https://golang.org/cl/4668061
2011-07-08 13:13:38 +10:00
Brad Fitzpatrick
141f676bab doc: remove ed from apt-get package list
R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/4672052
2011-07-07 13:45:13 -07:00
Rob Pike
9cf37c3723 docs: fold the prog.sh scripting from makehtml into htmlgen itself.
This allows us to drop some crufty scripting and provides a firmer
footing for building better tools for preparing documents with source
code inside.

Also eliminate line numbers from the examples and text.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/4650069
2011-07-04 16:15:14 +10:00
Wei Guangjing
63b8b948d9 windows: define and use syscall.Handle
Fixes #1487.

R=rsc, alex.brainman, go.peter.90, mikioh.mikioh, mattn.jp
CC=golang-dev
https://golang.org/cl/4600042
2011-07-01 10:18:07 -04:00
Andrew Gerrand
f81d81ca3f document release.r58
R=rsc, r, bsiegert
CC=golang-dev
https://golang.org/cl/4643058
2011-06-30 09:45:10 +10:00
Russ Cox
9dd354c63f 5l, 6l, 8l: drop use of ed during build
build runs with chmod 0 /bin/ed now

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/4635071
2011-06-27 12:03:19 -04:00
Andrew Gerrand
30d08b404c weekly.2011-06-23
R=golang-dev, robert.hencke, r
CC=golang-dev
https://golang.org/cl/4625062
2011-06-24 16:04:17 +10:00
Ben Lynn
6be0bdf7bc Effective Go: supplied missing type in variadic function example.
R=golang-dev, nigeltao
CC=golang-dev
https://golang.org/cl/4595055
2011-06-21 10:55:07 +10:00
Rob Pike
5e77b9d334 doc/GoCourseDay1: shrink the PDF by rewriting it using ps2pdf.
No difference in content or appearance.
Forgot to do this when I updated this file a few days ago.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4626056
2011-06-20 12:36:14 +10:00
Andrew Gerrand
df02e65d54 doc/faq: remove misleading FAQ entry
R=golang-dev, dsymonds, r
CC=golang-dev
https://golang.org/cl/4638046
2011-06-19 13:53:07 +10:00
Andrew Gerrand
17805ddb6f doc/faq: add question about converting from []T to []interface{}
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4639046
2011-06-18 20:31:38 +10:00
Russ Cox
f4c7db0ed9 spec: disallow goto into blocks
R=gri, r, r
CC=golang-dev
https://golang.org/cl/4631045
2011-06-17 12:49:04 -04:00
Andrew Gerrand
d6b9dd8b81 weekly.2011-06-16
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4643044
2011-06-17 11:31:40 +10:00
Nigel Tao
ca91ce2d85 doc/effective_go: add a note about prefixing error strings with their
package name.

R=r, rsc
CC=golang-dev
https://golang.org/cl/4630042
2011-06-17 10:51:10 +10:00
Rob Pike
8db6802cec docs/GoCourseDay1.pdf: fix error in operator table.
Communications op was listed as a binary; it isn't any more.

R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/4637041
2011-06-16 16:03:24 +10:00
Russ Cox
aaae15ef0f doc: document r57.2
R=adg, r
CC=golang-dev
https://golang.org/cl/4627042
2011-06-16 01:46:14 -04:00
Rob Pike
e3d2a29e99 doc/effective_go.html: replace tab with spaces.
R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/4609042
2011-06-16 00:13:18 +10:00
Rob Pike
c6c8dbd646 doc/gopher: add a small gif to use as an app engine logo on GAE pages.
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4591078
2011-06-14 17:25:57 +10:00
Rob Pike
6d42af7197 doc/gopher: add jpgs of the goggled gopher logo for App Engine.
R=golang-dev, r, adg
CC=golang-dev
https://golang.org/cl/4591077
2011-06-14 16:42:52 +10:00
Robert Griesemer
2769356dda go spec: specify constant conversions
This is not a language change.

Added paragraphs specifying which conversions
yield results that are constants.

R=r, rsc, iant, ken
CC=golang-dev
https://golang.org/cl/4515176
2011-06-13 16:47:33 -07:00
Robert Griesemer
eee70b07c1 go spec: unsafe.Alignof/Offsetof/Sizeof return uintptr
This is (indirectly) a language change. Per e-mail discussion
on golang-dev.

Fixes #1943.

R=rsc, iant, r, ken
CC=golang-dev
https://golang.org/cl/4581058
2011-06-13 16:46:42 -07:00
Robert Griesemer
95b8137a16 go spec: clarify rules for append, scope rules for :=
Fixes #1936.
Fixes #1940.

R=rsc, r, iant, ken, iant
CC=golang-dev
https://golang.org/cl/4585049
2011-06-12 12:09:50 -07:00
Rob Pike
4b1170d2b1 sort: change IntArray etc. to IntSlice for better name hygiene.
R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/4602054
2011-06-11 09:25:18 +10:00
Robert Griesemer
18333f2de5 Go memory model: minor clarification
Fixes #1941.

R=rsc
CC=golang-dev
https://golang.org/cl/4576053
2011-06-10 12:31:10 -07:00
Rob Pike
9b409ac7ee docs: Update notes for 3-day Go course.
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/4605041
2011-06-10 15:05:51 +10:00
Andrew Gerrand
11b04261c7 weekly.2011-06-09
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4601052
2011-06-10 14:26:09 +10:00
Robert Griesemer
636c5fac2d go spec: handle a corner case of a special case for shifts...
- Added some additional examples.
- 6g appears to implement this semantics already.

Fixes #658.

R=rsc, r, iant, ken
CC=golang-dev
https://golang.org/cl/4538119
2011-06-08 09:11:18 -07:00
Andrew Gerrand
79eded509c doc: don't insert paragraphs inside pre blocks
doc: update go_tutorial

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4568056
2011-06-06 13:33:05 +10:00
Andrew Gerrand
897ad0c05e weekly.2011-06-02
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4548091
2011-06-03 11:18:34 +10:00
Andrew Gerrand
6c2b434820 doc: add Belarusian FAQ translation
R=golang-dev, dchest
CC=golang-dev
https://golang.org/cl/4564057
2011-06-03 09:48:42 +10:00
Andrew Gerrand
119a341c38 doc: add link to App Engine docs to front page
R=golang-dev, gri
CC=golang-dev
https://golang.org/cl/4539100
2011-06-02 11:00:24 +10:00
Andrew Gerrand
2386808ee9 doc: put Release History link on 'Documentation' page
Also put Weekly Snapshot History link on 'Contributing' page

Fixes #1885.

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/4559049
2011-05-27 16:07:30 +10:00
Andrew Gerrand
feb9a146f9 doc: mention go/printer instead of container/vector in effective go
Fixes #1876.

R=golang-dev, bradfitz, gri, r
CC=golang-dev
https://golang.org/cl/4538093
2011-05-25 11:39:40 +10:00
Rob Pike
2f655c4bb7 spec: delete spurious tag.
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/4536082
2011-05-25 10:58:58 +10:00
Robert Griesemer
3c7271f057 go spec: be precise with the use of the informal ellipsis … and the Go token ...
Fixes #1867.

R=r
CC=golang-dev
https://golang.org/cl/4538092
2011-05-24 14:18:44 -07:00
Rob Pike
46f482a2fc docs: remove some prose-unworthy empty parentheses.
In our evolving style, prose should name a function "f" not "f()".

R=gri, rsc
CC=golang-dev
https://golang.org/cl/4550075
2011-05-25 06:44:09 +10:00
Rob Pike
bdbe0decc6 spec: add missing comma.
A real humdinger.

R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/4538089
2011-05-25 06:00:07 +10:00
Robert Griesemer
32d127823f go spec: clarify rules for shifts
Note: This is not a spec change.

The spec was not clear on the result type of
constant shift expressions. Made it more
explicit and added additional examples.

Also: Remove paragraph on send expressions (they
are statements, now).

Fixes #1708.

R=rsc, r, iant, r
CC=golang-dev
https://golang.org/cl/4517074
2011-05-23 14:12:42 -07:00
Andrew Gerrand
f6742e7482 weekly.2011-05-22
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4523090
2011-05-23 16:30:06 +10:00
Evan Shaw
64d85769da doc: close paragraph tags in FAQ
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4532076
2011-05-22 14:56:12 +10:00
Andrew Gerrand
b9f9087605 godoc: don't display navigation list with only 1 element
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/4547056
2011-05-20 14:26:00 +10:00
Andrew Gerrand
b96fc594ba doc: add Korean Go site
R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/4515092
2011-05-17 14:24:32 +10:00
Andrew Gerrand
4fb5857596 doc: add I/O 2011 talks to talks/, docs.html, and front page.
R=rsc
CC=golang-dev
https://golang.org/cl/4516057
2011-05-17 13:46:54 +10:00