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

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
This commit is contained in:
Kirill Che 2023-07-19 13:52:23 +04:00 committed by Kirill Che.
parent 2f0b28da19
commit 7613930a3d
No known key found for this signature in database
GPG Key ID: 91CCC23DB8680D12
2 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

15
src/cmd/go/internal/work/build.go
View File

@ -38,11 +38,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 a single main package, build writes
the resulting executable to an output file named after
the first source file ('go build ed.go rx.go' writes 'ed' or 'ed.exe')
or the source code directory ('go build unix/sam' writes 'sam' or 'sam.exe').
The '.exe' suffix is added when writing a Windows executable.
When compiling a single main package, build writes the resulting
executable to an output file named after the last non-major-version
component of the package import path. 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,
build compiles the packages but discards the resulting object,