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