~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Jelmer Vernooij
  • Date: 2010-04-30 11:03:59 UTC
  • mto: This revision was merged to the branch mainline in revision 5197.
  • Revision ID: jelmer@samba.org-20100430110359-ow3e3grh7sxy93pa
Remove more unused imports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
16
16
 
17
17
import warnings
18
18
 
19
 
from bzrlib.lazy_import import lazy_import
20
 
lazy_import(globals(), """
21
19
from bzrlib import (
22
20
    branch as _mod_branch,
23
 
    cleanup,
24
21
    conflicts as _mod_conflicts,
25
22
    debug,
26
 
    generate_ids,
 
23
    decorators,
 
24
    errors,
27
25
    graph as _mod_graph,
 
26
    hooks,
28
27
    merge3,
29
28
    osutils,
30
29
    patiencediff,
35
34
    tree as _mod_tree,
36
35
    tsort,
37
36
    ui,
38
 
    versionedfile,
39
 
    workingtree,
40
 
    )
41
 
""")
42
 
from bzrlib import (
43
 
    decorators,
44
 
    errors,
45
 
    hooks,
46
 
    )
 
37
    versionedfile
 
38
    )
 
39
from bzrlib.cleanup import OperationWithCleanups
47
40
from bzrlib.symbol_versioning import (
48
41
    deprecated_in,
49
42
    deprecated_method,
53
46
 
54
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
55
48
    from_tree.lock_tree_write()
56
 
    operation = cleanup.OperationWithCleanups(merge_inner)
 
49
    operation = OperationWithCleanups(merge_inner)
57
50
    operation.add_cleanup(from_tree.unlock)
58
51
    operation.run_simple(from_tree.branch, to_tree, from_tree,
59
52
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
62
55
class MergeHooks(hooks.Hooks):
63
56
 
64
57
    def __init__(self):
65
 
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
66
 
        self.add_hook('merge_file_content',
 
58
        hooks.Hooks.__init__(self)
 
59
        self.create_hook(hooks.HookPoint('merge_file_content',
67
60
            "Called with a bzrlib.merge.Merger object to create a per file "
68
61
            "merge object when starting a merge. "
69
62
            "Should return either None or a subclass of "
73
66
            "side has deleted the file and the other has changed it). "
74
67
            "See the AbstractPerFileMerger API docs for details on how it is "
75
68
            "used by merge.",
76
 
            (2, 1))
 
69
            (2, 1), None))
77
70
 
78
71
 
79
72
class AbstractPerFileMerger(object):
100
93
        return ('not applicable', None)
101
94
 
102
95
 
103
 
class PerFileMerger(AbstractPerFileMerger):
104
 
    """Merge individual files when self.file_matches returns True.
105
 
 
106
 
    This class is intended to be subclassed.  The file_matches and
107
 
    merge_matching methods should be overridden with concrete implementations.
108
 
    """
109
 
 
110
 
    def file_matches(self, params):
111
 
        """Return True if merge_matching should be called on this file.
112
 
 
113
 
        Only called with merges of plain files with no clear winner.
114
 
 
115
 
        Subclasses must override this.
116
 
        """
117
 
        raise NotImplementedError(self.file_matches)
118
 
 
119
 
    def get_filename(self, params, tree):
120
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
 
        self.merger.this_tree) and a MergeHookParams.
122
 
        """
123
 
        return osutils.basename(tree.id2path(params.file_id))
124
 
 
125
 
    def get_filepath(self, params, tree):
126
 
        """Calculate the path to the file in a tree.
127
 
 
128
 
        :param params: A MergeHookParams describing the file to merge
129
 
        :param tree: a Tree, e.g. self.merger.this_tree.
130
 
        """
131
 
        return tree.id2path(params.file_id)
132
 
 
133
 
    def merge_contents(self, params):
134
 
        """Merge the contents of a single file."""
135
 
        # Check whether this custom merge logic should be used.
136
 
        if (
137
 
            # OTHER is a straight winner, rely on default merge.
138
 
            params.winner == 'other' or
139
 
            # THIS and OTHER aren't both files.
140
 
            not params.is_file_merge() or
141
 
            # The filename doesn't match *.xml
142
 
            not self.file_matches(params)):
143
 
            return 'not_applicable', None
144
 
        return self.merge_matching(params)
145
 
 
146
 
    def merge_matching(self, params):
147
 
        """Merge the contents of a single file that has matched the criteria
148
 
        in PerFileMerger.merge_contents (is a conflict, is a file,
149
 
        self.file_matches is True).
150
 
 
151
 
        Subclasses must override this.
152
 
        """
153
 
        raise NotImplementedError(self.merge_matching)
154
 
 
155
 
 
156
 
class ConfigurableFileMerger(PerFileMerger):
 
96
class ConfigurableFileMerger(AbstractPerFileMerger):
157
97
    """Merge individual files when configured via a .conf file.
158
98
 
159
99
    This is a base class for concrete custom file merging logic. Concrete
182
122
        if self.name_prefix is None:
183
123
            raise ValueError("name_prefix must be set.")
184
124
 
185
 
    def file_matches(self, params):
 
125
    def filename_matches_config(self, params):
186
126
        """Check whether the file should call the merge hook.
187
127
 
188
128
        <name_prefix>_merge_files configuration variable is a list of files
202
142
                affected_files = self.default_files
203
143
            self.affected_files = affected_files
204
144
        if affected_files:
205
 
            filepath = self.get_filepath(params, self.merger.this_tree)
206
 
            if filepath in affected_files:
 
145
            filename = self.merger.this_tree.id2path(params.file_id)
 
146
            if filename in affected_files:
207
147
                return True
208
148
        return False
209
149
 
210
 
    def merge_matching(self, params):
 
150
    def merge_contents(self, params):
 
151
        """Merge the contents of a single file."""
 
152
        # First, check whether this custom merge logic should be used.  We
 
153
        # expect most files should not be merged by this handler.
 
154
        if (
 
155
            # OTHER is a straight winner, rely on default merge.
 
156
            params.winner == 'other' or
 
157
            # THIS and OTHER aren't both files.
 
158
            not params.is_file_merge() or
 
159
            # The filename isn't listed in the 'NAME_merge_files' config
 
160
            # option.
 
161
            not self.filename_matches_config(params)):
 
162
            return 'not_applicable', None
211
163
        return self.merge_text(params)
212
164
 
213
165
    def merge_text(self, params):
428
380
        return self._cached_trees[revision_id]
429
381
 
430
382
    def _get_tree(self, treespec, possible_transports=None):
 
383
        from bzrlib import workingtree
431
384
        location, revno = treespec
432
385
        if revno is None:
433
386
            tree = workingtree.WorkingTree.open_containing(location)[0]
458
411
    @deprecated_method(deprecated_in((2, 1, 0)))
459
412
    def file_revisions(self, file_id):
460
413
        self.ensure_revision_trees()
 
414
        def get_id(tree, file_id):
 
415
            revision_id = tree.inventory[file_id].revision
 
416
            return revision_id
461
417
        if self.this_rev_id is None:
462
418
            if self.this_basis_tree.get_file_sha1(file_id) != \
463
419
                self.this_tree.get_file_sha1(file_id):
464
420
                raise errors.WorkingTreeNotRevision(self.this_tree)
465
421
 
466
422
        trees = (self.this_basis_tree, self.other_tree)
467
 
        return [tree.get_file_revision(file_id) for tree in trees]
 
423
        return [get_id(tree, file_id) for tree in trees]
468
424
 
469
425
    @deprecated_method(deprecated_in((2, 1, 0)))
470
426
    def check_basis(self, check_clean, require_commits=True):
498
454
    def _add_parent(self):
499
455
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
500
456
        new_parent_trees = []
501
 
        operation = cleanup.OperationWithCleanups(
502
 
            self.this_tree.set_parent_trees)
 
457
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
503
458
        for revision_id in new_parents:
504
459
            try:
505
460
                tree = self.revision_tree(revision_id)
580
535
            elif len(lcas) == 1:
581
536
                self.base_rev_id = list(lcas)[0]
582
537
            else: # len(lcas) > 1
583
 
                self._is_criss_cross = True
584
538
                if len(lcas) > 2:
585
539
                    # find_unique_lca can only handle 2 nodes, so we have to
586
540
                    # start back at the beginning. It is a shame to traverse
591
545
                else:
592
546
                    self.base_rev_id = self.revision_graph.find_unique_lca(
593
547
                                            *lcas)
594
 
                sorted_lca_keys = self.revision_graph.find_merge_order(                
595
 
                    revisions[0], lcas)
596
 
                if self.base_rev_id == _mod_revision.NULL_REVISION:
597
 
                    self.base_rev_id = sorted_lca_keys[0]
598
 
                
 
548
                self._is_criss_cross = True
599
549
            if self.base_rev_id == _mod_revision.NULL_REVISION:
600
550
                raise errors.UnrelatedBranches()
601
551
            if self._is_criss_cross:
602
552
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
603
553
                              ' help criss-cross.')
604
554
                trace.mutter('Criss-cross lcas: %r' % lcas)
605
 
                if self.base_rev_id in lcas:
606
 
                    trace.mutter('Unable to find unique lca. '
607
 
                                 'Fallback %r as best option.' % self.base_rev_id)
608
 
                interesting_revision_ids = set(lcas)
609
 
                interesting_revision_ids.add(self.base_rev_id)
 
555
                interesting_revision_ids = [self.base_rev_id]
 
556
                interesting_revision_ids.extend(lcas)
610
557
                interesting_trees = dict((t.get_revision_id(), t)
611
558
                    for t in self.this_branch.repository.revision_trees(
612
559
                        interesting_revision_ids))
613
560
                self._cached_trees.update(interesting_trees)
614
 
                if self.base_rev_id in lcas:
615
 
                    self.base_tree = interesting_trees[self.base_rev_id]
616
 
                else:
617
 
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
 
561
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
562
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
563
                    revisions[0], lcas)
618
564
                self._lca_trees = [interesting_trees[key]
619
565
                                   for key in sorted_lca_keys]
620
566
            else:
699
645
        return merge
700
646
 
701
647
    def do_merge(self):
702
 
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
 
648
        operation = OperationWithCleanups(self._do_merge_to)
703
649
        self.this_tree.lock_tree_write()
704
650
        operation.add_cleanup(self.this_tree.unlock)
705
651
        if self.base_tree is not None:
758
704
        :param this_tree: The local tree in the merge operation
759
705
        :param base_tree: The common tree in the merge operation
760
706
        :param other_tree: The other tree to merge changes from
761
 
        :param this_branch: The branch associated with this_tree.  Defaults to
762
 
            this_tree.branch if not supplied.
 
707
        :param this_branch: The branch associated with this_tree
763
708
        :param interesting_ids: The file_ids of files that should be
764
709
            participate in the merge.  May not be combined with
765
710
            interesting_files.
783
728
        if interesting_files is not None and interesting_ids is not None:
784
729
            raise ValueError(
785
730
                'specify either interesting_ids or interesting_files')
786
 
        if this_branch is None:
787
 
            this_branch = this_tree.branch
788
731
        self.interesting_ids = interesting_ids
789
732
        self.interesting_files = interesting_files
790
733
        self.this_tree = working_tree
811
754
            warnings.warn("pb argument to Merge3Merger is deprecated")
812
755
 
813
756
    def do_merge(self):
814
 
        operation = cleanup.OperationWithCleanups(self._do_merge)
 
757
        operation = OperationWithCleanups(self._do_merge)
815
758
        self.this_tree.lock_tree_write()
816
759
        operation.add_cleanup(self.this_tree.unlock)
817
760
        self.base_tree.lock_read()
832
775
            pass
833
776
 
834
777
    def make_preview_transform(self):
835
 
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
 
778
        operation = OperationWithCleanups(self._make_preview_transform)
836
779
        self.base_tree.lock_read()
837
780
        operation.add_cleanup(self.base_tree.unlock)
838
781
        self.other_tree.lock_read()
869
812
        finally:
870
813
            child_pb.finished()
871
814
        self.fix_root()
872
 
        self._finish_computing_transform()
873
 
 
874
 
    def _finish_computing_transform(self):
875
 
        """Finalize the transform and report the changes.
876
 
 
877
 
        This is the second half of _compute_transform.
878
 
        """
879
815
        child_pb = ui.ui_factory.nested_progress_bar()
880
816
        try:
881
817
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
901
837
        """
902
838
        result = []
903
839
        iterator = self.other_tree.iter_changes(self.base_tree,
904
 
                specific_files=self.interesting_files,
 
840
                include_unchanged=True, specific_files=self.interesting_files,
905
841
                extra_trees=[self.this_tree])
906
842
        this_entries = dict((e.file_id, e) for p, e in
907
843
                            self.this_tree.iter_entries_by_dir(
1079
1015
                        continue
1080
1016
                else:
1081
1017
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
1018
                # XXX: We need to handle kind == 'symlink'
1082
1019
 
1083
1020
            # If we have gotten this far, that means something has changed
1084
1021
            result.append((file_id, content_changed,
1091
1028
                          ))
1092
1029
        return result
1093
1030
 
 
1031
 
1094
1032
    def fix_root(self):
1095
 
        if self.tt.final_kind(self.tt.root) is None:
 
1033
        try:
 
1034
            self.tt.final_kind(self.tt.root)
 
1035
        except errors.NoSuchFile:
1096
1036
            self.tt.cancel_deletion(self.tt.root)
1097
1037
        if self.tt.final_file_id(self.tt.root) is None:
1098
1038
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1103
1043
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1104
1044
        if other_root == self.tt.root:
1105
1045
            return
1106
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1107
 
            # the other tree's root is a non-root in the current tree (as when
1108
 
            # a previously unrelated branch is merged into another)
1109
 
            return
1110
 
        if self.tt.final_kind(other_root) is not None:
1111
 
            other_root_is_present = True
1112
 
        else:
1113
 
            # other_root doesn't have a physical representation. We still need
1114
 
            # to move any references to the actual root of the tree.
1115
 
            other_root_is_present = False
1116
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1117
 
        # calling adjust_path for children which *want* to be present with a
1118
 
        # correct place to go.
1119
 
        for _, child in self.other_tree.inventory.root.children.iteritems():
 
1046
        try:
 
1047
            self.tt.final_kind(other_root)
 
1048
        except errors.NoSuchFile:
 
1049
            return
 
1050
        if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
 
1051
            # the other tree's root is a non-root in the current tree
 
1052
            return
 
1053
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
1054
        self.tt.cancel_creation(other_root)
 
1055
        self.tt.cancel_versioning(other_root)
 
1056
 
 
1057
    def reparent_children(self, ie, target):
 
1058
        for thing, child in ie.children.iteritems():
1120
1059
            trans_id = self.tt.trans_id_file_id(child.file_id)
1121
 
            if not other_root_is_present:
1122
 
                if self.tt.final_kind(trans_id) is not None:
1123
 
                    # The item exist in the final tree and has a defined place
1124
 
                    # to go already.
1125
 
                    continue
1126
 
            # Move the item into the root
1127
 
            try:
1128
 
                final_name = self.tt.final_name(trans_id)
1129
 
            except errors.NoFinalPath:
1130
 
                # This file is not present anymore, ignore it.
1131
 
                continue
1132
 
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
1133
 
        if other_root_is_present:
1134
 
            self.tt.cancel_creation(other_root)
1135
 
            self.tt.cancel_versioning(other_root)
 
1060
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1136
1061
 
1137
1062
    def write_modified(self, results):
1138
1063
        modified_hashes = {}
1185
1110
 
1186
1111
    @staticmethod
1187
1112
    def _three_way(base, other, this):
 
1113
        #if base == other, either they all agree, or only THIS has changed.
1188
1114
        if base == other:
1189
 
            # if 'base == other', either they all agree, or only 'this' has
1190
 
            # changed.
1191
1115
            return 'this'
1192
1116
        elif this not in (base, other):
1193
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1194
1117
            return 'conflict'
 
1118
        # "Ambiguous clean merge" -- both sides have made the same change.
1195
1119
        elif this == other:
1196
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1197
1120
            return "this"
 
1121
        # this == base: only other has changed.
1198
1122
        else:
1199
 
            # this == base: only other has changed.
1200
1123
            return "other"
1201
1124
 
1202
1125
    @staticmethod
1246
1169
                # only has an lca value
1247
1170
                return 'other'
1248
1171
 
1249
 
        # At this point, the lcas disagree, and the tip disagree
 
1172
        # At this point, the lcas disagree, and the tips disagree
1250
1173
        return 'conflict'
1251
1174
 
1252
1175
    @staticmethod
1408
1331
            self.tt.version_file(file_id, trans_id)
1409
1332
        # The merge has been performed, so the old contents should not be
1410
1333
        # retained.
1411
 
        self.tt.delete_contents(trans_id)
 
1334
        try:
 
1335
            self.tt.delete_contents(trans_id)
 
1336
        except errors.NoSuchFile:
 
1337
            pass
1412
1338
        return result
1413
1339
 
1414
1340
    def _default_other_winner_merge(self, merge_hook_params):
1467
1393
    def get_lines(self, tree, file_id):
1468
1394
        """Return the lines in a file, or an empty list."""
1469
1395
        if tree.has_id(file_id):
1470
 
            return tree.get_file_lines(file_id)
 
1396
            return tree.get_file(file_id).readlines()
1471
1397
        else:
1472
1398
            return []
1473
1399
 
1586
1512
        if winner == 'this' and file_status != "modified":
1587
1513
            return
1588
1514
        trans_id = self.tt.trans_id_file_id(file_id)
1589
 
        if self.tt.final_kind(trans_id) != "file":
 
1515
        try:
 
1516
            if self.tt.final_kind(trans_id) != "file":
 
1517
                return
 
1518
        except errors.NoSuchFile:
1590
1519
            return
1591
1520
        if winner == "this":
1592
1521
            executability = this_executable
1759
1688
            osutils.rmtree(temp_dir)
1760
1689
 
1761
1690
 
1762
 
class PathNotInTree(errors.BzrError):
1763
 
 
1764
 
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1765
 
 
1766
 
    def __init__(self, path, tree):
1767
 
        errors.BzrError.__init__(self, path=path, tree=tree)
1768
 
 
1769
 
 
1770
 
class MergeIntoMerger(Merger):
1771
 
    """Merger that understands other_tree will be merged into a subdir.
1772
 
 
1773
 
    This also changes the Merger api so that it uses real Branch, revision_id,
1774
 
    and RevisonTree objects, rather than using revision specs.
1775
 
    """
1776
 
 
1777
 
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1778
 
            source_subpath, other_rev_id=None):
1779
 
        """Create a new MergeIntoMerger object.
1780
 
 
1781
 
        source_subpath in other_tree will be effectively copied to
1782
 
        target_subdir in this_tree.
1783
 
 
1784
 
        :param this_tree: The tree that we will be merging into.
1785
 
        :param other_branch: The Branch we will be merging from.
1786
 
        :param other_tree: The RevisionTree object we want to merge.
1787
 
        :param target_subdir: The relative path where we want to merge
1788
 
            other_tree into this_tree
1789
 
        :param source_subpath: The relative path specifying the subtree of
1790
 
            other_tree to merge into this_tree.
1791
 
        """
1792
 
        # It is assumed that we are merging a tree that is not in our current
1793
 
        # ancestry, which means we are using the "EmptyTree" as our basis.
1794
 
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1795
 
                                _mod_revision.NULL_REVISION)
1796
 
        super(MergeIntoMerger, self).__init__(
1797
 
            this_branch=this_tree.branch,
1798
 
            this_tree=this_tree,
1799
 
            other_tree=other_tree,
1800
 
            base_tree=null_ancestor_tree,
1801
 
            )
1802
 
        self._target_subdir = target_subdir
1803
 
        self._source_subpath = source_subpath
1804
 
        self.other_branch = other_branch
1805
 
        if other_rev_id is None:
1806
 
            other_rev_id = other_tree.get_revision_id()
1807
 
        self.other_rev_id = self.other_basis = other_rev_id
1808
 
        self.base_is_ancestor = True
1809
 
        self.backup_files = True
1810
 
        self.merge_type = Merge3Merger
1811
 
        self.show_base = False
1812
 
        self.reprocess = False
1813
 
        self.interesting_ids = None
1814
 
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1815
 
              target_subdir=self._target_subdir,
1816
 
              source_subpath=self._source_subpath)
