Skip to content

Commit

Permalink
cmd/cgo: applied alternative wording to cgo constraint
Browse files Browse the repository at this point in the history
A change suggested by @ianlancetaylor on gerrit, provides a more direct and clear message for the documentation.
  • Loading branch information
ikkerens authored Feb 23, 2018
1 parent 2a298db commit 0bf7571
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/cmd/cgo/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,11 @@ it is expected to work. It is disabled by default when
cross-compiling. You can control this by setting the CGO_ENABLED
environment variable when running the go tool: set it to 1 to enable
the use of cgo, and to 0 to disable it. The go tool will set the
build constraint "cgo" if cgo is enabled. When the Go tool sees the
special import "C", the "cgo" build constraint will be implied, causing
the tool to skip the file if CGO_ENABLED is set to 0.
build constraint "cgo" if cgo is enabled. The special import "C"
implies the "cgo" build constraint, as though the file also said
"// +build cgo". Therefore, if cgo is disabled, files that import
"C" will not be built by the go tool.
(For more about build constraints see https://golang.org/pkg/go/build/#hdr-Build_Constraints).
When cross-compiling, you must specify a C cross-compiler for cgo to
use. You can do this by setting the generic CC_FOR_TARGET or the
Expand Down

0 comments on commit 0bf7571

Please sign in to comment.