~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2016-04-03 16:32:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6617.
  • Revision ID: jelmer@jelmer.uk-20160403163231-h72bo0uyek2gikw0
Don't put French text in doc/en/user-reference when LANGUAGE=fr_CH.UTF_8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2012 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
 
 
19
import bzrlib.bzrdir
17
20
 
18
21
from cStringIO import StringIO
19
 
import sys
20
22
 
21
23
from bzrlib.lazy_import import lazy_import
22
24
lazy_import(globals(), """
23
 
from itertools import chain
 
25
import itertools
24
26
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        cleanup,
28
 
        config as _mod_config,
29
 
        debug,
30
 
        errors,
31
 
        fetch,
32
 
        graph as _mod_graph,
33
 
        lockdir,
34
 
        lockable_files,
35
 
        remote,
36
 
        repository,
37
 
        revision as _mod_revision,
38
 
        rio,
39
 
        transport,
40
 
        ui,
41
 
        urlutils,
42
 
        )
43
 
from bzrlib.config import BranchConfig, TransportConfig
44
 
from bzrlib.tag import (
45
 
    BasicTags,
46
 
    DisabledTags,
 
27
    bzrdir,
 
28
    controldir,
 
29
    cache_utf8,
 
30
    cleanup,
 
31
    config as _mod_config,
 
32
    debug,
 
33
    errors,
 
34
    fetch,
 
35
    graph as _mod_graph,
 
36
    lockdir,
 
37
    lockable_files,
 
38
    remote,
 
39
    repository,
 
40
    revision as _mod_revision,
 
41
    rio,
 
42
    shelf,
 
43
    tag as _mod_tag,
 
44
    transport,
 
45
    ui,
 
46
    urlutils,
 
47
    vf_search,
47
48
    )
 
49
from bzrlib.i18n import gettext, ngettext
48
50
""")
49
51
 
 
52
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
53
# is guaranteed to be registered.
 
54
import bzrlib.bzrdir
 
55
 
50
56
from bzrlib import (
 
57
    bzrdir,
51
58
    controldir,
52
59
    )
