diff options
Diffstat (limited to 'include/git2/merge.h')
-rw-r--r-- | include/git2/merge.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/git2/merge.h b/include/git2/merge.h index 9082fd6fb..fb06d6e37 100644 --- a/include/git2/merge.h +++ b/include/git2/merge.h @@ -486,6 +486,11 @@ GIT_EXTERN(int) git_merge_commits( * to the index. Callers should inspect the repository's index after this * completes, resolve any conflicts and prepare a commit. * + * For compatibility with git, the repository is put into a merging + * state. Once the commit is done (or if the uses wishes to abort), + * you should clear this state by calling + * `git_repository_state_cleanup()`. + * * @param repo the repository to merge * @param their_heads the heads to merge into * @param their_heads_len the number of heads to merge |