log

Documentation

Index

• Constants
• func GetCommit(ctx context.Context, repo *gitalypb.Repository, revision string) (*gitalypb.GitCommit, error)
• func GetCommitCatfile(c *catfile.Batch, revision string) (*gitalypb.GitCommit, error)
• func GetCommitMessage(c *catfile.Batch, repo *gitalypb.Repository, revision string) ([]byte, error)
• func GetTagCatfile(c *catfile.Batch, tagID, tagName string, trimLen, trimRightNewLine bool) (*gitalypb.Tag, error)
• func GitLogCommand(ctx context.Context, repo *gitalypb.Repository, revisions []string, ...) (*command.Command, error)
• func IsNotFound(err error) bool
• func LastCommitForPath(ctx context.Context, batch *catfile.Batch, repo *gitalypb.Repository, ...) (*gitalypb.GitCommit, error)
• type Parser
  • func NewLogParser(ctx context.Context, repo *gitalypb.Repository, src io.Reader) (*Parser, error)
  • func (parser *Parser) Commit() *gitalypb.GitCommit
  • func (parser *Parser) Err() error
  • func (parser *Parser) Parse() bool

Constants

const (
	// MaxTagReferenceDepth is the maximum depth of tag references we will dereference
	MaxTagReferenceDepth = 10
)

Functions

func GetCommit

func GetCommit(ctx context.Context, repo *gitalypb.Repository, revision string) (*gitalypb.GitCommit, error)

GetCommit tries to resolve revision to a Git commit. Returns nil if no object is found at revision.

func GetCommitCatfile

func GetCommitCatfile(c *catfile.Batch, revision string) (*gitalypb.GitCommit, error)

GetCommitCatfile looks up a commit by revision using an existing *catfile.Batch instance.

func GetCommitMessage

func GetCommitMessage(c *catfile.Batch, repo *gitalypb.Repository, revision string) ([]byte, error)

GetCommitMessage looks up a commit message and returns it in its entirety.

func GetTagCatfile

func GetTagCatfile(c *catfile.Batch, tagID, tagName string, trimLen, trimRightNewLine bool) (*gitalypb.Tag, error)

GetTagCatfile looks up a commit by tagID using an existing *catfile.Batch instance. When 'trim' is 'true', the tag message will be trimmed to fit in a gRPC message. When 'trimRightNewLine' is 'true', the tag message will be trimmed to remove all '\n' characters from right. note: we pass in the tagName because the tag name from refs/tags may be different than the name found in the actual tag object. We want to use the tagName found in refs/tags

func GitLogCommand

func GitLogCommand(ctx context.Context, repo *gitalypb.Repository, revisions []string, paths []string, extraArgs ...git.Option) (*command.Command, error)

GitLogCommand returns a Command that executes git log with the given the arguments

func IsNotFound

func IsNotFound(err error) bool

IsNotFound tests if an error is a "not found" error.

func LastCommitForPath

func LastCommitForPath(ctx context.Context, batch *catfile.Batch, repo *gitalypb.Repository, revision string, path string) (*gitalypb.GitCommit, error)

LastCommitForPath returns the last commit which modified path.

Types

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser holds necessary state for parsing a git log stream

func NewLogParser

func NewLogParser(ctx context.Context, repo *gitalypb.Repository, src io.Reader) (*Parser, error)

NewLogParser returns a new Parser

func (*Parser) Commit

func (parser *Parser) Commit() *gitalypb.GitCommit

Commit returns a successfully parsed git log line. It should be called only when Parser.Parse() returns true.

func (*Parser) Err

func (parser *Parser) Err() error

Err returns the error encountered (if any) when parsing the diff stream. It should be called only when Parser.Parse() returns false.

func (*Parser) Parse

func (parser *Parser) Parse() bool

Parse parses a single git log line. It returns true if successful, false if it finished parsing all logs or when it encounters an error, in which case use Parser.Err() to get the error.