53
60
from bzrlib.decorators import (
66
73
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
74
 
68
75
 
69
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
70
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
71
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
 
 
73
 
 
74
76
class Branch(controldir.ControlComponent):
75
77
    """Branch holding a history of revisions.
76
78
 
93
95
    def user_transport(self):
94
96
        return self.bzrdir.user_transport
95
97
 
96
 
    def __init__(self, *ignored, **ignored_too):
 
98
    def __init__(self, possible_transports=None):
97
99
        self.tags = self._format.make_tags(self)
98
100
        self._revision_history_cache = None
99
101
        self._revision_id_to_revno_cache = None
103
105
        self._last_revision_info_cache = None
104
106
        self._master_branch_cache = None
105
107
        self._merge_sorted_revisions_cache = None
106
 
        self._open_hook()
 
108
        self._open_hook(possible_transports)
107
109
        hooks = Branch.hooks['open']
108
110
        for hook in hooks:
109
111
            hook(self)
110
112
 
111
 
    def _open_hook(self):
 
113
    def _open_hook(self, possible_transports):
112
114
        """Called by init to allow simpler extension of the base class."""
113
115
 
114
 
    def _activate_fallback_location(self, url):
 
116
    def _activate_fallback_location(self, url, possible_transports):
115
117
        """Activate the branch/repository from url as a fallback repository."""
116
118
        for existing_fallback_repo in self.repository._fallback_repositories:
117
119
            if existing_fallback_repo.user_url == url:
118
120
                # This fallback is already configured.  This probably only
119
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
121
                # happens because ControlDir.sprout is a horrible mess.  To avoid
120
122
                # confusing _unstack we don't add this a second time.
121
123
                mutter('duplicate activation of fallback %r on %r', url, self)
122
124
                return
123
 
        repo = self._get_fallback_repository(url)
 
125
        repo = self._get_fallback_repository(url, possible_transports)
124
126
        if repo.has_same_location(self.repository):
125
127
            raise errors.UnstackableLocationError(self.user_url, url)
126
128
        self.repository.add_fallback_repository(repo)
180
182
        For instance, if the branch is at URL/.bzr/branch,
181
183
        Branch.open(URL) -> a Branch instance.
182
184
        """
183
 
        control = bzrdir.BzrDir.open(base, _unsupported,
184
 
                                     possible_transports=possible_transports)
185
 
        return control.open_branch(unsupported=_unsupported)
 
185
        control = controldir.ControlDir.open(base,
 
186
            possible_transports=possible_transports, _unsupported=_unsupported)
 
187
        return control.open_branch(unsupported=_unsupported,
 
188
            possible_transports=possible_transports)
186
189
 
187
190
    @staticmethod
188
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
191
    def open_from_transport(transport, name=None, _unsupported=False,
 
192
            possible_transports=None):
189
193
        """Open the branch rooted at transport"""
190
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
191
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
194
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
195
        return control.open_branch(name=name, unsupported=_unsupported,
 
196
            possible_transports=possible_transports)
192
197
 
193
198
    @staticmethod
194
199
    def open_containing(url, possible_transports=None):
202
207
        format, UnknownFormatError or UnsupportedFormatError are raised.
203
208
        If there is one, it is returned, along with the unused portion of url.
204
209
        """
205
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
210
        control, relpath = controldir.ControlDir.open_containing(url,
206
211
                                                         possible_transports)
207
 
        return control.open_branch(), relpath
 
212
        branch = control.open_branch(possible_transports=possible_transports)
 
213
        return (branch, relpath)
208
214
 
209
215
    def _push_should_merge_tags(self):
210
216
        """Should _basic_push merge this branch's tags into the target?
222
228
 
223
229
        :return: A bzrlib.config.BranchConfig.
224
230
        """
225
 
        return BranchConfig(self)
 
231
        return _mod_config.BranchConfig(self)
 
232
 
 
233
    def get_config_stack(self):
 
234
        """Get a bzrlib.config.BranchStack for this Branch.
 
235
 
 
236
        This can then be used to get and set configuration options for the
 
237
        branch.
 
238
 
 
239
        :return: A bzrlib.config.BranchStack.
 
240
        """
 
241
        return _mod_config.BranchStack(self)
226
242
 
227
243
    def _get_config(self):
228
244
        """Get the concrete config for just the config in this branch.
236
252
        """
237
253
        raise NotImplementedError(self._get_config)
238
254
 
239
 
    def _get_fallback_repository(self, url):
 
255
    def store_uncommitted(self, creator):
 
256
        """Store uncommitted changes from a ShelfCreator.
 
257
 
 
258
        :param creator: The ShelfCreator containing uncommitted changes, or
 
259
            None to delete any stored changes.
 
260
        :raises: ChangesAlreadyStored if the branch already has changes.
 
261
        """
 
262
        raise NotImplementedError(self.store_uncommitted)
 
263
 
 
264
    def get_unshelver(self, tree):
 
265
        """Return a shelf.Unshelver for this branch and tree.
 
266
 
 
267
        :param tree: The tree to use to construct the Unshelver.
 
268
        :return: an Unshelver or None if no changes are stored.
 
269
        """
 
270
        raise NotImplementedError(self.get_unshelver)
 
271
 
 
272
    def _get_fallback_repository(self, url, possible_transports):
240
273
        """Get the repository we fallback to at url."""
241
274
        url = urlutils.join(self.base, url)
242
 
        a_branch = Branch.open(url,
243
 
            possible_transports=[self.bzrdir.root_transport])
 
275
        a_branch = Branch.open(url, possible_transports=possible_transports)
244
276
        return a_branch.repository
245
277
 
246
278
    @needs_read_lock
520
552
                    # The decision to include the start or not
521
553
                    # depends on the stop_rule if a stop is provided
522
554
                    # so pop this node back into the iterator
523
 
                    rev_iter = chain(iter([node]), rev_iter)
 
555
                    rev_iter = itertools.chain(iter([node]), rev_iter)
524
556
                    break
525
557
        if stop_revision_id is None:
526
558
            # Yield everything
651
683
        """
652
684
        raise errors.UpgradeRequired(self.user_url)
653
685
 
 
686
    def get_append_revisions_only(self):
 
687
        """Whether it is only possible to append revisions to the history.
 
688
        """
 
689
        if not self._format.supports_set_append_revisions_only():
 
690
            return False
 
691
        return self.get_config_stack().get('append_revisions_only')
 
692
 
654
693
    def set_append_revisions_only(self, enabled):
655
694
        if not self._format.supports_set_append_revisions_only():
656
695
            raise errors.UpgradeRequired(self.user_url)
657
 
        if enabled:
658
 
            value = 'True'
659
 
        else:
660
 
            value = 'False'
661
 
        self.get_config().set_user_option('append_revisions_only', value,
662
 
            warn_masked=True)
 
696
        self.get_config_stack().set('append_revisions_only', enabled)
663
697
 
664
698
    def set_reference_info(self, file_id, tree_path, branch_location):
665
699
        """Set the branch location to use for a tree reference."""
694
728
        """
695
729
        raise errors.UpgradeRequired(self.user_url)
696
730
 
697
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
731
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
698
732
                           timezone=None, committer=None, revprops=None,
699
733
                           revision_id=None, lossy=False):
700
734
        """Obtain a CommitBuilder for this branch.
710
744
            represented, when pushing to a foreign VCS 
711
745
        """
712
746
 
713
 
        if config is None:
714
 
            config = self.get_config()
 
747
        if config_stack is None:
 
748
            config_stack = self.get_config_stack()
715
749
 
716
 
        return self.repository.get_commit_builder(self, parents, config,
 
750
        return self.repository.get_commit_builder(self, parents, config_stack,
717
751
            timestamp, timezone, committer, revprops, revision_id,
718
752
            lossy)
719
753
 
724
758
        """
725
759
        return None
726
760
 
 
761
    @deprecated_method(deprecated_in((2, 5, 0)))
727
762
    def get_revision_delta(self, revno):
728
763
        """Return the delta for one revision.
729
764
 
730
765
        The delta is relative to its mainline predecessor, or the
731
766
        empty tree for revision 1.
732
767
        """
733
 
        rh = self.revision_history()
734
 
        if not (1 <= revno <= len(rh)):
 
768
        try:
 
769
            revid = self.get_rev_id(revno)
 
770
        except errors.NoSuchRevision:
735
771
            raise errors.InvalidRevisionNumber(revno)
736
 
        return self.repository.get_revision_delta(rh[revno-1])
 
772
        return self.repository.get_revision_delta(revid)
737
773
 
738
774
    def get_stacked_on_url(self):
739
775
        """Get the URL this branch is stacked against.
748
784
        """Print `file` to stdout."""
749
785
        raise NotImplementedError(self.print_file)
750
786
 
751
 
    @deprecated_method(deprecated_in((2, 4, 0)))
752
 
    def set_revision_history(self, rev_history):
753
 
        """See Branch.set_revision_history."""
754
 
        self._set_revision_history(rev_history)
755
 
 
756
 
    @needs_write_lock
757
 
    def _set_revision_history(self, rev_history):
758
 
        if len(rev_history) == 0:
759
 
            revid = _mod_revision.NULL_REVISION
760
 
        else:
761
 
            revid = rev_history[-1]
762
 
        if rev_history != self._lefthand_history(revid):
763
 
            raise errors.NotLefthandHistory(rev_history)
764
 
        self.set_last_revision_info(len(rev_history), revid)
765
 
        self._cache_revision_history(rev_history)
766
 
        for hook in Branch.hooks['set_rh']:
767
 
            hook(self, rev_history)
768
 
 
769
787
    @needs_write_lock
770
788
    def set_last_revision_info(self, revno, revision_id):
771
789
        """Set the last revision of this branch.
838
856
                return
839
857
            self._unstack()
840
858
        else:
841
 
            self._activate_fallback_location(url)
 
859
            self._activate_fallback_location(url,
 
860
                possible_transports=[self.bzrdir.root_transport])
842
861
        # write this out after the repository is stacked to avoid setting a
843
862
        # stacked config that doesn't work.
844
863
        self._set_config_location('stacked_on_location', url)
850
869
        """
851
870
        pb = ui.ui_factory.nested_progress_bar()
852
871
        try:
853
 
            pb.update("Unstacking")
 
872
            pb.update(gettext("Unstacking"))
854
873
            # The basic approach here is to fetch the tip of the branch,
855
874
            # including all available ghosts, from the existing stacked
856
875
            # repository into a new repository object without the fallbacks. 
870
889
            # stream from one of them to the other.  This does mean doing
871
890
            # separate SSH connection setup, but unstacking is not a
872
891
            # common operation so it's tolerable.
873
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
892
            new_bzrdir = controldir.ControlDir.open(
 
893
                self.bzrdir.root_transport.base)
874
894
            new_repository = new_bzrdir.find_repository()
875
895
            if new_repository._fallback_repositories:
876
896
                raise AssertionError("didn't expect %r to have "
919
939
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
920
940
                except errors.TagsNotSupported:
921
941
                    tags_to_fetch = set()
922
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
942
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
923
943
                    old_repository, required_ids=[self.last_revision()],
924
944
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
925
945
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
966
986
        This means the next call to revision_history will need to call
967
987
        _gen_revision_history.
968
988
 
969
 
        This API is semi-public; it only for use by subclasses, all other code
970
 
        should consider it to be private.
 
989
        This API is semi-public; it is only for use by subclasses, all other
 
990
        code should consider it to be private.
971
991
        """
972
992
        self._revision_history_cache = None
973
993
        self._revision_id_to_revno_cache = None
993
1013
        """
994
1014
        raise NotImplementedError(self._gen_revision_history)
995
1015
 
996
 
    @needs_read_lock
997
 
    def revision_history(self):
998
 
        """Return sequence of revision ids on this branch.
999
 
 
1000
 
        This method will cache the revision history for as long as it is safe to
1001
 
        do so.
1002
 
        """
 
1016
    def _revision_history(self):
1003
1017
        if 'evil' in debug.debug_flags:
1004
1018
            mutter_callsite(3, "revision_history scales with history.")
1005
1019
        if self._revision_history_cache is not None:
1038
1052
    def _read_last_revision_info(self):
1039
1053
        raise NotImplementedError(self._read_last_revision_info)
1040
1054
 
1041
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1042
 
    def import_last_revision_info(self, source_repo, revno, revid):
1043
 
        """Set the last revision info, importing from another repo if necessary.
1044
 
 
1045
 
        :param source_repo: Source repository to optionally fetch from
1046
 
        :param revno: Revision number of the new tip
1047
 
        :param revid: Revision id of the new tip
1048
 
        """
1049
 
        if not self.repository.has_same_location(source_repo):
1050
 
            self.repository.fetch(source_repo, revision_id=revid)
1051
 
        self.set_last_revision_info(revno, revid)
1052
 
 
1053
1055
    def import_last_revision_info_and_tags(self, source, revno, revid,
1054
1056
                                           lossy=False):
1055
1057
        """Set the last revision info, importing from another repo if necessary.
1075
1077
        """Given a revision id, return its revno"""
1076
1078
        if _mod_revision.is_null(revision_id):
1077
1079
            return 0
1078
 
        history = self.revision_history()
 
1080
        history = self._revision_history()
1079
1081
        try:
1080
1082
            return history.index(revision_id) + 1
1081
1083
        except ValueError:
1146
1148
    def _set_config_location(self, name, url, config=None,
1147
1149
                             make_relative=False):
1148
1150
        if config is None:
1149
 
            config = self.get_config()
 
1151
            config = self.get_config_stack()
1150
1152
        if url is None:
1151
1153
            url = ''
1152
1154
        elif make_relative:
1153
1155
            url = urlutils.relative_url(self.base, url)
1154
 
        config.set_user_option(name, url, warn_masked=True)
 
1156
        config.set(name, url)
1155
1157
 
1156
1158
    def _get_config_location(self, name, config=None):
1157
1159
        if config is None:
1158
 
            config = self.get_config()
1159
 
        location = config.get_user_option(name)
 
1160
            config = self.get_config_stack()
 
1161
        location = config.get(name)
1160
1162
        if location == '':
1161
1163
            location = None
1162
1164
        return location
1163
1165
 
1164
1166
    def get_child_submit_format(self):
1165
1167
        """Return the preferred format of submissions to this branch."""
1166
 
        return self.get_config().get_user_option("child_submit_format")
 
1168
        return self.get_config_stack().get('child_submit_format')
1167
1169
 
1168
1170
    def get_submit_branch(self):
1169
1171
        """Return the submit location of the branch.
1172
1174
        pattern is that the user can override it by specifying a
1173
1175
        location.
1174
1176
        """
1175
 
        return self.get_config().get_user_option('submit_branch')
 
1177
        return self.get_config_stack().get('submit_branch')
1176
1178
 
1177
1179
    def set_submit_branch(self, location):
1178
1180
        """Return the submit location of the branch.
1181
1183
        pattern is that the user can override it by specifying a
1182
1184
        location.
1183
1185
        """
1184
 
        self.get_config().set_user_option('submit_branch', location,
1185
 
            warn_masked=True)
 
1186
        self.get_config_stack().set('submit_branch', location)
1186
1187
 
1187
1188
    def get_public_branch(self):
1188
1189
        """Return the public location of the branch.
1201
1202
        self._set_config_location('public_branch', location)
1202
1203
 
1203
1204
    def get_push_location(self):
1204
 
        """Return the None or the location to push this branch to."""
1205
 
        push_loc = self.get_config().get_user_option('push_location')
1206
 
        return push_loc
 
1205
        """Return None or the location to push this branch to."""
 
1206
        return self.get_config_stack().get('push_location')
1207
1207
 
1208
1208
    def set_push_location(self, location):
1209
1209
        """Set a new push location for this branch."""
1378
1378
        # TODO: We should probably also check that self.revision_history
1379
1379
        # matches the repository for older branch formats.
1380
1380
        # If looking for the code that cross-checks repository parents against
1381
 
        # the iter_reverse_revision_history output, that is now a repository
 
1381
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1382
1382
        # specific check.
1383
1383
        return result
1384
1384
 
1385
 
    def _get_checkout_format(self):
 
1385
    def _get_checkout_format(self, lightweight=False):
1386
1386
        """Return the most suitable metadir for a checkout of this branch.
1387
1387
        Weaves are used if this branch's repository uses weaves.
1388
1388
        """
1434
1434
        """
1435
1435
        t = transport.get_transport(to_location)
1436
1436
        t.ensure_base()
 
1437
        format = self._get_checkout_format(lightweight=lightweight)
 
1438
        try:
 
1439
            checkout = format.initialize_on_transport(t)
 
1440
        except errors.AlreadyControlDirError:
 
1441
            # It's fine if the control directory already exists,
 
1442
            # as long as there is no existing branch and working tree.
 
1443
            checkout = controldir.ControlDir.open_from_transport(t)
 
1444
            try:
 
1445
                checkout.open_branch()
 
1446
            except errors.NotBranchError:
 
1447
                pass
 
1448
            else:
 
1449
                raise errors.AlreadyControlDirError(t.base)
 
1450
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
 
1451
                # When checking out to the same control directory,
 
1452
                # always create a lightweight checkout
 
1453
                lightweight = True
 
1454
 
1437
1455
        if lightweight:
1438
 
            format = self._get_checkout_format()
1439
 
            checkout = format.initialize_on_transport(t)
1440
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1441
 
                target_branch=self)
 
