merge: talk about the merging state after git_merge()

carlosmn · carlosmn · commit 521c0cab7a02 · 2014-11-02T17:18:19.000+01:00
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
@@ -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