1817
 
        if self._source_subpath != '':
1818
 
            # If this isn't a partial merge make sure the revisions will be
1819
 
            # present.
1820
 
            self._maybe_fetch(self.other_branch, self.this_branch,
1821
 
                self.other_basis)
1822
 
 
1823
 
    def set_pending(self):
1824
 
        if self._source_subpath != '':
1825
 
            return
1826
 
        Merger.set_pending(self)
1827
 
 
1828
 
 
1829
 
class _MergeTypeParameterizer(object):
1830
 
    """Wrap a merge-type class to provide extra parameters.
1831
 
    
1832
 
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1833
 
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1834
 
    the 'merge_type' member.  It is difficult override do_merge without
1835
 
    re-writing the whole thing, so instead we create a wrapper which will pass
1836
 
    the extra parameters.
1837
 
    """
1838
 
 
1839
 
    def __init__(self, merge_type, **kwargs):
1840
 
        self._extra_kwargs = kwargs
1841
 
        self._merge_type = merge_type
1842
 
 
1843
 
    def __call__(self, *args, **kwargs):
1844
 
        kwargs.update(self._extra_kwargs)
1845
 
        return self._merge_type(*args, **kwargs)
1846
 
 
1847
 
    def __getattr__(self, name):
1848
 
        return getattr(self._merge_type, name)
