diff options
author | Shenghou Ma <minux.ma@gmail.com> | 2014-05-31 00:51:46 -0700 |
---|---|---|
committer | Shenghou Ma <minux.ma@gmail.com> | 2014-05-31 00:51:46 -0700 |
commit | 3f66c0c07b271af796765ce5e9e9c21a86ddb0d7 (patch) | |
tree | 88ecb16f41a937c012967e3cc520d52f791a1ffc | |
parent | 1afbceb5999f9c9743630ff8ea002d3ec58a08af (diff) | |
download | go-3f66c0c07b271af796765ce5e9e9c21a86ddb0d7.tar.gz go-3f66c0c07b271af796765ce5e9e9c21a86ddb0d7.zip |
cmd/cgo: document the cgo types also follow Go name space rules.
Fixes #7958.
LGTM=rsc
R=golang-codereviews, rsc, r, gobot
CC=golang-codereviews
https://golang.org/cl/91520043
-rw-r--r-- | src/cmd/cgo/doc.go | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/cmd/cgo/doc.go b/src/cmd/cgo/doc.go index 97e4b6af06..69c7ce893c 100644 --- a/src/cmd/cgo/doc.go +++ b/src/cmd/cgo/doc.go @@ -107,6 +107,11 @@ C's union types are represented as a Go byte array with the same length. Go structs cannot embed fields with C types. +Cgo translates C types into equivalent unexported Go types. +Because the translations are unexported, a Go package should not +expose C types in its exported API: a C type used in one Go package +is different from the same C type used in another. + Any C function (even void functions) may be called in a multiple assignment context to retrieve both the return value (if any) and the C errno variable as an error (use _ to skip the result value if the |