openstack/deb-python-pygit2
Code Issues Proposed changes

Add documentation for merge_commits() and merge_trees()

Browse Source
This commit is contained in:
Carlos Martín Nieto 2015-02-09 21:25:33 +01:00
parent fcd4b9446b
commit d4da228c0e
1 changed files with 10 additions and 0 deletions

10
docs/merge.rst

@ -33,3 +33,13 @@ can create a commit with these two parents.
>>> tree = repo.index.write_tree() >>> tree = repo.index.write_tree()
>>> new_commit = repo.create_commit('HEAD', user, user, tree, >>> new_commit = repo.create_commit('HEAD', user, user, tree,
[repo.head.target, other_branch_tip]) [repo.head.target, other_branch_tip])
Lower-level methods
===================
These methods allow more direct control over how to perform the
merging. They do not modify the working directory and return an
in-memory Index representing the result of the merge.
.. automethod:: pygit2.Repository.merge_commits
.. automethod:: pygit2.Repository.merge_trees