1 // Copyright 2011 The Go Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style 3 // license that can be found in the LICENSE file. 4 5 // Code generated by 'go test cmd/go -v -run=^TestDocsUpToDate$ -fixdocs'; DO NOT EDIT. 6 // Edit the documentation in other files and then execute 'go generate cmd/go' to generate this one. 7 8 // Go is a tool for managing Go source code. 9 // 10 // Usage: 11 // 12 // go <command> [arguments] 13 // 14 // The commands are: 15 // 16 // bug start a bug report 17 // build compile packages and dependencies 18 // clean remove object files and cached files 19 // doc show documentation for package or symbol 20 // env print Go environment information 21 // fix update packages to use new APIs 22 // fmt gofmt (reformat) package sources 23 // generate generate Go files by processing source 24 // get add dependencies to current module and install them 25 // install compile and install packages and dependencies 26 // list list packages or modules 27 // mod module maintenance 28 // work workspace maintenance 29 // run compile and run Go program 30 // telemetry manage telemetry data and settings 31 // test test packages 32 // tool run specified go tool 33 // version print Go version 34 // vet report likely mistakes in packages 35 // 36 // Use "go help <command>" for more information about a command. 37 // 38 // Additional help topics: 39 // 40 // buildconstraint build constraints 41 // buildmode build modes 42 // c calling between Go and C 43 // cache build and test caching 44 // environment environment variables 45 // filetype file types 46 // go.mod the go.mod file 47 // gopath GOPATH environment variable 48 // goproxy module proxy protocol 49 // importpath import path syntax 50 // modules modules, module versions, and more 51 // module-auth module authentication using go.sum 52 // packages package lists and patterns 53 // private configuration for downloading non-public code 54 // testflag testing flags 55 // testfunc testing functions 56 // vcs controlling version control with GOVCS 57 // 58 // Use "go help <topic>" for more information about that topic. 59 // 60 // # Start a bug report 61 // 62 // Usage: 63 // 64 // go bug 65 // 66 // Bug opens the default browser and starts a new bug report. 67 // The report includes useful system information. 68 // 69 // # Compile packages and dependencies 70 // 71 // Usage: 72 // 73 // go build [-o output] [build flags] [packages] 74 // 75 // Build compiles the packages named by the import paths, 76 // along with their dependencies, but it does not install the results. 77 // 78 // If the arguments to build are a list of .go files from a single directory, 79 // build treats them as a list of source files specifying a single package. 80 // 81 // When compiling packages, build ignores files that end in '_test.go'. 82 // 83 // When compiling a single main package, build writes the resulting 84 // executable to an output file named after the last non-major-version 85 // component of the package import path. The '.exe' suffix is added 86 // when writing a Windows executable. 87 // So 'go build example/sam' writes 'sam' or 'sam.exe'. 88 // 'go build example.com/foo/v2' writes 'foo' or 'foo.exe', not 'v2.exe'. 89 // 90 // When compiling a package from a list of .go files, the executable 91 // is named after the first source file. 92 // 'go build ed.go rx.go' writes 'ed' or 'ed.exe'. 93 // 94 // When compiling multiple packages or a single non-main package, 95 // build compiles the packages but discards the resulting object, 96 // serving only as a check that the packages can be built. 97 // 98 // The -o flag forces build to write the resulting executable or object 99 // to the named output file or directory, instead of the default behavior described 100 // in the last two paragraphs. If the named output is an existing directory or 101 // ends with a slash or backslash, then any resulting executables 102 // will be written to that directory. 103 // 104 // The build flags are shared by the build, clean, get, install, list, run, 105 // and test commands: 106 // 107 // -C dir 108 // Change to dir before running the command. 109 // Any files named on the command line are interpreted after 110 // changing directories. 111 // If used, this flag must be the first one in the command line. 112 // -a 113 // force rebuilding of packages that are already up-to-date. 114 // -n 115 // print the commands but do not run them. 116 // -p n 117 // the number of programs, such as build commands or 118 // test binaries, that can be run in parallel. 119 // The default is GOMAXPROCS, normally the number of CPUs available. 120 // -race 121 // enable data race detection. 122 // Supported only on linux/amd64, freebsd/amd64, darwin/amd64, darwin/arm64, windows/amd64, 123 // linux/ppc64le and linux/arm64 (only for 48-bit VMA). 124 // -msan 125 // enable interoperation with memory sanitizer. 126 // Supported only on linux/amd64, linux/arm64, linux/loong64, freebsd/amd64 127 // and only with Clang/LLVM as the host C compiler. 128 // PIE build mode will be used on all platforms except linux/amd64. 129 // -asan 130 // enable interoperation with address sanitizer. 131 // Supported only on linux/arm64, linux/amd64, linux/loong64. 132 // Supported on linux/amd64 or linux/arm64 and only with GCC 7 and higher 133 // or Clang/LLVM 9 and higher. 134 // And supported on linux/loong64 only with Clang/LLVM 16 and higher. 135 // -cover 136 // enable code coverage instrumentation. 137 // -covermode set,count,atomic 138 // set the mode for coverage analysis. 139 // The default is "set" unless -race is enabled, 140 // in which case it is "atomic". 141 // The values: 142 // set: bool: does this statement run? 143 // count: int: how many times does this statement run? 144 // atomic: int: count, but correct in multithreaded tests; 145 // significantly more expensive. 146 // Sets -cover. 147 // -coverpkg pattern1,pattern2,pattern3 148 // For a build that targets package 'main' (e.g. building a Go 149 // executable), apply coverage analysis to each package matching 150 // the patterns. The default is to apply coverage analysis to 151 // packages in the main Go module. See 'go help packages' for a 152 // description of package patterns. Sets -cover. 153 // -v 154 // print the names of packages as they are compiled. 155 // -work 156 // print the name of the temporary work directory and 157 // do not delete it when exiting. 158 // -x 159 // print the commands. 160 // -asmflags '[pattern=]arg list' 161 // arguments to pass on each go tool asm invocation. 162 // -buildmode mode 163 // build mode to use. See 'go help buildmode' for more. 164 // -buildvcs 165 // Whether to stamp binaries with version control information 166 // ("true", "false", or "auto"). By default ("auto"), version control 167 // information is stamped into a binary if the main package, the main module 168 // containing it, and the current directory are all in the same repository. 169 // Use -buildvcs=false to always omit version control information, or 170 // -buildvcs=true to error out if version control information is available but 171 // cannot be included due to a missing tool or ambiguous directory structure. 172 // -compiler name 173 // name of compiler to use, as in runtime.Compiler (gccgo or gc). 174 // -gccgoflags '[pattern=]arg list' 175 // arguments to pass on each gccgo compiler/linker invocation. 176 // -gcflags '[pattern=]arg list' 177 // arguments to pass on each go tool compile invocation. 178 // -installsuffix suffix 179 // a suffix to use in the name of the package installation directory, 180 // in order to keep output separate from default builds. 181 // If using the -race flag, the install suffix is automatically set to race 182 // or, if set explicitly, has _race appended to it. Likewise for the -msan 183 // and -asan flags. Using a -buildmode option that requires non-default compile 184 // flags has a similar effect. 185 // -ldflags '[pattern=]arg list' 186 // arguments to pass on each go tool link invocation. 187 // -linkshared 188 // build code that will be linked against shared libraries previously 189 // created with -buildmode=shared. 190 // -mod mode 191 // module download mode to use: readonly, vendor, or mod. 192 // By default, if a vendor directory is present and the go version in go.mod 193 // is 1.14 or higher, the go command acts as if -mod=vendor were set. 194 // Otherwise, the go command acts as if -mod=readonly were set. 195 // See https://golang.org/ref/mod#build-commands for details. 196 // -modcacherw 197 // leave newly-created directories in the module cache read-write 198 // instead of making them read-only. 199 // -modfile file 200 // in module aware mode, read (and possibly write) an alternate go.mod 201 // file instead of the one in the module root directory. A file named 202 // "go.mod" must still be present in order to determine the module root 203 // directory, but it is not accessed. When -modfile is specified, an 204 // alternate go.sum file is also used: its path is derived from the 205 // -modfile flag by trimming the ".mod" extension and appending ".sum". 206 // -overlay file 207 // read a JSON config file that provides an overlay for build operations. 208 // The file is a JSON struct with a single field, named 'Replace', that 209 // maps each disk file path (a string) to its backing file path, so that 210 // a build will run as if the disk file path exists with the contents 211 // given by the backing file paths, or as if the disk file path does not 212 // exist if its backing file path is empty. Support for the -overlay flag 213 // has some limitations: importantly, cgo files included from outside the 214 // include path must be in the same directory as the Go package they are 215 // included from, and overlays will not appear when binaries and tests are 216 // run through go run and go test respectively. 217 // -pgo file 218 // specify the file path of a profile for profile-guided optimization (PGO). 219 // When the special name "auto" is specified, for each main package in the 220 // build, the go command selects a file named "default.pgo" in the package's 221 // directory if that file exists, and applies it to the (transitive) 222 // dependencies of the main package (other packages are not affected). 223 // Special name "off" turns off PGO. The default is "auto". 224 // -pkgdir dir 225 // install and load all packages from dir instead of the usual locations. 226 // For example, when building with a non-standard configuration, 227 // use -pkgdir to keep generated packages in a separate location. 228 // -tags tag,list 229 // a comma-separated list of additional build tags to consider satisfied 230 // during the build. For more information about build tags, see 231 // 'go help buildconstraint'. (Earlier versions of Go used a 232 // space-separated list, and that form is deprecated but still recognized.) 233 // -trimpath 234 // remove all file system paths from the resulting executable. 235 // Instead of absolute file system paths, the recorded file names 236 // will begin either a module path@version (when using modules), 237 // or a plain import path (when using the standard library, or GOPATH). 238 // -toolexec 'cmd args' 239 // a program to use to invoke toolchain programs like vet and asm. 240 // For example, instead of running asm, the go command will run 241 // 'cmd args /path/to/asm <arguments for asm>'. 242 // The TOOLEXEC_IMPORTPATH environment variable will be set, 243 // matching 'go list -f {{.ImportPath}}' for the package being built. 244 // 245 // The -asmflags, -gccgoflags, -gcflags, and -ldflags flags accept a 246 // space-separated list of arguments to pass to an underlying tool 247 // during the build. To embed spaces in an element in the list, surround 248 // it with either single or double quotes. The argument list may be 249 // preceded by a package pattern and an equal sign, which restricts 250 // the use of that argument list to the building of packages matching 251 // that pattern (see 'go help packages' for a description of package 252 // patterns). Without a pattern, the argument list applies only to the 253 // packages named on the command line. The flags may be repeated 254 // with different patterns in order to specify different arguments for 255 // different sets of packages. If a package matches patterns given in 256 // multiple flags, the latest match on the command line wins. 257 // For example, 'go build -gcflags=-S fmt' prints the disassembly 258 // only for package fmt, while 'go build -gcflags=all=-S fmt' 259 // prints the disassembly for fmt and all its dependencies. 260 // 261 // For more about specifying packages, see 'go help packages'. 262 // For more about where packages and binaries are installed, 263 // run 'go help gopath'. 264 // For more about calling between Go and C/C++, run 'go help c'. 265 // 266 // Note: Build adheres to certain conventions such as those described 267 // by 'go help gopath'. Not all projects can follow these conventions, 268 // however. Installations that have their own conventions or that use 269 // a separate software build system may choose to use lower-level 270 // invocations such as 'go tool compile' and 'go tool link' to avoid 271 // some of the overheads and design decisions of the build tool. 272 // 273 // See also: go install, go get, go clean. 274 // 275 // # Remove object files and cached files 276 // 277 // Usage: 278 // 279 // go clean [-i] [-r] [-cache] [-testcache] [-modcache] [-fuzzcache] [build flags] [packages] 280 // 281 // Clean removes object files from package source directories. 282 // The go command builds most objects in a temporary directory, 283 // so go clean is mainly concerned with object files left by other 284 // tools or by manual invocations of go build. 285 // 286 // If a package argument is given or the -i or -r flag is set, 287 // clean removes the following files from each of the 288 // source directories corresponding to the import paths: 289 // 290 // _obj/ old object directory, left from Makefiles 291 // _test/ old test directory, left from Makefiles 292 // _testmain.go old gotest file, left from Makefiles 293 // test.out old test log, left from Makefiles 294 // build.out old test log, left from Makefiles 295 // *.[568ao] object files, left from Makefiles 296 // 297 // DIR(.exe) from go build 298 // DIR.test(.exe) from go test -c 299 // MAINFILE(.exe) from go build MAINFILE.go 300 // *.so from SWIG 301 // 302 // In the list, DIR represents the final path element of the 303 // directory, and MAINFILE is the base name of any Go source 304 // file in the directory that is not included when building 305 // the package. 306 // 307 // The -i flag causes clean to remove the corresponding installed 308 // archive or binary (what 'go install' would create). 309 // 310 // The -n flag causes clean to print the remove commands it would execute, 311 // but not run them. 312 // 313 // The -r flag causes clean to be applied recursively to all the 314 // dependencies of the packages named by the import paths. 315 // 316 // The -x flag causes clean to print remove commands as it executes them. 317 // 318 // The -cache flag causes clean to remove the entire go build cache. 319 // 320 // The -testcache flag causes clean to expire all test results in the 321 // go build cache. 322 // 323 // The -modcache flag causes clean to remove the entire module 324 // download cache, including unpacked source code of versioned 325 // dependencies. 326 // 327 // The -fuzzcache flag causes clean to remove files stored in the Go build 328 // cache for fuzz testing. The fuzzing engine caches files that expand 329 // code coverage, so removing them may make fuzzing less effective until 330 // new inputs are found that provide the same coverage. These files are 331 // distinct from those stored in testdata directory; clean does not remove 332 // those files. 333 // 334 // For more about build flags, see 'go help build'. 335 // 336 // For more about specifying packages, see 'go help packages'. 337 // 338 // # Show documentation for package or symbol 339 // 340 // Usage: 341 // 342 // go doc [doc flags] [package|[package.]symbol[.methodOrField]] 343 // 344 // Doc prints the documentation comments associated with the item identified by its 345 // arguments (a package, const, func, type, var, method, or struct field) 346 // followed by a one-line summary of each of the first-level items "under" 347 // that item (package-level declarations for a package, methods for a type, 348 // etc.). 349 // 350 // Doc accepts zero, one, or two arguments. 351 // 352 // Given no arguments, that is, when run as 353 // 354 // go doc 355 // 356 // it prints the package documentation for the package in the current directory. 357 // If the package is a command (package main), the exported symbols of the package 358 // are elided from the presentation unless the -cmd flag is provided. 359 // 360 // When run with one argument, the argument is treated as a Go-syntax-like 361 // representation of the item to be documented. What the argument selects depends 362 // on what is installed in GOROOT and GOPATH, as well as the form of the argument, 363 // which is schematically one of these: 364 // 365 // go doc <pkg> 366 // go doc <sym>[.<methodOrField>] 367 // go doc [<pkg>.]<sym>[.<methodOrField>] 368 // go doc [<pkg>.][<sym>.]<methodOrField> 369 // 370 // The first item in this list matched by the argument is the one whose documentation 371 // is printed. (See the examples below.) However, if the argument starts with a capital 372 // letter it is assumed to identify a symbol or method in the current directory. 373 // 374 // For packages, the order of scanning is determined lexically in breadth-first order. 375 // That is, the package presented is the one that matches the search and is nearest 376 // the root and lexically first at its level of the hierarchy. The GOROOT tree is 377 // always scanned in its entirety before GOPATH. 378 // 379 // If there is no package specified or matched, the package in the current 380 // directory is selected, so "go doc Foo" shows the documentation for symbol Foo in 381 // the current package. 382 // 383 // The package path must be either a qualified path or a proper suffix of a 384 // path. The go tool's usual package mechanism does not apply: package path 385 // elements like . and ... are not implemented by go doc. 386 // 387 // When run with two arguments, the first is a package path (full path or suffix), 388 // and the second is a symbol, or symbol with method or struct field: 389 // 390 // go doc <pkg> <sym>[.<methodOrField>] 391 // 392 // In all forms, when matching symbols, lower-case letters in the argument match 393 // either case but upper-case letters match exactly. This means that there may be 394 // multiple matches of a lower-case argument in a package if different symbols have 395 // different cases. If this occurs, documentation for all matches is printed. 396 // 397 // Examples: 398 // 399 // go doc 400 // Show documentation for current package. 401 // go doc Foo 402 // Show documentation for Foo in the current package. 403 // (Foo starts with a capital letter so it cannot match 404 // a package path.) 405 // go doc encoding/json 406 // Show documentation for the encoding/json package. 407 // go doc json 408 // Shorthand for encoding/json. 409 // go doc json.Number (or go doc json.number) 410 // Show documentation and method summary for json.Number. 411 // go doc json.Number.Int64 (or go doc json.number.int64) 412 // Show documentation for json.Number's Int64 method. 413 // go doc cmd/doc 414 // Show package docs for the doc command. 415 // go doc -cmd cmd/doc 416 // Show package docs and exported symbols within the doc command. 417 // go doc template.new 418 // Show documentation for html/template's New function. 419 // (html/template is lexically before text/template) 420 // go doc text/template.new # One argument 421 // Show documentation for text/template's New function. 422 // go doc text/template new # Two arguments 423 // Show documentation for text/template's New function. 424 // 425 // At least in the current tree, these invocations all print the 426 // documentation for json.Decoder's Decode method: 427 // 428 // go doc json.Decoder.Decode 429 // go doc json.decoder.decode 430 // go doc json.decode 431 // cd go/src/encoding/json; go doc decode 432 // 433 // Flags: 434 // 435 // -all 436 // Show all the documentation for the package. 437 // -c 438 // Respect case when matching symbols. 439 // -cmd 440 // Treat a command (package main) like a regular package. 441 // Otherwise package main's exported symbols are hidden 442 // when showing the package's top-level documentation. 443 // -short 444 // One-line representation for each symbol. 445 // -src 446 // Show the full source code for the symbol. This will 447 // display the full Go source of its declaration and 448 // definition, such as a function definition (including 449 // the body), type declaration or enclosing const 450 // block. The output may therefore include unexported 451 // details. 452 // -u 453 // Show documentation for unexported as well as exported 454 // symbols, methods, and fields. 455 // 456 // # Print Go environment information 457 // 458 // Usage: 459 // 460 // go env [-json] [-changed] [-u] [-w] [var ...] 461 // 462 // Env prints Go environment information. 463 // 464 // By default env prints information as a shell script 465 // (on Windows, a batch file). If one or more variable 466 // names is given as arguments, env prints the value of 467 // each named variable on its own line. 468 // 469 // The -json flag prints the environment in JSON format 470 // instead of as a shell script. 471 // 472 // The -u flag requires one or more arguments and unsets 473 // the default setting for the named environment variables, 474 // if one has been set with 'go env -w'. 475 // 476 // The -w flag requires one or more arguments of the 477 // form NAME=VALUE and changes the default settings 478 // of the named environment variables to the given values. 479 // 480 // The -changed flag prints only those settings whose effective 481 // value differs from the default value that would be obtained in 482 // an empty environment with no prior uses of the -w flag. 483 // 484 // For more about environment variables, see 'go help environment'. 485 // 486 // # Update packages to use new APIs 487 // 488 // Usage: 489 // 490 // go fix [-fix list] [packages] 491 // 492 // Fix runs the Go fix command on the packages named by the import paths. 493 // 494 // The -fix flag sets a comma-separated list of fixes to run. 495 // The default is all known fixes. 496 // (Its value is passed to 'go tool fix -r'.) 497 // 498 // For more about fix, see 'go doc cmd/fix'. 499 // For more about specifying packages, see 'go help packages'. 500 // 501 // To run fix with other options, run 'go tool fix'. 502 // 503 // See also: go fmt, go vet. 504 // 505 // # Gofmt (reformat) package sources 506 // 507 // Usage: 508 // 509 // go fmt [-n] [-x] [packages] 510 // 511 // Fmt runs the command 'gofmt -l -w' on the packages named 512 // by the import paths. It prints the names of the files that are modified. 513 // 514 // For more about gofmt, see 'go doc cmd/gofmt'. 515 // For more about specifying packages, see 'go help packages'. 516 // 517 // The -n flag prints commands that would be executed. 518 // The -x flag prints commands as they are executed. 519 // 520 // The -mod flag's value sets which module download mode 521 // to use: readonly or vendor. See 'go help modules' for more. 522 // 523 // To run gofmt with specific options, run gofmt itself. 524 // 525 // See also: go fix, go vet. 526 // 527 // # Generate Go files by processing source 528 // 529 // Usage: 530 // 531 // go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages] 532 // 533 // Generate runs commands described by directives within existing 534 // files. Those commands can run any process but the intent is to 535 // create or update Go source files. 536 // 537 // Go generate is never run automatically by go build, go test, 538 // and so on. It must be run explicitly. 539 // 540 // Go generate scans the file for directives, which are lines of 541 // the form, 542 // 543 // //go:generate command argument... 544 // 545 // (note: no leading spaces and no space in "//go") where command 546 // is the generator to be run, corresponding to an executable file 547 // that can be run locally. It must either be in the shell path 548 // (gofmt), a fully qualified path (/usr/you/bin/mytool), or a 549 // command alias, described below. 550 // 551 // Note that go generate does not parse the file, so lines that look 552 // like directives in comments or multiline strings will be treated 553 // as directives. 554 // 555 // The arguments to the directive are space-separated tokens or 556 // double-quoted strings passed to the generator as individual 557 // arguments when it is run. 558 // 559 // Quoted strings use Go syntax and are evaluated before execution; a 560 // quoted string appears as a single argument to the generator. 561 // 562 // To convey to humans and machine tools that code is generated, 563 // generated source should have a line that matches the following 564 // regular expression (in Go syntax): 565 // 566 // ^// Code generated .* DO NOT EDIT\.$ 567 // 568 // This line must appear before the first non-comment, non-blank 569 // text in the file. 570 // 571 // Go generate sets several variables when it runs the generator: 572 // 573 // $GOARCH 574 // The execution architecture (arm, amd64, etc.) 575 // $GOOS 576 // The execution operating system (linux, windows, etc.) 577 // $GOFILE 578 // The base name of the file. 579 // $GOLINE 580 // The line number of the directive in the source file. 581 // $GOPACKAGE 582 // The name of the package of the file containing the directive. 583 // $GOROOT 584 // The GOROOT directory for the 'go' command that invoked the 585 // generator, containing the Go toolchain and standard library. 586 // $DOLLAR 587 // A dollar sign. 588 // $PATH 589 // The $PATH of the parent process, with $GOROOT/bin 590 // placed at the beginning. This causes generators 591 // that execute 'go' commands to use the same 'go' 592 // as the parent 'go generate' command. 593 // 594 // Other than variable substitution and quoted-string evaluation, no 595 // special processing such as "globbing" is performed on the command 596 // line. 597 // 598 // As a last step before running the command, any invocations of any 599 // environment variables with alphanumeric names, such as $GOFILE or 600 // $HOME, are expanded throughout the command line. The syntax for 601 // variable expansion is $NAME on all operating systems. Due to the 602 // order of evaluation, variables are expanded even inside quoted 603 // strings. If the variable NAME is not set, $NAME expands to the 604 // empty string. 605 // 606 // A directive of the form, 607 // 608 // //go:generate -command xxx args... 609 // 610 // specifies, for the remainder of this source file only, that the 611 // string xxx represents the command identified by the arguments. This 612 // can be used to create aliases or to handle multiword generators. 613 // For example, 614 // 615 // //go:generate -command foo go tool foo 616 // 617 // specifies that the command "foo" represents the generator 618 // "go tool foo". 619 // 620 // Generate processes packages in the order given on the command line, 621 // one at a time. If the command line lists .go files from a single directory, 622 // they are treated as a single package. Within a package, generate processes the 623 // source files in a package in file name order, one at a time. Within 624 // a source file, generate runs generators in the order they appear 625 // in the file, one at a time. The go generate tool also sets the build 626 // tag "generate" so that files may be examined by go generate but ignored 627 // during build. 628 // 629 // For packages with invalid code, generate processes only source files with a 630 // valid package clause. 631 // 632 // If any generator returns an error exit status, "go generate" skips 633 // all further processing for that package. 634 // 635 // The generator is run in the package's source directory. 636 // 637 // Go generate accepts two specific flags: 638 // 639 // -run="" 640 // if non-empty, specifies a regular expression to select 641 // directives whose full original source text (excluding 642 // any trailing spaces and final newline) matches the 643 // expression. 644 // 645 // -skip="" 646 // if non-empty, specifies a regular expression to suppress 647 // directives whose full original source text (excluding 648 // any trailing spaces and final newline) matches the 649 // expression. If a directive matches both the -run and 650 // the -skip arguments, it is skipped. 651 // 652 // It also accepts the standard build flags including -v, -n, and -x. 653 // The -v flag prints the names of packages and files as they are 654 // processed. 655 // The -n flag prints commands that would be executed. 656 // The -x flag prints commands as they are executed. 657 // 658 // For more about build flags, see 'go help build'. 659 // 660 // For more about specifying packages, see 'go help packages'. 661 // 662 // # Add dependencies to current module and install them 663 // 664 // Usage: 665 // 666 // go get [-t] [-u] [-v] [build flags] [packages] 667 // 668 // Get resolves its command-line arguments to packages at specific module versions, 669 // updates go.mod to require those versions, and downloads source code into the 670 // module cache. 671 // 672 // To add a dependency for a package or upgrade it to its latest version: 673 // 674 // go get example.com/pkg 675 // 676 // To upgrade or downgrade a package to a specific version: 677 // 678 // go get example.com/pkg@v1.2.3 679 // 680 // To remove a dependency on a module and downgrade modules that require it: 681 // 682 // go get example.com/mod@none 683 // 684 // To upgrade the minimum required Go version to the latest released Go version: 685 // 686 // go get go@latest 687 // 688 // To upgrade the Go toolchain to the latest patch release of the current Go toolchain: 689 // 690 // go get toolchain@patch 691 // 692 // See https://golang.org/ref/mod#go-get for details. 693 // 694 // In earlier versions of Go, 'go get' was used to build and install packages. 695 // Now, 'go get' is dedicated to adjusting dependencies in go.mod. 'go install' 696 // may be used to build and install commands instead. When a version is specified, 697 // 'go install' runs in module-aware mode and ignores the go.mod file in the 698 // current directory. For example: 699 // 700 // go install example.com/pkg@v1.2.3 701 // go install example.com/pkg@latest 702 // 703 // See 'go help install' or https://golang.org/ref/mod#go-install for details. 704 // 705 // 'go get' accepts the following flags. 706 // 707 // The -t flag instructs get to consider modules needed to build tests of 708 // packages specified on the command line. 709 // 710 // The -u flag instructs get to update modules providing dependencies 711 // of packages named on the command line to use newer minor or patch 712 // releases when available. 713 // 714 // The -u=patch flag (not -u patch) also instructs get to update dependencies, 715 // but changes the default to select patch releases. 716 // 717 // When the -t and -u flags are used together, get will update 718 // test dependencies as well. 719 // 720 // The -x flag prints commands as they are executed. This is useful for 721 // debugging version control commands when a module is downloaded directly 722 // from a repository. 723 // 724 // For more about build flags, see 'go help build'. 725 // 726 // For more about modules, see https://golang.org/ref/mod. 727 // 728 // For more about using 'go get' to update the minimum Go version and 729 // suggested Go toolchain, see https://go.dev/doc/toolchain. 730 // 731 // For more about specifying packages, see 'go help packages'. 732 // 733 // This text describes the behavior of get using modules to manage source 734 // code and dependencies. If instead the go command is running in GOPATH 735 // mode, the details of get's flags and effects change, as does 'go help get'. 736 // See 'go help gopath-get'. 737 // 738 // See also: go build, go install, go clean, go mod. 739 // 740 // # Compile and install packages and dependencies 741 // 742 // Usage: 743 // 744 // go install [build flags] [packages] 745 // 746 // Install compiles and installs the packages named by the import paths. 747 // 748 // Executables are installed in the directory named by the GOBIN environment 749 // variable, which defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH 750 // environment variable is not set. Executables in $GOROOT 751 // are installed in $GOROOT/bin or $GOTOOLDIR instead of $GOBIN. 752 // 753 // If the arguments have version suffixes (like @latest or @v1.0.0), "go install" 754 // builds packages in module-aware mode, ignoring the go.mod file in the current 755 // directory or any parent directory, if there is one. This is useful for 756 // installing executables without affecting the dependencies of the main module. 757 // To eliminate ambiguity about which module versions are used in the build, the 758 // arguments must satisfy the following constraints: 759 // 760 // - Arguments must be package paths or package patterns (with "..." wildcards). 761 // They must not be standard packages (like fmt), meta-patterns (std, cmd, 762 // all), or relative or absolute file paths. 763 // 764 // - All arguments must have the same version suffix. Different queries are not 765 // allowed, even if they refer to the same version. 766 // 767 // - All arguments must refer to packages in the same module at the same version. 768 // 769 // - Package path arguments must refer to main packages. Pattern arguments 770 // will only match main packages. 771 // 772 // - No module is considered the "main" module. If the module containing 773 // packages named on the command line has a go.mod file, it must not contain 774 // directives (replace and exclude) that would cause it to be interpreted 775 // differently than if it were the main module. The module must not require 776 // a higher version of itself. 777 // 778 // - Vendor directories are not used in any module. (Vendor directories are not 779 // included in the module zip files downloaded by 'go install'.) 780 // 781 // If the arguments don't have version suffixes, "go install" may run in 782 // module-aware mode or GOPATH mode, depending on the GO111MODULE environment 783 // variable and the presence of a go.mod file. See 'go help modules' for details. 784 // If module-aware mode is enabled, "go install" runs in the context of the main 785 // module. 786 // 787 // When module-aware mode is disabled, non-main packages are installed in the 788 // directory $GOPATH/pkg/$GOOS_$GOARCH. When module-aware mode is enabled, 789 // non-main packages are built and cached but not installed. 790 // 791 // Before Go 1.20, the standard library was installed to 792 // $GOROOT/pkg/$GOOS_$GOARCH. 793 // Starting in Go 1.20, the standard library is built and cached but not installed. 794 // Setting GODEBUG=installgoroot=all restores the use of 795 // $GOROOT/pkg/$GOOS_$GOARCH. 796 // 797 // For more about build flags, see 'go help build'. 798 // 799 // For more about specifying packages, see 'go help packages'. 800 // 801 // See also: go build, go get, go clean. 802 // 803 // # List packages or modules 804 // 805 // Usage: 806 // 807 // go list [-f format] [-json] [-m] [list flags] [build flags] [packages] 808 // 809 // List lists the named packages, one per line. 810 // The most commonly-used flags are -f and -json, which control the form 811 // of the output printed for each package. Other list flags, documented below, 812 // control more specific details. 813 // 814 // The default output shows the package import path: 815 // 816 // bytes 817 // encoding/json 818 // github.com/gorilla/mux 819 // golang.org/x/net/html 820 // 821 // The -f flag specifies an alternate format for the list, using the 822 // syntax of package template. The default output is equivalent 823 // to -f '{{.ImportPath}}'. The struct being passed to the template is: 824 // 825 // type Package struct { 826 // Dir string // directory containing package sources 827 // ImportPath string // import path of package in dir 828 // ImportComment string // path in import comment on package statement 829 // Name string // package name 830 // Doc string // package documentation string 831 // Target string // install path 832 // Shlib string // the shared library that contains this package (only set when -linkshared) 833 // Goroot bool // is this package in the Go root? 834 // Standard bool // is this package part of the standard Go library? 835 // Stale bool // would 'go install' do anything for this package? 836 // StaleReason string // explanation for Stale==true 837 // Root string // Go root or Go path dir containing this package 838 // ConflictDir string // this directory shadows Dir in $GOPATH 839 // BinaryOnly bool // binary-only package (no longer supported) 840 // ForTest string // package is only for use in named test 841 // Export string // file containing export data (when using -export) 842 // BuildID string // build ID of the compiled package (when using -export) 843 // Module *Module // info about package's containing module, if any (can be nil) 844 // Match []string // command-line patterns matching this package 845 // DepOnly bool // package is only a dependency, not explicitly listed 846 // DefaultGODEBUG string // default GODEBUG setting, for main packages 847 // 848 // // Source files 849 // GoFiles []string // .go source files (excluding CgoFiles, TestGoFiles, XTestGoFiles) 850 // CgoFiles []string // .go source files that import "C" 851 // CompiledGoFiles []string // .go files presented to compiler (when using -compiled) 852 // IgnoredGoFiles []string // .go source files ignored due to build constraints 853 // IgnoredOtherFiles []string // non-.go source files ignored due to build constraints 854 // CFiles []string // .c source files 855 // CXXFiles []string // .cc, .cxx and .cpp source files 856 // MFiles []string // .m source files 857 // HFiles []string // .h, .hh, .hpp and .hxx source files 858 // FFiles []string // .f, .F, .for and .f90 Fortran source files 859 // SFiles []string // .s source files 860 // SwigFiles []string // .swig files 861 // SwigCXXFiles []string // .swigcxx files 862 // SysoFiles []string // .syso object files to add to archive 863 // TestGoFiles []string // _test.go files in package 864 // XTestGoFiles []string // _test.go files outside package 865 // 866 // // Embedded files 867 // EmbedPatterns []string // //go:embed patterns 868 // EmbedFiles []string // files matched by EmbedPatterns 869 // TestEmbedPatterns []string // //go:embed patterns in TestGoFiles 870 // TestEmbedFiles []string // files matched by TestEmbedPatterns 871 // XTestEmbedPatterns []string // //go:embed patterns in XTestGoFiles 872 // XTestEmbedFiles []string // files matched by XTestEmbedPatterns 873 // 874 // // Cgo directives 875 // CgoCFLAGS []string // cgo: flags for C compiler 876 // CgoCPPFLAGS []string // cgo: flags for C preprocessor 877 // CgoCXXFLAGS []string // cgo: flags for C++ compiler 878 // CgoFFLAGS []string // cgo: flags for Fortran compiler 879 // CgoLDFLAGS []string // cgo: flags for linker 880 // CgoPkgConfig []string // cgo: pkg-config names 881 // 882 // // Dependency information 883 // Imports []string // import paths used by this package 884 // ImportMap map[string]string // map from source import to ImportPath (identity entries omitted) 885 // Deps []string // all (recursively) imported dependencies 886 // TestImports []string // imports from TestGoFiles 887 // XTestImports []string // imports from XTestGoFiles 888 // 889 // // Error information 890 // Incomplete bool // this package or a dependency has an error 891 // Error *PackageError // error loading package 892 // DepsErrors []*PackageError // errors loading dependencies 893 // } 894 // 895 // Packages stored in vendor directories report an ImportPath that includes the 896 // path to the vendor directory (for example, "d/vendor/p" instead of "p"), 897 // so that the ImportPath uniquely identifies a given copy of a package. 898 // The Imports, Deps, TestImports, and XTestImports lists also contain these 899 // expanded import paths. See golang.org/s/go15vendor for more about vendoring. 900 // 901 // The error information, if any, is 902 // 903 // type PackageError struct { 904 // ImportStack []string // shortest path from package named on command line to this one 905 // Pos string // position of error (if present, file:line:col) 906 // Err string // the error itself 907 // } 908 // 909 // The module information is a Module struct, defined in the discussion 910 // of list -m below. 911 // 912 // The template function "join" calls strings.Join. 913 // 914 // The template function "context" returns the build context, defined as: 915 // 916 // type Context struct { 917 // GOARCH string // target architecture 918 // GOOS string // target operating system 919 // GOROOT string // Go root 920 // GOPATH string // Go path 921 // CgoEnabled bool // whether cgo can be used 922 // UseAllFiles bool // use files regardless of //go:build lines, file names 923 // Compiler string // compiler to assume when computing target paths 924 // BuildTags []string // build constraints to match in //go:build lines 925 // ToolTags []string // toolchain-specific build constraints 926 // ReleaseTags []string // releases the current release is compatible with 927 // InstallSuffix string // suffix to use in the name of the install dir 928 // } 929 // 930 // For more information about the meaning of these fields see the documentation 931 // for the go/build package's Context type. 932 // 933 // The -json flag causes the package data to be printed in JSON format 934 // instead of using the template format. The JSON flag can optionally be 935 // provided with a set of comma-separated required field names to be output. 936 // If so, those required fields will always appear in JSON output, but 937 // others may be omitted to save work in computing the JSON struct. 938 // 939 // The -compiled flag causes list to set CompiledGoFiles to the Go source 940 // files presented to the compiler. Typically this means that it repeats 941 // the files listed in GoFiles and then also adds the Go code generated 942 // by processing CgoFiles and SwigFiles. The Imports list contains the 943 // union of all imports from both GoFiles and CompiledGoFiles. 944 // 945 // The -deps flag causes list to iterate over not just the named packages 946 // but also all their dependencies. It visits them in a depth-first post-order 947 // traversal, so that a package is listed only after all its dependencies. 948 // Packages not explicitly listed on the command line will have the DepOnly 949 // field set to true. 950 // 951 // The -e flag changes the handling of erroneous packages, those that 952 // cannot be found or are malformed. By default, the list command 953 // prints an error to standard error for each erroneous package and 954 // omits the packages from consideration during the usual printing. 955 // With the -e flag, the list command never prints errors to standard 956 // error and instead processes the erroneous packages with the usual 957 // printing. Erroneous packages will have a non-empty ImportPath and 958 // a non-nil Error field; other information may or may not be missing 959 // (zeroed). 960 // 961 // The -export flag causes list to set the Export field to the name of a 962 // file containing up-to-date export information for the given package, 963 // and the BuildID field to the build ID of the compiled package. 964 // 965 // The -find flag causes list to identify the named packages but not 966 // resolve their dependencies: the Imports and Deps lists will be empty. 967 // With the -find flag, the -deps, -test and -export commands cannot be 968 // used. 969 // 970 // The -test flag causes list to report not only the named packages 971 // but also their test binaries (for packages with tests), to convey to 972 // source code analysis tools exactly how test binaries are constructed. 973 // The reported import path for a test binary is the import path of 974 // the package followed by a ".test" suffix, as in "math/rand.test". 975 // When building a test, it is sometimes necessary to rebuild certain 976 // dependencies specially for that test (most commonly the tested 977 // package itself). The reported import path of a package recompiled 978 // for a particular test binary is followed by a space and the name of 979 // the test binary in brackets, as in "math/rand [math/rand.test]" 980 // or "regexp [sort.test]". The ForTest field is also set to the name 981 // of the package being tested ("math/rand" or "sort" in the previous 982 // examples). 983 // 984 // The Dir, Target, Shlib, Root, ConflictDir, and Export file paths 985 // are all absolute paths. 986 // 987 // By default, the lists GoFiles, CgoFiles, and so on hold names of files in Dir 988 // (that is, paths relative to Dir, not absolute paths). 989 // The generated files added when using the -compiled and -test flags 990 // are absolute paths referring to cached copies of generated Go source files. 991 // Although they are Go source files, the paths may not end in ".go". 992 // 993 // The -m flag causes list to list modules instead of packages. 994 // 995 // When listing modules, the -f flag still specifies a format template 996 // applied to a Go struct, but now a Module struct: 997 // 998 // type Module struct { 999 // Path string // module path 1000 // Query string // version query corresponding to this version 1001 // Version string // module version 1002 // Versions []string // available module versions 1003 // Replace *Module // replaced by this module 1004 // Time *time.Time // time version was created 1005 // Update *Module // available update (with -u) 1006 // Main bool // is this the main module? 1007 // Indirect bool // module is only indirectly needed by main module 1008 // Dir string // directory holding local copy of files, if any 1009 // GoMod string // path to go.mod file describing module, if any 1010 // GoVersion string // go version used in module 1011 // Retracted []string // retraction information, if any (with -retracted or -u) 1012 // Deprecated string // deprecation message, if any (with -u) 1013 // Error *ModuleError // error loading module 1014 // Sum string // checksum for path, version (as in go.sum) 1015 // GoModSum string // checksum for go.mod (as in go.sum) 1016 // Origin any // provenance of module 1017 // Reuse bool // reuse of old module info is safe 1018 // } 1019 // 1020 // type ModuleError struct { 1021 // Err string // the error itself 1022 // } 1023 // 1024 // The file GoMod refers to may be outside the module directory if the 1025 // module is in the module cache or if the -modfile flag is used. 1026 // 1027 // The default output is to print the module path and then 1028 // information about the version and replacement if any. 1029 // For example, 'go list -m all' might print: 1030 // 1031 // my/main/module 1032 // golang.org/x/text v0.3.0 => /tmp/text 1033 // rsc.io/pdf v0.1.1 1034 // 1035 // The Module struct has a String method that formats this 1036 // line of output, so that the default format is equivalent 1037 // to -f '{{.String}}'. 1038 // 1039 // Note that when a module has been replaced, its Replace field 1040 // describes the replacement module, and its Dir field is set to 1041 // the replacement's source code, if present. (That is, if Replace 1042 // is non-nil, then Dir is set to Replace.Dir, with no access to 1043 // the replaced source code.) 1044 // 1045 // The -u flag adds information about available upgrades. 1046 // When the latest version of a given module is newer than 1047 // the current one, list -u sets the Module's Update field 1048 // to information about the newer module. list -u will also set 1049 // the module's Retracted field if the current version is retracted. 1050 // The Module's String method indicates an available upgrade by 1051 // formatting the newer version in brackets after the current version. 1052 // If a version is retracted, the string "(retracted)" will follow it. 1053 // For example, 'go list -m -u all' might print: 1054 // 1055 // my/main/module 1056 // golang.org/x/text v0.3.0 [v0.4.0] => /tmp/text 1057 // rsc.io/pdf v0.1.1 (retracted) [v0.1.2] 1058 // 1059 // (For tools, 'go list -m -u -json all' may be more convenient to parse.) 1060 // 1061 // The -versions flag causes list to set the Module's Versions field 1062 // to a list of all known versions of that module, ordered according 1063 // to semantic versioning, earliest to latest. The flag also changes 1064 // the default output format to display the module path followed by the 1065 // space-separated version list. 1066 // 1067 // The -retracted flag causes list to report information about retracted 1068 // module versions. When -retracted is used with -f or -json, the Retracted 1069 // field will be set to a string explaining why the version was retracted. 1070 // The string is taken from comments on the retract directive in the 1071 // module's go.mod file. When -retracted is used with -versions, retracted 1072 // versions are listed together with unretracted versions. The -retracted 1073 // flag may be used with or without -m. 1074 // 1075 // The arguments to list -m are interpreted as a list of modules, not packages. 1076 // The main module is the module containing the current directory. 1077 // The active modules are the main module and its dependencies. 1078 // With no arguments, list -m shows the main module. 1079 // With arguments, list -m shows the modules specified by the arguments. 1080 // Any of the active modules can be specified by its module path. 1081 // The special pattern "all" specifies all the active modules, first the main 1082 // module and then dependencies sorted by module path. 1083 // A pattern containing "..." specifies the active modules whose 1084 // module paths match the pattern. 1085 // A query of the form path@version specifies the result of that query, 1086 // which is not limited to active modules. 1087 // See 'go help modules' for more about module queries. 1088 // 1089 // The template function "module" takes a single string argument 1090 // that must be a module path or query and returns the specified 1091 // module as a Module struct. If an error occurs, the result will 1092 // be a Module struct with a non-nil Error field. 1093 // 1094 // When using -m, the -reuse=old.json flag accepts the name of file containing 1095 // the JSON output of a previous 'go list -m -json' invocation with the 1096 // same set of modifier flags (such as -u, -retracted, and -versions). 1097 // The go command may use this file to determine that a module is unchanged 1098 // since the previous invocation and avoid redownloading information about it. 1099 // Modules that are not redownloaded will be marked in the new output by 1100 // setting the Reuse field to true. Normally the module cache provides this 1101 // kind of reuse automatically; the -reuse flag can be useful on systems that 1102 // do not preserve the module cache. 1103 // 1104 // For more about build flags, see 'go help build'. 1105 // 1106 // For more about specifying packages, see 'go help packages'. 1107 // 1108 // For more about modules, see https://golang.org/ref/mod. 1109 // 1110 // # Module maintenance 1111 // 1112 // Go mod provides access to operations on modules. 1113 // 1114 // Note that support for modules is built into all the go commands, 1115 // not just 'go mod'. For example, day-to-day adding, removing, upgrading, 1116 // and downgrading of dependencies should be done using 'go get'. 1117 // See 'go help modules' for an overview of module functionality. 1118 // 1119 // Usage: 1120 // 1121 // go mod <command> [arguments] 1122 // 1123 // The commands are: 1124 // 1125 // download download modules to local cache 1126 // edit edit go.mod from tools or scripts 1127 // graph print module requirement graph 1128 // init initialize new module in current directory 1129 // tidy add missing and remove unused modules 1130 // vendor make vendored copy of dependencies 1131 // verify verify dependencies have expected content 1132 // why explain why packages or modules are needed 1133 // 1134 // Use "go help mod <command>" for more information about a command. 1135 // 1136 // # Download modules to local cache 1137 // 1138 // Usage: 1139 // 1140 // go mod download [-x] [-json] [-reuse=old.json] [modules] 1141 // 1142 // Download downloads the named modules, which can be module patterns selecting 1143 // dependencies of the main module or module queries of the form path@version. 1144 // 1145 // With no arguments, download applies to the modules needed to build and test 1146 // the packages in the main module: the modules explicitly required by the main 1147 // module if it is at 'go 1.17' or higher, or all transitively-required modules 1148 // if at 'go 1.16' or lower. 1149 // 1150 // The go command will automatically download modules as needed during ordinary 1151 // execution. The "go mod download" command is useful mainly for pre-filling 1152 // the local cache or to compute the answers for a Go module proxy. 1153 // 1154 // By default, download writes nothing to standard output. It may print progress 1155 // messages and errors to standard error. 1156 // 1157 // The -json flag causes download to print a sequence of JSON objects 1158 // to standard output, describing each downloaded module (or failure), 1159 // corresponding to this Go struct: 1160 // 1161 // type Module struct { 1162 // Path string // module path 1163 // Query string // version query corresponding to this version 1164 // Version string // module version 1165 // Error string // error loading module 1166 // Info string // absolute path to cached .info file 1167 // GoMod string // absolute path to cached .mod file 1168 // Zip string // absolute path to cached .zip file 1169 // Dir string // absolute path to cached source root directory 1170 // Sum string // checksum for path, version (as in go.sum) 1171 // GoModSum string // checksum for go.mod (as in go.sum) 1172 // Origin any // provenance of module 1173 // Reuse bool // reuse of old module info is safe 1174 // } 1175 // 1176 // The -reuse flag accepts the name of file containing the JSON output of a 1177 // previous 'go mod download -json' invocation. The go command may use this 1178 // file to determine that a module is unchanged since the previous invocation 1179 // and avoid redownloading it. Modules that are not redownloaded will be marked 1180 // in the new output by setting the Reuse field to true. Normally the module 1181 // cache provides this kind of reuse automatically; the -reuse flag can be 1182 // useful on systems that do not preserve the module cache. 1183 // 1184 // The -x flag causes download to print the commands download executes. 1185 // 1186 // See https://golang.org/ref/mod#go-mod-download for more about 'go mod download'. 1187 // 1188 // See https://golang.org/ref/mod#version-queries for more about version queries. 1189 // 1190 // # Edit go.mod from tools or scripts 1191 // 1192 // Usage: 1193 // 1194 // go mod edit [editing flags] [-fmt|-print|-json] [go.mod] 1195 // 1196 // Edit provides a command-line interface for editing go.mod, 1197 // for use primarily by tools or scripts. It reads only go.mod; 1198 // it does not look up information about the modules involved. 1199 // By default, edit reads and writes the go.mod file of the main module, 1200 // but a different target file can be specified after the editing flags. 1201 // 1202 // The editing flags specify a sequence of editing operations. 1203 // 1204 // The -fmt flag reformats the go.mod file without making other changes. 1205 // This reformatting is also implied by any other modifications that use or 1206 // rewrite the go.mod file. The only time this flag is needed is if no other 1207 // flags are specified, as in 'go mod edit -fmt'. 1208 // 1209 // The -module flag changes the module's path (the go.mod file's module line). 1210 // 1211 // The -godebug=key=value flag adds a godebug key=value line, 1212 // replacing any existing godebug lines with the given key. 1213 // 1214 // The -dropgodebug=key flag drops any existing godebug lines 1215 // with the given key. 1216 // 1217 // The -require=path@version and -droprequire=path flags 1218 // add and drop a requirement on the given module path and version. 1219 // Note that -require overrides any existing requirements on path. 1220 // These flags are mainly for tools that understand the module graph. 1221 // Users should prefer 'go get path@version' or 'go get path@none', 1222 // which make other go.mod adjustments as needed to satisfy 1223 // constraints imposed by other modules. 1224 // 1225 // The -go=version flag sets the expected Go language version. 1226 // This flag is mainly for tools that understand Go version dependencies. 1227 // Users should prefer 'go get go@version'. 1228 // 1229 // The -toolchain=version flag sets the Go toolchain to use. 1230 // This flag is mainly for tools that understand Go version dependencies. 1231 // Users should prefer 'go get toolchain@version'. 1232 // 1233 // The -exclude=path@version and -dropexclude=path@version flags 1234 // add and drop an exclusion for the given module path and version. 1235 // Note that -exclude=path@version is a no-op if that exclusion already exists. 1236 // 1237 // The -replace=old[@v]=new[@v] flag adds a replacement of the given 1238 // module path and version pair. If the @v in old@v is omitted, a 1239 // replacement without a version on the left side is added, which applies 1240 // to all versions of the old module path. If the @v in new@v is omitted, 1241 // the new path should be a local module root directory, not a module 1242 // path. Note that -replace overrides any redundant replacements for old[@v], 1243 // so omitting @v will drop existing replacements for specific versions. 1244 // 1245 // The -dropreplace=old[@v] flag drops a replacement of the given 1246 // module path and version pair. If the @v is omitted, a replacement without 1247 // a version on the left side is dropped. 1248 // 1249 // The -retract=version and -dropretract=version flags add and drop a 1250 // retraction on the given version. The version may be a single version 1251 // like "v1.2.3" or a closed interval like "[v1.1.0,v1.1.9]". Note that 1252 // -retract=version is a no-op if that retraction already exists. 1253 // 1254 // The -godebug, -dropgodebug, -require, -droprequire, -exclude, -dropexclude, 1255 // -replace, -dropreplace, -retract, and -dropretract editing flags may be 1256 // repeated, and the changes are applied in the order given. 1257 // 1258 // The -print flag prints the final go.mod in its text format instead of 1259 // writing it back to go.mod. 1260 // 1261 // The -json flag prints the final go.mod file in JSON format instead of 1262 // writing it back to go.mod. The JSON output corresponds to these Go types: 1263 // 1264 // type Module struct { 1265 // Path string 1266 // Version string 1267 // } 1268 // 1269 // type GoMod struct { 1270 // Module ModPath 1271 // Go string 1272 // Toolchain string 1273 // Godebug []Godebug 1274 // Require []Require 1275 // Exclude []Module 1276 // Replace []Replace 1277 // Retract []Retract 1278 // } 1279 // 1280 // type ModPath struct { 1281 // Path string 1282 // Deprecated string 1283 // } 1284 // 1285 // type Godebug struct { 1286 // Key string 1287 // Value string 1288 // } 1289 // 1290 // type Require struct { 1291 // Path string 1292 // Version string 1293 // Indirect bool 1294 // } 1295 // 1296 // type Replace struct { 1297 // Old Module 1298 // New Module 1299 // } 1300 // 1301 // type Retract struct { 1302 // Low string 1303 // High string 1304 // Rationale string 1305 // } 1306 // 1307 // Retract entries representing a single version (not an interval) will have 1308 // the "Low" and "High" fields set to the same value. 1309 // 1310 // Note that this only describes the go.mod file itself, not other modules 1311 // referred to indirectly. For the full set of modules available to a build, 1312 // use 'go list -m -json all'. 1313 // 1314 // Edit also provides the -C, -n, and -x build flags. 1315 // 1316 // See https://golang.org/ref/mod#go-mod-edit for more about 'go mod edit'. 1317 // 1318 // # Print module requirement graph 1319 // 1320 // Usage: 1321 // 1322 // go mod graph [-go=version] [-x] 1323 // 1324 // Graph prints the module requirement graph (with replacements applied) 1325 // in text form. Each line in the output has two space-separated fields: a module 1326 // and one of its requirements. Each module is identified as a string of the form 1327 // path@version, except for the main module, which has no @version suffix. 1328 // 1329 // The -go flag causes graph to report the module graph as loaded by the 1330 // given Go version, instead of the version indicated by the 'go' directive 1331 // in the go.mod file. 1332 // 1333 // The -x flag causes graph to print the commands graph executes. 1334 // 1335 // See https://golang.org/ref/mod#go-mod-graph for more about 'go mod graph'. 1336 // 1337 // # Initialize new module in current directory 1338 // 1339 // Usage: 1340 // 1341 // go mod init [module-path] 1342 // 1343 // Init initializes and writes a new go.mod file in the current directory, in 1344 // effect creating a new module rooted at the current directory. The go.mod file 1345 // must not already exist. 1346 // 1347 // Init accepts one optional argument, the module path for the new module. If the 1348 // module path argument is omitted, init will attempt to infer the module path 1349 // using import comments in .go files, vendoring tool configuration files (like 1350 // Gopkg.lock), and the current directory (if in GOPATH). 1351 // 1352 // See https://golang.org/ref/mod#go-mod-init for more about 'go mod init'. 1353 // 1354 // # Add missing and remove unused modules 1355 // 1356 // Usage: 1357 // 1358 // go mod tidy [-e] [-v] [-x] [-diff] [-go=version] [-compat=version] 1359 // 1360 // Tidy makes sure go.mod matches the source code in the module. 1361 // It adds any missing modules necessary to build the current module's 1362 // packages and dependencies, and it removes unused modules that 1363 // don't provide any relevant packages. It also adds any missing entries 1364 // to go.sum and removes any unnecessary ones. 1365 // 1366 // The -v flag causes tidy to print information about removed modules 1367 // to standard error. 1368 // 1369 // The -e flag causes tidy to attempt to proceed despite errors 1370 // encountered while loading packages. 1371 // 1372 // The -diff flag causes tidy not to modify go.mod or go.sum but 1373 // instead print the necessary changes as a unified diff. It exits 1374 // with a non-zero code if the diff is not empty. 1375 // 1376 // The -go flag causes tidy to update the 'go' directive in the go.mod 1377 // file to the given version, which may change which module dependencies 1378 // are retained as explicit requirements in the go.mod file. 1379 // (Go versions 1.17 and higher retain more requirements in order to 1380 // support lazy module loading.) 1381 // 1382 // The -compat flag preserves any additional checksums needed for the 1383 // 'go' command from the indicated major Go release to successfully load 1384 // the module graph, and causes tidy to error out if that version of the 1385 // 'go' command would load any imported package from a different module 1386 // version. By default, tidy acts as if the -compat flag were set to the 1387 // version prior to the one indicated by the 'go' directive in the go.mod 1388 // file. 1389 // 1390 // The -x flag causes tidy to print the commands download executes. 1391 // 1392 // See https://golang.org/ref/mod#go-mod-tidy for more about 'go mod tidy'. 1393 // 1394 // # Make vendored copy of dependencies 1395 // 1396 // Usage: 1397 // 1398 // go mod vendor [-e] [-v] [-o outdir] 1399 // 1400 // Vendor resets the main module's vendor directory to include all packages 1401 // needed to build and test all the main module's packages. 1402 // It does not include test code for vendored packages. 1403 // 1404 // The -v flag causes vendor to print the names of vendored 1405 // modules and packages to standard error. 1406 // 1407 // The -e flag causes vendor to attempt to proceed despite errors 1408 // encountered while loading packages. 1409 // 1410 // The -o flag causes vendor to create the vendor directory at the given 1411 // path instead of "vendor". The go command can only use a vendor directory 1412 // named "vendor" within the module root directory, so this flag is 1413 // primarily useful for other tools. 1414 // 1415 // See https://golang.org/ref/mod#go-mod-vendor for more about 'go mod vendor'. 1416 // 1417 // # Verify dependencies have expected content 1418 // 1419 // Usage: 1420 // 1421 // go mod verify 1422 // 1423 // Verify checks that the dependencies of the current module, 1424 // which are stored in a local downloaded source cache, have not been 1425 // modified since being downloaded. If all the modules are unmodified, 1426 // verify prints "all modules verified." Otherwise it reports which 1427 // modules have been changed and causes 'go mod' to exit with a 1428 // non-zero status. 1429 // 1430 // See https://golang.org/ref/mod#go-mod-verify for more about 'go mod verify'. 1431 // 1432 // # Explain why packages or modules are needed 1433 // 1434 // Usage: 1435 // 1436 // go mod why [-m] [-vendor] packages... 1437 // 1438 // Why shows a shortest path in the import graph from the main module to 1439 // each of the listed packages. If the -m flag is given, why treats the 1440 // arguments as a list of modules and finds a path to any package in each 1441 // of the modules. 1442 // 1443 // By default, why queries the graph of packages matched by "go list all", 1444 // which includes tests for reachable packages. The -vendor flag causes why 1445 // to exclude tests of dependencies. 1446 // 1447 // The output is a sequence of stanzas, one for each package or module 1448 // name on the command line, separated by blank lines. Each stanza begins 1449 // with a comment line "# package" or "# module" giving the target 1450 // package or module. Subsequent lines give a path through the import 1451 // graph, one package per line. If the package or module is not 1452 // referenced from the main module, the stanza will display a single 1453 // parenthesized note indicating that fact. 1454 // 1455 // For example: 1456 // 1457 // $ go mod why golang.org/x/text/language golang.org/x/text/encoding 1458 // # golang.org/x/text/language 1459 // rsc.io/quote 1460 // rsc.io/sampler 1461 // golang.org/x/text/language 1462 // 1463 // # golang.org/x/text/encoding 1464 // (main module does not need package golang.org/x/text/encoding) 1465 // $ 1466 // 1467 // See https://golang.org/ref/mod#go-mod-why for more about 'go mod why'. 1468 // 1469 // # Workspace maintenance 1470 // 1471 // Work provides access to operations on workspaces. 1472 // 1473 // Note that support for workspaces is built into many other commands, not 1474 // just 'go work'. 1475 // 1476 // See 'go help modules' for information about Go's module system of which 1477 // workspaces are a part. 1478 // 1479 // See https://go.dev/ref/mod#workspaces for an in-depth reference on 1480 // workspaces. 1481 // 1482 // See https://go.dev/doc/tutorial/workspaces for an introductory 1483 // tutorial on workspaces. 1484 // 1485 // A workspace is specified by a go.work file that specifies a set of 1486 // module directories with the "use" directive. These modules are used as 1487 // root modules by the go command for builds and related operations. A 1488 // workspace that does not specify modules to be used cannot be used to do 1489 // builds from local modules. 1490 // 1491 // go.work files are line-oriented. Each line holds a single directive, 1492 // made up of a keyword followed by arguments. For example: 1493 // 1494 // go 1.18 1495 // 1496 // use ../foo/bar 1497 // use ./baz 1498 // 1499 // replace example.com/foo v1.2.3 => example.com/bar v1.4.5 1500 // 1501 // The leading keyword can be factored out of adjacent lines to create a block, 1502 // like in Go imports. 1503 // 1504 // use ( 1505 // ../foo/bar 1506 // ./baz 1507 // ) 1508 // 1509 // The use directive specifies a module to be included in the workspace's 1510 // set of main modules. The argument to the use directive is the directory 1511 // containing the module's go.mod file. 1512 // 1513 // The go directive specifies the version of Go the file was written at. It 1514 // is possible there may be future changes in the semantics of workspaces 1515 // that could be controlled by this version, but for now the version 1516 // specified has no effect. 1517 // 1518 // The replace directive has the same syntax as the replace directive in a 1519 // go.mod file and takes precedence over replaces in go.mod files. It is 1520 // primarily intended to override conflicting replaces in different workspace 1521 // modules. 1522 // 1523 // To determine whether the go command is operating in workspace mode, use 1524 // the "go env GOWORK" command. This will specify the workspace file being 1525 // used. 1526 // 1527 // Usage: 1528 // 1529 // go work <command> [arguments] 1530 // 1531 // The commands are: 1532 // 1533 // edit edit go.work from tools or scripts 1534 // init initialize workspace file 1535 // sync sync workspace build list to modules 1536 // use add modules to workspace file 1537 // vendor make vendored copy of dependencies 1538 // 1539 // Use "go help work <command>" for more information about a command. 1540 // 1541 // # Edit go.work from tools or scripts 1542 // 1543 // Usage: 1544 // 1545 // go work edit [editing flags] [go.work] 1546 // 1547 // Edit provides a command-line interface for editing go.work, 1548 // for use primarily by tools or scripts. It only reads go.work; 1549 // it does not look up information about the modules involved. 1550 // If no file is specified, Edit looks for a go.work file in the current 1551 // directory and its parent directories 1552 // 1553 // The editing flags specify a sequence of editing operations. 1554 // 1555 // The -fmt flag reformats the go.work file without making other changes. 1556 // This reformatting is also implied by any other modifications that use or 1557 // rewrite the go.mod file. The only time this flag is needed is if no other 1558 // flags are specified, as in 'go work edit -fmt'. 1559 // 1560 // The -godebug=key=value flag adds a godebug key=value line, 1561 // replacing any existing godebug lines with the given key. 1562 // 1563 // The -dropgodebug=key flag drops any existing godebug lines 1564 // with the given key. 1565 // 1566 // The -use=path and -dropuse=path flags 1567 // add and drop a use directive from the go.work file's set of module directories. 1568 // 1569 // The -replace=old[@v]=new[@v] flag adds a replacement of the given 1570 // module path and version pair. If the @v in old@v is omitted, a 1571 // replacement without a version on the left side is added, which applies 1572 // to all versions of the old module path. If the @v in new@v is omitted, 1573 // the new path should be a local module root directory, not a module 1574 // path. Note that -replace overrides any redundant replacements for old[@v], 1575 // so omitting @v will drop existing replacements for specific versions. 1576 // 1577 // The -dropreplace=old[@v] flag drops a replacement of the given 1578 // module path and version pair. If the @v is omitted, a replacement without 1579 // a version on the left side is dropped. 1580 // 1581 // The -use, -dropuse, -replace, and -dropreplace, 1582 // editing flags may be repeated, and the changes are applied in the order given. 1583 // 1584 // The -go=version flag sets the expected Go language version. 1585 // 1586 // The -toolchain=name flag sets the Go toolchain to use. 1587 // 1588 // The -print flag prints the final go.work in its text format instead of 1589 // writing it back to go.mod. 1590 // 1591 // The -json flag prints the final go.work file in JSON format instead of 1592 // writing it back to go.mod. The JSON output corresponds to these Go types: 1593 // 1594 // type GoWork struct { 1595 // Go string 1596 // Toolchain string 1597 // Godebug []Godebug 1598 // Use []Use 1599 // Replace []Replace 1600 // } 1601 // 1602 // type Godebug struct { 1603 // Key string 1604 // Value string 1605 // } 1606 // 1607 // type Use struct { 1608 // DiskPath string 1609 // ModulePath string 1610 // } 1611 // 1612 // type Replace struct { 1613 // Old Module 1614 // New Module 1615 // } 1616 // 1617 // type Module struct { 1618 // Path string 1619 // Version string 1620 // } 1621 // 1622 // See the workspaces reference at https://go.dev/ref/mod#workspaces 1623 // for more information. 1624 // 1625 // # Initialize workspace file 1626 // 1627 // Usage: 1628 // 1629 // go work init [moddirs] 1630 // 1631 // Init initializes and writes a new go.work file in the 1632 // current directory, in effect creating a new workspace at the current 1633 // directory. 1634 // 1635 // go work init optionally accepts paths to the workspace modules as 1636 // arguments. If the argument is omitted, an empty workspace with no 1637 // modules will be created. 1638 // 1639 // Each argument path is added to a use directive in the go.work file. The 1640 // current go version will also be listed in the go.work file. 1641 // 1642 // See the workspaces reference at https://go.dev/ref/mod#workspaces 1643 // for more information. 1644 // 1645 // # Sync workspace build list to modules 1646 // 1647 // Usage: 1648 // 1649 // go work sync 1650 // 1651 // Sync syncs the workspace's build list back to the 1652 // workspace's modules 1653 // 1654 // The workspace's build list is the set of versions of all the 1655 // (transitive) dependency modules used to do builds in the workspace. go 1656 // work sync generates that build list using the Minimal Version Selection 1657 // algorithm, and then syncs those versions back to each of modules 1658 // specified in the workspace (with use directives). 1659 // 1660 // The syncing is done by sequentially upgrading each of the dependency 1661 // modules specified in a workspace module to the version in the build list 1662 // if the dependency module's version is not already the same as the build 1663 // list's version. Note that Minimal Version Selection guarantees that the 1664 // build list's version of each module is always the same or higher than 1665 // that in each workspace module. 1666 // 1667 // See the workspaces reference at https://go.dev/ref/mod#workspaces 1668 // for more information. 1669 // 1670 // # Add modules to workspace file 1671 // 1672 // Usage: 1673 // 1674 // go work use [-r] [moddirs] 1675 // 1676 // Use provides a command-line interface for adding 1677 // directories, optionally recursively, to a go.work file. 1678 // 1679 // A use directive will be added to the go.work file for each argument 1680 // directory listed on the command line go.work file, if it exists, 1681 // or removed from the go.work file if it does not exist. 1682 // Use fails if any remaining use directives refer to modules that 1683 // do not exist. 1684 // 1685 // Use updates the go line in go.work to specify a version at least as 1686 // new as all the go lines in the used modules, both preexisting ones 1687 // and newly added ones. With no arguments, this update is the only 1688 // thing that go work use does. 1689 // 1690 // The -r flag searches recursively for modules in the argument 1691 // directories, and the use command operates as if each of the directories 1692 // were specified as arguments. 1693 // 1694 // See the workspaces reference at https://go.dev/ref/mod#workspaces 1695 // for more information. 1696 // 1697 // # Make vendored copy of dependencies 1698 // 1699 // Usage: 1700 // 1701 // go work vendor [-e] [-v] [-o outdir] 1702 // 1703 // Vendor resets the workspace's vendor directory to include all packages 1704 // needed to build and test all the workspace's packages. 1705 // It does not include test code for vendored packages. 1706 // 1707 // The -v flag causes vendor to print the names of vendored 1708 // modules and packages to standard error. 1709 // 1710 // The -e flag causes vendor to attempt to proceed despite errors 1711 // encountered while loading packages. 1712 // 1713 // The -o flag causes vendor to create the vendor directory at the given 1714 // path instead of "vendor". The go command can only use a vendor directory 1715 // named "vendor" within the module root directory, so this flag is 1716 // primarily useful for other tools. 1717 // 1718 // # Compile and run Go program 1719 // 1720 // Usage: 1721 // 1722 // go run [build flags] [-exec xprog] package [arguments...] 1723 // 1724 // Run compiles and runs the named main Go package. 1725 // Typically the package is specified as a list of .go source files from a single 1726 // directory, but it may also be an import path, file system path, or pattern 1727 // matching a single known package, as in 'go run .' or 'go run my/cmd'. 1728 // 1729 // If the package argument has a version suffix (like @latest or @v1.0.0), 1730 // "go run" builds the program in module-aware mode, ignoring the go.mod file in 1731 // the current directory or any parent directory, if there is one. This is useful 1732 // for running programs without affecting the dependencies of the main module. 1733 // 1734 // If the package argument doesn't have a version suffix, "go run" may run in 1735 // module-aware mode or GOPATH mode, depending on the GO111MODULE environment 1736 // variable and the presence of a go.mod file. See 'go help modules' for details. 1737 // If module-aware mode is enabled, "go run" runs in the context of the main 1738 // module. 1739 // 1740 // By default, 'go run' runs the compiled binary directly: 'a.out arguments...'. 1741 // If the -exec flag is given, 'go run' invokes the binary using xprog: 1742 // 1743 // 'xprog a.out arguments...'. 1744 // 1745 // If the -exec flag is not given, GOOS or GOARCH is different from the system 1746 // default, and a program named go_$GOOS_$GOARCH_exec can be found 1747 // on the current search path, 'go run' invokes the binary using that program, 1748 // for example 'go_js_wasm_exec a.out arguments...'. This allows execution of 1749 // cross-compiled programs when a simulator or other execution method is 1750 // available. 1751 // 1752 // By default, 'go run' compiles the binary without generating the information 1753 // used by debuggers, to reduce build time. To include debugger information in 1754 // the binary, use 'go build'. 1755 // 1756 // The exit status of Run is not the exit status of the compiled binary. 1757 // 1758 // For more about build flags, see 'go help build'. 1759 // For more about specifying packages, see 'go help packages'. 1760 // 1761 // See also: go build. 1762 // 1763 // # Manage telemetry data and settings 1764 // 1765 // Usage: 1766 // 1767 // go telemetry [off|local|on] 1768 // 1769 // Telemetry is used to manage Go telemetry data and settings. 1770 // 1771 // Telemetry can be in one of three modes: off, local, or on. 1772 // 1773 // When telemetry is in local mode, counter data is written to the local file 1774 // system, but will not be uploaded to remote servers. 1775 // 1776 // When telemetry is off, local counter data is neither collected nor uploaded. 1777 // 1778 // When telemetry is on, telemetry data is written to the local file system 1779 // and periodically sent to https://telemetry.go.dev/. Uploaded data is used to 1780 // help improve the Go toolchain and related tools, and it will be published as 1781 // part of a public dataset. 1782 // 1783 // For more details, see https://telemetry.go.dev/privacy. 1784 // This data is collected in accordance with the Google Privacy Policy 1785 // (https://policies.google.com/privacy). 1786 // 1787 // To view the current telemetry mode, run "go telemetry". 1788 // To disable telemetry uploading, but keep local data collection, run 1789 // "go telemetry local". 1790 // To enable both collection and uploading, run “go telemetry on”. 1791 // To disable both collection and uploading, run "go telemetry off". 1792 // 1793 // See https://go.dev/doc/telemetry for more information on telemetry. 1794 // 1795 // # Test packages 1796 // 1797 // Usage: 1798 // 1799 // go test [build/test flags] [packages] [build/test flags & test binary flags] 1800 // 1801 // 'Go test' automates testing the packages named by the import paths. 1802 // It prints a summary of the test results in the format: 1803 // 1804 // ok archive/tar 0.011s 1805 // FAIL archive/zip 0.022s 1806 // ok compress/gzip 0.033s 1807 // ... 1808 // 1809 // followed by detailed output for each failed package. 1810 // 1811 // 'Go test' recompiles each package along with any files with names matching 1812 // the file pattern "*_test.go". 1813 // These additional files can contain test functions, benchmark functions, fuzz 1814 // tests and example functions. See 'go help testfunc' for more. 1815 // Each listed package causes the execution of a separate test binary. 1816 // Files whose names begin with "_" (including "_test.go") or "." are ignored. 1817 // 1818 // Test files that declare a package with the suffix "_test" will be compiled as a 1819 // separate package, and then linked and run with the main test binary. 1820 // 1821 // The go tool will ignore a directory named "testdata", making it available 1822 // to hold ancillary data needed by the tests. 1823 // 1824 // As part of building a test binary, go test runs go vet on the package 1825 // and its test source files to identify significant problems. If go vet 1826 // finds any problems, go test reports those and does not run the test 1827 // binary. Only a high-confidence subset of the default go vet checks are 1828 // used. That subset is: atomic, bool, buildtags, directive, errorsas, 1829 // ifaceassert, nilfunc, printf, and stringintconv. You can see 1830 // the documentation for these and other vet tests via "go doc cmd/vet". 1831 // To disable the running of go vet, use the -vet=off flag. To run all 1832 // checks, use the -vet=all flag. 1833 // 1834 // All test output and summary lines are printed to the go command's 1835 // standard output, even if the test printed them to its own standard 1836 // error. (The go command's standard error is reserved for printing 1837 // errors building the tests.) 1838 // 1839 // The go command places $GOROOT/bin at the beginning of $PATH 1840 // in the test's environment, so that tests that execute 1841 // 'go' commands use the same 'go' as the parent 'go test' command. 1842 // 1843 // Go test runs in two different modes: 1844 // 1845 // The first, called local directory mode, occurs when go test is 1846 // invoked with no package arguments (for example, 'go test' or 'go 1847 // test -v'). In this mode, go test compiles the package sources and 1848 // tests found in the current directory and then runs the resulting 1849 // test binary. In this mode, caching (discussed below) is disabled. 1850 // After the package test finishes, go test prints a summary line 1851 // showing the test status ('ok' or 'FAIL'), package name, and elapsed 1852 // time. 1853 // 1854 // The second, called package list mode, occurs when go test is invoked 1855 // with explicit package arguments (for example 'go test math', 'go 1856 // test ./...', and even 'go test .'). In this mode, go test compiles 1857 // and tests each of the packages listed on the command line. If a 1858 // package test passes, go test prints only the final 'ok' summary 1859 // line. If a package test fails, go test prints the full test output. 1860 // If invoked with the -bench or -v flag, go test prints the full 1861 // output even for passing package tests, in order to display the 1862 // requested benchmark results or verbose logging. After the package 1863 // tests for all of the listed packages finish, and their output is 1864 // printed, go test prints a final 'FAIL' status if any package test 1865 // has failed. 1866 // 1867 // In package list mode only, go test caches successful package test 1868 // results to avoid unnecessary repeated running of tests. When the 1869 // result of a test can be recovered from the cache, go test will 1870 // redisplay the previous output instead of running the test binary 1871 // again. When this happens, go test prints '(cached)' in place of the 1872 // elapsed time in the summary line. 1873 // 1874 // The rule for a match in the cache is that the run involves the same 1875 // test binary and the flags on the command line come entirely from a 1876 // restricted set of 'cacheable' test flags, defined as -benchtime, -cpu, 1877 // -list, -parallel, -run, -short, -timeout, -failfast, -fullpath and -v. 1878 // If a run of go test has any test or non-test flags outside this set, 1879 // the result is not cached. To disable test caching, use any test flag 1880 // or argument other than the cacheable flags. The idiomatic way to disable 1881 // test caching explicitly is to use -count=1. Tests that open files within 1882 // the package's source root (usually $GOPATH) or that consult environment 1883 // variables only match future runs in which the files and environment 1884 // variables are unchanged. A cached test result is treated as executing 1885 // in no time at all, so a successful package test result will be cached and 1886 // reused regardless of -timeout setting. 1887 // 1888 // In addition to the build flags, the flags handled by 'go test' itself are: 1889 // 1890 // -args 1891 // Pass the remainder of the command line (everything after -args) 1892 // to the test binary, uninterpreted and unchanged. 1893 // Because this flag consumes the remainder of the command line, 1894 // the package list (if present) must appear before this flag. 1895 // 1896 // -c 1897 // Compile the test binary to pkg.test in the current directory but do not run it 1898 // (where pkg is the last element of the package's import path). 1899 // The file name or target directory can be changed with the -o flag. 1900 // 1901 // -exec xprog 1902 // Run the test binary using xprog. The behavior is the same as 1903 // in 'go run'. See 'go help run' for details. 1904 // 1905 // -json 1906 // Convert test output to JSON suitable for automated processing. 1907 // See 'go doc test2json' for the encoding details. 1908 // 1909 // -o file 1910 // Compile the test binary to the named file. 1911 // The test still runs (unless -c or -i is specified). 1912 // If file ends in a slash or names an existing directory, 1913 // the test is written to pkg.test in that directory. 1914 // 1915 // The test binary also accepts flags that control execution of the test; these 1916 // flags are also accessible by 'go test'. See 'go help testflag' for details. 1917 // 1918 // For more about build flags, see 'go help build'. 1919 // For more about specifying packages, see 'go help packages'. 1920 // 1921 // See also: go build, go vet. 1922 // 1923 // # Run specified go tool 1924 // 1925 // Usage: 1926 // 1927 // go tool [-n] command [args...] 1928 // 1929 // Tool runs the go tool command identified by the arguments. 1930 // With no arguments it prints the list of known tools. 1931 // 1932 // The -n flag causes tool to print the command that would be 1933 // executed but not execute it. 1934 // 1935 // For more about each tool command, see 'go doc cmd/<command>'. 1936 // 1937 // # Print Go version 1938 // 1939 // Usage: 1940 // 1941 // go version [-m] [-v] [file ...] 1942 // 1943 // Version prints the build information for Go binary files. 1944 // 1945 // Go version reports the Go version used to build each of the named files. 1946 // 1947 // If no files are named on the command line, go version prints its own 1948 // version information. 1949 // 1950 // If a directory is named, go version walks that directory, recursively, 1951 // looking for recognized Go binaries and reporting their versions. 1952 // By default, go version does not report unrecognized files found 1953 // during a directory scan. The -v flag causes it to report unrecognized files. 1954 // 1955 // The -m flag causes go version to print each file's embedded 1956 // module version information, when available. In the output, the module 1957 // information consists of multiple lines following the version line, each 1958 // indented by a leading tab character. 1959 // 1960 // See also: go doc runtime/debug.BuildInfo. 1961 // 1962 // # Report likely mistakes in packages 1963 // 1964 // Usage: 1965 // 1966 // go vet [build flags] [-vettool prog] [vet flags] [packages] 1967 // 1968 // Vet runs the Go vet command on the packages named by the import paths. 1969 // 1970 // For more about vet and its flags, see 'go doc cmd/vet'. 1971 // For more about specifying packages, see 'go help packages'. 1972 // For a list of checkers and their flags, see 'go tool vet help'. 1973 // For details of a specific checker such as 'printf', see 'go tool vet help printf'. 1974 // 1975 // The -vettool=prog flag selects a different analysis tool with alternative 1976 // or additional checks. 1977 // For example, the 'shadow' analyzer can be built and run using these commands: 1978 // 1979 // go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow@latest 1980 // go vet -vettool=$(which shadow) 1981 // 1982 // The build flags supported by go vet are those that control package resolution 1983 // and execution, such as -C, -n, -x, -v, -tags, and -toolexec. 1984 // For more about these flags, see 'go help build'. 1985 // 1986 // See also: go fmt, go fix. 1987 // 1988 // # Build constraints 1989 // 1990 // A build constraint, also known as a build tag, is a condition under which a 1991 // file should be included in the package. Build constraints are given by a 1992 // line comment that begins 1993 // 1994 // //go:build 1995 // 1996 // Build constraints can also be used to downgrade the language version 1997 // used to compile a file. 1998 // 1999 // Constraints may appear in any kind of source file (not just Go), but 2000 // they must appear near the top of the file, preceded 2001 // only by blank lines and other comments. These rules mean that in Go 2002 // files a build constraint must appear before the package clause. 2003 // 2004 // To distinguish build constraints from package documentation, 2005 // a build constraint should be followed by a blank line. 2006 // 2007 // A build constraint comment is evaluated as an expression containing 2008 // build tags combined by ||, &&, and ! operators and parentheses. 2009 // Operators have the same meaning as in Go. 2010 // 2011 // For example, the following build constraint constrains a file to 2012 // build when the "linux" and "386" constraints are satisfied, or when 2013 // "darwin" is satisfied and "cgo" is not: 2014 // 2015 // //go:build (linux && 386) || (darwin && !cgo) 2016 // 2017 // It is an error for a file to have more than one //go:build line. 2018 // 2019 // During a particular build, the following build tags are satisfied: 2020 // 2021 // - the target operating system, as spelled by runtime.GOOS, set with the 2022 // GOOS environment variable. 2023 // - the target architecture, as spelled by runtime.GOARCH, set with the 2024 // GOARCH environment variable. 2025 // - any architecture features, in the form GOARCH.feature 2026 // (for example, "amd64.v2"), as detailed below. 2027 // - "unix", if GOOS is a Unix or Unix-like system. 2028 // - the compiler being used, either "gc" or "gccgo" 2029 // - "cgo", if the cgo command is supported (see CGO_ENABLED in 2030 // 'go help environment'). 2031 // - a term for each Go major release, through the current version: 2032 // "go1.1" from Go version 1.1 onward, "go1.12" from Go 1.12, and so on. 2033 // - any additional tags given by the -tags flag (see 'go help build'). 2034 // 2035 // There are no separate build tags for beta or minor releases. 2036 // 2037 // If a file's name, after stripping the extension and a possible _test suffix, 2038 // matches any of the following patterns: 2039 // 2040 // *_GOOS 2041 // *_GOARCH 2042 // *_GOOS_GOARCH 2043 // 2044 // (example: source_windows_amd64.go) where GOOS and GOARCH represent 2045 // any known operating system and architecture values respectively, then 2046 // the file is considered to have an implicit build constraint requiring 2047 // those terms (in addition to any explicit constraints in the file). 2048 // 2049 // Using GOOS=android matches build tags and files as for GOOS=linux 2050 // in addition to android tags and files. 2051 // 2052 // Using GOOS=illumos matches build tags and files as for GOOS=solaris 2053 // in addition to illumos tags and files. 2054 // 2055 // Using GOOS=ios matches build tags and files as for GOOS=darwin 2056 // in addition to ios tags and files. 2057 // 2058 // The defined architecture feature build tags are: 2059 // 2060 // - For GOARCH=386, GO386=387 and GO386=sse2 2061 // set the 386.387 and 386.sse2 build tags, respectively. 2062 // - For GOARCH=amd64, GOAMD64=v1, v2, and v3 2063 // correspond to the amd64.v1, amd64.v2, and amd64.v3 feature build tags. 2064 // - For GOARCH=arm, GOARM=5, 6, and 7 2065 // correspond to the arm.5, arm.6, and arm.7 feature build tags. 2066 // - For GOARCH=arm64, GOARM64=v8.{0-9} and v9.{0-5} 2067 // correspond to the arm64.v8.{0-9} and arm64.v9.{0-5} feature build tags. 2068 // - For GOARCH=mips or mipsle, 2069 // GOMIPS=hardfloat and softfloat 2070 // correspond to the mips.hardfloat and mips.softfloat 2071 // (or mipsle.hardfloat and mipsle.softfloat) feature build tags. 2072 // - For GOARCH=mips64 or mips64le, 2073 // GOMIPS64=hardfloat and softfloat 2074 // correspond to the mips64.hardfloat and mips64.softfloat 2075 // (or mips64le.hardfloat and mips64le.softfloat) feature build tags. 2076 // - For GOARCH=ppc64 or ppc64le, 2077 // GOPPC64=power8, power9, and power10 correspond to the 2078 // ppc64.power8, ppc64.power9, and ppc64.power10 2079 // (or ppc64le.power8, ppc64le.power9, and ppc64le.power10) 2080 // feature build tags. 2081 // - For GOARCH=riscv64, 2082 // GORISCV64=rva20u64 and rva22u64 correspond to the riscv64.rva20u64 2083 // and riscv64.rva22u64 build tags. 2084 // - For GOARCH=wasm, GOWASM=satconv and signext 2085 // correspond to the wasm.satconv and wasm.signext feature build tags. 2086 // 2087 // For GOARCH=amd64, arm, ppc64, ppc64le, and riscv64, a particular feature level 2088 // sets the feature build tags for all previous levels as well. 2089 // For example, GOAMD64=v2 sets the amd64.v1 and amd64.v2 feature flags. 2090 // This ensures that code making use of v2 features continues to compile 2091 // when, say, GOAMD64=v4 is introduced. 2092 // Code handling the absence of a particular feature level 2093 // should use a negation: 2094 // 2095 // //go:build !amd64.v2 2096 // 2097 // To keep a file from being considered for any build: 2098 // 2099 // //go:build ignore 2100 // 2101 // (Any other unsatisfied word will work as well, but "ignore" is conventional.) 2102 // 2103 // To build a file only when using cgo, and only on Linux and OS X: 2104 // 2105 // //go:build cgo && (linux || darwin) 2106 // 2107 // Such a file is usually paired with another file implementing the 2108 // default functionality for other systems, which in this case would 2109 // carry the constraint: 2110 // 2111 // //go:build !(cgo && (linux || darwin)) 2112 // 2113 // Naming a file dns_windows.go will cause it to be included only when 2114 // building the package for Windows; similarly, math_386.s will be included 2115 // only when building the package for 32-bit x86. 2116 // 2117 // Go versions 1.16 and earlier used a different syntax for build constraints, 2118 // with a "// +build" prefix. The gofmt command will add an equivalent //go:build 2119 // constraint when encountering the older syntax. 2120 // 2121 // In modules with a Go version of 1.21 or later, if a file's build constraint 2122 // has a term for a Go major release, the language version used when compiling 2123 // the file will be the minimum version implied by the build constraint. 2124 // 2125 // # Build modes 2126 // 2127 // The 'go build' and 'go install' commands take a -buildmode argument which 2128 // indicates which kind of object file is to be built. Currently supported values 2129 // are: 2130 // 2131 // -buildmode=archive 2132 // Build the listed non-main packages into .a files. Packages named 2133 // main are ignored. 2134 // 2135 // -buildmode=c-archive 2136 // Build the listed main package, plus all packages it imports, 2137 // into a C archive file. The only callable symbols will be those 2138 // functions exported using a cgo //export comment. Requires 2139 // exactly one main package to be listed. 2140 // 2141 // -buildmode=c-shared 2142 // Build the listed main package, plus all packages it imports, 2143 // into a C shared library. The only callable symbols will 2144 // be those functions exported using a cgo //export comment. 2145 // Requires exactly one main package to be listed. 2146 // 2147 // -buildmode=default 2148 // Listed main packages are built into executables and listed 2149 // non-main packages are built into .a files (the default 2150 // behavior). 2151 // 2152 // -buildmode=shared 2153 // Combine all the listed non-main packages into a single shared 2154 // library that will be used when building with the -linkshared 2155 // option. Packages named main are ignored. 2156 // 2157 // -buildmode=exe 2158 // Build the listed main packages and everything they import into 2159 // executables. Packages not named main are ignored. 2160 // 2161 // -buildmode=pie 2162 // Build the listed main packages and everything they import into 2163 // position independent executables (PIE). Packages not named 2164 // main are ignored. 2165 // 2166 // -buildmode=plugin 2167 // Build the listed main packages, plus all packages that they 2168 // import, into a Go plugin. Packages not named main are ignored. 2169 // 2170 // On AIX, when linking a C program that uses a Go archive built with 2171 // -buildmode=c-archive, you must pass -Wl,-bnoobjreorder to the C compiler. 2172 // 2173 // # Calling between Go and C 2174 // 2175 // There are two different ways to call between Go and C/C++ code. 2176 // 2177 // The first is the cgo tool, which is part of the Go distribution. For 2178 // information on how to use it see the cgo documentation (go doc cmd/cgo). 2179 // 2180 // The second is the SWIG program, which is a general tool for 2181 // interfacing between languages. For information on SWIG see 2182 // http://swig.org/. When running go build, any file with a .swig 2183 // extension will be passed to SWIG. Any file with a .swigcxx extension 2184 // will be passed to SWIG with the -c++ option. 2185 // 2186 // When either cgo or SWIG is used, go build will pass any .c, .m, .s, .S 2187 // or .sx files to the C compiler, and any .cc, .cpp, .cxx files to the C++ 2188 // compiler. The CC or CXX environment variables may be set to determine 2189 // the C or C++ compiler, respectively, to use. 2190 // 2191 // # Build and test caching 2192 // 2193 // The go command caches build outputs for reuse in future builds. 2194 // The default location for cache data is a subdirectory named go-build 2195 // in the standard user cache directory for the current operating system. 2196 // Setting the GOCACHE environment variable overrides this default, 2197 // and running 'go env GOCACHE' prints the current cache directory. 2198 // 2199 // The go command periodically deletes cached data that has not been 2200 // used recently. Running 'go clean -cache' deletes all cached data. 2201 // 2202 // The build cache correctly accounts for changes to Go source files, 2203 // compilers, compiler options, and so on: cleaning the cache explicitly 2204 // should not be necessary in typical use. However, the build cache 2205 // does not detect changes to C libraries imported with cgo. 2206 // If you have made changes to the C libraries on your system, you 2207 // will need to clean the cache explicitly or else use the -a build flag 2208 // (see 'go help build') to force rebuilding of packages that 2209 // depend on the updated C libraries. 2210 // 2211 // The go command also caches successful package test results. 2212 // See 'go help test' for details. Running 'go clean -testcache' removes 2213 // all cached test results (but not cached build results). 2214 // 2215 // The go command also caches values used in fuzzing with 'go test -fuzz', 2216 // specifically, values that expanded code coverage when passed to a 2217 // fuzz function. These values are not used for regular building and 2218 // testing, but they're stored in a subdirectory of the build cache. 2219 // Running 'go clean -fuzzcache' removes all cached fuzzing values. 2220 // This may make fuzzing less effective, temporarily. 2221 // 2222 // The GODEBUG environment variable can enable printing of debugging 2223 // information about the state of the cache: 2224 // 2225 // GODEBUG=gocacheverify=1 causes the go command to bypass the 2226 // use of any cache entries and instead rebuild everything and check 2227 // that the results match existing cache entries. 2228 // 2229 // GODEBUG=gocachehash=1 causes the go command to print the inputs 2230 // for all of the content hashes it uses to construct cache lookup keys. 2231 // The output is voluminous but can be useful for debugging the cache. 2232 // 2233 // GODEBUG=gocachetest=1 causes the go command to print details of its 2234 // decisions about whether to reuse a cached test result. 2235 // 2236 // # Environment variables 2237 // 2238 // The go command and the tools it invokes consult environment variables 2239 // for configuration. If an environment variable is unset or empty, the go 2240 // command uses a sensible default setting. To see the effective setting of 2241 // the variable <NAME>, run 'go env <NAME>'. To change the default setting, 2242 // run 'go env -w <NAME>=<VALUE>'. Defaults changed using 'go env -w' 2243 // are recorded in a Go environment configuration file stored in the 2244 // per-user configuration directory, as reported by os.UserConfigDir. 2245 // The location of the configuration file can be changed by setting 2246 // the environment variable GOENV, and 'go env GOENV' prints the 2247 // effective location, but 'go env -w' cannot change the default location. 2248 // See 'go help env' for details. 2249 // 2250 // General-purpose environment variables: 2251 // 2252 // GO111MODULE 2253 // Controls whether the go command runs in module-aware mode or GOPATH mode. 2254 // May be "off", "on", or "auto". 2255 // See https://golang.org/ref/mod#mod-commands. 2256 // GCCGO 2257 // The gccgo command to run for 'go build -compiler=gccgo'. 2258 // GOARCH 2259 // The architecture, or processor, for which to compile code. 2260 // Examples are amd64, 386, arm, ppc64. 2261 // GOBIN 2262 // The directory where 'go install' will install a command. 2263 // GOCACHE 2264 // The directory where the go command will store cached 2265 // information for reuse in future builds. 2266 // GOMODCACHE 2267 // The directory where the go command will store downloaded modules. 2268 // GODEBUG 2269 // Enable various debugging facilities. See https://go.dev/doc/godebug 2270 // for details. 2271 // GOENV 2272 // The location of the Go environment configuration file. 2273 // Cannot be set using 'go env -w'. 2274 // Setting GOENV=off in the environment disables the use of the 2275 // default configuration file. 2276 // GOFLAGS 2277 // A space-separated list of -flag=value settings to apply 2278 // to go commands by default, when the given flag is known by 2279 // the current command. Each entry must be a standalone flag. 2280 // Because the entries are space-separated, flag values must 2281 // not contain spaces. Flags listed on the command line 2282 // are applied after this list and therefore override it. 2283 // GOINSECURE 2284 // Comma-separated list of glob patterns (in the syntax of Go's path.Match) 2285 // of module path prefixes that should always be fetched in an insecure 2286 // manner. Only applies to dependencies that are being fetched directly. 2287 // GOINSECURE does not disable checksum database validation. GOPRIVATE or 2288 // GONOSUMDB may be used to achieve that. 2289 // GOOS 2290 // The operating system for which to compile code. 2291 // Examples are linux, darwin, windows, netbsd. 2292 // GOPATH 2293 // Controls where various files are stored. See: 'go help gopath'. 2294 // GOPROXY 2295 // URL of Go module proxy. See https://golang.org/ref/mod#environment-variables 2296 // and https://golang.org/ref/mod#module-proxy for details. 2297 // GOPRIVATE, GONOPROXY, GONOSUMDB 2298 // Comma-separated list of glob patterns (in the syntax of Go's path.Match) 2299 // of module path prefixes that should always be fetched directly 2300 // or that should not be compared against the checksum database. 2301 // See https://golang.org/ref/mod#private-modules. 2302 // GOROOT 2303 // The root of the go tree. 2304 // GOSUMDB 2305 // The name of checksum database to use and optionally its public key and 2306 // URL. See https://golang.org/ref/mod#authenticating. 2307 // GOTOOLCHAIN 2308 // Controls which Go toolchain is used. See https://go.dev/doc/toolchain. 2309 // GOTMPDIR 2310 // The directory where the go command will write 2311 // temporary source files, packages, and binaries. 2312 // GOVCS 2313 // Lists version control commands that may be used with matching servers. 2314 // See 'go help vcs'. 2315 // GOWORK 2316 // In module aware mode, use the given go.work file as a workspace file. 2317 // By default or when GOWORK is "auto", the go command searches for a 2318 // file named go.work in the current directory and then containing directories 2319 // until one is found. If a valid go.work file is found, the modules 2320 // specified will collectively be used as the main modules. If GOWORK 2321 // is "off", or a go.work file is not found in "auto" mode, workspace 2322 // mode is disabled. 2323 // 2324 // Environment variables for use with cgo: 2325 // 2326 // AR 2327 // The command to use to manipulate library archives when 2328 // building with the gccgo compiler. 2329 // The default is 'ar'. 2330 // CC 2331 // The command to use to compile C code. 2332 // CGO_ENABLED 2333 // Whether the cgo command is supported. Either 0 or 1. 2334 // CGO_CFLAGS 2335 // Flags that cgo will pass to the compiler when compiling 2336 // C code. 2337 // CGO_CFLAGS_ALLOW 2338 // A regular expression specifying additional flags to allow 2339 // to appear in #cgo CFLAGS source code directives. 2340 // Does not apply to the CGO_CFLAGS environment variable. 2341 // CGO_CFLAGS_DISALLOW 2342 // A regular expression specifying flags that must be disallowed 2343 // from appearing in #cgo CFLAGS source code directives. 2344 // Does not apply to the CGO_CFLAGS environment variable. 2345 // CGO_CPPFLAGS, CGO_CPPFLAGS_ALLOW, CGO_CPPFLAGS_DISALLOW 2346 // Like CGO_CFLAGS, CGO_CFLAGS_ALLOW, and CGO_CFLAGS_DISALLOW, 2347 // but for the C preprocessor. 2348 // CGO_CXXFLAGS, CGO_CXXFLAGS_ALLOW, CGO_CXXFLAGS_DISALLOW 2349 // Like CGO_CFLAGS, CGO_CFLAGS_ALLOW, and CGO_CFLAGS_DISALLOW, 2350 // but for the C++ compiler. 2351 // CGO_FFLAGS, CGO_FFLAGS_ALLOW, CGO_FFLAGS_DISALLOW 2352 // Like CGO_CFLAGS, CGO_CFLAGS_ALLOW, and CGO_CFLAGS_DISALLOW, 2353 // but for the Fortran compiler. 2354 // CGO_LDFLAGS, CGO_LDFLAGS_ALLOW, CGO_LDFLAGS_DISALLOW 2355 // Like CGO_CFLAGS, CGO_CFLAGS_ALLOW, and CGO_CFLAGS_DISALLOW, 2356 // but for the linker. 2357 // CXX 2358 // The command to use to compile C++ code. 2359 // FC 2360 // The command to use to compile Fortran code. 2361 // PKG_CONFIG 2362 // Path to pkg-config tool. 2363 // 2364 // Architecture-specific environment variables: 2365 // 2366 // GOARM 2367 // For GOARCH=arm, the ARM architecture for which to compile. 2368 // Valid values are 5, 6, 7. 2369 // The value can be followed by an option specifying how to implement floating point instructions. 2370 // Valid options are ,softfloat (default for 5) and ,hardfloat (default for 6 and 7). 2371 // GOARM64 2372 // For GOARCH=arm64, the ARM64 architecture for which to compile. 2373 // Valid values are v8.0 (default), v8.{1-9}, v9.{0-5}. 2374 // The value can be followed by an option specifying extensions implemented by target hardware. 2375 // Valid options are ,lse and ,crypto. 2376 // Note that some extensions are enabled by default starting from a certain GOARM64 version; 2377 // for example, lse is enabled by default starting from v8.1. 2378 // GO386 2379 // For GOARCH=386, how to implement floating point instructions. 2380 // Valid values are sse2 (default), softfloat. 2381 // GOAMD64 2382 // For GOARCH=amd64, the microarchitecture level for which to compile. 2383 // Valid values are v1 (default), v2, v3, v4. 2384 // See https://golang.org/wiki/MinimumRequirements#amd64 2385 // GOMIPS 2386 // For GOARCH=mips{,le}, whether to use floating point instructions. 2387 // Valid values are hardfloat (default), softfloat. 2388 // GOMIPS64 2389 // For GOARCH=mips64{,le}, whether to use floating point instructions. 2390 // Valid values are hardfloat (default), softfloat. 2391 // GOPPC64 2392 // For GOARCH=ppc64{,le}, the target ISA (Instruction Set Architecture). 2393 // Valid values are power8 (default), power9, power10. 2394 // GORISCV64 2395 // For GOARCH=riscv64, the RISC-V user-mode application profile for which 2396 // to compile. Valid values are rva20u64 (default), rva22u64. 2397 // See https://github.com/riscv/riscv-profiles/blob/main/src/profiles.adoc 2398 // GOWASM 2399 // For GOARCH=wasm, comma-separated list of experimental WebAssembly features to use. 2400 // Valid values are satconv, signext. 2401 // 2402 // Environment variables for use with code coverage: 2403 // 2404 // GOCOVERDIR 2405 // Directory into which to write code coverage data files 2406 // generated by running a "go build -cover" binary. 2407 // Requires that GOEXPERIMENT=coverageredesign is enabled. 2408 // 2409 // Special-purpose environment variables: 2410 // 2411 // GCCGOTOOLDIR 2412 // If set, where to find gccgo tools, such as cgo. 2413 // The default is based on how gccgo was configured. 2414 // GOEXPERIMENT 2415 // Comma-separated list of toolchain experiments to enable or disable. 2416 // The list of available experiments may change arbitrarily over time. 2417 // See src/internal/goexperiment/flags.go for currently valid values. 2418 // Warning: This variable is provided for the development and testing 2419 // of the Go toolchain itself. Use beyond that purpose is unsupported. 2420 // GO_EXTLINK_ENABLED 2421 // Whether the linker should use external linking mode 2422 // when using -linkmode=auto with code that uses cgo. 2423 // Set to 0 to disable external linking mode, 1 to enable it. 2424 // GIT_ALLOW_PROTOCOL 2425 // Defined by Git. A colon-separated list of schemes that are allowed 2426 // to be used with git fetch/clone. If set, any scheme not explicitly 2427 // mentioned will be considered insecure by 'go get'. 2428 // Because the variable is defined by Git, the default value cannot 2429 // be set using 'go env -w'. 2430 // 2431 // Additional information available from 'go env' but not read from the environment: 2432 // 2433 // GOEXE 2434 // The executable file name suffix (".exe" on Windows, "" on other systems). 2435 // GOGCCFLAGS 2436 // A space-separated list of arguments supplied to the CC command. 2437 // GOHOSTARCH 2438 // The architecture (GOARCH) of the Go toolchain binaries. 2439 // GOHOSTOS 2440 // The operating system (GOOS) of the Go toolchain binaries. 2441 // GOMOD 2442 // The absolute path to the go.mod of the main module. 2443 // If module-aware mode is enabled, but there is no go.mod, GOMOD will be 2444 // os.DevNull ("/dev/null" on Unix-like systems, "NUL" on Windows). 2445 // If module-aware mode is disabled, GOMOD will be the empty string. 2446 // GOTOOLDIR 2447 // The directory where the go tools (compile, cover, doc, etc...) are installed. 2448 // GOVERSION 2449 // The version of the installed Go tree, as reported by runtime.Version. 2450 // 2451 // # File types 2452 // 2453 // The go command examines the contents of a restricted set of files 2454 // in each directory. It identifies which files to examine based on 2455 // the extension of the file name. These extensions are: 2456 // 2457 // .go 2458 // Go source files. 2459 // .c, .h 2460 // C source files. 2461 // If the package uses cgo or SWIG, these will be compiled with the 2462 // OS-native compiler (typically gcc); otherwise they will 2463 // trigger an error. 2464 // .cc, .cpp, .cxx, .hh, .hpp, .hxx 2465 // C++ source files. Only useful with cgo or SWIG, and always 2466 // compiled with the OS-native compiler. 2467 // .m 2468 // Objective-C source files. Only useful with cgo, and always 2469 // compiled with the OS-native compiler. 2470 // .s, .S, .sx 2471 // Assembler source files. 2472 // If the package uses cgo or SWIG, these will be assembled with the 2473 // OS-native assembler (typically gcc (sic)); otherwise they 2474 // will be assembled with the Go assembler. 2475 // .swig, .swigcxx 2476 // SWIG definition files. 2477 // .syso 2478 // System object files. 2479 // 2480 // Files of each of these types except .syso may contain build 2481 // constraints, but the go command stops scanning for build constraints 2482 // at the first item in the file that is not a blank line or //-style 2483 // line comment. See the go/build package documentation for 2484 // more details. 2485 // 2486 // # The go.mod file 2487 // 2488 // A module version is defined by a tree of source files, with a go.mod 2489 // file in its root. When the go command is run, it looks in the current 2490 // directory and then successive parent directories to find the go.mod 2491 // marking the root of the main (current) module. 2492 // 2493 // The go.mod file format is described in detail at 2494 // https://golang.org/ref/mod#go-mod-file. 2495 // 2496 // To create a new go.mod file, use 'go mod init'. For details see 2497 // 'go help mod init' or https://golang.org/ref/mod#go-mod-init. 2498 // 2499 // To add missing module requirements or remove unneeded requirements, 2500 // use 'go mod tidy'. For details, see 'go help mod tidy' or 2501 // https://golang.org/ref/mod#go-mod-tidy. 2502 // 2503 // To add, upgrade, downgrade, or remove a specific module requirement, use 2504 // 'go get'. For details, see 'go help module-get' or 2505 // https://golang.org/ref/mod#go-get. 2506 // 2507 // To make other changes or to parse go.mod as JSON for use by other tools, 2508 // use 'go mod edit'. See 'go help mod edit' or 2509 // https://golang.org/ref/mod#go-mod-edit. 2510 // 2511 // # GOPATH environment variable 2512 // 2513 // The Go path is used to resolve import statements. 2514 // It is implemented by and documented in the go/build package. 2515 // 2516 // The GOPATH environment variable lists places to look for Go code. 2517 // On Unix, the value is a colon-separated string. 2518 // On Windows, the value is a semicolon-separated string. 2519 // On Plan 9, the value is a list. 2520 // 2521 // If the environment variable is unset, GOPATH defaults 2522 // to a subdirectory named "go" in the user's home directory 2523 // ($HOME/go on Unix, %USERPROFILE%\go on Windows), 2524 // unless that directory holds a Go distribution. 2525 // Run "go env GOPATH" to see the current GOPATH. 2526 // 2527 // See https://golang.org/wiki/SettingGOPATH to set a custom GOPATH. 2528 // 2529 // Each directory listed in GOPATH must have a prescribed structure: 2530 // 2531 // The src directory holds source code. The path below src 2532 // determines the import path or executable name. 2533 // 2534 // The pkg directory holds installed package objects. 2535 // As in the Go tree, each target operating system and 2536 // architecture pair has its own subdirectory of pkg 2537 // (pkg/GOOS_GOARCH). 2538 // 2539 // If DIR is a directory listed in the GOPATH, a package with 2540 // source in DIR/src/foo/bar can be imported as "foo/bar" and 2541 // has its compiled form installed to "DIR/pkg/GOOS_GOARCH/foo/bar.a". 2542 // 2543 // The bin directory holds compiled commands. 2544 // Each command is named for its source directory, but only 2545 // the final element, not the entire path. That is, the 2546 // command with source in DIR/src/foo/quux is installed into 2547 // DIR/bin/quux, not DIR/bin/foo/quux. The "foo/" prefix is stripped 2548 // so that you can add DIR/bin to your PATH to get at the 2549 // installed commands. If the GOBIN environment variable is 2550 // set, commands are installed to the directory it names instead 2551 // of DIR/bin. GOBIN must be an absolute path. 2552 // 2553 // Here's an example directory layout: 2554 // 2555 // GOPATH=/home/user/go 2556 // 2557 // /home/user/go/ 2558 // src/ 2559 // foo/ 2560 // bar/ (go code in package bar) 2561 // x.go 2562 // quux/ (go code in package main) 2563 // y.go 2564 // bin/ 2565 // quux (installed command) 2566 // pkg/ 2567 // linux_amd64/ 2568 // foo/ 2569 // bar.a (installed package object) 2570 // 2571 // Go searches each directory listed in GOPATH to find source code, 2572 // but new packages are always downloaded into the first directory 2573 // in the list. 2574 // 2575 // See https://golang.org/doc/code.html for an example. 2576 // 2577 // # GOPATH and Modules 2578 // 2579 // When using modules, GOPATH is no longer used for resolving imports. 2580 // However, it is still used to store downloaded source code (in GOPATH/pkg/mod) 2581 // and compiled commands (in GOPATH/bin). 2582 // 2583 // # Internal Directories 2584 // 2585 // Code in or below a directory named "internal" is importable only 2586 // by code in the directory tree rooted at the parent of "internal". 2587 // Here's an extended version of the directory layout above: 2588 // 2589 // /home/user/go/ 2590 // src/ 2591 // crash/ 2592 // bang/ (go code in package bang) 2593 // b.go 2594 // foo/ (go code in package foo) 2595 // f.go 2596 // bar/ (go code in package bar) 2597 // x.go 2598 // internal/ 2599 // baz/ (go code in package baz) 2600 // z.go 2601 // quux/ (go code in package main) 2602 // y.go 2603 // 2604 // The code in z.go is imported as "foo/internal/baz", but that 2605 // import statement can only appear in source files in the subtree 2606 // rooted at foo. The source files foo/f.go, foo/bar/x.go, and 2607 // foo/quux/y.go can all import "foo/internal/baz", but the source file 2608 // crash/bang/b.go cannot. 2609 // 2610 // See https://golang.org/s/go14internal for details. 2611 // 2612 // # Vendor Directories 2613 // 2614 // Go 1.6 includes support for using local copies of external dependencies 2615 // to satisfy imports of those dependencies, often referred to as vendoring. 2616 // 2617 // Code below a directory named "vendor" is importable only 2618 // by code in the directory tree rooted at the parent of "vendor", 2619 // and only using an import path that omits the prefix up to and 2620 // including the vendor element. 2621 // 2622 // Here's the example from the previous section, 2623 // but with the "internal" directory renamed to "vendor" 2624 // and a new foo/vendor/crash/bang directory added: 2625 // 2626 // /home/user/go/ 2627 // src/ 2628 // crash/ 2629 // bang/ (go code in package bang) 2630 // b.go 2631 // foo/ (go code in package foo) 2632 // f.go 2633 // bar/ (go code in package bar) 2634 // x.go 2635 // vendor/ 2636 // crash/ 2637 // bang/ (go code in package bang) 2638 // b.go 2639 // baz/ (go code in package baz) 2640 // z.go 2641 // quux/ (go code in package main) 2642 // y.go 2643 // 2644 // The same visibility rules apply as for internal, but the code 2645 // in z.go is imported as "baz", not as "foo/vendor/baz". 2646 // 2647 // Code in vendor directories deeper in the source tree shadows 2648 // code in higher directories. Within the subtree rooted at foo, an import 2649 // of "crash/bang" resolves to "foo/vendor/crash/bang", not the 2650 // top-level "crash/bang". 2651 // 2652 // Code in vendor directories is not subject to import path 2653 // checking (see 'go help importpath'). 2654 // 2655 // When 'go get' checks out or updates a git repository, it now also 2656 // updates submodules. 2657 // 2658 // Vendor directories do not affect the placement of new repositories 2659 // being checked out for the first time by 'go get': those are always 2660 // placed in the main GOPATH, never in a vendor subtree. 2661 // 2662 // See https://golang.org/s/go15vendor for details. 2663 // 2664 // # Module proxy protocol 2665 // 2666 // A Go module proxy is any web server that can respond to GET requests for 2667 // URLs of a specified form. The requests have no query parameters, so even 2668 // a site serving from a fixed file system (including a file:/// URL) 2669 // can be a module proxy. 2670 // 2671 // For details on the GOPROXY protocol, see 2672 // https://golang.org/ref/mod#goproxy-protocol. 2673 // 2674 // # Import path syntax 2675 // 2676 // An import path (see 'go help packages') denotes a package stored in the local 2677 // file system. In general, an import path denotes either a standard package (such 2678 // as "unicode/utf8") or a package found in one of the work spaces (For more 2679 // details see: 'go help gopath'). 2680 // 2681 // # Relative import paths 2682 // 2683 // An import path beginning with ./ or ../ is called a relative path. 2684 // The toolchain supports relative import paths as a shortcut in two ways. 2685 // 2686 // First, a relative path can be used as a shorthand on the command line. 2687 // If you are working in the directory containing the code imported as 2688 // "unicode" and want to run the tests for "unicode/utf8", you can type 2689 // "go test ./utf8" instead of needing to specify the full path. 2690 // Similarly, in the reverse situation, "go test .." will test "unicode" from 2691 // the "unicode/utf8" directory. Relative patterns are also allowed, like 2692 // "go test ./..." to test all subdirectories. See 'go help packages' for details 2693 // on the pattern syntax. 2694 // 2695 // Second, if you are compiling a Go program not in a work space, 2696 // you can use a relative path in an import statement in that program 2697 // to refer to nearby code also not in a work space. 2698 // This makes it easy to experiment with small multipackage programs 2699 // outside of the usual work spaces, but such programs cannot be 2700 // installed with "go install" (there is no work space in which to install them), 2701 // so they are rebuilt from scratch each time they are built. 2702 // To avoid ambiguity, Go programs cannot use relative import paths 2703 // within a work space. 2704 // 2705 // # Remote import paths 2706 // 2707 // Certain import paths also 2708 // describe how to obtain the source code for the package using 2709 // a revision control system. 2710 // 2711 // A few common code hosting sites have special syntax: 2712 // 2713 // Bitbucket (Git, Mercurial) 2714 // 2715 // import "bitbucket.org/user/project" 2716 // import "bitbucket.org/user/project/sub/directory" 2717 // 2718 // GitHub (Git) 2719 // 2720 // import "github.com/user/project" 2721 // import "github.com/user/project/sub/directory" 2722 // 2723 // Launchpad (Bazaar) 2724 // 2725 // import "launchpad.net/project" 2726 // import "launchpad.net/project/series" 2727 // import "launchpad.net/project/series/sub/directory" 2728 // 2729 // import "launchpad.net/~user/project/branch" 2730 // import "launchpad.net/~user/project/branch/sub/directory" 2731 // 2732 // IBM DevOps Services (Git) 2733 // 2734 // import "hub.jazz.net/git/user/project" 2735 // import "hub.jazz.net/git/user/project/sub/directory" 2736 // 2737 // For code hosted on other servers, import paths may either be qualified 2738 // with the version control type, or the go tool can dynamically fetch 2739 // the import path over https/http and discover where the code resides 2740 // from a <meta> tag in the HTML. 2741 // 2742 // To declare the code location, an import path of the form 2743 // 2744 // repository.vcs/path 2745 // 2746 // specifies the given repository, with or without the .vcs suffix, 2747 // using the named version control system, and then the path inside 2748 // that repository. The supported version control systems are: 2749 // 2750 // Bazaar .bzr 2751 // Fossil .fossil 2752 // Git .git 2753 // Mercurial .hg 2754 // Subversion .svn 2755 // 2756 // For example, 2757 // 2758 // import "example.org/user/foo.hg" 2759 // 2760 // denotes the root directory of the Mercurial repository at 2761 // example.org/user/foo or foo.hg, and 2762 // 2763 // import "example.org/repo.git/foo/bar" 2764 // 2765 // denotes the foo/bar directory of the Git repository at 2766 // example.org/repo or repo.git. 2767 // 2768 // When a version control system supports multiple protocols, 2769 // each is tried in turn when downloading. For example, a Git 2770 // download tries https://, then git+ssh://. 2771 // 2772 // By default, downloads are restricted to known secure protocols 2773 // (e.g. https, ssh). To override this setting for Git downloads, the 2774 // GIT_ALLOW_PROTOCOL environment variable can be set (For more details see: 2775 // 'go help environment'). 2776 // 2777 // If the import path is not a known code hosting site and also lacks a 2778 // version control qualifier, the go tool attempts to fetch the import 2779 // over https/http and looks for a <meta> tag in the document's HTML 2780 // <head>. 2781 // 2782 // The meta tag has the form: 2783 // 2784 // <meta name="go-import" content="import-prefix vcs repo-root"> 2785 // 2786 // The import-prefix is the import path corresponding to the repository 2787 // root. It must be a prefix or an exact match of the package being 2788 // fetched with "go get". If it's not an exact match, another http 2789 // request is made at the prefix to verify the <meta> tags match. 2790 // 2791 // The meta tag should appear as early in the file as possible. 2792 // In particular, it should appear before any raw JavaScript or CSS, 2793 // to avoid confusing the go command's restricted parser. 2794 // 2795 // The vcs is one of "bzr", "fossil", "git", "hg", "svn". 2796 // 2797 // The repo-root is the root of the version control system 2798 // containing a scheme and not containing a .vcs qualifier. 2799 // 2800 // For example, 2801 // 2802 // import "example.org/pkg/foo" 2803 // 2804 // will result in the following requests: 2805 // 2806 // https://example.org/pkg/foo?go-get=1 (preferred) 2807 // http://example.org/pkg/foo?go-get=1 (fallback, only with use of correctly set GOINSECURE) 2808 // 2809 // If that page contains the meta tag 2810 // 2811 // <meta name="go-import" content="example.org git https://code.org/r/p/exproj"> 2812 // 2813 // the go tool will verify that https://example.org/?go-get=1 contains the 2814 // same meta tag and then git clone https://code.org/r/p/exproj into 2815 // GOPATH/src/example.org. 2816 // 2817 // When using GOPATH, downloaded packages are written to the first directory 2818 // listed in the GOPATH environment variable. 2819 // (See 'go help gopath-get' and 'go help gopath'.) 2820 // 2821 // When using modules, downloaded packages are stored in the module cache. 2822 // See https://golang.org/ref/mod#module-cache. 2823 // 2824 // When using modules, an additional variant of the go-import meta tag is 2825 // recognized and is preferred over those listing version control systems. 2826 // That variant uses "mod" as the vcs in the content value, as in: 2827 // 2828 // <meta name="go-import" content="example.org mod https://code.org/moduleproxy"> 2829 // 2830 // This tag means to fetch modules with paths beginning with example.org 2831 // from the module proxy available at the URL https://code.org/moduleproxy. 2832 // See https://golang.org/ref/mod#goproxy-protocol for details about the 2833 // proxy protocol. 2834 // 2835 // # Import path checking 2836 // 2837 // When the custom import path feature described above redirects to a 2838 // known code hosting site, each of the resulting packages has two possible 2839 // import paths, using the custom domain or the known hosting site. 2840 // 2841 // A package statement is said to have an "import comment" if it is immediately 2842 // followed (before the next newline) by a comment of one of these two forms: 2843 // 2844 // package math // import "path" 2845 // package math /* import "path" */ 2846 // 2847 // The go command will refuse to install a package with an import comment 2848 // unless it is being referred to by that import path. In this way, import comments 2849 // let package authors make sure the custom import path is used and not a 2850 // direct path to the underlying code hosting site. 2851 // 2852 // Import path checking is disabled for code found within vendor trees. 2853 // This makes it possible to copy code into alternate locations in vendor trees 2854 // without needing to update import comments. 2855 // 2856 // Import path checking is also disabled when using modules. 2857 // Import path comments are obsoleted by the go.mod file's module statement. 2858 // 2859 // See https://golang.org/s/go14customimport for details. 2860 // 2861 // # Modules, module versions, and more 2862 // 2863 // Modules are how Go manages dependencies. 2864 // 2865 // A module is a collection of packages that are released, versioned, and 2866 // distributed together. Modules may be downloaded directly from version control 2867 // repositories or from module proxy servers. 2868 // 2869 // For a series of tutorials on modules, see 2870 // https://golang.org/doc/tutorial/create-module. 2871 // 2872 // For a detailed reference on modules, see https://golang.org/ref/mod. 2873 // 2874 // By default, the go command may download modules from https://proxy.golang.org. 2875 // It may authenticate modules using the checksum database at 2876 // https://sum.golang.org. Both services are operated by the Go team at Google. 2877 // The privacy policies for these services are available at 2878 // https://proxy.golang.org/privacy and https://sum.golang.org/privacy, 2879 // respectively. 2880 // 2881 // The go command's download behavior may be configured using GOPROXY, GOSUMDB, 2882 // GOPRIVATE, and other environment variables. See 'go help environment' 2883 // and https://golang.org/ref/mod#private-module-privacy for more information. 2884 // 2885 // # Module authentication using go.sum 2886 // 2887 // When the go command downloads a module zip file or go.mod file into the 2888 // module cache, it computes a cryptographic hash and compares it with a known 2889 // value to verify the file hasn't changed since it was first downloaded. Known 2890 // hashes are stored in a file in the module root directory named go.sum. Hashes 2891 // may also be downloaded from the checksum database depending on the values of 2892 // GOSUMDB, GOPRIVATE, and GONOSUMDB. 2893 // 2894 // For details, see https://golang.org/ref/mod#authenticating. 2895 // 2896 // # Package lists and patterns 2897 // 2898 // Many commands apply to a set of packages: 2899 // 2900 // go <action> [packages] 2901 // 2902 // Usually, [packages] is a list of import paths. 2903 // 2904 // An import path that is a rooted path or that begins with 2905 // a . or .. element is interpreted as a file system path and 2906 // denotes the package in that directory. 2907 // 2908 // Otherwise, the import path P denotes the package found in 2909 // the directory DIR/src/P for some DIR listed in the GOPATH 2910 // environment variable (For more details see: 'go help gopath'). 2911 // 2912 // If no import paths are given, the action applies to the 2913 // package in the current directory. 2914 // 2915 // There are four reserved names for paths that should not be used 2916 // for packages to be built with the go tool: 2917 // 2918 // - "main" denotes the top-level package in a stand-alone executable. 2919 // 2920 // - "all" expands to all packages found in all the GOPATH 2921 // trees. For example, 'go list all' lists all the packages on the local 2922 // system. When using modules, "all" expands to all packages in 2923 // the main module and their dependencies, including dependencies 2924 // needed by tests of any of those. 2925 // 2926 // - "std" is like all but expands to just the packages in the standard 2927 // Go library. 2928 // 2929 // - "cmd" expands to the Go repository's commands and their 2930 // internal libraries. 2931 // 2932 // Import paths beginning with "cmd/" only match source code in 2933 // the Go repository. 2934 // 2935 // An import path is a pattern if it includes one or more "..." wildcards, 2936 // each of which can match any string, including the empty string and 2937 // strings containing slashes. Such a pattern expands to all package 2938 // directories found in the GOPATH trees with names matching the 2939 // patterns. 2940 // 2941 // To make common patterns more convenient, there are two special cases. 2942 // First, /... at the end of the pattern can match an empty string, 2943 // so that net/... matches both net and packages in its subdirectories, like net/http. 2944 // Second, any slash-separated pattern element containing a wildcard never 2945 // participates in a match of the "vendor" element in the path of a vendored 2946 // package, so that ./... does not match packages in subdirectories of 2947 // ./vendor or ./mycode/vendor, but ./vendor/... and ./mycode/vendor/... do. 2948 // Note, however, that a directory named vendor that itself contains code 2949 // is not a vendored package: cmd/vendor would be a command named vendor, 2950 // and the pattern cmd/... matches it. 2951 // See golang.org/s/go15vendor for more about vendoring. 2952 // 2953 // An import path can also name a package to be downloaded from 2954 // a remote repository. Run 'go help importpath' for details. 2955 // 2956 // Every package in a program must have a unique import path. 2957 // By convention, this is arranged by starting each path with a 2958 // unique prefix that belongs to you. For example, paths used 2959 // internally at Google all begin with 'google', and paths 2960 // denoting remote repositories begin with the path to the code, 2961 // such as 'github.com/user/repo'. 2962 // 2963 // Packages in a program need not have unique package names, 2964 // but there are two reserved package names with special meaning. 2965 // The name main indicates a command, not a library. 2966 // Commands are built into binaries and cannot be imported. 2967 // The name documentation indicates documentation for 2968 // a non-Go program in the directory. Files in package documentation 2969 // are ignored by the go command. 2970 // 2971 // As a special case, if the package list is a list of .go files from a 2972 // single directory, the command is applied to a single synthesized 2973 // package made up of exactly those files, ignoring any build constraints 2974 // in those files and ignoring any other files in the directory. 2975 // 2976 // Directory and file names that begin with "." or "_" are ignored 2977 // by the go tool, as are directories named "testdata". 2978 // 2979 // # Configuration for downloading non-public code 2980 // 2981 // The go command defaults to downloading modules from the public Go module 2982 // mirror at proxy.golang.org. It also defaults to validating downloaded modules, 2983 // regardless of source, against the public Go checksum database at sum.golang.org. 2984 // These defaults work well for publicly available source code. 2985 // 2986 // The GOPRIVATE environment variable controls which modules the go command 2987 // considers to be private (not available publicly) and should therefore not use 2988 // the proxy or checksum database. The variable is a comma-separated list of 2989 // glob patterns (in the syntax of Go's path.Match) of module path prefixes. 2990 // For example, 2991 // 2992 // GOPRIVATE=*.corp.example.com,rsc.io/private 2993 // 2994 // causes the go command to treat as private any module with a path prefix 2995 // matching either pattern, including git.corp.example.com/xyzzy, rsc.io/private, 2996 // and rsc.io/private/quux. 2997 // 2998 // For fine-grained control over module download and validation, the GONOPROXY 2999 // and GONOSUMDB environment variables accept the same kind of glob list 3000 // and override GOPRIVATE for the specific decision of whether to use the proxy 3001 // and checksum database, respectively. 3002 // 3003 // For example, if a company ran a module proxy serving private modules, 3004 // users would configure go using: 3005 // 3006 // GOPRIVATE=*.corp.example.com 3007 // GOPROXY=proxy.example.com 3008 // GONOPROXY=none 3009 // 3010 // The GOPRIVATE variable is also used to define the "public" and "private" 3011 // patterns for the GOVCS variable; see 'go help vcs'. For that usage, 3012 // GOPRIVATE applies even in GOPATH mode. In that case, it matches import paths 3013 // instead of module paths. 3014 // 3015 // The 'go env -w' command (see 'go help env') can be used to set these variables 3016 // for future go command invocations. 3017 // 3018 // For more details, see https://golang.org/ref/mod#private-modules. 3019 // 3020 // # Testing flags 3021 // 3022 // The 'go test' command takes both flags that apply to 'go test' itself 3023 // and flags that apply to the resulting test binary. 3024 // 3025 // Several of the flags control profiling and write an execution profile 3026 // suitable for "go tool pprof"; run "go tool pprof -h" for more 3027 // information. The --alloc_space, --alloc_objects, and --show_bytes 3028 // options of pprof control how the information is presented. 3029 // 3030 // The following flags are recognized by the 'go test' command and 3031 // control the execution of any test: 3032 // 3033 // -bench regexp 3034 // Run only those benchmarks matching a regular expression. 3035 // By default, no benchmarks are run. 3036 // To run all benchmarks, use '-bench .' or '-bench=.'. 3037 // The regular expression is split by unbracketed slash (/) 3038 // characters into a sequence of regular expressions, and each 3039 // part of a benchmark's identifier must match the corresponding 3040 // element in the sequence, if any. Possible parents of matches 3041 // are run with b.N=1 to identify sub-benchmarks. For example, 3042 // given -bench=X/Y, top-level benchmarks matching X are run 3043 // with b.N=1 to find any sub-benchmarks matching Y, which are 3044 // then run in full. 3045 // 3046 // -benchtime t 3047 // Run enough iterations of each benchmark to take t, specified 3048 // as a time.Duration (for example, -benchtime 1h30s). 3049 // The default is 1 second (1s). 3050 // The special syntax Nx means to run the benchmark N times 3051 // (for example, -benchtime 100x). 3052 // 3053 // -count n 3054 // Run each test, benchmark, and fuzz seed n times (default 1). 3055 // If -cpu is set, run n times for each GOMAXPROCS value. 3056 // Examples are always run once. -count does not apply to 3057 // fuzz tests matched by -fuzz. 3058 // 3059 // -cover 3060 // Enable coverage analysis. 3061 // Note that because coverage works by annotating the source 3062 // code before compilation, compilation and test failures with 3063 // coverage enabled may report line numbers that don't correspond 3064 // to the original sources. 3065 // 3066 // -covermode set,count,atomic 3067 // Set the mode for coverage analysis for the package[s] 3068 // being tested. The default is "set" unless -race is enabled, 3069 // in which case it is "atomic". 3070 // The values: 3071 // set: bool: does this statement run? 3072 // count: int: how many times does this statement run? 3073 // atomic: int: count, but correct in multithreaded tests; 3074 // significantly more expensive. 3075 // Sets -cover. 3076 // 3077 // -coverpkg pattern1,pattern2,pattern3 3078 // Apply coverage analysis in each test to packages matching the patterns. 3079 // The default is for each test to analyze only the package being tested. 3080 // See 'go help packages' for a description of package patterns. 3081 // Sets -cover. 3082 // 3083 // -cpu 1,2,4 3084 // Specify a list of GOMAXPROCS values for which the tests, benchmarks or 3085 // fuzz tests should be executed. The default is the current value 3086 // of GOMAXPROCS. -cpu does not apply to fuzz tests matched by -fuzz. 3087 // 3088 // -failfast 3089 // Do not start new tests after the first test failure. 3090 // 3091 // -fullpath 3092 // Show full file names in the error messages. 3093 // 3094 // -fuzz regexp 3095 // Run the fuzz test matching the regular expression. When specified, 3096 // the command line argument must match exactly one package within the 3097 // main module, and regexp must match exactly one fuzz test within 3098 // that package. Fuzzing will occur after tests, benchmarks, seed corpora 3099 // of other fuzz tests, and examples have completed. See the Fuzzing 3100 // section of the testing package documentation for details. 3101 // 3102 // -fuzztime t 3103 // Run enough iterations of the fuzz target during fuzzing to take t, 3104 // specified as a time.Duration (for example, -fuzztime 1h30s). 3105 // The default is to run forever. 3106 // The special syntax Nx means to run the fuzz target N times 3107 // (for example, -fuzztime 1000x). 3108 // 3109 // -fuzzminimizetime t 3110 // Run enough iterations of the fuzz target during each minimization 3111 // attempt to take t, as specified as a time.Duration (for example, 3112 // -fuzzminimizetime 30s). 3113 // The default is 60s. 3114 // The special syntax Nx means to run the fuzz target N times 3115 // (for example, -fuzzminimizetime 100x). 3116 // 3117 // -json 3118 // Log verbose output and test results in JSON. This presents the 3119 // same information as the -v flag in a machine-readable format. 3120 // 3121 // -list regexp 3122 // List tests, benchmarks, fuzz tests, or examples matching the regular 3123 // expression. No tests, benchmarks, fuzz tests, or examples will be run. 3124 // This will only list top-level tests. No subtest or subbenchmarks will be 3125 // shown. 3126 // 3127 // -parallel n 3128 // Allow parallel execution of test functions that call t.Parallel, and 3129 // fuzz targets that call t.Parallel when running the seed corpus. 3130 // The value of this flag is the maximum number of tests to run 3131 // simultaneously. 3132 // While fuzzing, the value of this flag is the maximum number of 3133 // subprocesses that may call the fuzz function simultaneously, regardless of 3134 // whether T.Parallel is called. 3135 // By default, -parallel is set to the value of GOMAXPROCS. 3136 // Setting -parallel to values higher than GOMAXPROCS may cause degraded 3137 // performance due to CPU contention, especially when fuzzing. 3138 // Note that -parallel only applies within a single test binary. 3139 // The 'go test' command may run tests for different packages 3140 // in parallel as well, according to the setting of the -p flag 3141 // (see 'go help build'). 3142 // 3143 // -run regexp 3144 // Run only those tests, examples, and fuzz tests matching the regular 3145 // expression. For tests, the regular expression is split by unbracketed 3146 // slash (/) characters into a sequence of regular expressions, and each 3147 // part of a test's identifier must match the corresponding element in 3148 // the sequence, if any. Note that possible parents of matches are 3149 // run too, so that -run=X/Y matches and runs and reports the result 3150 // of all tests matching X, even those without sub-tests matching Y, 3151 // because it must run them to look for those sub-tests. 3152 // See also -skip. 3153 // 3154 // -short 3155 // Tell long-running tests to shorten their run time. 3156 // It is off by default but set during all.bash so that installing 3157 // the Go tree can run a sanity check but not spend time running 3158 // exhaustive tests. 3159 // 3160 // -shuffle off,on,N 3161 // Randomize the execution order of tests and benchmarks. 3162 // It is off by default. If -shuffle is set to on, then it will seed 3163 // the randomizer using the system clock. If -shuffle is set to an 3164 // integer N, then N will be used as the seed value. In both cases, 3165 // the seed will be reported for reproducibility. 3166 // 3167 // -skip regexp 3168 // Run only those tests, examples, fuzz tests, and benchmarks that 3169 // do not match the regular expression. Like for -run and -bench, 3170 // for tests and benchmarks, the regular expression is split by unbracketed 3171 // slash (/) characters into a sequence of regular expressions, and each 3172 // part of a test's identifier must match the corresponding element in 3173 // the sequence, if any. 3174 // 3175 // -timeout d 3176 // If a test binary runs longer than duration d, panic. 3177 // If d is 0, the timeout is disabled. 3178 // The default is 10 minutes (10m). 3179 // 3180 // -v 3181 // Verbose output: log all tests as they are run. Also print all 3182 // text from Log and Logf calls even if the test succeeds. 3183 // 3184 // -vet list 3185 // Configure the invocation of "go vet" during "go test" 3186 // to use the comma-separated list of vet checks. 3187 // If list is empty, "go test" runs "go vet" with a curated list of 3188 // checks believed to be always worth addressing. 3189 // If list is "off", "go test" does not run "go vet" at all. 3190 // 3191 // The following flags are also recognized by 'go test' and can be used to 3192 // profile the tests during execution: 3193 // 3194 // -benchmem 3195 // Print memory allocation statistics for benchmarks. 3196 // Allocations made in C or using C.malloc are not counted. 3197 // 3198 // -blockprofile block.out 3199 // Write a goroutine blocking profile to the specified file 3200 // when all tests are complete. 3201 // Writes test binary as -c would. 3202 // 3203 // -blockprofilerate n 3204 // Control the detail provided in goroutine blocking profiles by 3205 // calling runtime.SetBlockProfileRate with n. 3206 // See 'go doc runtime.SetBlockProfileRate'. 3207 // The profiler aims to sample, on average, one blocking event every 3208 // n nanoseconds the program spends blocked. By default, 3209 // if -test.blockprofile is set without this flag, all blocking events 3210 // are recorded, equivalent to -test.blockprofilerate=1. 3211 // 3212 // -coverprofile cover.out 3213 // Write a coverage profile to the file after all tests have passed. 3214 // Sets -cover. 3215 // 3216 // -cpuprofile cpu.out 3217 // Write a CPU profile to the specified file before exiting. 3218 // Writes test binary as -c would. 3219 // 3220 // -memprofile mem.out 3221 // Write an allocation profile to the file after all tests have passed. 3222 // Writes test binary as -c would. 3223 // 3224 // -memprofilerate n 3225 // Enable more precise (and expensive) memory allocation profiles by 3226 // setting runtime.MemProfileRate. See 'go doc runtime.MemProfileRate'. 3227 // To profile all memory allocations, use -test.memprofilerate=1. 3228 // 3229 // -mutexprofile mutex.out 3230 // Write a mutex contention profile to the specified file 3231 // when all tests are complete. 3232 // Writes test binary as -c would. 3233 // 3234 // -mutexprofilefraction n 3235 // Sample 1 in n stack traces of goroutines holding a 3236 // contended mutex. 3237 // 3238 // -outputdir directory 3239 // Place output files from profiling in the specified directory, 3240 // by default the directory in which "go test" is running. 3241 // 3242 // -trace trace.out 3243 // Write an execution trace to the specified file before exiting. 3244 // 3245 // Each of these flags is also recognized with an optional 'test.' prefix, 3246 // as in -test.v. When invoking the generated test binary (the result of 3247 // 'go test -c') directly, however, the prefix is mandatory. 3248 // 3249 // The 'go test' command rewrites or removes recognized flags, 3250 // as appropriate, both before and after the optional package list, 3251 // before invoking the test binary. 3252 // 3253 // For instance, the command 3254 // 3255 // go test -v -myflag testdata -cpuprofile=prof.out -x 3256 // 3257 // will compile the test binary and then run it as 3258 // 3259 // pkg.test -test.v -myflag testdata -test.cpuprofile=prof.out 3260 // 3261 // (The -x flag is removed because it applies only to the go command's 3262 // execution, not to the test itself.) 3263 // 3264 // The test flags that generate profiles (other than for coverage) also 3265 // leave the test binary in pkg.test for use when analyzing the profiles. 3266 // 3267 // When 'go test' runs a test binary, it does so from within the 3268 // corresponding package's source code directory. Depending on the test, 3269 // it may be necessary to do the same when invoking a generated test 3270 // binary directly. Because that directory may be located within the 3271 // module cache, which may be read-only and is verified by checksums, the 3272 // test must not write to it or any other directory within the module 3273 // unless explicitly requested by the user (such as with the -fuzz flag, 3274 // which writes failures to testdata/fuzz). 3275 // 3276 // The command-line package list, if present, must appear before any 3277 // flag not known to the go test command. Continuing the example above, 3278 // the package list would have to appear before -myflag, but could appear 3279 // on either side of -v. 3280 // 3281 // When 'go test' runs in package list mode, 'go test' caches successful 3282 // package test results to avoid unnecessary repeated running of tests. To 3283 // disable test caching, use any test flag or argument other than the 3284 // cacheable flags. The idiomatic way to disable test caching explicitly 3285 // is to use -count=1. 3286 // 3287 // To keep an argument for a test binary from being interpreted as a 3288 // known flag or a package name, use -args (see 'go help test') which 3289 // passes the remainder of the command line through to the test binary 3290 // uninterpreted and unaltered. 3291 // 3292 // For instance, the command 3293 // 3294 // go test -v -args -x -v 3295 // 3296 // will compile the test binary and then run it as 3297 // 3298 // pkg.test -test.v -x -v 3299 // 3300 // Similarly, 3301 // 3302 // go test -args math 3303 // 3304 // will compile the test binary and then run it as 3305 // 3306 // pkg.test math 3307 // 3308 // In the first example, the -x and the second -v are passed through to the 3309 // test binary unchanged and with no effect on the go command itself. 3310 // In the second example, the argument math is passed through to the test 3311 // binary, instead of being interpreted as the package list. 3312 // 3313 // # Testing functions 3314 // 3315 // The 'go test' command expects to find test, benchmark, and example functions 3316 // in the "*_test.go" files corresponding to the package under test. 3317 // 3318 // A test function is one named TestXxx (where Xxx does not start with a 3319 // lower case letter) and should have the signature, 3320 // 3321 // func TestXxx(t *testing.T) { ... } 3322 // 3323 // A benchmark function is one named BenchmarkXxx and should have the signature, 3324 // 3325 // func BenchmarkXxx(b *testing.B) { ... } 3326 // 3327 // A fuzz test is one named FuzzXxx and should have the signature, 3328 // 3329 // func FuzzXxx(f *testing.F) { ... } 3330 // 3331 // An example function is similar to a test function but, instead of using 3332 // *testing.T to report success or failure, prints output to os.Stdout. 3333 // If the last comment in the function starts with "Output:" then the output 3334 // is compared exactly against the comment (see examples below). If the last 3335 // comment begins with "Unordered output:" then the output is compared to the 3336 // comment, however the order of the lines is ignored. An example with no such 3337 // comment is compiled but not executed. An example with no text after 3338 // "Output:" is compiled, executed, and expected to produce no output. 3339 // 3340 // Godoc displays the body of ExampleXxx to demonstrate the use 3341 // of the function, constant, or variable Xxx. An example of a method M with 3342 // receiver type T or *T is named ExampleT_M. There may be multiple examples 3343 // for a given function, constant, or variable, distinguished by a trailing _xxx, 3344 // where xxx is a suffix not beginning with an upper case letter. 3345 // 3346 // Here is an example of an example: 3347 // 3348 // func ExamplePrintln() { 3349 // Println("The output of\nthis example.") 3350 // // Output: The output of 3351 // // this example. 3352 // } 3353 // 3354 // Here is another example where the ordering of the output is ignored: 3355 // 3356 // func ExamplePerm() { 3357 // for _, value := range Perm(4) { 3358 // fmt.Println(value) 3359 // } 3360 // 3361 // // Unordered output: 4 3362 // // 2 3363 // // 1 3364 // // 3 3365 // // 0 3366 // } 3367 // 3368 // The entire test file is presented as the example when it contains a single 3369 // example function, at least one other function, type, variable, or constant 3370 // declaration, and no tests, benchmarks, or fuzz tests. 3371 // 3372 // See the documentation of the testing package for more information. 3373 // 3374 // # Controlling version control with GOVCS 3375 // 3376 // The 'go get' command can run version control commands like git 3377 // to download imported code. This functionality is critical to the decentralized 3378 // Go package ecosystem, in which code can be imported from any server, 3379 // but it is also a potential security problem, if a malicious server finds a 3380 // way to cause the invoked version control command to run unintended code. 3381 // 3382 // To balance the functionality and security concerns, the 'go get' command 3383 // by default will only use git and hg to download code from public servers. 3384 // But it will use any known version control system (bzr, fossil, git, hg, svn) 3385 // to download code from private servers, defined as those hosting packages 3386 // matching the GOPRIVATE variable (see 'go help private'). The rationale behind 3387 // allowing only Git and Mercurial is that these two systems have had the most 3388 // attention to issues of being run as clients of untrusted servers. In contrast, 3389 // Bazaar, Fossil, and Subversion have primarily been used in trusted, 3390 // authenticated environments and are not as well scrutinized as attack surfaces. 3391 // 3392 // The version control command restrictions only apply when using direct version 3393 // control access to download code. When downloading modules from a proxy, 3394 // 'go get' uses the proxy protocol instead, which is always permitted. 3395 // By default, the 'go get' command uses the Go module mirror (proxy.golang.org) 3396 // for public packages and only falls back to version control for private 3397 // packages or when the mirror refuses to serve a public package (typically for 3398 // legal reasons). Therefore, clients can still access public code served from 3399 // Bazaar, Fossil, or Subversion repositories by default, because those downloads 3400 // use the Go module mirror, which takes on the security risk of running the 3401 // version control commands using a custom sandbox. 3402 // 3403 // The GOVCS variable can be used to change the allowed version control systems 3404 // for specific packages (identified by a module or import path). 3405 // The GOVCS variable applies when building package in both module-aware mode 3406 // and GOPATH mode. When using modules, the patterns match against the module path. 3407 // When using GOPATH, the patterns match against the import path corresponding to 3408 // the root of the version control repository. 3409 // 3410 // The general form of the GOVCS setting is a comma-separated list of 3411 // pattern:vcslist rules. The pattern is a glob pattern that must match 3412 // one or more leading elements of the module or import path. The vcslist 3413 // is a pipe-separated list of allowed version control commands, or "all" 3414 // to allow use of any known command, or "off" to disallow all commands. 3415 // Note that if a module matches a pattern with vcslist "off", it may still be 3416 // downloaded if the origin server uses the "mod" scheme, which instructs the 3417 // go command to download the module using the GOPROXY protocol. 3418 // The earliest matching pattern in the list applies, even if later patterns 3419 // might also match. 3420 // 3421 // For example, consider: 3422 // 3423 // GOVCS=github.com:git,evil.com:off,*:git|hg 3424 // 3425 // With this setting, code with a module or import path beginning with 3426 // github.com/ can only use git; paths on evil.com cannot use any version 3427 // control command, and all other paths (* matches everything) can use 3428 // only git or hg. 3429 // 3430 // The special patterns "public" and "private" match public and private 3431 // module or import paths. A path is private if it matches the GOPRIVATE 3432 // variable; otherwise it is public. 3433 // 3434 // If no rules in the GOVCS variable match a particular module or import path, 3435 // the 'go get' command applies its default rule, which can now be summarized 3436 // in GOVCS notation as 'public:git|hg,private:all'. 3437 // 3438 // To allow unfettered use of any version control system for any package, use: 3439 // 3440 // GOVCS=*:all 3441 // 3442 // To disable all use of version control, use: 3443 // 3444 // GOVCS=*:off 3445 // 3446 // The 'go env -w' command (see 'go help env') can be used to set the GOVCS 3447 // variable for future go command invocations. 3448 package main 3449