internalrefs

Documentation

Index

• type Cleaner
  • func NewCleaner(ctx context.Context, repo *gitalypb.Repository, forEach ForEachFunc) (*Cleaner, error)
  • func (c *Cleaner) ApplyObjectMap(reader io.Reader) error
• type ErrInvalidObjectMap
• type ForEachFunc

Types

type Cleaner

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

Cleaner is responsible for updating the internal references in a repository as specified by a BFG object map. Currently, internal references pointing to a commit that has been rewritten will simply be removed.

func NewCleaner

func NewCleaner(ctx context.Context, repo *gitalypb.Repository, forEach ForEachFunc) (*Cleaner, error)

NewCleaner builds a new instance of Cleaner, which is used to apply a BFG object map to a repository.

func (*Cleaner) ApplyObjectMap

func (c *Cleaner) ApplyObjectMap(reader io.Reader) error

ApplyObjectMap processes a BFG object map file, removing any internal references that point to a rewritten commit.

type ErrInvalidObjectMap

type ErrInvalidObjectMap error

ErrInvalidObjectMap is returned with descriptive text if the supplied object map file is in the wrong format

type ForEachFunc

type ForEachFunc func(oldOID, newOID string, isInternalRef bool) error

A ForEachFunc can be called for every entry in the BFG object map file that the cleaner is processing. Returning an error will stop the cleaner before it has processed the entry in question