Commit 521c0cab by Carlos Martín Nieto

merge: talk about the merging state after git_merge()

Since it's not necessarily obvious, mention the merging state and how to
clear it.
parent 264d74fd
...@@ -486,6 +486,11 @@ GIT_EXTERN(int) git_merge_commits( ...@@ -486,6 +486,11 @@ GIT_EXTERN(int) git_merge_commits(
* to the index. Callers should inspect the repository's index after this * to the index. Callers should inspect the repository's index after this
* completes, resolve any conflicts and prepare a commit. * 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 repo the repository to merge
* @param their_heads the heads to merge into * @param their_heads the heads to merge into
* @param their_heads_len the number of heads to merge * @param their_heads_len the number of heads to merge
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment