libgit2

git_stash_apply

Version:

Apply a single stashed state from the stash list.

If local changes in the working directory conflict with changes in the stash then GIT_EMERGECONFLICT will be returned. In this case, the index will always remain unmodified and all files in the working directory will remain unmodified. However, if you are restoring untracked files or ignored files and there is a conflict when applying the modified files, then those files will remain in the working directory.

If passing the GIT_STASH_APPLY_REINSTATE_INDEX flag and there would be conflicts when reinstating the index, the function will return GIT_EMERGECONFLICT and both the working directory and index will be left unmodified.

Note that a minimum checkout strategy of GIT_CHECKOUT_SAFE is implied.

Signature

GitHub
int git_stash_apply(git_repository *repo, size_t index, const git_stash_apply_options *options);

Parameters

git_repository *
In
repo

The owning repository.

size_t
In
index

The position within the stash list. 0 points to the most recent stashed state.

const git_stash_apply_options *
In
options

Optional options to control how stashes are applied.

Returns

int

0 on success, GIT_ENOTFOUND if there's no stashed state for the given index, GIT_EMERGECONFLICT if changes exist in the working directory, or an error code

Versions