mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cmd/go: mention go tool compile etc. in the help text for build 

Not everyone is aware that go build is a wrapper for other
tools. Mention this in the text for go help build so people using
other build systems won't just wrap go build, which is usually a
mistake (it doesn't do incremental builds by default, for instance).

Update #11854.

Change-Id: I759f91f23ccd3671204c39feea12a3bfaf9f0114
Reviewed-on: https://go-review.googlesource.com/12625
Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
Rob Pike 2015-07-24 14:37:58 +10:00
parent 2b0ddb6c23
commit 3dcfb72fa3
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/cmd/go/alldocs.go
View File

@ -56,8 +56,8 @@ Usage:
Build compiles the packages named by the import paths, Build compiles the packages named by the import paths,
along with their dependencies, but it does not install the results. along with their dependencies, but it does not install the results.
If the arguments are a list of .go files, build treats them as a list If the arguments to build are a list of .go files, build treats
of source files specifying a single package. them as a list of source files specifying a single package.
When the command line specifies a single main package, When the command line specifies a single main package,
build writes the resulting executable to output. build writes the resulting executable to output.
@ -139,6 +139,13 @@ For more about where packages and binaries are installed,
run 'go help gopath'. run 'go help gopath'.
For more about calling between Go and C/C++, run 'go help c'. For more about calling between Go and C/C++, run 'go help c'.
Note: Build adheres to certain conventions such as those described
by 'go help gopath'. Not all projects can follow these conventions,
however. Installations that have their own conventions or that use
a separate software build system may choose to use lower-level
invocations such as 'go tool compile' and 'go tool link' to avoid
some of the overheads and design decisions of the build tool.
See also: go install, go get, go clean. See also: go install, go get, go clean.

11
src/cmd/go/build.go
View File

@ -35,8 +35,8 @@ var cmdBuild = &Command{
Build compiles the packages named by the import paths, Build compiles the packages named by the import paths,
along with their dependencies, but it does not install the results. along with their dependencies, but it does not install the results.
If the arguments are a list of .go files, build treats them as a list If the arguments to build are a list of .go files, build treats
of source files specifying a single package. them as a list of source files specifying a single package.
When the command line specifies a single main package, When the command line specifies a single main package,
build writes the resulting executable to output. build writes the resulting executable to output.
@ -118,6 +118,13 @@ For more about where packages and binaries are installed,
run 'go help gopath'. run 'go help gopath'.
For more about calling between Go and C/C++, run 'go help c'. For more about calling between Go and C/C++, run 'go help c'.
Note: Build adheres to certain conventions such as those described
by 'go help gopath'. Not all projects can follow these conventions,
however. Installations that have their own conventions or that use
a separate software build system may choose to use lower-level
invocations such as 'go tool compile' and 'go tool link' to avoid
some of the overheads and design decisions of the build tool.
See also: go install, go get, go clean. See also: go install, go get, go clean.
`, `,
} }