Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var GitEnv = []string{
"LANG=en_US.UTF-8",
}
GitEnv contains the ENV variables for git commands
var SetupStdin io.Reader = stdinSentinel{}
SetupStdin instructs New() to configure the stdin pipe of the command it is creating. This allows you call Write() on the command as if it is an ordinary io.Writer, sending data directly to the stdin of the process.
You should not call Read() on this value - it is strictly for configuration!
Functions ¶
func ExitStatus ¶
ExitStatus will return the exit-code from an error returned by Wait().
func GitPath ¶
func GitPath() string
GitPath returns the path to the `git` binary. See `SetGitPath` for details on how this is set
func WaitAllDone ¶ added in v0.40.0
func WaitAllDone()
WaitAllDone waits for all commands started by the command package to finish. This can only be called once in the lifecycle of the current Go process.
Types ¶
type Command ¶
type Command struct {
// contains filtered or unexported fields
}
Command encapsulates a running exec.Cmd. The embedded exec.Cmd is terminated and reaped automatically when the context.Context that created it is canceled.
func New ¶
func New(ctx context.Context, cmd *exec.Cmd, stdin io.Reader, stdout, stderr io.Writer, env ...string) (*Command, error)
New creates a Command from an exec.Cmd. On success, the Command contains a running subprocess. When ctx is canceled the embedded process will be terminated and reaped automatically.
If stdin is specified as SetupStdin, you will be able to write to the stdin of the subprocess by calling Write() on the returned Command.
type SpawnConfig ¶ added in v0.61.0
type SpawnConfig struct {
// This default value (10 seconds) is very high. Spawning should take
// milliseconds or less. If we hit 10 seconds, something is wrong, and
// failing the request will create breathing room. Can be modified at
// runtime with the GITALY_COMMAND_SPAWN_TIMEOUT environment variable.
Timeout time.Duration `split_words:"true" default:"10s"`
// MaxSpawnParallel limits the number of goroutines that can spawn a
// process at the same time. These parallel spawns will contend for a
// single lock (syscall.ForkLock) in exec.Cmd.Start(). Can be modified at
// runtime with the GITALY_COMMAND_SPAWN_MAX_PARALLEL variable.
//
// Note that this does not limit the total number of child processes that
// can be attached to Gitaly at the same time. It only limits the rate at
// which we can create new child processes.
MaxParallel int `split_words:"true" default:"10"`
}
SpawnConfig holds configuration for command spawning timeouts and parallelism.
Source Files