package gocommand

Import Path
	golang.org/x/tools/internal/gocommand (on go.dev)

Dependency Relation
	imports 16 packages, and imported by 3 packages

Involved Source Files

	   #d invoke.go
		Package gocommand is a helper for calling the go command.

	      vendor.go
	      version.go
Package-Level Type Names (total 3, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Invocation (struct)
		An Invocation represents a call to the go command.

		Fields (total 10, all are exported)
			Args []string
			BuildFlags []string
			CleanEnv bool
				If CleanEnv is set, the invocation will run only with the environment
				in Env, not starting with os.Environ.

			Env []string
			Logf func(format string, args ...interface{})
			ModFile string
				If ModFile is set, the go command is invoked with -modfile=ModFile.

			ModFlag string
				If ModFlag is set, the go command is invoked with -mod=ModFlag.

			Overlay string
				If Overlay is set, the go command is invoked with -overlay=Overlay.

			Verb string
			WorkingDir string
		Methods (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*Invocation) run(ctx context.Context, stdout, stderr io.Writer) error
			(*Invocation) runWithFriendlyError(ctx context.Context, stdout, stderr io.Writer) (friendlyError error, rawError error)
		As Inputs Of (at least 10, in which 7 are exported)
			func GoVersion(ctx context.Context, inv Invocation, r *Runner) (int, error)
			func GoVersionOutput(ctx context.Context, inv Invocation, r *Runner) (string, error)
			func VendorEnabled(ctx context.Context, inv Invocation, r *Runner) (bool, *ModuleJSON, error)
			func (*Runner).Run(ctx context.Context, inv Invocation) (*bytes.Buffer, error)
			func (*Runner).RunPiped(ctx context.Context, inv Invocation, stdout, stderr io.Writer) error
			func (*Runner).RunRaw(ctx context.Context, inv Invocation) (*bytes.Buffer, *bytes.Buffer, error, error)
			func golang.org/x/tools/go/internal/packagesdriver.GetSizesGolist(ctx context.Context, inv Invocation, gocmdRunner *Runner) (types.Sizes, error)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func getMainModuleAnd114(ctx context.Context, inv Invocation, r *Runner) (*ModuleJSON, bool, error)
			func (*Runner).runConcurrent(ctx context.Context, inv Invocation) (*bytes.Buffer, *bytes.Buffer, error, error)
			func (*Runner).runPiped(ctx context.Context, inv Invocation, stdout, stderr io.Writer) (error, error)

	 type ModuleJSON (struct)
		ModuleJSON holds information about a module.

		Fields (total 11, all are exported)
			Dir string
				// directory holding files for this module, if any

			GoMod string
				// path to go.mod file used when loading this module, if any

			GoVersion string
				// go version used in module

			Indirect bool
				// is this module only an indirect dependency of main module?

			Main bool
				// is this the main module?

			Path string
				// module path

			Replace *ModuleJSON
				// replaced by this module

			Time *time.Time
				// time version was created

			Update *ModuleJSON
				// available update, if any (with -u)

			Version string
				// module version

			Versions []string
				// available module versions (with -versions)

		As Outputs Of (at least 2, in which 1 are exported)
			func VendorEnabled(ctx context.Context, inv Invocation, r *Runner) (bool, *ModuleJSON, error)
			/* at least one unexported ... *//* at least one unexported: */
			func getMainModuleAnd114(ctx context.Context, inv Invocation, r *Runner) (*ModuleJSON, bool, error)

	 type Runner (struct)
		An Runner will run go command invocations and serialize
		them if it sees a concurrency error.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			inFlight chan struct{}
				inFlight tracks available workers.

			once sync.Once
				once guards the runner initialization.

			serialized chan struct{}
				serialized guards the ability to run a go command serially,
				to avoid deadlocks when claiming workers.

		Methods (total 6, in which 3 are exported)
			(*Runner) Run(ctx context.Context, inv Invocation) (*bytes.Buffer, error)
				Run is a convenience wrapper around RunRaw.
				It returns only stdout and a "friendly" error.

			(*Runner) RunPiped(ctx context.Context, inv Invocation, stdout, stderr io.Writer) error
				RunPiped runs the invocation serially, always waiting for any concurrent
				invocations to complete first.

			(*Runner) RunRaw(ctx context.Context, inv Invocation) (*bytes.Buffer, *bytes.Buffer, error, error)
				RunRaw runs the invocation, serializing requests only if they fight over
				go.mod changes.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*Runner) initialize()
			(*Runner) runConcurrent(ctx context.Context, inv Invocation) (*bytes.Buffer, *bytes.Buffer, error, error)
			(*Runner) runPiped(ctx context.Context, inv Invocation, stdout, stderr io.Writer) (error, error)
		As Inputs Of (at least 5, in which 4 are exported)
			func GoVersion(ctx context.Context, inv Invocation, r *Runner) (int, error)
			func GoVersionOutput(ctx context.Context, inv Invocation, r *Runner) (string, error)
			func VendorEnabled(ctx context.Context, inv Invocation, r *Runner) (bool, *ModuleJSON, error)
			func golang.org/x/tools/go/internal/packagesdriver.GetSizesGolist(ctx context.Context, inv Invocation, gocmdRunner *Runner) (types.Sizes, error)
			/* at least one unexported ... *//* at least one unexported: */
			func getMainModuleAnd114(ctx context.Context, inv Invocation, r *Runner) (*ModuleJSON, bool, error)


