tempdir

Documentation

Index

• Constants
• func CacheDir(storage config.Storage) string
• func ForDeleteAllRepositories(storageName string) (string, error)
• func New(ctx context.Context, repo *gitalypb.Repository) (string, error)
• func NewAsRepository(ctx context.Context, repo *gitalypb.Repository) (*gitalypb.Repository, string, error)
• func StartCleaning()
• func StateDir(storage config.Storage) string
• func TempDir(storage config.Storage) string

Constants

const (
	// GitalyDataPrefix is the top-level directory we use to store system
	// (non-user) data. We need to be careful that this path does not clash
	// with any directory name that could be provided by a user. The '+'
	// character is not allowed in GitLab namespaces or repositories.
	GitalyDataPrefix = "+gitaly"

	// MaxAge is used by ForDeleteAllRepositories. It is also a fallback
	// for the context-scoped temporary directories, to ensure they get
	// cleaned up if the cleanup at the end of the context failed to run.
	MaxAge = 7 * 24 * time.Hour
)

Functions

func CacheDir

func CacheDir(storage config.Storage) string

CacheDir returns the path to the cache dir for a storage location

func ForDeleteAllRepositories

func ForDeleteAllRepositories(storageName string) (string, error)

ForDeleteAllRepositories returns a temporary directory for the given storage. It is not context-scoped but it will get removed eventuall (after MaxAge).

func New

func New(ctx context.Context, repo *gitalypb.Repository) (string, error)

New returns the path of a new temporary directory for use with the repository. The directory is removed with os.RemoveAll when ctx expires.

func NewAsRepository

func NewAsRepository(ctx context.Context, repo *gitalypb.Repository) (*gitalypb.Repository, string, error)

NewAsRepository is the same as New, but it returns a *gitalypb.Repository for the created directory as well as the bare path as a string

func StartCleaning

func StartCleaning()

StartCleaning starts tempdir cleanup goroutines.

func StateDir

func StateDir(storage config.Storage) string

StateDir returns the path to the state dir for a storage location

func TempDir

func TempDir(storage config.Storage) string

TempDir returns the path to the temp dir for a storage location