← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Vincent Ladeuil
  • Date: 2014-02-07 10:20:38 UTC
  • mto: This revision was merged to the branch mainline in revision 6590.
  • Revision ID: v.ladeuil+lp@free.fr-20140207102038-17sgslnv35no6bsu
https://launchpad.net/bugs/1269886
Fix test failure on recent Ubuntu Trusty versions without weakening the test itself.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import warnings
18
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
19
23
from bzrlib import (
20
24
    branch as _mod_branch,
 
25
    cleanup,
21
26
    conflicts as _mod_conflicts,
22
27
    debug,
23
 
    decorators,
24
 
    errors,
 
28
    generate_ids,
25
29
    graph as _mod_graph,
26
 
    hooks,
27
30
    merge3,
28
31
    osutils,
29
32
    patiencediff,
34
37
    tree as _mod_tree,
35
38
    tsort,
36
39
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
 
40
    versionedfile,
 
41
    workingtree,
 
42
    )
 
43
from bzrlib.i18n import gettext
 
44
""")
 
45
from bzrlib import (
 
46
    decorators,
 
47
    errors,
 
48
    hooks,
 
49
    registry,
 
50
    )
40
51
from bzrlib.symbol_versioning import (
41
52
    deprecated_in,
42
53
    deprecated_method,
46
57
 
47
58
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
59
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
 
60
    operation = cleanup.OperationWithCleanups(merge_inner)
50
61
    operation.add_cleanup(from_tree.unlock)
51
62
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
63
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
66
class MergeHooks(hooks.Hooks):
56
67
 
57
68
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
 
69
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
 
70
        self.add_hook('merge_file_content',
60
71
            "Called with a bzrlib.merge.Merger object to create a per file "
61
72
            "merge object when starting a merge. "
62
73
            "Should return either None or a subclass of "
66
77
            "side has deleted the file and the other has changed it). "
67
78
            "See the AbstractPerFileMerger API docs for details on how it is "
68
79
            "used by merge.",
69
 
            (2, 1), None))
 
80
            (2, 1))
 
81
        self.add_hook('pre_merge',
 
82
            'Called before a merge. '
 
83
            'Receives a Merger object as the single argument.',
 
84
            (2, 5))
 
85
        self.add_hook('post_merge',
 
86
            'Called after a merge. '
 
87
            'Receives a Merger object as the single argument. '
 
88
            'The return value is ignored.',
 
89
            (2, 5))
70
90
 
71
91
 
72
92
class AbstractPerFileMerger(object):
84
104
    def merge_contents(self, merge_params):
85
105
        """Attempt to merge the contents of a single file.
86
106
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
 
107
        :param merge_params: A bzrlib.merge.MergeFileHookParams
 
108
        :return: A tuple of (status, chunks), where status is one of
89
109
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
110
            is 'success' or 'conflicted', then chunks should be an iterable of
91
111
            strings for the new file contents.
111
131
 
112
132
    def get_filename(self, params, tree):
113
133
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
 
        self.merger.this_tree) and a MergeHookParams.
 
134
        self.merger.this_tree) and a MergeFileHookParams.
115
135
        """
116
136
        return osutils.basename(tree.id2path(params.file_id))
117
137
 
118
138
    def get_filepath(self, params, tree):
119
139
        """Calculate the path to the file in a tree.
120
140
 
121
 
        :param params: A MergeHookParams describing the file to merge
 
141
        :param params: A MergeFileHookParams describing the file to merge
122
142
        :param tree: a Tree, e.g. self.merger.this_tree.
123
143
        """
124
144
        return tree.id2path(params.file_id)
131
151
            params.winner == 'other' or
132
152
            # THIS and OTHER aren't both files.
133
153
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
 
154
            # The filename doesn't match
135
155
            not self.file_matches(params)):
136
156
            return 'not_applicable', None
137
157
        return self.merge_matching(params)
213
233
        raise NotImplementedError(self.merge_text)
214
234
 
215
235
 
216
 
class MergeHookParams(object):
 
236
class MergeFileHookParams(object):
217
237
    """Object holding parameters passed to merge_file_content hooks.
218
238
 
219
239
    There are some fields hooks can access:
421
441
        return self._cached_trees[revision_id]
422
442
 
423
443
    def _get_tree(self, treespec, possible_transports=None):
424
 
        from bzrlib import workingtree
425
444
        location, revno = treespec
426
445
        if revno is None:
427
446
            tree = workingtree.WorkingTree.open_containing(location)[0]
435
454
        revision_id = _mod_revision.ensure_null(revision_id)
436
455
        return branch, self.revision_tree(revision_id, branch)
437
456
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
 
    def ensure_revision_trees(self):
440
 
        if self.this_revision_tree is None:
441
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
442
 
            if self.this_basis == self.this_rev_id:
443
 
                self.this_revision_tree = self.this_basis_tree
444
 
 
445
 
        if self.other_rev_id is None:
446
 
            other_basis_tree = self.revision_tree(self.other_basis)
447
 
            if other_basis_tree.has_changes(self.other_tree):
448
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
449
 
            other_rev_id = self.other_basis
450
 
            self.other_tree = other_basis_tree
451
 
 
452
 
    @deprecated_method(deprecated_in((2, 1, 0)))
453
 
    def file_revisions(self, file_id):
454
 
        self.ensure_revision_trees()
455
 
        def get_id(tree, file_id):
456
 
            revision_id = tree.inventory[file_id].revision
457
 
            return revision_id
458
 
        if self.this_rev_id is None:
459
 
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
 
                self.this_tree.get_file_sha1(file_id):
