diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2014-11-02 17:18:19 +0100 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-11-02 17:18:19 +0100 |
| commit | 521c0cab7a02f718e4a7e3c2ae7ef81d6f16ffd1 (patch) | |
| tree | de6c3fb2b1f46d6b4b33634ad0729c08be7f766e | |
| parent | 264d74fd4088585fa9fb6ffd6d9afe280c0048bb (diff) | |
| download | libgit2-521c0cab7a02f718e4a7e3c2ae7ef81d6f16ffd1.tar.gz | |
merge: talk about the merging state after git_merge()
Since it's not necessarily obvious, mention the merging state and how to
clear it.
| -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 |