checkout

Documentation

Overview

Package checkout handles workspace materialization and .gitignore management.

Index

• func AddToGitignore(target string) error
• func Materialize(c *cache.Cache, out dvcfile.Out, wsPath string, types []LinkType) error
• type LinkType
  • func ParseCacheTypes(s string) []LinkType

Functions

func AddToGitignore

func AddToGitignore(target string) error

AddToGitignore ensures the directory containing target has a .gitignore entry that ignores target, matching DVC: one .gitignore per directory, entry "/<basename>" with POSIX separators, idempotent.

func Materialize

func Materialize(c *cache.Cache, out dvcfile.Out, wsPath string, types []LinkType) error

Materialize reconstructs the workspace path for out from cache objects using the given link strategies (reflink/hardlink/symlink/copy). Files already matching are left untouched. For directories, workspace files absent from the manifest are pruned, matching `dvc checkout`.

Types

type LinkType

type LinkType string

LinkType is a cache.type strategy.

const (
	Reflink  LinkType = "reflink"
	Hardlink LinkType = "hardlink"
	Symlink  LinkType = "symlink"
	Copy     LinkType = "copy"
)

func ParseCacheTypes

func ParseCacheTypes(s string) []LinkType

ParseCacheTypes parses a cache.type value ("reflink,copy") into an ordered list of strategies, defaulting to DVC's default (reflink, copy).