1849
 
 
1850
 
 
1851
 
class MergeIntoMergeType(Merge3Merger):
1852
 
    """Merger that incorporates a tree (or part of a tree) into another."""
1853
 
 
1854
 
    def __init__(self, *args, **kwargs):
1855
 
        """Initialize the merger object.
1856
 
 
1857
 
        :param args: See Merge3Merger.__init__'s args.
1858
 
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1859
 
            source_subpath and target_subdir.
1860
 
        :keyword source_subpath: The relative path specifying the subtree of
1861
 
            other_tree to merge into this_tree.
1862
 
        :keyword target_subdir: The relative path where we want to merge
1863
 
            other_tree into this_tree
1864
 
        """
1865
 
        # All of the interesting work happens during Merge3Merger.__init__(),
1866
 
        # so we have have to hack in to get our extra parameters set.
1867
 
        self._source_subpath = kwargs.pop('source_subpath')
1868
 
        self._target_subdir = kwargs.pop('target_subdir')
1869
 
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1870
 
 
1871
 
    def _compute_transform(self):
1872
 
        child_pb = ui.ui_factory.nested_progress_bar()
1873
 
        try:
1874
 
            entries = self._entries_to_incorporate()
1875
 
            entries = list(entries)
1876
 
            for num, (entry, parent_id) in enumerate(entries):