461
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
462
 
 
463
 
        trees = (self.this_basis_tree, self.other_tree)
464
 
        return [get_id(tree, file_id) for tree in trees]
465
 
 
466
 
    @deprecated_method(deprecated_in((2, 1, 0)))
467
 
    def check_basis(self, check_clean, require_commits=True):
468
 
        if self.this_basis is None and require_commits is True:
469
 
            raise errors.BzrCommandError(
470
 
                "This branch has no commits."
471
 
                " (perhaps you would prefer 'bzr pull')")
472
 
        if check_clean:
473
 
            self.compare_basis()
474
 
            if self.this_basis != self.this_rev_id:
475
 
                raise errors.UncommittedChanges(self.this_tree)
476
 
 
477
 
    @deprecated_method(deprecated_in((2, 1, 0)))
478
 
    def compare_basis(self):
479
 
        try:
480
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
481
 
        except errors.NoSuchRevision:
482
 
            basis_tree = self.this_tree.basis_tree()
483
 
        if not self.this_tree.has_changes(basis_tree):
484
 
            self.this_rev_id = self.this_basis
485
 
 
486
457
    def set_interesting_files(self, file_list):
487
458
        self.interesting_files = file_list
488
459
 
495
466
    def _add_parent(self):
496
467
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
468
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
 
469
        operation = cleanup.OperationWithCleanups(
 
470
            self.this_tree.set_parent_trees)
499
471
        for revision_id in new_parents:
500
472
            try:
501
473
                tree = self.revision_tree(revision_id)
532
504
                raise errors.NoCommits(self.other_branch)
533
505
        if self.other_rev_id is not None:
534
506
            self._cached_trees[self.other_rev_id] = self.other_tree
535
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
507
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
536
508
 
537
509
    def set_other_revision(self, revision_id, other_branch):
538
510
        """Set 'other' based on a branch and revision id
576
548
            elif len(lcas) == 1:
577
549
                self.base_rev_id = list(lcas)[0]
578
550
            else: # len(lcas) > 1
 
551
                self._is_criss_cross = True
579
552
                if len(lcas) > 2:
580
553
                    # find_unique_lca can only handle 2 nodes, so we have to
581
554
                    # start back at the beginning. It is a shame to traverse
586
559
                else:
587
560
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
561
                                            *lcas)
589
 
                self._is_criss_cross = True
 
562
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
563
                    revisions[0], lcas)
 
564
                if self.base_rev_id == _mod_revision.NULL_REVISION:
 
565
                    self.base_rev_id = sorted_lca_keys[0]
 
566
 
590
567
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
568
                raise errors.UnrelatedBranches()
592
569
            if self._is_criss_cross:
593
570
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
571
                              ' help criss-cross.')
595
572
                trace.mutter('Criss-cross lcas: %r' % lcas)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(lcas)
 
573
                if self.base_rev_id in lcas:
 
574
                    trace.mutter('Unable to find unique lca. '
 
575
                                 'Fallback %r as best option.'
 
576
                                 % self.base_rev_id)
 
577
                interesting_revision_ids = set(lcas)
 
578
                interesting_revision_ids.add(self.base_rev_id)
598
579
                interesting_trees = dict((t.get_revision_id(), t)
599
580
                    for t in self.this_branch.repository.revision_trees(
600
581
                        interesting_revision_ids))
601
582
                self._cached_trees.update(interesting_trees)
602
 
                self.base_tree = interesting_trees.pop(self.base_rev_id)
603
 
                sorted_lca_keys = self.revision_graph.find_merge_order(
604
 
                    revisions[0], lcas)
 
583
                if self.base_rev_id in lcas:
 
584
                    self.base_tree = interesting_trees[self.base_rev_id]
 
585
                else:
 
586
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
605
587
                self._lca_trees = [interesting_trees[key]
606
588
                                   for key in sorted_lca_keys]
607
589
            else:
630
612
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
631
613
 
632
614
    def make_merger(self):
633
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
615
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
634
616
                  'other_tree': self.other_tree,
635
617
                  'interesting_ids': self.interesting_ids,
636
618
                  'interesting_files': self.interesting_files,
637
619
                  'this_branch': self.this_branch,
 
620
                  'other_branch': self.other_branch,
638
621
                  'do_merge': False}
639
622
        if self.merge_type.requires_base:
640
623
            kwargs['base_tree'] = self.base_tree
666
649
        merge = self.make_merger()
667
650
        if self.other_branch is not None:
668
651
            self.other_branch.update_references(self.this_branch)
 
652
        for hook in Merger.hooks['pre_merge']:
 
653
            hook(merge)
669
654
        merge.do_merge()
 
655
        for hook in Merger.hooks['post_merge']:
 
656
            hook(merge)
670
657
        if self.recurse == 'down':
671
658
            for relpath, file_id in self.this_tree.iter_references():
672
659
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
676
663
                    continue
677
664
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
665
                sub_merge.merge_type = self.merge_type
679
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
666
                other_branch = self.other_branch.reference_parent(file_id,
 
667
                                                                  relpath)
680
668
                sub_merge.set_other_revision(other_revision, other_branch)
681
669
                base_revision = self.base_tree.get_reference_revision(file_id)
682
670
                sub_merge.base_tree = \
686
674
        return merge
687
675
 
688
676
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
 
677
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
690
678
        self.this_tree.lock_tree_write()
691
679
        operation.add_cleanup(self.this_tree.unlock)
692
680
        if self.base_tree is not None:
698
686
        merge = operation.run_simple()
699
687
        if len(merge.cooked_conflicts) == 0:
700
688
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
689
                trace.note(gettext("All changes applied successfully."))
702
690
        else:
703
 
            trace.note("%d conflicts encountered."
 
691
            trace.note(gettext("%d conflicts encountered.")
704
692
                       % len(merge.cooked_conflicts))
705
693
 
706
694
        return len(merge.cooked_conflicts)
738
726
                 interesting_ids=None, reprocess=False, show_base=False,
739
727
                 pb=None, pp=None, change_reporter=None,
740
728
                 interesting_files=None, do_merge=True,
741
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
729
                 cherrypick=False, lca_trees=None, this_branch=None,
 
730
                 other_branch=None):
742
731
        """Initialize the merger object and perform the merge.
