proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-30 22:24:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

merge: talk about the merging state after git_merge()

Browse Source 
Since it's not necessarily obvious, mention the merging state and how to
clear it.
This commit is contained in:
Carlos Martín Nieto 2014-11-02 17:18:19 +01:00
parent 264d74fd40
commit 521c0cab7a
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/git2/merge.h
View File

@ -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