1456
            from_branch = checkout.set_branch_reference(target_branch=self)
1442
1457
        else:
1443
 
            format = self._get_checkout_format()
1444
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1445
 
                to_location, force_new_tree=False, format=format)
1446
 
            checkout = checkout_branch.bzrdir
 
1458
            policy = checkout.determine_repository_policy()
 
1459
            repo = policy.acquire_repository()[0]
 
1460
            checkout_branch = checkout.create_branch()
1447
1461
            checkout_branch.bind(self)
1448
1462
            # pull up to the specified revision_id to set the initial
1449
1463
            # branch tip correctly, and seed it with history.
1450
1464
            checkout_branch.pull(self, stop_revision=revision_id)
1451
 
            from_branch=None
 
1465
            from_branch = None
1452
1466
        tree = checkout.create_workingtree(revision_id,
1453
1467
                                           from_branch=from_branch,
1454
1468
                                           accelerator_tree=accelerator_tree,
1543
1557
            heads that must be fetched if present, but no error is necessary if
1544
1558
            they are not present.
1545
1559
        """
1546
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1547
 
        # are the tags.
 
1560
        # For bzr native formats must_fetch is just the tip, and
 
1561
        # if_present_fetch are the tags.
1548
1562
        must_fetch = set([self.last_revision()])
1549
1563
        if_present_fetch = set()
1550
 
        c = self.get_config()
1551
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1552
 
                                                 default=False)
1553
 
        if include_tags:
 
1564
        if self.get_config_stack().get('branch.fetch_tags'):
1554
1565
            try:
1555
1566
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1556
1567
            except errors.TagsNotSupported:
1565
1576
 
1566
1577
    Formats provide three things:
1567
1578
     * An initialization routine,
1568
 
     * a format string,
 
1579
     * a format description
1569
1580
     * an open routine.
1570
1581
 
1571
1582
    Formats are placed in an dict by their format string for reference
1578
1589
    object will be created every time regardless.
1579
1590
    """
1580
1591
 
1581
 
    can_set_append_revisions_only = True
1582
 
 
1583
1592
    def __eq__(self, other):
1584
1593
        return self.__class__ is other.__class__
1585
1594
 
1586
1595
    def __ne__(self, other):
1587
1596
        return not (self == other)
1588
1597
 
1589
 
    @classmethod
1590
 
    def find_format(klass, a_bzrdir, name=None):
1591
 
        """Return the format for the branch object in a_bzrdir."""
1592
 
        try:
1593
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1594
 
            format_string = bzrdir.extract_format_string(
1595
 
                transport.get_bytes("format"))
1596
 
            return format_registry.get(format_string)
1597
 
        except errors.NoSuchFile:
1598
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1599
 
        except KeyError:
1600
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1601
 
 
1602
 
    @classmethod
1603
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1604
 
    def get_default_format(klass):
1605
 
        """Return the current default format."""
1606
 
        return format_registry.get_default()
1607
 
 
1608
 
    @classmethod
1609
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1610
 
    def get_formats(klass):
1611
 
        """Get all the known formats.
1612
 
 
1613
 
        Warning: This triggers a load of all lazy registered formats: do not
1614
 
        use except when that is desireed.
1615
 
        """
1616
 
        return format_registry._get_all()
1617
 
 
1618
 
    def get_reference(self, a_bzrdir, name=None):
1619
 
        """Get the target reference of the branch in a_bzrdir.
 
1598
    def get_reference(self, controldir, name=None):
 
1599
        """Get the target reference of the branch in controldir.
1620
1600
 
1621
1601
        format probing must have been completed before calling
1622
1602
        this method - it is assumed that the format of the branch
1623
 
        in a_bzrdir is correct.
 
1603
        in controldir is correct.
1624
1604
 
1625
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1605
        :param controldir: The controldir to get the branch data from.
1626
1606
        :param name: Name of the colocated branch to fetch
1627
1607
        :return: None if the branch is not a reference branch.
1628
1608
        """
1629
1609
        return None
1630
1610
 
1631
1611
    @classmethod
1632
 
    def set_reference(self, a_bzrdir, name, to_branch):
1633
 
        """Set the target reference of the branch in a_bzrdir.
 
1612
    def set_reference(self, controldir, name, to_branch):
 
1613
        """Set the target reference of the branch in controldir.
1634
1614
 
1635
1615
        format probing must have been completed before calling
1636
1616
        this method - it is assumed that the format of the branch
1637
 
        in a_bzrdir is correct.
 
1617
        in controldir is correct.
1638
1618
 
1639
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1619
        :param controldir: The controldir to set the branch reference for.
1640
1620
        :param name: Name of colocated branch to set, None for default
1641
1621
        :param to_branch: branch that the checkout is to reference
1642
1622
        """
1643
1623
        raise NotImplementedError(self.set_reference)
1644
1624
 
1645
 
    def get_format_string(self):
1646
 
        """Return the ASCII format string that identifies this format."""
1647
 
        raise NotImplementedError(self.get_format_string)
1648
 
 
1649
1625
    def get_format_description(self):
1650
1626
        """Return the short format description for this format."""
1651
1627
        raise NotImplementedError(self.get_format_description)
1652
1628
 
1653
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1629
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1654
1630
        hooks = Branch.hooks['post_branch_init']
1655
1631
        if not hooks:
1656
1632
            return
1657
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1633
        params = BranchInitHookParams(self, controldir, name, branch)
1658
1634
        for hook in hooks:
1659
1635
            hook(params)
1660
1636
 
1661
 
    def initialize(self, a_bzrdir, name=None, repository=None):
1662
 
        """Create a branch of this format in a_bzrdir.
1663
 
        
 
1637
    def initialize(self, controldir, name=None, repository=None,
 
1638
                   append_revisions_only=None):
 
1639
        """Create a branch of this format in controldir.
 
1640
 
1664
1641
        :param name: Name of the colocated branch to create.
1665
1642
        """
1666
1643
        raise NotImplementedError(self.initialize)
1686
1663
        Note that it is normal for branch to be a RemoteBranch when using tags
1687
1664
        on a RemoteBranch.
1688
1665
        """
1689
 
        return DisabledTags(branch)
 
1666
        return _mod_tag.DisabledTags(branch)
1690
1667
 
1691
1668
    def network_name(self):
1692
1669
        """A simple byte string uniquely identifying this format for RPC calls.
1698
1675
        """
1699
1676
        raise NotImplementedError(self.network_name)
1700
1677
 
1701
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1702
 
            found_repository=None):