743
732
 
744
733
        :param working_tree: The working tree to apply the merge to
747
736
        :param other_tree: The other tree to merge changes from
748
737
        :param this_branch: The branch associated with this_tree.  Defaults to
749
738
            this_tree.branch if not supplied.
 
739
        :param other_branch: The branch associated with other_tree, if any.
750
740
        :param interesting_ids: The file_ids of files that should be
751
741
            participate in the merge.  May not be combined with
752
742
            interesting_files.
774
764
            this_branch = this_tree.branch
775
765
        self.interesting_ids = interesting_ids
776
766
        self.interesting_files = interesting_files
777
 
        self.this_tree = working_tree
 
767
        self.working_tree = working_tree
 
768
        self.this_tree = this_tree
778
769
        self.base_tree = base_tree
779
770
        self.other_tree = other_tree
780
771
        self.this_branch = this_branch
 
772
        self.other_branch = other_branch
781
773
        self._raw_conflicts = []
782
774
        self.cooked_conflicts = []
783
775
        self.reprocess = reprocess
798
790
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
791
 
800
792
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
 
        self.this_tree.lock_tree_write()
 
793
        operation = cleanup.OperationWithCleanups(self._do_merge)
 
794
        self.working_tree.lock_tree_write()
 
795
        operation.add_cleanup(self.working_tree.unlock)
 
796
        self.this_tree.lock_read()
803
797
        operation.add_cleanup(self.this_tree.unlock)
804
798
        self.base_tree.lock_read()
805
799
        operation.add_cleanup(self.base_tree.unlock)
808
802
        operation.run()
809
803
 
810
804
    def _do_merge(self, operation):
811
 
        self.tt = transform.TreeTransform(self.this_tree, None)
 
805
        self.tt = transform.TreeTransform(self.working_tree, None)
812
806
        operation.add_cleanup(self.tt.finalize)
813
807
        self._compute_transform()
814
808
        results = self.tt.apply(no_conflicts=True)
815
809
        self.write_modified(results)
816
810
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
 
811
            self.working_tree.add_conflicts(self.cooked_conflicts)
818
812
        except errors.UnsupportedOperation:
819
813
            pass
820
814
 
821
815
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
 
816
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
823
817
        self.base_tree.lock_read()
824
818
        operation.add_cleanup(self.base_tree.unlock)
825
819
        self.other_tree.lock_read()
827
821
        return operation.run_simple()
828
822
 
829
823
    def _make_preview_transform(self):
830
 
        self.tt = transform.TransformPreview(self.this_tree)
 
824
        self.tt = transform.TransformPreview(self.working_tree)
831
825
        self._compute_transform()
832
826
        return self.tt
833
827
 
838
832
        else:
839
833
            entries = self._entries_lca()
840
834
            resolver = self._lca_multi_way
 
835
        # Prepare merge hooks
 
836
        factories = Merger.hooks['merge_file_content']
 
837
        # One hook for each registered one plus our default merger
 
838
        hooks = [factory(self) for factory in factories] + [self]
 
839
        self.active_hooks = [hook for hook in hooks if hook is not None]
841
840
        child_pb = ui.ui_factory.nested_progress_bar()
842
841
        try:
843
 
            factories = Merger.hooks['merge_file_content']
844
 
            hooks = [factory(self) for factory in factories] + [self]
845
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
846
842
            for num, (file_id, changed, parents3, names3,
847
843
                      executable3) in enumerate(entries):
848
 
                child_pb.update('Preparing file merge', num, len(entries))
 
844
                # Try merging each entry
 
845
                child_pb.update(gettext('Preparing file merge'),
 
846
                                num, len(entries))
849
847
                self._merge_names(file_id, parents3, names3, resolver=resolver)
850
848
                if changed:
851
849
                    file_status = self._do_merge_contents(file_id)
855
853
                    executable3, file_status, resolver=resolver)
856
854
        finally:
857
855
            child_pb.finished()
858
 
        self.fix_root()
 
856
        self.tt.fixup_new_roots()
 
857
        self._finish_computing_transform()
 
858
 
 
859
    def _finish_computing_transform(self):
 
860
        """Finalize the transform and report the changes.
 
861
 
 
862
        This is the second half of _compute_transform.
 
863
        """
859
864
        child_pb = ui.ui_factory.nested_progress_bar()
860
865
        try:
861
866
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
868
873
                self.tt.iter_changes(), self.change_reporter)
869
874
        self.cook_conflicts(fs_conflicts)
870
875
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
876
            trace.warning(unicode(conflict))
872
877
 
873
878
    def _entries3(self):
874
879
        """Gather data about files modified between three trees.
881
886
        """
882
887
        result = []
883
888
        iterator = self.other_tree.iter_changes(self.base_tree,
884
 
                include_unchanged=True, specific_files=self.interesting_files,
 
889
                specific_files=self.interesting_files,
885
890
                extra_trees=[self.this_tree])
