1cc112c32f
It seems I have been forgetting to update the documentation with the last few changes, so adjust to the oid -> id renaming and add missing attributes to the listings.
38 lines
1.2 KiB
ReStructuredText
38 lines
1.2 KiB
ReStructuredText
**********************************************************************
|
|
Merge
|
|
**********************************************************************
|
|
|
|
.. contents::
|
|
|
|
.. automethod:: pygit2.Repository.merge_base
|
|
.. automethod:: pygit2.Repository.merge
|
|
|
|
The merge method
|
|
=================
|
|
|
|
The method does a merge over the current working copy.
|
|
It gets an Oid object as a parameter and returns a MergeResult object.
|
|
|
|
As its name says, it only does the merge, does not commit nor update the
|
|
branch reference in the case of a fastforward.
|
|
|
|
For the moment, the merge does not support options, it will perform the
|
|
merge with the default ones defined in GIT_MERGE_OPTS_INIT libgit2 constant.
|
|
|
|
Example::
|
|
|
|
>>> branch_head_hex = '5ebeeebb320790caf276b9fc8b24546d63316533'
|
|
>>> branch_oid = self.repo.get(branch_head_hex).id
|
|
>>> merge_result = self.repo.merge(branch_oid)
|
|
|
|
The MergeResult object
|
|
======================
|
|
|
|
Represents the result of a merge and contains these fields:
|
|
|
|
- is_uptodate: bool, if there wasn't any merge because the repo was already
|
|
up to date
|
|
- is_fastforward: bool, whether the merge was fastforward or not
|
|
- fastforward_oid: Oid, in the case it was a fastforward, this is the
|
|
forwarded Oid.
|