1703
 
        """Return the branch object for a_bzrdir
 
1678
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1679
            found_repository=None, possible_transports=None):
 
1680
        """Return the branch object for controldir.
1704
1681
 
1705
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1682
        :param controldir: A ControlDir that contains a branch.
1706
1683
        :param name: Name of colocated branch to open
1707
1684
        :param _found: a private parameter, do not use it. It is used to
1708
1685
            indicate if format probing has already be done.
1711
1688
        """
1712
1689
        raise NotImplementedError(self.open)
1713
1690
 
1714
 
    @classmethod
1715
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1716
 
    def register_format(klass, format):
1717
 
        """Register a metadir format.
1718
 
 
1719
 
        See MetaDirBranchFormatFactory for the ability to register a format
1720
 
        without loading the code the format needs until it is actually used.
1721
 
        """
1722
 
        format_registry.register(format)
1723
 
 
1724
 
    @classmethod
1725
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1726
 
    def set_default_format(klass, format):
1727
 
        format_registry.set_default(format)
1728
 
 
1729
1691
    def supports_set_append_revisions_only(self):
1730
1692
        """True if this format supports set_append_revisions_only."""
1731
1693
        return False
1738
1700
        """True if this format supports leaving locks in place."""
1739
1701
        return False # by default
1740
1702
 
1741
 
    @classmethod
1742
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1743
 
    def unregister_format(klass, format):
1744
 
        format_registry.remove(format)
1745
 
 
1746
1703
    def __str__(self):
1747
1704
        return self.get_format_description().rstrip()
1748
1705
 
1750
1707
        """True if this format supports tags stored in the branch"""
1751
1708
        return False  # by default
1752
1709
 
 
1710
    def tags_are_versioned(self):
 
1711
        """Whether the tag container for this branch versions tags."""
 
1712
        return False
 
1713
 
 
1714
    def supports_tags_referencing_ghosts(self):
 
1715
        """True if tags can reference ghost revisions."""
 
1716
        return True
 
1717
 
1753
1718
 
1754
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1755
1720
    """A factory for a BranchFormat object, permitting simple lazy registration.
1769
1734
        """
1770
1735
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1771
1736
        self._format_string = format_string
1772
 
        
 
1737
 
1773
1738
    def get_format_string(self):
1774
1739
        """See BranchFormat.get_format_string."""
1775
1740
        return self._format_string
1782
1747
class BranchHooks(Hooks):
1783
1748
    """A dictionary mapping hook name to a list of callables for branch hooks.
1784
1749
 
1785
 
    e.g. ['set_rh'] Is the list of items to be called when the
1786
 
    set_revision_history function is invoked.
 
1750
    e.g. ['post_push'] Is the list of items to be called when the
 
1751
    push function is invoked.
1787
1752
    """
1788
1753
 
1789
1754
    def __init__(self):
1793
1758
        notified.
1794
1759
        """
1795
1760
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1796
 
        self.add_hook('set_rh',
1797
 
            "Invoked whenever the revision history has been set via "
1798
 
            "set_revision_history. The api signature is (branch, "
1799
 
            "revision_history), and the branch will be write-locked. "
1800
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1801
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1802
1761
        self.add_hook('open',
1803
1762
            "Called with the Branch object that has been opened after a "
1804
1763
            "branch is opened.", (1, 8))
1920
1879
    There are 4 fields that hooks may wish to access:
1921
1880
 
1922
1881
    :ivar format: the branch format
1923
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1882
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1924
1883
    :ivar name: name of colocated branch, if any (or None)
1925
1884
    :ivar branch: the branch created
1926
1885
 
1929
1888
    branch, which refer to the original branch.
1930
1889
    """
1931
1890
 
1932
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1891
    def __init__(self, format, controldir, name, branch):
1933
1892
        """Create a group of BranchInitHook parameters.
1934
1893
 
1935
1894
        :param format: the branch format
1936
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1895
        :param controldir: the ControlDir where the branch will be/has been
1937
1896
            initialized
1938
1897
        :param name: name of colocated branch, if any (or None)
1939
1898
        :param branch: the branch created
1943
1902
        in branch, which refer to the original branch.
1944
1903
        """
1945
1904
        self.format = format
1946
 
        self.bzrdir = a_bzrdir
 
1905
        self.bzrdir = controldir
1947
1906
        self.name = name
1948
1907
        self.branch = branch
1949
1908
 
1959
1918
 
1960
1919
    There are 4 fields that hooks may wish to access:
1961
1920
 
1962
 
    :ivar control_dir: BzrDir of the checkout to change
 
1921
    :ivar control_dir: ControlDir of the checkout to change
1963
1922
    :ivar to_branch: branch that the checkout is to reference
1964
1923
    :ivar force: skip the check for local commits in a heavy checkout
1965
1924
    :ivar revision_id: revision ID to switch to (or None)
1968
1927
    def __init__(self, control_dir, to_branch, force, revision_id):
1969
1928
        """Create a group of SwitchHook parameters.
1970
1929
 
1971
 
        :param control_dir: BzrDir of the checkout to change
 
1930
        :param control_dir: ControlDir of the checkout to change
1972
1931
        :param to_branch: branch that the checkout is to reference
1973
1932
        :param force: skip the check for local commits in a heavy checkout
1974
1933
        :param revision_id: revision ID to switch to (or None)
1987
1946
            self.revision_id)
1988
1947
 
1989
1948
 
1990
 
class BranchFormatMetadir(BranchFormat):
1991
 
    """Common logic for meta-dir based branch formats."""
 
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
1950
    """Base class for branch formats that live in meta directories.
 
1951
    """
 
1952
 
 
1953
    def __init__(self):
 
1954
        BranchFormat.__init__(self)
 
1955
        bzrdir.BzrFormat.__init__(self)
 
1956
 
 
1957
    @classmethod
 
1958
    def find_format(klass, controldir, name=None):
 
1959
        """Return the format for the branch object in controldir."""
 
1960
        try:
 
1961
            transport = controldir.get_branch_transport(None, name=name)
 
1962
        except errors.NoSuchFile:
 
1963
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
1964
        try:
 
1965
            format_string = transport.get_bytes("format")
 
1966
        except errors.NoSuchFile:
 
1967
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
1968
        return klass._find_format(format_registry, 'branch', format_string)
1992
1969
 
1993
1970
    def _branch_class(self):
1994
1971
        """What class to instantiate on open calls."""
1995
1972
        raise NotImplementedError(self._branch_class)
1996
1973
 
 
1974
    def _get_initial_config(self, append_revisions_only=None):
 
1975
        if append_revisions_only:
 
1976
            return "append_revisions_only = True\n"
 
1977
        else:
 
1978
            # Avoid writing anything if append_revisions_only is disabled,
 
1979
            # as that is the default.
 
1980
            return ""
 
1981
 
1997
1982
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1998
1983
                           repository=None):
1999
 
        """Initialize a branch in a bzrdir, with specified files
 
1984
        """Initialize a branch in a control dir, with specified files
2000
1985
 
2001
1986
        :param a_bzrdir: The bzrdir to initialize the branch in
2002
1987
        :param utf8_files: The files to create as a list of
2004
1989
        :param name: Name of colocated branch to create, if any
2005
1990
        :return: a branch in this format
2006
1991
        """
 
1992
        if name is None:
 
1993
            name = a_bzrdir._get_selected_branch()
2007
1994
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2008
1995
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2009
1996
        control_files = lockable_files.LockableFiles(branch_transport,
2011
1998
        control_files.create_lock()
2012
1999
        control_files.lock_write()
2013
2000
        try:
2014
 
            utf8_files += [('format', self.get_format_string())]
 
2001
            utf8_files += [('format', self.as_string())]
2015
2002
            for (filename, content) in utf8_files:
2016
2003
                branch_transport.put_bytes(
2017
2004
                    filename, content,
2023
2010
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2024
2011
        return branch
2025
2012
 
2026
 
    def network_name(self):
2027
 
        """A simple byte string uniquely identifying this format for RPC calls.
2028
 
 
2029
 
        Metadir branch formats use their format string.