886
891
        this_entries = dict((e.file_id, e) for p, e in
887
892
                            self.this_tree.iter_entries_by_dir(
913
918
        it then compares with THIS and BASE.
914
919
 
915
920
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
 
        :return: [(file_id, changed, parents, names, executable)]
917
 
            file_id     Simple file_id of the entry
918
 
            changed     Boolean, True if the kind or contents changed
919
 
                        else False
920
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
921
 
                         parent_id_this)
922
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
923
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
921
 
 
922
        :return: [(file_id, changed, parents, names, executable)], where:
 
923
 
 
924
            * file_id: Simple file_id of the entry
 
925
            * changed: Boolean, True if the kind or contents changed else False
 
926
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
927
                        parent_id_this)
 
928
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
929
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
930
                        exec_in_this)
924
931
        """
925
932
        if self.interesting_files is not None:
926
933
            lookup_trees = [self.this_tree, self.base_tree]
933
940
        result = []
934
941
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
935
942
 
936
 
        base_inventory = self.base_tree.inventory
937
 
        this_inventory = self.this_tree.inventory
 
943
        base_inventory = self.base_tree.root_inventory
 
944
        this_inventory = self.this_tree.root_inventory
938
945
        for path, file_id, other_ie, lca_values in walker.iter_all():
939
946
            # Is this modified at all from any of the other trees?
940
947
            if other_ie is None:
968
975
                else:
969
976
                    lca_entries.append(lca_ie)
970
977
 
971
 
            if file_id in base_inventory:
 
978
            if base_inventory.has_id(file_id):
972
979
                base_ie = base_inventory[file_id]
973
980
            else:
974
981
                base_ie = _none_entry
975
982
 
976
 
            if file_id in this_inventory:
 
983
            if this_inventory.has_id(file_id):
977
984
                this_ie = this_inventory[file_id]
978
985
            else:
979
986
                this_ie = _none_entry
1071
1078
                          ))
1072
1079
        return result
1073
1080
 
1074
 
 
1075
 
    def fix_root(self):
1076
 
        try:
1077
 
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
1079
 
            self.tt.cancel_deletion(self.tt.root)
1080
 
        if self.tt.final_file_id(self.tt.root) is None:
1081
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1082
 
                                 self.tt.root)
1083
 
        other_root_file_id = self.other_tree.get_root_id()
1084
 
        if other_root_file_id is None:
1085
 
            return
1086
 
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
 
        if other_root == self.tt.root:
1088
 
            return
1089
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
 
            # the other tree's root is a non-root in the current tree (as when
1091
 
            # a previously unrelated branch is merged into another)
1092
 
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
1095
 
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
1097
 
            # other_root doesn't have a physical representation. We still need
1098
 
            # to move any references to the actual root of the tree.
1099
 
            other_root_is_present = False
1100
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
 
        # calling adjust_path for children which *want* to be present with a
1102
 
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1104
 
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
 
            if not other_root_is_present:
1106
 
                # FIXME: Make final_kind returns None instead of raising
1107
 
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1108
 
                try:
1109
 
                    self.tt.final_kind(trans_id)
1110
 
                    # The item exist in the final tree and has a defined place
1111
 
                    # to go already.
1112
 
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
 
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
1118
 
        if other_root_is_present:
1119
 
            self.tt.cancel_creation(other_root)
1120
 
            self.tt.cancel_versioning(other_root)
1121
 
 
1122
1081
    def write_modified(self, results):
1123
1082
        modified_hashes = {}
1124
1083
        for path in results.modified_paths:
1125
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
1084
            file_id = self.working_tree.path2id(self.working_tree.relpath(path))
1126
1085
            if file_id is None:
1127
1086
                continue
1128
 
            hash = self.this_tree.get_file_sha1(file_id)
 
1087
            hash = self.working_tree.get_file_sha1(file_id)
1129
1088
            if hash is None:
1130
1089
                continue
1131
1090
            modified_hashes[file_id] = hash
1132
 
        self.this_tree.set_merge_modified(modified_hashes)
 
1091
        self.working_tree.set_merge_modified(modified_hashes)
1133
1092
 
1134
1093
    @staticmethod
1135
1094
    def parent(entry, file_id):
1148
1107
    @staticmethod
1149
1108
    def contents_sha1(tree, file_id):
1150
1109
        """Determine the sha1 of the file contents (used as a key method)."""
1151
 
        if file_id not in tree:
 
1110
        if not tree.has_id(file_id):
1152
1111
            return None
1153
1112
        return tree.get_file_sha1(file_id)
1154
1113
 
1234
1193
        # At this point, the lcas disagree, and the tip disagree
1235
1194
        return 'conflict'
1236
1195
 
1237
 
    @staticmethod
1238
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1239
 
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
 
        """Do a three-way test on a scalar.
1241
 
        Return "this", "other" or "conflict", depending whether a value wins.
