GitCheckout enum

Checkout behavior flags.

In libgit2, checkout is used to update the working directory and index to match a target tree. Unlike git checkout, it does not move the HEAD commit for you - use setHead or the like to do that.

Inheritance
Available extensions

Values

none → const GitCheckout

Default is a dry run, no actual updates.

const GitCheckout(0)
safe → const GitCheckout

Allow safe updates that cannot overwrite uncommitted data. If the uncommitted changes don't conflict with the checked out files, the checkout will still proceed, leaving the changes intact.

Mutually exclusive with GitCheckout.force. GitCheckout.force takes precedence over GitCheckout.safe.

const GitCheckout(1)
force → const GitCheckout

Allow all updates to force working directory to look like index.

Mutually exclusive with GitCheckout.safe. GitCheckout.force takes precedence over GitCheckout.safe.

const GitCheckout(2)
recreateMissing → const GitCheckout

Allow checkout to recreate missing files.

const GitCheckout(4)
allowConflicts → const GitCheckout

Allow checkout to make safe updates even if conflicts are found.

const GitCheckout(16)
removeUntracked → const GitCheckout

Remove untracked files not in index (that are not ignored).

const GitCheckout(32)
removeIgnored → const GitCheckout

Remove ignored files not in index.

const GitCheckout(64)
updateOnly → const GitCheckout

Only update existing files, don't create new ones.

const GitCheckout(128)
dontUpdateIndex → const GitCheckout

Normally checkout updates index entries as it goes; this stops that. Implies GitCheckout.dontWriteIndex.

const GitCheckout(256)
noRefresh → const GitCheckout

Don't refresh index/config/etc before doing checkout.

const GitCheckout(512)
skipUnmerged → const GitCheckout

Allow checkout to skip unmerged files.

const GitCheckout(1024)
useOurs → const GitCheckout

For unmerged files, checkout stage 2 from index.

const GitCheckout(2048)
useTheirs → const GitCheckout

For unmerged files, checkout stage 3 from index.

const GitCheckout(4096)
disablePathspecMatch → const GitCheckout

Treat pathspec as simple list of exact match file paths.

const GitCheckout(8192)
skipLockedDirectories → const GitCheckout

Ignore directories in use, they will be left empty.

const GitCheckout(262144)
dontOverwriteIgnored → const GitCheckout

Don't overwrite ignored files that exist in the checkout target.

const GitCheckout(524288)
conflictStyleMerge → const GitCheckout

Write normal merge files for conflicts.

const GitCheckout(1048576)
conflictStyleDiff3 → const GitCheckout

Include common ancestor data in diff3 format files for conflicts.

const GitCheckout(2097152)
dontRemoveExisting → const GitCheckout

Don't overwrite existing files or folders.

const GitCheckout(4194304)
dontWriteIndex → const GitCheckout

Normally checkout writes the index upon completion; this prevents that.

const GitCheckout(8388608)
dryRun → const GitCheckout

Show what would be done by a checkout. Stop after sending notifications; don't update the working directory or index.

const GitCheckout(16777216)
conflictStyleZdiff3 → const GitCheckout

Include common ancestor data in zdiff3 format for conflicts.

const GitCheckout(33554432)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → int
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromValue(int value) → GitCheckout

Constants

values → const List<GitCheckout>
A constant List of the values in this enum, in order of their declaration.