Skip to content

Commit 0bf7571

Browse files
authored
cmd/cgo: applied alternative wording to cgo constraint
A change suggested by @ianlancetaylor on gerrit, provides a more direct and clear message for the documentation.
1 parent 2a298db commit 0bf7571

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/cmd/cgo/doc.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,11 @@ it is expected to work. It is disabled by default when
109109
cross-compiling. You can control this by setting the CGO_ENABLED
110110
environment variable when running the go tool: set it to 1 to enable
111111
the use of cgo, and to 0 to disable it. The go tool will set the
112-
build constraint "cgo" if cgo is enabled. When the Go tool sees the
113-
special import "C", the "cgo" build constraint will be implied, causing
114-
the tool to skip the file if CGO_ENABLED is set to 0.
112+
build constraint "cgo" if cgo is enabled. The special import "C"
113+
implies the "cgo" build constraint, as though the file also said
114+
"// +build cgo". Therefore, if cgo is disabled, files that import
115+
"C" will not be built by the go tool.
116+
(For more about build constraints see https://golang.org/pkg/go/build/#hdr-Build_Constraints).
115117
116118
When cross-compiling, you must specify a C cross-compiler for cgo to
117119
use. You can do this by setting the generic CC_FOR_TARGET or the

0 commit comments

Comments
 (0)