Commit 521c0cab7a02f718e4a7e3c2ae7ef81d6f16ffd1
2014-11-02T17:18:19
merge: talk about the merging state after git_merge() Since it's not necessarily obvious, mention the merging state and how to clear it.
diff --git a/include/git2/merge.h b/include/git2/merge.h
index 9082fd6..fb06d6e 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