1877
 
                child_pb.update('Preparing file merge', num, len(entries))
1878
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1879
 
                trans_id = transform.new_by_entry(self.tt, entry,
1880
 
                    parent_trans_id, self.other_tree)
1881
 
        finally:
1882
 
            child_pb.finished()
1883
 
        self._finish_computing_transform()
1884
 
 
1885
 
    def _entries_to_incorporate(self):
1886
 
        """Yields pairs of (inventory_entry, new_parent)."""
1887
 
        other_inv = self.other_tree.inventory
1888
 
        subdir_id = other_inv.path2id(self._source_subpath)
1889
 
        if subdir_id is None:
1890
 
            # XXX: The error would be clearer if it gave the URL of the source
1891
 
            # branch, but we don't have a reference to that here.
1892
 
            raise PathNotInTree(self._source_subpath, "Source tree")
1893
 
        subdir = other_inv[subdir_id]
1894
 
        parent_in_target = osutils.dirname(self._target_subdir)
1895
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1896
 
        if target_id is None:
1897
 
            raise PathNotInTree(self._target_subdir, "Target tree")
1898
 
        name_in_target = osutils.basename(self._target_subdir)
1899
 
        merge_into_root = subdir.copy()
1900
 
        merge_into_root.name = name_in_target
1901
 
        if merge_into_root.file_id in self.this_tree.inventory:
