git

Documentation

Index

• Constants
• Variables
• func AddGitProtocolEnv(ctx context.Context, req RequestWithGitProtocol, env []string) []string
• func AlternatesPath(repo repository.GitRepo) (string, error)
• func BareCommand(ctx context.Context, stdin io.Reader, stdout, stderr io.Writer, env []string, ...) (*command.Command, error)
• func BuildGitOptions(gitOpts []string, otherOpts ...string) []string
• func Command(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)
• func CommandWithoutRepo(ctx context.Context, args ...string) (*command.Command, error)
• func IsValidRef(ctx context.Context, repo *gitalypb.Repository, ref string) bool
• func StdinCommand(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)
• func SupportsDeltaIslands(version string) (bool, error)
• func ValidateCommitID(id string) error
• func ValidateRevision(revision []byte) error
• func Version() (string, error)
• type RequestWithGitProtocol

Constants

const (
	// EmptyTreeID is the Git tree object hash that corresponds to an empty tree (directory)
	EmptyTreeID = "4b825dc642cb6eb9a060e54bf8d69288fbee4904"

	// NullSHA is the special value that Git uses to signal a ref or object does not exist
	NullSHA = "0000000000000000000000000000000000000000"
)

const (
	// ProtocolV2 is the special value used by Git clients to request protocol v2
	ProtocolV2 = "version=2"
)

Variables

var FallbackTimeValue = time.Unix(1<<63-62135596801, 999999999)

FallbackTimeValue is the value returned by `SafeTimeParse` in case it encounters a parse error. It's the maximum time value possible in golang. See https://gitlab.com/gitlab-org/gitaly/issues/556#note_40289573

Functions

func AddGitProtocolEnv

func AddGitProtocolEnv(ctx context.Context, req RequestWithGitProtocol, env []string) []string

AddGitProtocolEnv checks whether the request has Git protocol v2 and sets this in the environment.

func AlternatesPath

func AlternatesPath(repo repository.GitRepo) (string, error)

AlternatesPath finds the fully qualified path for the alternates file.

func BareCommand

func BareCommand(ctx context.Context, stdin io.Reader, stdout, stderr io.Writer, env []string, args ...string) (*command.Command, error)

BareCommand creates a git.Command with the given args, stdin/stdout/stderr, and env

func BuildGitOptions

func BuildGitOptions(gitOpts []string, otherOpts ...string) []string

BuildGitOptions helps to generate options to the git command. If gitOpts is not empty then its values are passed as part of the "-c" option of the git command, the other values are passed along with the subcommand.

func Command

func Command(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)

Command creates a git.Command with the given args and Repository

func CommandWithoutRepo

func CommandWithoutRepo(ctx context.Context, args ...string) (*command.Command, error)

CommandWithoutRepo works like Command but without a git repository

func IsValidRef

func IsValidRef(ctx context.Context, repo *gitalypb.Repository, ref string) bool

IsValidRef checks if a ref in a repo is valid

func StdinCommand

func StdinCommand(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)

StdinCommand creates a git.Command with the given args and Repository that is suitable for Write()ing to

func SupportsDeltaIslands

func SupportsDeltaIslands(version string) (bool, error)

SupportsDeltaIslands checks if a version string (e.g. "2.20.0") corresponds to a Git version that supports delta islands.

func ValidateCommitID

func ValidateCommitID(id string) error

ValidateCommitID checks if id could be a Git commit ID, syntactically.

func ValidateRevision

func ValidateRevision(revision []byte) error

ValidateRevision checks if a revision looks valid

func Version

func Version() (string, error)

Version returns the used git version.

Types

type RequestWithGitProtocol

type RequestWithGitProtocol interface {
	GetGitProtocol() string
}

RequestWithGitProtocol holds requests that respond to GitProtocol