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