1902
 
            # Give the root a new file-id.
1903
 
            # This can happen fairly easily if the directory we are
1904
 
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1905
 
            # their root_id.  Users will expect this to Just Work, so we
1906
 
            # change the file-id here.
1907
 
            # Non-root file-ids could potentially conflict too.  That's really
1908
 
            # an edge case, so we don't do anything special for those.  We let
1909
 
            # them cause conflicts.
1910
 
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1911
 
        yield (merge_into_root, target_id)
1912
 
        if subdir.kind != 'directory':
1913
 
            # No children, so we are done.
1914
 
            return
1915
 
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1916
 
            parent_id = entry.parent_id
1917
 
            if parent_id == subdir.file_id:
1918
 
                # The root's parent ID has changed, so make sure children of
1919
 
                # the root refer to the new ID.
1920
 
                parent_id = merge_into_root.file_id
1921
 
            yield (entry, parent_id)
1922
 
 
1923
 
 
1924
1691
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1925
1692
                backup_files=False,
1926
1693
                merge_type=Merge3Merger,
1934
1701
                change_reporter=None):
1935
1702
    """Primary interface for merging.
1936
1703
 
1937
 
    Typical use is probably::
1938
 
 
1939
 
        merge_inner(branch, branch.get_revision_tree(other_revision),
1940
 
                    branch.get_revision_tree(base_revision))
1941
 
    """
 
1704
        typical use is probably
 
1705
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1706
                     branch.get_revision_tree(base_revision))'
 
1707
        """
1942
1708
    if this_tree is None:
1943
1709
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1944
1710
                              "parameter as of bzrlib version 0.8.")