diff options
Diffstat (limited to 'src/cmd/go/doc.go')
| -rw-r--r-- | src/cmd/go/doc.go | 66 |
1 files changed, 45 insertions, 21 deletions
diff --git a/src/cmd/go/doc.go b/src/cmd/go/doc.go index 0297b7602..df82ab45b 100644 --- a/src/cmd/go/doc.go +++ b/src/cmd/go/doc.go @@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// DO NOT EDIT THIS FILE. GENERATED BY mkdoc.sh. +// Edit the documentation in other files and rerun mkdoc.sh to generate this one. + /* Go is a tool for managing Go source code. @@ -56,9 +59,13 @@ build writes the resulting executable to output. Otherwise build compiles the packages but discards the results, serving only as a check that the packages can be built. -The -o flag specifies the output file name. If not specified, the -name is packagename.a (for a non-main package) or the base -name of the first source file (for a main package). +The -o flag specifies the output file name. If not specified, the +output file name depends on the arguments and derives from the name +of the package, such as p.a for package p, unless p is 'main'. If +the package is main and file names are provided, the file name +derives from the first file name mentioned, such as f1 for 'go build +f1.go f2.go'; with no files provided ('go build'), the output file +name is the base name of the containing directory. The build flags are shared by the build, install, run, and test commands: @@ -69,6 +76,9 @@ The build flags are shared by the build, install, run, and test commands: -p n the number of builds that can be run in parallel. The default is the number of CPUs available. + -race + enable data race detection. + Supported only on linux/amd64, darwin/amd64 and windows/amd64. -v print the names of packages as they are compiled. -work @@ -76,20 +86,22 @@ The build flags are shared by the build, install, run, and test commands: do not delete it when exiting. -x print the commands. - -race - enable data race detection. - Supported only on linux/amd64, darwin/amd64 and windows/amd64. -ccflags 'arg list' - arguments to pass on each 5c, 6c, or 8c compiler invocation + arguments to pass on each 5c, 6c, or 8c compiler invocation. -compiler name - name of compiler to use, as in runtime.Compiler (gccgo or gc) + name of compiler to use, as in runtime.Compiler (gccgo or gc). -gccgoflags 'arg list' - arguments to pass on each gccgo compiler/linker invocation + arguments to pass on each gccgo compiler/linker invocation. -gcflags 'arg list' - arguments to pass on each 5g, 6g, or 8g compiler invocation + arguments to pass on each 5g, 6g, or 8g compiler invocation. + -installsuffix suffix + a suffix to use in the name of the package installation directory, + in order to keep output separate from default builds. + If using the -race flag, the install suffix is automatically set to race + or, if set explicitly, has _race appended to it. -ldflags 'flag list' - arguments to pass on each 5l, 6l, or 8l linker invocation + arguments to pass on each 5l, 6l, or 8l linker invocation. -tags 'tag list' a list of build tags to consider satisfied during the build. See the documentation for the go/build package for @@ -358,6 +370,7 @@ Usage: go run [build flags] gofiles... [arguments...] Run compiles and runs the main package comprising the named Go source files. +If no files are named, it compiles and runs all non-test Go source files. For more about build flags, see 'go help build'. @@ -385,6 +398,9 @@ the file pattern "*_test.go". These additional files can contain test functions benchmark functions, and example functions. See 'go help testfunc' for more. Each listed package causes the execution of a separate test binary. +Test files that declare a package with the suffix "_test" will be compiled as a +separate package, and then linked and run with the main test binary. + By default, go test needs no arguments. It compiles and tests the package with source in the current directory, including tests, and runs the tests. @@ -394,6 +410,7 @@ non-test installation. In addition to the build flags, the flags handled by 'go test' itself are: -c Compile the test binary to pkg.test but do not run it. + (Where pkg is the last element of the package's import path.) -i Install packages that are dependencies of the test. @@ -569,7 +586,7 @@ a revision control system. A few common code hosting sites have special syntax: - BitBucket (Mercurial) + Bitbucket (Git, Mercurial) import "bitbucket.org/user/project" import "bitbucket.org/user/project/sub/directory" @@ -679,6 +696,11 @@ Description of testing flags The 'go test' command takes both flags that apply to 'go test' itself and flags that apply to the resulting test binary. +Several of the flags control profiling and write an execution profile +suitable for "go tool pprof"; run "go tool pprof help" for more +information. The --alloc_space, --alloc_objects, and --show_bytes +options of pprof control how the information is presented. + The following flags are recognized by the 'go test' command and control the execution of any test: @@ -691,17 +713,18 @@ control the execution of any test: Print memory allocation statistics for benchmarks. -benchtime t - Run enough iterations of each benchmark to take t, specified - as a time.Duration (for example, -benchtime 1h30s). - The default is 1 second (1s). + Run enough iterations of each benchmark to take t, specified + as a time.Duration (for example, -benchtime 1h30s). + The default is 1 second (1s). -blockprofile block.out Write a goroutine blocking profile to the specified file when all tests are complete. -blockprofilerate n - Control the detail provided in goroutine blocking profiles by setting - runtime.BlockProfileRate to n. See 'godoc runtime BlockProfileRate'. + Control the detail provided in goroutine blocking profiles by + calling runtime.SetBlockProfileRate with n. + See 'godoc runtime SetBlockProfileRate'. The profiler aims to sample, on average, one blocking event every n nanoseconds the program spends blocked. By default, if -test.blockprofile is set without this flag, all blocking events @@ -716,8 +739,8 @@ control the execution of any test: Write a CPU profile to the specified file before exiting. -memprofile mem.out - Write a memory profile to the specified file when all tests - are complete. + Write a memory profile to the specified file after all tests + have passed. -memprofilerate n Enable more precise (and expensive) memory profiles by setting @@ -743,10 +766,11 @@ control the execution of any test: exhaustive tests. -timeout t - If a test runs longer than t, panic. + If a test runs longer than t, panic. -v - Verbose output: log all tests as they are run. + Verbose output: log all tests as they are run. Also print all + text from Log and Logf calls even if the test succeeds. The test binary, called pkg.test where pkg is the name of the directory containing the package sources, can be invoked directly |