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