2030
 
        """
2031
 
        return self.get_format_string()
2032
 
 
2033
2013
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2034
 
            found_repository=None):
 
2014
            found_repository=None, possible_transports=None):
2035
2015
        """See BranchFormat.open()."""
 
2016
        if name is None:
 
2017
            name = a_bzrdir._get_selected_branch()
2036
2018
        if not _found:
2037
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2019
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2038
2020
            if format.__class__ != self.__class__:
2039
2021
                raise AssertionError("wrong format %r found for %r" %
2040
2022
                    (format, self))
2049
2031
                              name=name,
2050
2032
                              a_bzrdir=a_bzrdir,
2051
2033
                              _repository=found_repository,
2052
 
                              ignore_fallbacks=ignore_fallbacks)
 
2034
                              ignore_fallbacks=ignore_fallbacks,
 
2035
                              possible_transports=possible_transports)
2053
2036
        except errors.NoSuchFile:
2054
2037
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2055
2038
 
2056
 
    def __init__(self):
2057
 
        super(BranchFormatMetadir, self).__init__()
2058
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2059
 
        self._matchingbzrdir.set_branch_format(self)
 
2039
    @property
 
2040
    def _matchingbzrdir(self):
 
2041
        ret = bzrdir.BzrDirMetaFormat1()
 
2042
        ret.set_branch_format(self)
 
2043
        return ret
2060
2044
 
2061
2045
    def supports_tags(self):
2062
2046
        return True
2064
2048
    def supports_leaving_lock(self):
2065
2049
        return True
2066
2050
 
2067
 
 
2068
 
class BzrBranchFormat5(BranchFormatMetadir):
2069
 
    """Bzr branch format 5.
2070
 
 
2071
 
    This format has:
2072
 
     - a revision-history file.
2073
 
     - a format string
2074
 
     - a lock dir guarding the branch itself
2075
 
     - all of this stored in a branch/ subdirectory
2076
 
     - works with shared repositories.
2077
 
 
2078
 
    This format is new in bzr 0.8.
2079
 
    """
2080
 
 
2081
 
    def _branch_class(self):
2082
 
        return BzrBranch5
2083
 
 
2084
 
    def get_format_string(self):
2085
 
        """See BranchFormat.get_format_string()."""
2086
 
        return "Bazaar-NG branch format 5\n"
2087
 
 
2088
 
    def get_format_description(self):
2089
 
        """See BranchFormat.get_format_description()."""
2090
 
        return "Branch format 5"
2091
 
 
2092
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2093
 
        """Create a branch of this format in a_bzrdir."""
2094
 
        utf8_files = [('revision-history', ''),
2095
 
                      ('branch-name', ''),
2096
 
                      ]
2097
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2098
 
 
2099
 
    def supports_tags(self):
2100
 
        return False
 
2051
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2052
            basedir=None):
 
2053
        BranchFormat.check_support_status(self,
 
2054
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2055
            basedir=basedir)
 
2056
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2057
            recommend_upgrade=recommend_upgrade, basedir=basedir)
2101
2058
 
2102
2059
 
2103
2060
class BzrBranchFormat6(BranchFormatMetadir):
2114
2071
    def _branch_class(self):
2115
2072
        return BzrBranch6
2116
2073
 
2117
 
    def get_format_string(self):
 
2074
    @classmethod
 
2075
    def get_format_string(cls):
2118
2076
        """See BranchFormat.get_format_string()."""
2119
2077
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2120
2078
 
2122
2080
        """See BranchFormat.get_format_description()."""
2123
2081
        return "Branch format 6"
2124
2082
 
2125
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2083
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2084
                   append_revisions_only=None):
2126
2085
        """Create a branch of this format in a_bzrdir."""
2127
2086
        utf8_files = [('last-revision', '0 null:\n'),
2128
 
                      ('branch.conf', ''),
 
2087
                      ('branch.conf',
 
2088
                          self._get_initial_config(append_revisions_only)),
2129
2089
                      ('tags', ''),
2130
2090
                      ]
2131
2091
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2132
2092
 
2133
2093
    def make_tags(self, branch):
2134
2094
        """See bzrlib.branch.BranchFormat.make_tags()."""
2135
 
        return BasicTags(branch)
 
2095
        return _mod_tag.BasicTags(branch)
2136
2096
 
2137
2097
    def supports_set_append_revisions_only(self):
2138
2098
        return True
2144
2104
    def _branch_class(self):
2145
2105
        return BzrBranch8
2146
2106
 
2147
 
    def get_format_string(self):
 
2107
    @classmethod
 
2108
    def get_format_string(cls):
2148
2109
        """See BranchFormat.get_format_string()."""
2149
2110
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2150
2111
 
2152
2113
        """See BranchFormat.get_format_description()."""
2153
2114
        return "Branch format 8"
2154
2115
 
2155
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2116
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2117
                   append_revisions_only=None):
2156
2118
        """Create a branch of this format in a_bzrdir."""
2157
2119
        utf8_files = [('last-revision', '0 null:\n'),
2158
 
                      ('branch.conf', ''),
 
2120
                      ('branch.conf',
 
2121
                          self._get_initial_config(append_revisions_only)),
2159
2122
                      ('tags', ''),
2160
2123
                      ('references', '')
2161
2124
                      ]
2163
2126
 
2164
2127
    def make_tags(self, branch):
2165
2128
        """See bzrlib.branch.BranchFormat.make_tags()."""
2166
 
        return BasicTags(branch)
 
2129
        return _mod_tag.BasicTags(branch)
2167
2130
 
2168
2131
    def supports_set_append_revisions_only(self):
2169
2132
        return True
2183
2146
    This format was introduced in bzr 1.6.
2184
2147
    """
2185
2148
 
2186
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2149
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2150
                   append_revisions_only=None):
2187
2151
        """Create a branch of this format in a_bzrdir."""
2188
2152
        utf8_files = [('last-revision', '0 null:\n'),
2189
 
                      ('branch.conf', ''),
 
2153
                      ('branch.conf',
 
2154
                          self._get_initial_config(append_revisions_only)),
2190
2155
                      ('tags', ''),
2191
2156
                      ]
2192
2157
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2194
2159
    def _branch_class(self):
2195
2160
        return BzrBranch7
2196
2161
 
2197
 
    def get_format_string(self):
 
2162
    @classmethod
 
2163
    def get_format_string(cls):
2198
2164
        """See BranchFormat.get_format_string()."""
2199
2165
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2200
2166
 
2210
2176
 
2211
2177
    def make_tags(self, branch):
2212
2178
        """See bzrlib.branch.BranchFormat.make_tags()."""
2213
 
        return BasicTags(branch)
 
2179
        return _mod_tag.BasicTags(branch)
2214
2180
 
2215
2181
    supports_reference_locations = False
2216
2182
 
2217
2183
 
2218
 
class BranchReferenceFormat(BranchFormat):
 
2184
class BranchReferenceFormat(BranchFormatMetadir):
2219
2185
    """Bzr branch reference format.
2220
2186
 
2221
2187
    Branch references are used in implementing checkouts, they
2226
2192
     - a format string
2227
2193
    """
2228
2194
 
2229
 
    def get_format_string(self):
 
2195
    @classmethod
 
2196
    def get_format_string(cls):
2230
2197
        """See BranchFormat.get_format_string()."""
2231
2198
        return "Bazaar-NG Branch Reference Format 1\n"
2232
2199
 
2245
2212
        location = transport.put_bytes('location', to_branch.base)
2246
2213
 
2247
2214
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2248
 
            repository=None):
 
2215
            repository=None, append_revisions_only=None):
2249
2216
        """Create a branch of this format in a_bzrdir."""
2250
2217
        if target_branch is None:
2251
2218
            # this format does not implement branch itself, thus the implicit
2252
2219
            # creation contract must see it as uninitializable
2253
2220
            raise errors.UninitializableFormat(self)
2254
2221
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2222
        if a_bzrdir._format.fixed_components:
 
2223
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
2224
        if name is None:
 
2225
            name = a_bzrdir._get_selected_branch()
2255
2226
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2256
2227
        branch_transport.put_bytes('location',
2257
 
            target_branch.bzrdir.user_url)
2258
 
        branch_transport.put_bytes('format', self.get_format_string())
2259
 
        branch = self.open(
2260
 
            a_bzrdir, name, _found=True,
 
2228
            target_branch.user_url)
 
2229
        branch_transport.put_bytes('format', self.as_string())
 
2230
        branch = self.open(a_bzrdir, name, _found=True,
2261
2231
            possible_transports=[target_branch.bzrdir.root_transport])
2262
2232
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2263
2233
        return branch
2264
2234
 
2265
 
    def __init__(self):
2266
 
        super(BranchReferenceFormat, self).__init__()