Package-Level Functions (total 8, in which 5 are exported)

	 func GoVersion(ctx context.Context, inv Invocation, r *Runner) (int, error)
		GoVersion reports the minor version number of the highest release
		tag built into the go command on the PATH.

		Note that this may be higher than the version of the go tool used
		to build this application, and thus the versions of the standard
		go/{scanner,parser,ast,types} packages that are linked into it.
		In that case, callers should either downgrade to the version of
		go used to build the application, or report an error that the
		application is too old to use the go command on the PATH.

	 func GoVersionOutput(ctx context.Context, inv Invocation, r *Runner) (string, error)
		GoVersionOutput returns the complete output of the go version command.

	 func HandleHangingGoCommand(proc *os.Process)
	 func ParseGoVersionOutput(data string) string
		ParseGoVersionOutput extracts the Go version string
		from the output of the "go version" command.
		Given an unrecognized form, it returns an empty string.

	 func VendorEnabled(ctx context.Context, inv Invocation, r *Runner) (bool, *ModuleJSON, error)
		VendorEnabled reports whether vendoring is enabled. It takes a *Runner to execute Go commands
		with the supplied context.Context and Invocation. The Invocation can contain pre-defined fields,
		of which only Verb and Args are modified to run the appropriate Go command.
		Inspired by setDefaultBuildMod in modload/init.go

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func cmdDebugStr(cmd *exec.Cmd) string
	 func getMainModuleAnd114(ctx context.Context, inv Invocation, r *Runner) (*ModuleJSON, bool, error)
		getMainModuleAnd114 gets one of the main modules' information and whether the
		go command in use is 1.14+. This is the information needed to figure out
		if vendoring should be enabled.

	 func runCmdContext(ctx context.Context, cmd *exec.Cmd) error
		runCmdContext is like exec.CommandContext except it sends os.Interrupt
		before os.Kill.


Package-Level Variables (total 3, in which 1 are exported)

	  var DebugHangingGoCommands bool
		DebugHangingGoCommands may be set by tests to enable additional
		instrumentation (including panics) for debugging hanging Go commands.

		See golang/go#54461 for details.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var modConcurrencyError *regexp.Regexp
		1.13: go: updates to go.mod needed, but contents have changed
		1.14: go: updating go.mod: existing contents have changed since last read

	  var modFlagRegexp *regexp.Regexp
Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const maxInFlight = 10

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)