From 3bc2d0f20bd6ae91dd1f724a9ac10baddd7abad4 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Sat, 10 Sep 2011 09:35:25 +1000 Subject: [PATCH] doc: link to notable blog posts R=golang-dev, r CC=golang-dev https://golang.org/cl/4996041 --- doc/docs.html | 45 ++++++++++++++++++++++++++++++++++++++--- src/cmd/cgo/doc.go | 3 +++ src/cmd/godoc/doc.go | 3 +++ src/pkg/gob/doc.go | 3 +++ src/pkg/json/encode.go | 3 +++ src/pkg/reflect/type.go | 3 +++ 6 files changed, 57 insertions(+), 3 deletions(-) diff --git a/doc/docs.html b/doc/docs.html index 9fd3dcebedb..ce833fdd1a0 100644 --- a/doc/docs.html +++ b/doc/docs.html @@ -29,9 +29,9 @@ Slides from a 3-day course about the Go programming language. A more thorough introduction than the tutorial.

Effective Go

@@ -62,12 +62,51 @@ and closures.

Guided tours of Go programs.

+

Go for C++ Programmers

An introduction to Go for C++ programmers.

+

Go Articles

+ +

+Notable articles from the Go Blog. +

+ +

Language

+ + + +

Packages

+ + + +

Tools

+ + +

Non-English Documentation

Belarusian — Беларуская

diff --git a/src/cmd/cgo/doc.go b/src/cmd/cgo/doc.go index 7faece81c80..dc9edd6fd31 100644 --- a/src/cmd/cgo/doc.go +++ b/src/cmd/cgo/doc.go @@ -95,5 +95,8 @@ process of using cgo. See $GOROOT/misc/cgo/stdio and $GOROOT/misc/cgo/gmp for examples. Cgo does not yet work with gccgo. + +See "C? Go? Cgo!" for an introduction to using cgo: +http://blog.golang.org/2011/03/c-go-cgo.html */ package documentation diff --git a/src/cmd/godoc/doc.go b/src/cmd/godoc/doc.go index 813527d280e..3f0b8e45899 100644 --- a/src/cmd/godoc/doc.go +++ b/src/cmd/godoc/doc.go @@ -137,5 +137,8 @@ one may run godoc as follows: godoc -http=:6060 -zip=go.zip -goroot=$HOME/go + +See "Godoc: documenting Go code" for how to write good comments for godoc: +http://blog.golang.org/2011/03/godoc-documenting-go-code.html */ package documentation diff --git a/src/pkg/gob/doc.go b/src/pkg/gob/doc.go index 35d882afb7a..a9284ced7f9 100644 --- a/src/pkg/gob/doc.go +++ b/src/pkg/gob/doc.go @@ -221,6 +221,9 @@ In summary, a gob stream looks like where * signifies zero or more repetitions and the type id of a value must be predefined or be defined before the value in the stream. + +See "Gobs of data" for a design discussion of the gob wire format: +http://blog.golang.org/2011/03/gobs-of-data.html */ package gob diff --git a/src/pkg/json/encode.go b/src/pkg/json/encode.go index 5b4e616f712..16be5e2af16 100644 --- a/src/pkg/json/encode.go +++ b/src/pkg/json/encode.go @@ -4,6 +4,9 @@ // Package json implements encoding and decoding of JSON objects as defined in // RFC 4627. +// +// See "JSON and Go" for an introduction to this package: +// http://blog.golang.org/2011/01/json-and-go.html package json import ( diff --git a/src/pkg/reflect/type.go b/src/pkg/reflect/type.go index c9a9edc73de..74163292515 100644 --- a/src/pkg/reflect/type.go +++ b/src/pkg/reflect/type.go @@ -10,6 +10,9 @@ // A call to ValueOf returns a Value representing the run-time data. // Zero takes a Type and returns a Value representing a zero value // for that type. +// +// See "The Laws of Reflection" for an introduction to reflection in Go: +// http://blog.golang.org/2011/09/laws-of-reflection.html package reflect import (