2267
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2268
 
        self._matchingbzrdir.set_branch_format(self)
2269
 
 
2270
2235
    def _make_reference_clone_function(format, a_branch):
2271
2236
        """Create a clone() routine for a branch dynamically."""
2272
2237
        def clone(to_bzrdir, revision_id=None,
2294
2259
            a_bzrdir.
2295
2260
        :param possible_transports: An optional reusable transports list.
2296
2261
        """
 
2262
        if name is None:
 
2263
            name = a_bzrdir._get_selected_branch()
2297
2264
        if not _found:
2298
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2265
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2299
2266
            if format.__class__ != self.__class__:
2300
2267
                raise AssertionError("wrong format %r found for %r" %
2301
2268
                    (format, self))
2302
2269
        if location is None:
2303
2270
            location = self.get_reference(a_bzrdir, name)
2304
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2271
        real_bzrdir = controldir.ControlDir.open(
2305
2272
            location, possible_transports=possible_transports)
2306
 
        result = real_bzrdir.open_branch(name=name, 
2307
 
            ignore_fallbacks=ignore_fallbacks)
 
2273
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
 
2274
            possible_transports=possible_transports)
2308
2275
        # this changes the behaviour of result.clone to create a new reference
2309
2276
        # rather than a copy of the content of the branch.
2310
2277
        # I did not use a proxy object because that needs much more extensive
2344
2311
 
2345
2312
# formats which have no format string are not discoverable
2346
2313
# and not independently creatable, so are not registered.
2347
 
__format5 = BzrBranchFormat5()
2348
2314
__format6 = BzrBranchFormat6()
2349
2315
__format7 = BzrBranchFormat7()
2350
2316
__format8 = BzrBranchFormat8()
2351
 
format_registry.register(__format5)
 
2317
format_registry.register_lazy(
 
2318
    "Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2352
2319
format_registry.register(BranchReferenceFormat())
2353
2320
format_registry.register(__format6)
2354
2321
format_registry.register(__format7)
2391
2358
 
2392
2359
    def __init__(self, _format=None,
2393
2360
                 _control_files=None, a_bzrdir=None, name=None,
2394
 
                 _repository=None, ignore_fallbacks=False):
 
2361
                 _repository=None, ignore_fallbacks=False,
 
2362
                 possible_transports=None):
2395
2363
        """Create new branch object at a particular location."""
2396
2364
        if a_bzrdir is None:
2397
2365
            raise ValueError('a_bzrdir must be supplied')
2398
 
        else:
2399
 
            self.bzrdir = a_bzrdir
2400
 
        self._base = self.bzrdir.transport.clone('..').base
 
2366
        if name is None:
 
2367
            raise ValueError('name must be supplied')
 
2368
        self.bzrdir = a_bzrdir
 
2369
        self._user_transport = self.bzrdir.transport.clone('..')
 
2370
        if name != "":
 
2371
            self._user_transport.set_segment_parameter(
 
2372
                "branch", urlutils.escape(name))
 
2373
        self._base = self._user_transport.base
2401
2374
        self.name = name
2402
 
        # XXX: We should be able to just do
2403
 
        #   self.base = self.bzrdir.root_transport.base
2404
 
        # but this does not quite work yet -- mbp 20080522
2405
2375
        self._format = _format
2406
2376
        if _control_files is None:
2407
2377
            raise ValueError('BzrBranch _control_files is None')
2408
2378
        self.control_files = _control_files
2409
2379
        self._transport = _control_files._transport
2410
2380
        self.repository = _repository
2411
 
        Branch.__init__(self)
 
2381
        self.conf_store = None
 
2382
        Branch.__init__(self, possible_transports)
2412
2383
 
2413
2384
    def __str__(self):
2414
 
        if self.name is None:
2415
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2416
 
        else:
2417
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2418
 
                self.name)
 
2385
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2419
2386
 
2420
2387
    __repr__ = __str__
2421
2388
 
2425
2392
 
2426
2393
    base = property(_get_base, doc="The URL for the root of this branch.")
2427
2394
 
 
2395
    @property
 
2396
    def user_transport(self):
 
2397
        return self._user_transport
 
2398
 
2428
2399
    def _get_config(self):
2429
 
        return TransportConfig(self._transport, 'branch.conf')
 
2400
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2401
 
 
2402
    def _get_config_store(self):
 
2403
        if self.conf_store is None:
 
2404
            self.conf_store =  _mod_config.BranchStore(self)
 
2405
        return self.conf_store
 
2406
 
 
2407
    def _uncommitted_branch(self):
 
2408
        """Return the branch that may contain uncommitted changes."""
 
2409
        master = self.get_master_branch()
 
2410
        if master is not None:
 
2411
            return master
 
2412
        else:
 
2413
            return self
 
2414
 
 
2415
    def store_uncommitted(self, creator):
 
2416
        """Store uncommitted changes from a ShelfCreator.
 
2417
 
 
2418
        :param creator: The ShelfCreator containing uncommitted changes, or
 
2419
            None to delete any stored changes.
 
2420
        :raises: ChangesAlreadyStored if the branch already has changes.
 
2421
        """
 
2422
        branch = self._uncommitted_branch()
 
2423
        if creator is None:
 
2424
            branch._transport.delete('stored-transform')
 
2425
            return
 
2426
        if branch._transport.has('stored-transform'):
 
2427
            raise errors.ChangesAlreadyStored
 
2428
        transform = StringIO()
 
2429
        creator.write_shelf(transform)
 
2430
        transform.seek(0)
 
2431
        branch._transport.put_file('stored-transform', transform)
 
2432
 
 
2433
    def get_unshelver(self, tree):
 
2434
        """Return a shelf.Unshelver for this branch and tree.
 
2435
 
 
2436
        :param tree: The tree to use to construct the Unshelver.
 
2437
        :return: an Unshelver or None if no changes are stored.
 
2438
        """
 
2439
        branch = self._uncommitted_branch()
 
2440
        try:
 
2441
            transform = branch._transport.get('stored-transform')
 
2442
        except errors.NoSuchFile:
 
2443
            return None
 
2444
        return shelf.Unshelver.from_tree_and_shelf(tree, transform)
2430
2445
 
2431
2446
    def is_locked(self):
2432
2447
        return self.control_files.is_locked()
2440
2455
        """
2441
2456
        if not self.is_locked():
2442
2457
            self._note_lock('w')
2443
 
        # All-in-one needs to always unlock/lock.
2444
 
        repo_control = getattr(self.repository, 'control_files', None)
2445
 
        if self.control_files == repo_control or not self.is_locked():
2446
2458
            self.repository._warn_if_deprecated(self)
2447
2459
            self.repository.lock_write()
2448
2460
            took_lock = True
2463
2475
        """
2464
2476
        if not self.is_locked():
2465
2477
            self._note_lock('r')
2466
 
        # All-in-one needs to always unlock/lock.
2467
 
        repo_control = getattr(self.repository, 'control_files', None)
2468
 
        if self.control_files == repo_control or not self.is_locked():
2469
2478
            self.repository._warn_if_deprecated(self)
2470
2479
            self.repository.lock_read()
2471
2480
            took_lock = True
2481
2490
 
2482
2491
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2483
2492
    def unlock(self):
 
2493
        if self.control_files._lock_count == 1 and self.conf_store is not None:
 
2494
            self.conf_store.save_changes()
2484
2495
        try:
2485
2496
            self.control_files.unlock()
2486
2497
        finally:
2487
 
            # All-in-one needs to always unlock/lock.
2488
 
            repo_control = getattr(self.repository, 'control_files', None)
2489
 
            if (self.control_files == repo_control or
2490
 
                not self.control_files.is_locked()):
2491
 
                self.repository.unlock()
2492
2498
            if not self.control_files.is_locked():
 
2499
                self.repository.unlock()
2493
2500
                # we just released the lock
2494
2501
                self._clear_cached_state()
2495
2502
 
2513
2520
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2514
2521
        revision_id = _mod_revision.ensure_null(revision_id)
2515
2522
        old_revno, old_revid = self.last_revision_info()
2516
 
        if self._get_append_revisions_only():
 
2523
        if self.get_append_revisions_only():
2517
2524
            self._check_history_violation(revision_id)
2518
2525
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2519
2526
        self._write_last_revision_info(revno, revision_id)
2662
2669
        self._transport.put_bytes('last-revision', out_string,
2663
2670
            mode=self.bzrdir._get_file_mode())
2664
2671
 
2665
 
 
2666
 
class FullHistoryBzrBranch(BzrBranch):
2667
 
    """Bzr branch which contains the full revision history."""
2668
 
 
2669
 
    @needs_write_lock
2670
 
    def set_last_revision_info(self, revno, revision_id):
2671
 
        if not revision_id or not isinstance(revision_id, basestring):
2672
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2673
 
        revision_id = _mod_revision.ensure_null(revision_id)
2674
 
        # this old format stores the full history, but this api doesn't
2675
 
        # provide it, so we must generate, and might as well check it's
2676
 
        # correct
2677
 
        history = self._lefthand_history(revision_id)
2678
 
        if len(history) != revno:
2679
 
            raise AssertionError('%d != %d' % (len(history), revno))
2680
 
        self._set_revision_history(history)
2681
 
 
2682
 
    def _read_last_revision_info(self):
2683
 
        rh = self.revision_history()
2684
 
        revno = len(rh)
2685
 
        if revno:
2686
 
            return (revno, rh[-1])
2687
 
        else:
2688
 
            return (0, _mod_revision.NULL_REVISION)
2689
 
 
2690
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2691
 
    @needs_write_lock
2692
 
    def set_revision_history(self, rev_history):
2693
 
        """See Branch.set_revision_history."""
2694
 
        self._set_revision_history(rev_history)
2695
 
 
2696
 
    def _set_revision_history(self, rev_history):
2697
 
        if 'evil' in debug.debug_flags:
2698
 
            mutter_callsite(3, "set_revision_history scales with history.")
2699
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2700
 
        for rev_id in rev_history:
2701
 
            check_not_reserved_id(rev_id)
2702
 
        if Branch.hooks['post_change_branch_tip']:
2703
 
            # Don't calculate the last_revision_info() if there are no hooks
2704
 
            # that will use it.
2705
 
            old_revno, old_revid = self.last_revision_info()
2706
 
        if len(rev_history) == 0:
2707
 
            revid = _mod_revision.NULL_REVISION
2708
 
        else:
2709
 
            revid = rev_history[-1]
2710
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2711
 
        self._write_revision_history(rev_history)
2712
 
        self._clear_cached_state()
2713
 
        self._cache_revision_history(rev_history)
2714
 
        for hook in Branch.hooks['set_rh']:
2715
 
            hook(self, rev_history)
2716
 
        if Branch.hooks['post_change_branch_tip']:
2717
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2718
 
 
2719
 
    def _write_revision_history(self, history):
2720
 
        """Factored out of set_revision_history.
2721
 
 
2722
 
        This performs the actual writing to disk.
2723
 
        It is intended to be called by set_revision_history."""
2724
 
        self._transport.put_bytes(
2725
 
            'revision-history', '\n'.join(history),
2726
 
            mode=self.bzrdir._get_file_mode())
2727
 
 
2728
 
    def _gen_revision_history(self):
2729
 
        history = self._transport.get_bytes('revision-history').split('\n')
2730
 
        if history[-1:] == ['']:
2731
 
            # There shouldn't be a trailing newline, but just in case.
2732
 
            history.pop()
2733
 
        return history
2734
 
 
2735
 
    def _synchronize_history(self, destination, revision_id):
2736
 
        if not isinstance(destination, FullHistoryBzrBranch):
2737
 
            super(BzrBranch, self)._synchronize_history(
2738
 
                destination, revision_id)
2739
 
            return
2740
 
        if revision_id == _mod_revision.NULL_REVISION:
2741
 
            new_history = []
2742
 
        else:
2743
 
            new_history = self.revision_history()
2744
 
        if revision_id is not None and new_history != []:
2745
 
            try:
2746
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2747
 
            except ValueError:
2748
 
                rev = self.repository.get_revision(revision_id)
2749
 
                new_history = rev.get_history(self.repository)[1:]
2750
 
        destination._set_revision_history(new_history)
2751
 
 
2752
 
    @needs_write_lock
2753
 
    def generate_revision_history(self, revision_id, last_rev=None,
2754
 
        other_branch=None):
2755
 
        """Create a new revision history that will finish with revision_id.
2756
 
 
2757
 
        :param revision_id: the new tip to use.
2758
 
        :param last_rev: The previous last_revision. If not None, then this
2759
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2760
 
        :param other_branch: The other branch that DivergedBranches should
2761
 
            raise with respect to.
 
2672
    @needs_write_lock
 
2673
    def update_feature_flags(self, updated_flags):
 
2674
        """Update the feature flags for this branch.
 
2675
 
 
2676
        :param updated_flags: Dictionary mapping feature names to necessities
 
2677
            A necessity can be None to indicate the feature should be removed
2762
2678
        """
2763
 
        self._set_revision_history(self._lefthand_history(revision_id,
2764
 
            last_rev, other_branch))
2765
 
 
2766
 
 
2767
 
class BzrBranch5(FullHistoryBzrBranch):
2768
 
    """A format 5 branch. This supports new features over plain branches.
2769
 
 
2770
 
    It has support for a master_branch which is the data for bound branches.
2771
 
    """
 
2679
        self._format._update_feature_flags(updated_flags)
 
2680
        self.control_transport.put_bytes('format', self._format.as_string())
2772
2681
 
2773
2682
 
2774
2683
class BzrBranch8(BzrBranch):
2775
2684
    """A branch that stores tree-reference locations."""
2776
2685
 
2777
 
    def _open_hook(self):
 
2686
    def _open_hook(self, possible_transports=None):
2778
2687
        if self._ignore_fallbacks:
2779
2688
            return
 
2689
        if possible_transports is None:
 
2690
            possible_transports = [self.bzrdir.root_transport]
2780
2691
        try:
2781
2692
            url = self.get_stacked_on_url()
2782
2693
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2790
2701
                    raise AssertionError(
2791
2702
                        "'transform_fallback_location' hook %s returned "
2792
2703
                        "None, not a URL." % hook_name)
2793
 
            self._activate_fallback_location(url)
 
2704
            self._activate_fallback_location(url,
 
2705
                possible_transports=possible_transports)
2794
2706
 
2795
2707
    def __init__(self, *args, **kwargs):
2796
2708
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2914
2826
        """See Branch.set_push_location."""
2915
2827
        self._master_branch_cache = None
2916
2828
        result = None
2917
 
        config = self.get_config()
 
2829
        conf = self.get_config_stack()
2918
2830
        if location is None:
2919
 
            if config.get_user_option('bound') != 'True':
 
2831
            if not conf.get('bound'):
2920
2832
                return False
2921
2833
            else:
2922
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
2834
                conf.set('bound', 'False')
2923
2835
                return True
2924
2836
        else:
2925
2837
            self._set_config_location('bound_location', location,
2926
 
                                      config=config)
2927
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
2838
                                      config=conf)
 