1242
 
        """
1243
 
        key_base = key(base_tree, file_id)
1244
 
        key_other = key(other_tree, file_id)
1245
 
        #if base == other, either they all agree, or only THIS has changed.
1246
 
        if key_base == key_other:
1247
 
            return "this"
1248
 
        key_this = key(this_tree, file_id)
1249
 
        # "Ambiguous clean merge"
1250
 
        if key_this == key_other:
1251
 
            return "this"
1252
 
        elif key_this == key_base:
1253
 
            return "other"
1254
 
        else:
1255
 
            return "conflict"
1256
 
 
1257
1196
    def merge_names(self, file_id):
1258
1197
        def get_entry(tree):
1259
 
            if tree.has_id(file_id):
1260
 
                return tree.inventory[file_id]
1261
 
            else:
 
1198
            try:
 
1199
                return tree.root_inventory[file_id]
 
1200
            except errors.NoSuchId:
1262
1201
                return None
1263
1202
        this_entry = get_entry(self.this_tree)
1264
1203
        other_entry = get_entry(self.other_tree)
1299
1238
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1239
                                        this_parent, this_name,
1301
1240
                                        other_parent, other_name))
1302
 
        if other_name is None:
 
1241
        if not self.other_tree.has_id(file_id):
1303
1242
            # it doesn't matter whether the result was 'other' or
1304
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1243
            # 'conflict'-- if it has no file id, we leave it alone.
1305
1244
            return
1306
1245
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
 
        if parent_id is not None:
 
1246
        name = names[self.winner_idx[name_winner]]
 
1247
        if parent_id is not None or name is not None:
1308
1248
            # if we get here, name_winner and parent_winner are set to safe
1309
1249
            # values.
1310
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
 
1250
            if parent_id is None and name is not None:
 
1251
                # if parent_id is None and name is non-None, current file is
 
1252
                # the tree root.
 
1253
                if names[self.winner_idx[parent_id_winner]] != '':
 
1254
                    raise AssertionError(
 
1255
                        'File looks like a root, but named %s' %
 
1256
                        names[self.winner_idx[parent_id_winner]])
 
1257
                parent_trans_id = transform.ROOT_PARENT
 
1258
            else:
 
1259
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1260
            self.tt.adjust_path(name, parent_trans_id,
1312
1261
                                self.tt.trans_id_file_id(file_id))
1313
1262
 
1314
1263
    def _do_merge_contents(self, file_id):
1315
1264
        """Performs a merge on file_id contents."""
1316
1265
        def contents_pair(tree):
1317
 
            if file_id not in tree:
 
1266
            if not tree.has_id(file_id):
1318
1267
                return (None, None)
1319
1268
            kind = tree.kind(file_id)
1320
1269
            if kind == "file":
1349
1298
        # We have a hypothetical conflict, but if we have files, then we
1350
1299
        # can try to merge the content
1351
1300
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
 
1301
        params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1353
1302
            other_pair[0], winner)
1354
1303
        hooks = self.active_hooks
1355
1304
        hook_status = 'not_applicable'
1358
1307
            if hook_status != 'not_applicable':
1359
1308
                # Don't try any more hooks, this one applies.
1360
1309
                break
 
1310
        # If the merge ends up replacing the content of the file, we get rid of
 
1311
        # it at the end of this method (this variable is used to track the
 
1312
        # exceptions to this rule).
 
1313
        keep_this = False
1361
1314
        result = "modified"
1362
1315
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
 
1316
            # No merge hook was able to resolve the situation. Two cases exist:
 
1317
            # a content conflict or a duplicate one.
1365
1318
            result = None
1366
1319
            name = self.tt.final_name(trans_id)
1367
1320
            parent_id = self.tt.final_parent(trans_id)
1368
 
            if self.this_tree.has_id(file_id):
1369
 
                self.tt.unversion_file(trans_id)
1370
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1371
 
                                              set_version=True)
1372
 
            self._raw_conflicts.append(('contents conflict', file_group))
 
1321
            duplicate = False
 
1322
            inhibit_content_conflict = False
 
1323
            if params.this_kind is None: # file_id is not in THIS
 
1324
                # Is the name used for a different file_id ?
 
1325
                dupe_path = self.other_tree.id2path(file_id)
 
1326
                this_id = self.this_tree.path2id(dupe_path)
 
1327
                if this_id is not None:
 
1328
                    # Two entries for the same path
 
1329
                    keep_this = True
 
1330
                    # versioning the merged file will trigger a duplicate
 
1331
                    # conflict
 
1332
                    self.tt.version_file(file_id, trans_id)
 
1333
                    transform.create_from_tree(
 
1334
                        self.tt, trans_id, self.other_tree, file_id,
 
1335
                        filter_tree_path=self._get_filter_tree_path(file_id))
 
1336
                    inhibit_content_conflict = True
 
1337
            elif params.other_kind is None: # file_id is not in OTHER
 
1338
                # Is the name used for a different file_id ?
 
1339
                dupe_path = self.this_tree.id2path(file_id)
 
1340
                other_id = self.other_tree.path2id(dupe_path)
 
1341
                if other_id is not None:
 
1342
                    # Two entries for the same path again, but here, the other
 
1343
                    # entry will also be merged.  We simply inhibit the
 
1344
                    # 'content' conflict creation because we know OTHER will
 
1345
                    # create (or has already created depending on ordering) an
 
1346
                    # entry at the same path. This will trigger a 'duplicate'
 
1347
                    # conflict later.
 
1348
                    keep_this = True
 
1349
                    inhibit_content_conflict = True
 
1350
            if not inhibit_content_conflict:
 
1351
                if params.this_kind is not None:
 
1352
                    self.tt.unversion_file(trans_id)
 
1353
                # This is a contents conflict, because none of the available
 
1354
                # functions could merge it.
 
1355
                file_group = self._dump_conflicts(name, parent_id, file_id,
 
1356
                                                  set_version=True)
 
1357
                self._raw_conflicts.append(('contents conflict', file_group))
1373
1358
        elif hook_status == 'success':
1374
1359
            self.tt.create_file(lines, trans_id)
1375
1360
        elif hook_status == 'conflicted':
1391
1376
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
1377
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
1378
            self.tt.version_file(file_id, trans_id)
1394
 
        # The merge has been performed, so the old contents should not be
1395
 
        # retained.
1396
 
        try:
 
1379
        if not keep_this:
 
1380
            # The merge has been performed and produced a new content, so the
 
1381
            # old contents should not be retained.
1397
1382
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
1383
        return result
1401
1384
 
1402
1385
    def _default_other_winner_merge(self, merge_hook_params):
1403
1386
        """Replace this contents with other."""
1404
1387
        file_id = merge_hook_params.file_id
1405
1388
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
1389
        if self.other_tree.has_id(file_id):
1408
1390
            # OTHER changed the file
1409
 
            wt = self.this_tree
1410
 
            if wt.supports_content_filtering():
1411
 
                # We get the path from the working tree if it exists.
1412
 
                # That fails though when OTHER is adding a file, so
1413
 
                # we fall back to the other tree to find the path if
1414
 
                # it doesn't exist locally.
1415
 
                try:
1416
 
                    filter_tree_path = wt.id2path(file_id)
1417
 
                except errors.NoSuchId:
1418
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1419
 
            else:
1420
 
                # Skip the id2path lookup for older formats
1421
 
                filter_tree_path = None
1422
 
            transform.create_from_tree(self.tt, trans_id,
1423
 
                             self.other_tree, file_id,
1424
 
                             filter_tree_path=filter_tree_path)
 
1391
            transform.create_from_tree(
 
1392
                self.tt, trans_id, self.other_tree, file_id,
 
1393
                filter_tree_path=self._get_filter_tree_path(file_id))
1425
1394
            return 'done', None
1426
 
        elif file_in_this:
 
1395
        elif self.this_tree.has_id(file_id):
1427
1396
            # OTHER deleted the file
1428
1397
            return 'delete', None
1429
1398
        else:
1455
1424
    def get_lines(self, tree, file_id):
1456
1425
        """Return the lines in a file, or an empty list."""
1457
1426
        if tree.has_id(file_id):
1458
 
            return tree.get_file(file_id).readlines()
 
1427
            return tree.get_file_lines(file_id)
1459
1428
        else:
1460
1429
            return []
1461
1430
 
1503
1472
                                              other_lines)
1504
1473
            file_group.append(trans_id)
1505
1474
 
 
1475
 
 
1476
    def _get_filter_tree_path(self, file_id):
 
1477
        if self.this_tree.supports_content_filtering():
 
1478
            # We get the path from the working tree if it exists.
 
1479
            # That fails though when OTHER is adding a file, so
 
1480
            # we fall back to the other tree to find the path if
 
1481
            # it doesn't exist locally.
 
1482
            try:
 
1483
                return self.this_tree.id2path(file_id)
 
1484
            except errors.NoSuchId:
 
1485
                return self.other_tree.id2path(file_id)
 
1486
        # Skip the id2path lookup for older formats
 
1487
        return None
 
1488
 
1506
1489
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1507
1490
                        base_lines=None, other_lines=None, set_version=False,
1508
1491
                        no_base=False):
1574
1557
        if winner == 'this' and file_status != "modified":
1575
1558
            return
1576
1559
        trans_id = self.tt.trans_id_file_id(file_id)
1577
 
        try:
1578
 
            if self.tt.final_kind(trans_id) != "file":
1579
 
                return
1580
 
        except errors.NoSuchFile:
 
1560
        if self.tt.final_kind(trans_id) != "file":
1581
1561
            return
1582
1562
        if winner == "this":
1583
1563
            executability = this_executable
1594
1574
 
1595
1575
    def cook_conflicts(self, fs_conflicts):
1596
1576
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1597
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1598
 
                fs_conflicts, self.tt))
 
1577
        content_conflict_file_ids = set()
 
1578
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1599
1579
        fp = transform.FinalPaths(self.tt)
1600
1580
        for conflict in self._raw_conflicts:
1601
1581
            conflict_type = conflict[0]
1612
1592
                if other_parent is None or other_name is None:
1613
1593
                    other_path = '<deleted>'
1614
1594
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
 
1595
                    if other_parent == self.other_tree.get_root_id():
 
1596
                        # The tree transform doesn't know about the other root,
 
1597
                        # so we special case here to avoid a NoFinalPath
 
1598
                        # exception
 
1599
                        parent_path = ''
 
1600
                    else:
 
1601
                        parent_path =  fp.get_path(
 
1602
                            self.tt.trans_id_file_id(other_parent))
1617
1603
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
1604
                c = _mod_conflicts.Conflict.factory(
1619
1605
                    'path conflict', path=this_path,
1623
1609
                for trans_id in conflict[1]:
1624
1610
                    file_id = self.tt.final_file_id(trans_id)
1625
1611
                    if file_id is not None:
 
1612
                        # Ok we found the relevant file-id
1626
1613
                        break
1627
1614
                path = fp.get_path(trans_id)
1628
1615
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1629
1616
                    if path.endswith(suffix):
 
1617
                        # Here is the raw path
1630
1618
                        path = path[:-len(suffix)]
1631
1619
                        break
1632
1620
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
1621
                                                    path=path, file_id=file_id)
 
1622
                content_conflict_file_ids.add(file_id)
1634
1623
            elif conflict_type == 'text conflict':
1635
1624
                trans_id = conflict[1]
1636
1625
                path = fp.get_path(trans_id)
1639
1628
                                                    path=path, file_id=file_id)
1640
1629
            else:
1641
1630
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1631
            cooked_conflicts.append(c)
 
1632
 
 
1633
        self.cooked_conflicts = []
 
1634
        # We want to get rid of path conflicts when a corresponding contents
 
1635
        # conflict exists. This can occur when one branch deletes a file while
 
1636
        # the other renames *and* modifies it. In this case, the content
 
1637
        # conflict is enough.
 
1638
        for c in cooked_conflicts:
 
1639
            if (c.typestring == 'path conflict'
 
1640
                and c.file_id in content_conflict_file_ids):
 
1641
                continue
1642
1642
            self.cooked_conflicts.append(c)
1643
1643
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1644
1644
 
1750
1750
            osutils.rmtree(temp_dir)
1751
1751
 
1752
1752
 
 
1753
class PathNotInTree(errors.BzrError):
 
1754
 
 
1755
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
 
1756
 
 
1757
    def __init__(self, path, tree):
 
1758
        errors.BzrError.__init__(self, path=path, tree=tree)
 
1759
 
 
1760
 
 
1761
class MergeIntoMerger(Merger):
 
1762
    """Merger that understands other_tree will be merged into a subdir.
 
