mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-30 11:15:04 +00:00
Merge pull request #3601 from ethomson/merge_doc
Better document `git_merge_commits` redux
This commit is contained in:
commit
463f53513f
@ -527,10 +527,6 @@ GIT_EXTERN(int) git_merge_trees(
|
|||||||
* or checked out. If the index is to be converted to a tree, the caller
|
* or checked out. If the index is to be converted to a tree, the caller
|
||||||
* should resolve any conflicts that arose as part of the merge.
|
* should resolve any conflicts that arose as part of the merge.
|
||||||
*
|
*
|
||||||
* The merge performed uses the first common ancestor, unlike the
|
|
||||||
* `git-merge-recursive` strategy, which may produce an artificial common
|
|
||||||
* ancestor tree when there are multiple ancestors.
|
|
||||||
*
|
|
||||||
* The returned index must be freed explicitly with `git_index_free`.
|
* The returned index must be freed explicitly with `git_index_free`.
|
||||||
*
|
*
|
||||||
* @param out pointer to store the index result in
|
* @param out pointer to store the index result in
|
||||||
@ -553,10 +549,6 @@ 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.
|
||||||
*
|
*
|
||||||
* The merge performed uses the first common ancestor, unlike the
|
|
||||||
* `git-merge-recursive` strategy, which may produce an artificial common
|
|
||||||
* ancestor tree when there are multiple ancestors.
|
|
||||||
*
|
|
||||||
* For compatibility with git, the repository is put into a merging
|
* For compatibility with git, the repository is put into a merging
|
||||||
* state. Once the commit is done (or if the uses wishes to abort),
|
* state. Once the commit is done (or if the uses wishes to abort),
|
||||||
* you should clear this state by calling
|
* you should clear this state by calling
|
||||||
|
Loading…
Reference in New Issue
Block a user