2839
            conf.set('bound', 'True')
2928
2840
        return True
2929
2841
 
2930
2842
    def _get_bound_location(self, bound):
2931
2843
        """Return the bound location in the config file.
2932
2844
 
2933
2845
        Return None if the bound parameter does not match"""
2934
 
        config = self.get_config()
2935
 
        config_bound = (config.get_user_option('bound') == 'True')
2936
 
        if config_bound != bound:
 
2846
        conf = self.get_config_stack()
 
2847
        if conf.get('bound') != bound:
2937
2848
            return None
2938
 
        return self._get_config_location('bound_location', config=config)
 
2849
        return self._get_config_location('bound_location', config=conf)
2939
2850
 
2940
2851
    def get_bound_location(self):
2941
 
        """See Branch.set_push_location."""
 
2852
        """See Branch.get_bound_location."""
2942
2853
        return self._get_bound_location(True)
2943
2854
 
2944
2855
    def get_old_bound_location(self):
2951
2862
        ## self._check_stackable_repo()
2952
2863
        # stacked_on_location is only ever defined in branch.conf, so don't
2953
2864
        # waste effort reading the whole stack of config files.
2954
 
        config = self.get_config()._get_branch_data_config()
 
2865
        conf = _mod_config.BranchOnlyStack(self)
2955
2866
        stacked_url = self._get_config_location('stacked_on_location',
2956
 
            config=config)
 
2867
                                                config=conf)
2957
2868
        if stacked_url is None:
2958
2869
            raise errors.NotStacked(self)
2959
 
        return stacked_url
2960
 
 
2961
 
    def _get_append_revisions_only(self):
2962
 
        return self.get_config(
2963
 
            ).get_user_option_as_bool('append_revisions_only')
 
2870
        return stacked_url.encode('utf-8')
2964
2871
 
2965
2872
    @needs_read_lock
2966
2873
    def get_rev_id(self, revno, history=None):
2996
2903
            except errors.RevisionNotPresent, e:
2997
2904
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2998
2905
            index = len(self._partial_revision_history_cache) - 1
 
2906
            if index < 0:
 
2907
                raise errors.NoSuchRevision(self, revision_id)
2999
2908
            if self._partial_revision_history_cache[index] != revision_id:
3000
2909
                raise errors.NoSuchRevision(self, revision_id)
3001
2910
        return self.revno() - index
3053
2962
    :ivar local_branch: target branch if there is a Master, else None
3054
2963
    :ivar target_branch: Target/destination branch object. (write locked)
3055
2964
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2965
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3056
2966
    """
3057
2967
 
3058
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3059
 
    def __int__(self):
3060
 
        """Return the relative change in revno.
3061
 
 
3062
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3063
 
        """
3064
 
        return self.new_revno - self.old_revno
3065
 
 
3066
2968
    def report(self, to_file):
 
2969
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
2970
        tag_updates = getattr(self, "tag_updates", None)
3067
2971
        if not is_quiet():
3068
 
            if self.old_revid == self.new_revid:
3069
 
                to_file.write('No revisions to pull.\n')
3070
 
            else:
 
2972
            if self.old_revid != self.new_revid:
3071
2973
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2974
            if tag_updates:
 
2975
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
2976
            if self.old_revid == self.new_revid and not tag_updates:
 
2977
                if not tag_conflicts:
 
2978
                    to_file.write('No revisions or tags to pull.\n')
 
2979
                else:
 
2980
                    to_file.write('No revisions to pull.\n')
3072
2981
        self._show_tag_conficts(to_file)
3073
2982
 
3074
2983
 
3091
3000
        target, otherwise it will be None.
3092
3001
    """
3093
3002
 
3094
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3095
 
    def __int__(self):
3096
 
        """Return the relative change in revno.
3097
 
 
3098
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3099
 
        """
3100
 
        return self.new_revno - self.old_revno
3101
 
 
3102
3003
    def report(self, to_file):
3103
 
        """Write a human-readable description of the result."""
3104
 
        if self.old_revid == self.new_revid:
3105
 
            note('No new revisions to push.')
3106
 
        else:
3107
 
            note('Pushed up to revision %d.' % self.new_revno)
 
3004
        # TODO: This function gets passed a to_file, but then
 
3005
        # ignores it and calls note() instead. This is also
 
3006
        # inconsistent with PullResult(), which writes to stdout.
 
3007
        # -- JRV20110901, bug #838853
 
3008
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3009
        tag_updates = getattr(self, "tag_updates", None)
 
3010
        if not is_quiet():
 
3011
            if self.old_revid != self.new_revid:
 
3012
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3013
            if tag_updates:
 
3014
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3015
            if self.old_revid == self.new_revid and not tag_updates:
 
3016
                if not tag_conflicts:
 
3017
                    note(gettext('No new revisions or tags to push.'))
 
3018
                else:
 
3019
                    note(gettext('No new revisions to push.'))
3108
3020
        self._show_tag_conficts(to_file)
3109
3021
 
3110
3022
 
3124
3036
        :param verbose: Requests more detailed display of what was checked,
3125
3037
            if any.
3126
3038
        """
3127
 
        note('checked branch %s format %s', self.branch.user_url,
3128
 
            self.branch._format)
 
3039
        note(gettext('checked branch {0} format {1}').format(
 
3040
                                self.branch.user_url, self.branch._format))
3129
3041
        for error in self.errors:
3130
 
            note('found error:%s', error)
 
3042
            note(gettext('found error:%s'), error)
3131
3043
 
3132
3044
 
3133
3045
class Converter5to6(object):
3140
3052
 
3141
3053
        # Copy source data into target
3142
3054
        new_branch._write_last_revision_info(*branch.last_revision_info())
3143
 
        new_branch.set_parent(branch.get_parent())
3144
 
        new_branch.set_bound_location(branch.get_bound_location())
3145
 
        new_branch.set_push_location(branch.get_push_location())
 
3055
        new_branch.lock_write()
 
3056
        try:
 
3057
            new_branch.set_parent(branch.get_parent())
 
3058
            new_branch.set_bound_location(branch.get_bound_location())
 
3059
            new_branch.set_push_location(branch.get_push_location())
 
3060
        finally:
 
3061
            new_branch.unlock()
3146
3062
 
3147
3063
        # New branch has no tags by default
3148
3064
        new_branch.tags._set_tag_dict({})
3149
3065
 
3150
3066
        # Copying done; now update target format
3151
3067
        new_branch._transport.put_bytes('format',
3152
 
            format.get_format_string(),
 
3068
            format.as_string(),
3153
3069
            mode=new_branch.bzrdir._get_file_mode())
3154
3070
 
3155
3071
        # Clean up old files
3156
3072
        new_branch._transport.delete('revision-history')
 
3073
        branch.lock_write()
3157
3074
        try:
3158
 
            branch.set_parent(None)
3159
 
        except errors.NoSuchFile:
3160
 
            pass
3161
 
        branch.set_bound_location(None)
 
3075
            try:
 
3076
                branch.set_parent(None)
 
3077
            except errors.NoSuchFile:
 
3078
                pass
 
3079
            branch.set_bound_location(None)
 
3080
        finally:
 
3081
            branch.unlock()
3162
3082
 
3163
3083
 
3164
3084
class Converter6to7(object):
3168
3088
        format = BzrBranchFormat7()
3169
3089
        branch._set_config_location('stacked_on_location', '')
3170
3090
        # update target format
3171
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3091
        branch._transport.put_bytes('format', format.as_string())
3172
3092
 
3173
3093
 
3174
3094
class Converter7to8(object):
3175
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3095
    """Perform an in-place upgrade of format 7 to format 8"""
3176
3096
 
3177
3097
    def convert(self, branch):
3178
3098
        format = BzrBranchFormat8()
3179
3099
        branch._transport.put_bytes('references', '')
3180
3100
        # update target format
3181
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3101
        branch._transport.put_bytes('format', format.as_string())
3182
3102
 
3183
3103
 
3184
3104
class InterBranch(InterObject):
3241
3161
        raise NotImplementedError(self.fetch)
3242
3162
 
3243
3163
 
 
3164
def _fix_overwrite_type(overwrite):
 
3165
    if isinstance(overwrite, bool):
 
3166
        if overwrite:
 
3167
            return ["history", "tags"]
 
3168
        else:
 
3169
            return []
 
3170
    return overwrite
 
3171
 
 
3172
 
3244
3173
class GenericInterBranch(InterBranch):
3245
3174
    """InterBranch implementation that uses public Branch functions."""
3246
3175
 
3411
3340
        result.target_branch = self.target
3412
3341
        result.old_revno, result.old_revid = self.target.last_revision_info()
3413
3342
        self.source.update_references(self.target)
 
3343
        overwrite = _fix_overwrite_type(overwrite)
3414
3344
        if result.old_revid != stop_revision:
3415
3345
            # We assume that during 'push' this repository is closer than
3416
3346
            # the target.
3417
3347
            graph = self.source.repository.get_graph(self.target.repository)
3418
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3419
 
                    graph=graph)
 
3348
            self._update_revisions(stop_revision,
 
3349
                overwrite=("history" in overwrite),
 
3350
                graph=graph)
3420
3351
        if self.source._push_should_merge_tags():
3421
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3422
 
                overwrite)
 
3352
            result.tag_updates, result.tag_conflicts = (
 
3353
                self.source.tags.merge_to(
 
3354
                self.target.tags, "tags" in overwrite))
3423
3355
        result.new_revno, result.new_revid = self.target.last_revision_info()
3424
3356
        return result
3425
3357
 
3503
3435
            # -- JRV20090506
3504
3436
            result.old_revno, result.old_revid = \
3505
3437
                self.target.last_revision_info()
3506
 
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3438
            overwrite = _fix_overwrite_type(overwrite)
 
3439
            self._update_revisions(stop_revision,
 
3440
                overwrite=("history" in overwrite),
3507
3441
                graph=graph)
3508
3442
            # TODO: The old revid should be specified when merging tags, 
3509
3443
            # so a tags implementation that versions tags can only 
3510
3444
            # pull in the most recent changes. -- JRV20090506
3511
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3512
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3445
            result.tag_updates, result.tag_conflicts = (
 
3446
                self.source.tags.merge_to(self.target.tags,
 
3447
                    "tags" in overwrite,
 
3448
                    ignore_master=not merge_tags_to_master))
3513
3449
            result.new_revno, result.new_revid = self.target.last_revision_info()
3514
3450
            if _hook_master:
3515
3451
                result.master_branch = _hook_master