1763
 
 
1764
    This also changes the Merger api so that it uses real Branch, revision_id,
 
1765
    and RevisonTree objects, rather than using revision specs.
 
1766
    """
 
1767
 
 
1768
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
 
1769
            source_subpath, other_rev_id=None):
 
1770
        """Create a new MergeIntoMerger object.
 
1771
 
 
1772
        source_subpath in other_tree will be effectively copied to
 
1773
        target_subdir in this_tree.
 
1774
 
 
1775
        :param this_tree: The tree that we will be merging into.
 
1776
        :param other_branch: The Branch we will be merging from.
 
1777
        :param other_tree: The RevisionTree object we want to merge.
 
1778
        :param target_subdir: The relative path where we want to merge
 
1779
            other_tree into this_tree
 
1780
        :param source_subpath: The relative path specifying the subtree of
 
1781
            other_tree to merge into this_tree.
 
1782
        """
 
1783
        # It is assumed that we are merging a tree that is not in our current
 
1784
        # ancestry, which means we are using the "EmptyTree" as our basis.
 
1785
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
 
1786
                                _mod_revision.NULL_REVISION)
 
1787
        super(MergeIntoMerger, self).__init__(
 
1788
            this_branch=this_tree.branch,
 
1789
            this_tree=this_tree,
 
1790
            other_tree=other_tree,
 
1791
            base_tree=null_ancestor_tree,
 
1792
            )
 
1793
        self._target_subdir = target_subdir
 
1794
        self._source_subpath = source_subpath
 
1795
        self.other_branch = other_branch
 
1796
        if other_rev_id is None:
 
1797
            other_rev_id = other_tree.get_revision_id()
 
1798
        self.other_rev_id = self.other_basis = other_rev_id
 
1799
        self.base_is_ancestor = True
 
1800
        self.backup_files = True
 
1801
        self.merge_type = Merge3Merger
 
1802
        self.show_base = False
 
1803
        self.reprocess = False
 
1804
        self.interesting_ids = None
 
1805
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
 
1806
              target_subdir=self._target_subdir,
 
1807
              source_subpath=self._source_subpath)
 
1808
        if self._source_subpath != '':
 
1809
            # If this isn't a partial merge make sure the revisions will be
 
1810
            # present.
 
1811
            self._maybe_fetch(self.other_branch, self.this_branch,
 
1812
                self.other_basis)
 
1813
 
 
1814
    def set_pending(self):
 
1815
        if self._source_subpath != '':
 
1816
            return
 
1817
        Merger.set_pending(self)
 
1818
 
 
1819
 
 
1820
class _MergeTypeParameterizer(object):
 
1821
    """Wrap a merge-type class to provide extra parameters.
 
