1
0
mirror of https://github.com/golang/go synced 2024-11-18 18:14:43 -07:00

cmd/go: improve go build documentation

The existing documentation for `go help build` does not match the current behavior of `go build`. This commit fixes inconsistency between documentation and behavior as suggested in #60836 ticket.

Fixes #60836

Change-Id: I22f24f84815f50fecfa8c51b7f1c24e8e0cd8bc8
GitHub-Last-Rev: 7613930a3d
GitHub-Pull-Request: golang/go#61438
Reviewed-on: https://go-review.googlesource.com/c/go/+/511015
Reviewed-by: qiulaidongfeng <2645477756@qq.com>
Auto-Submit: Bryan Mills <bcmills@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Bryan Mills <bcmills@google.com>
Reviewed-by: Matthew Dempsky <mdempsky@google.com>
This commit is contained in:
Kirill Che 2023-09-08 07:51:47 +00:00 committed by Gopher Robot
parent a72d1e5bf4
commit d5138e580c
2 changed files with 20 additions and 10 deletions

View File

@ -79,11 +79,16 @@
// //
// When compiling packages, build ignores files that end in '_test.go'. // When compiling packages, build ignores files that end in '_test.go'.
// //
// When compiling a single main package, build writes // When compiling a single main package, build writes the resulting
// the resulting executable to an output file named after // executable to an output file named after the last non-major-version
// the first source file ('go build ed.go rx.go' writes 'ed' or 'ed.exe') // component of the package import path. The '.exe' suffix is added
// or the source code directory ('go build unix/sam' writes 'sam' or 'sam.exe'). // when writing a Windows executable.
// The '.exe' suffix is added when writing a Windows executable. // So 'go build example/sam' writes 'sam' or 'sam.exe'.
// 'go build example.com/foo/v2' writes 'foo' or 'foo.exe', not 'v2.exe'.
//
// When compiling a package from a list of .go files, the executable
// is named after the first source file.
// 'go build ed.go rx.go' writes 'ed' or 'ed.exe'.
// //
// When compiling multiple packages or a single non-main package, // When compiling multiple packages or a single non-main package,
// build compiles the packages but discards the resulting object, // build compiles the packages but discards the resulting object,

View File

@ -37,11 +37,16 @@ build treats them as a list of source files specifying a single package.
When compiling packages, build ignores files that end in '_test.go'. When compiling packages, build ignores files that end in '_test.go'.
When compiling a single main package, build writes When compiling a single main package, build writes the resulting
the resulting executable to an output file named after executable to an output file named after the last non-major-version
the first source file ('go build ed.go rx.go' writes 'ed' or 'ed.exe') component of the package import path. The '.exe' suffix is added
or the source code directory ('go build unix/sam' writes 'sam' or 'sam.exe'). when writing a Windows executable.
The '.exe' suffix is added when writing a Windows executable. So 'go build example/sam' writes 'sam' or 'sam.exe'.
'go build example.com/foo/v2' writes 'foo' or 'foo.exe', not 'v2.exe'.
When compiling a package from a list of .go files, the executable
is named after the first source file.
'go build ed.go rx.go' writes 'ed' or 'ed.exe'.
When compiling multiple packages or a single non-main package, When compiling multiple packages or a single non-main package,
build compiles the packages but discards the resulting object, build compiles the packages but discards the resulting object,