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