1822
    
 
1823
    This is hack used by MergeIntoMerger to pass some extra parameters to its
 
1824
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
 
1825
    the 'merge_type' member.  It is difficult override do_merge without
 
1826
    re-writing the whole thing, so instead we create a wrapper which will pass
 
1827
    the extra parameters.
 
1828
    """
 
1829
 
 
1830
    def __init__(self, merge_type, **kwargs):
 
1831
        self._extra_kwargs = kwargs
 
1832
        self._merge_type = merge_type
 
1833
 
 
1834
    def __call__(self, *args, **kwargs):
 
1835
        kwargs.update(self._extra_kwargs)
 
1836
        return self._merge_type(*args, **kwargs)
 
1837
 
 
1838
    def __getattr__(self, name):
 
1839
        return getattr(self._merge_type, name)
 
1840
 
 
1841
 
 
1842
class MergeIntoMergeType(Merge3Merger):
 
1843
    """Merger that incorporates a tree (or part of a tree) into another."""
 
1844
 
 
1845
    def __init__(self, *args, **kwargs):
 
1846
        """Initialize the merger object.
 
1847
 
 
1848
        :param args: See Merge3Merger.__init__'s args.
 
1849
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
 
1850
            source_subpath and target_subdir.
 
1851
        :keyword source_subpath: The relative path specifying the subtree of
 
1852
            other_tree to merge into this_tree.
 
1853
        :keyword target_subdir: The relative path where we want to merge
 
1854
            other_tree into this_tree
 
