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