1855
        """
 
1856
        # All of the interesting work happens during Merge3Merger.__init__(),
 
1857
        # so we have have to hack in to get our extra parameters set.
 
1858
        self._source_subpath = kwargs.pop('source_subpath')
 
1859
        self._target_subdir = kwargs.pop('target_subdir')
 
1860
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
 
1861
 
 
1862
    def _compute_transform(self):
 
1863
        child_pb = ui.ui_factory.nested_progress_bar()
 
1864
        try:
 
1865
            entries = self._entries_to_incorporate()
 
1866
            entries = list(entries)
 
1867
            for num, (entry, parent_id) in enumerate(entries):
 
1868
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
 
1869
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1870
                trans_id = transform.new_by_entry(self.tt, entry,
 
1871
                    parent_trans_id, self.other_tree)
 
1872
        finally:
 
1873
            child_pb.finished()
 
1874
        self._finish_computing_transform()
 
1875
 
 
1876
    def _entries_to_incorporate(self):
 
1877
        """Yields pairs of (inventory_entry, new_parent)."""
 
1878
        other_inv = self.other_tree.root_inventory
 
1879
        subdir_id = other_inv.path2id(self._source_subpath)
 
1880
        if subdir_id is None:
 
1881
            # XXX: The error would be clearer if it gave the URL of the source
 
1882
            # branch, but we don't have a reference to that here.
 
1883
            raise PathNotInTree(self._source_subpath, "Source tree")
 
1884
        subdir = other_inv[subdir_id]
 
1885
        parent_in_target = osutils.dirname(self._target_subdir)
 
1886
        target_id = self.this_tree.path2id(parent_in_target)
 
1887
        if target_id is None:
 
1888
            raise PathNotInTree(self._target_subdir, "Target tree")
 
1889
        name_in_target = osutils.basename(self._target_subdir)
 
1890
        merge_into_root = subdir.copy()
 
1891
        merge_into_root.name = name_in_target
 
1892
        if self.this_tree.has_id(merge_into_root.file_id):
 
1893
            # Give the root a new file-id.
 
1894
            # This can happen fairly easily if the directory we are
 
1895
            # incorporating is the root, and both trees have 'TREE_ROOT' as
 
1896
            # their root_id.  Users will expect this to Just Work, so we
 
1897
            # change the file-id here.
 
1898
            # Non-root file-ids could potentially conflict too.  That's really
 
1899
            # an edge case, so we don't do anything special for those.  We let
 
1900
            # them cause conflicts.
 
1901
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
 
1902
        yield (merge_into_root, target_id)
 
1903
        if subdir.kind != 'directory':
 
1904
            # No children, so we are done.
 
1905
            return
 
1906
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
 
1907
            parent_id = entry.parent_id
 
1908
            if parent_id == subdir.file_id:
 
1909
                # The root's parent ID has changed, so make sure children of
 
1910
                # the root refer to the new ID.
 
1911
                parent_id = merge_into_root.file_id
 
1912
            yield (entry, parent_id)
 
1913
 
 
1914
 
1753
1915
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1916
                backup_files=False,
1755
1917
                merge_type=Merge3Merger,
1763
1925
                change_reporter=None):
1764
1926
    """Primary interface for merging.
1765
1927
 
1766
 
        typical use is probably
1767
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
 
                     branch.get_revision_tree(base_revision))'
1769
 
        """
 
1928
    Typical use is probably::
 
1929
 
 
1930
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
1931
                    branch.get_revision_tree(base_revision))
 
1932
    """
1770
1933
    if this_tree is None:
1771
1934
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
1935
                              "parameter")
1773
1936
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
1937
                    pb=pb, change_reporter=change_reporter)
1775
1938
    merger.backup_files = backup_files
1792
1955
    merger.set_base_revision(get_revision_id(), this_branch)
1793
1956
    return merger.do_merge()
1794
1957
 
 
1958
 
 
1959
merge_type_registry = registry.Registry()
 
1960
merge_type_registry.register('diff3', Diff3Merger,
 
1961
                             "Merge using external diff3.")
 
1962
merge_type_registry.register('lca', LCAMerger,
 
1963
                             "LCA-newness merge.")
 
1964
merge_type_registry.register('merge3', Merge3Merger,
 
1965
                             "Native diff3-style merge.")
 
1966
merge_type_registry.register('weave', WeaveMerger,
 
1967
                             "Weave-based merge.")
 
1968
 
 
1969
 
1795
1970
def get_merge_type_registry():
1796
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1971
    """Merge type registry was previously in bzrlib.option
1797
1972
 
1798
 
    This method provides a sanctioned way to retrieve it.
 
1973
    This method provides a backwards compatible way to retrieve it.
1799
1974
    """
1800
 
    from bzrlib import option
1801
 
    return option._merge_type_registry
 
1975
    return merge_type_registry
1802
1976
 
1803
1977
 
1804
1978
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2229
2403
class _PlanLCAMerge(_PlanMergeBase):
2230
2404
    """
2231
2405
    This merge algorithm differs from _PlanMerge in that:
 
2406
 
2232
2407
    1. comparisons are done against LCAs only
2233
2408
    2. cases where a contested line is new versus one LCA but old versus
2234
2409
       another are marked as conflicts, by emitting the line as conflicted-a
2275
2450
 
2276
2451
        If a line is killed and new, this indicates that the two merge
2277
2452
        revisions contain differing conflict resolutions.
 
2453
 
2278
2454
        :param revision_id: The id of the revision in which the lines are
2279
2455
            unique
2280
2456
        :param unique_line_numbers: The line numbers of unique lines.
2281
 
        :return a tuple of (new_this, killed_other):
 
2457
        :return: a tuple of (new_this, killed_other)
2282
2458
        """
2283
2459
        new = set()
2284
2460
        killed = set()