~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jonathan Lange
  • Date: 2009-07-03 09:16:06 UTC
  • mto: This revision was merged to the branch mainline in revision 4506.
  • Revision ID: jml@canonical.com-20090703091606-727yl1bsg5h08wux
Use 'foo', not 'jml'

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
35
35
        symbol_versioning,
36
36
        transport,
37
37
        tsort,
38
 
        ui,
39
38
        urlutils,
40
39
        )
41
40
from bzrlib.config import BranchConfig, TransportConfig
46
45
    )
47
46
""")
48
47
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
49
from bzrlib.hooks import HookPoint, Hooks
51
50
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
51
from bzrlib import registry
54
52
from bzrlib.symbol_versioning import (
55
53
    deprecated_in,
63
61
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
62
 
65
63
 
66
 
class Branch(bzrdir.ControlComponent):
 
64
# TODO: Maybe include checks for common corruption of newlines, etc?
 
65
 
 
66
# TODO: Some operations like log might retrieve the same revisions
 
67
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
68
# cache in memory to make this faster.  In general anything can be
 
69
# cached in memory between lock and unlock operations. .. nb thats
 
70
# what the transaction identity map provides
 
71
 
 
72
 
 
73
######################################################################
 
74
# branch objects
 
75
 
 
76
class Branch(object):
67
77
    """Branch holding a history of revisions.
68
78
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
79
    base
 
80
        Base directory/url of the branch.
72
81
 
73
82
    hooks: An instance of BranchHooks.
74
83
    """
76
85
    # - RBC 20060112
77
86
    base = None
78
87
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
88
    def __init__(self, *ignored, **ignored_too):
88
89
        self.tags = self._format.make_tags(self)
89
90
        self._revision_history_cache = None
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
107
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
108
            raise errors.UnstackableLocationError(self.base, url)
108
109
        self.repository.add_fallback_repository(repo)
109
110
 
110
111
    def break_lock(self):
147
148
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
149
            self._partial_revision_history_cache.pop()
149
150
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
151
    @staticmethod
159
152
    def open(base, _unsupported=False, possible_transports=None):
160
153
        """Open the branch rooted at base.
164
157
        """
165
158
        control = bzrdir.BzrDir.open(base, _unsupported,
166
159
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
160
        return control.open_branch(_unsupported)
168
161
 
169
162
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
163
    def open_from_transport(transport, _unsupported=False):
171
164
        """Open the branch rooted at transport"""
172
165
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
166
        return control.open_branch(_unsupported)
174
167
 
175
168
    @staticmethod
176
169
    def open_containing(url, possible_transports=None):
214
207
    def _get_fallback_repository(self, url):
215
208
        """Get the repository we fallback to at url."""
216
209
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
210
        a_bzrdir = bzrdir.BzrDir.open(url,
218
211
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
212
        return a_bzrdir.open_branch().repository
220
213
 
221
214
    def _get_tags_bytes(self):
222
215
        """Get the bytes of a serialised tags dict.
283
276
        new_history.reverse()
284
277
        return new_history
285
278
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
279
    def lock_write(self):
293
280
        raise NotImplementedError(self.lock_write)
294
281
 
295
282
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
283
        raise NotImplementedError(self.lock_read)
302
284
 
303
285
    def unlock(self):
428
410
            * 'include' - the stop revision is the last item in the result
429
411
            * 'with-merges' - include the stop revision and all of its
430
412
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
413
        :param direction: either 'reverse' or 'forward':
434
414
            * reverse means return the start_revision_id first, i.e.
435
415
              start at the most recent revision and go backwards in history
457
437
        # start_revision_id.
458
438
        if self._merge_sorted_revisions_cache is None:
459
439
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
440
            graph = self.repository.get_graph()
 
441
            parent_map = dict(((key, value) for key, value in
 
442
                     graph.iter_ancestry([last_revision]) if value is not None))
 
443
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
444
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
445
                generate_revno=True)
 
446
            # Drop the sequence # before caching
 
447
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
448
 
464
449
        filtered = self._filter_merge_sorted_revisions(
465
450
            self._merge_sorted_revisions_cache, start_revision_id,
466
451
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
452
        if direction == 'reverse':
471
453
            return filtered
472
454
        if direction == 'forward':
479
461
        """Iterate over an inclusive range of sorted revisions."""
480
462
        rev_iter = iter(merge_sorted_revisions)
481
463
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
465
                if rev_id != start_revision_id:
485
466
                    continue
486
467
                else:
487
468
                    # The decision to include the start or not
488
469
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
470
                    rev_iter = chain(
 
471
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
472
                        rev_iter)
491
473
                    break
492
474
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
475
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
476
                yield rev_id, depth, revno, end_of_merge
498
477
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
478
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
479
                if rev_id == stop_revision_id:
502
480
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
481
                yield rev_id, depth, revno, end_of_merge
505
482
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
483
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
484
                yield rev_id, depth, revno, end_of_merge
510
485
                if rev_id == stop_revision_id:
511
486
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
487
        elif stop_rule == 'with-merges':
525
488
            stop_rev = self.repository.get_revision(stop_revision_id)
526
489
            if stop_rev.parent_ids:
527
490
                left_parent = stop_rev.parent_ids[0]
528
491
            else:
529
492
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
493
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
494
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
495
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
496
                yield rev_id, depth, revno, end_of_merge
549
497
        else:
550
498
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
499
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
500
    def leave_lock_in_place(self):
598
501
        """Tell this branch object not to release the physical lock when this
599
502
        object is unlocked.
616
519
        :param other: The branch to bind to
617
520
        :type other: Branch
618
521
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
522
        raise errors.UpgradeRequired(self.base)
620
523
 
621
524
    def set_append_revisions_only(self, enabled):
622
525
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
526
            raise errors.UpgradeRequired(self.base)
624
527
        if enabled:
625
528
            value = 'True'
626
529
        else:
674
577
    def get_old_bound_location(self):
675
578
        """Return the URL of the branch we used to be bound to
676
579
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
580
        raise errors.UpgradeRequired(self.base)
678
581
 
679
582
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
583
                           timezone=None, committer=None, revprops=None,
758
661
            stacking.
759
662
        """
760
663
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
 
664
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
665
        self._check_stackable_repo()
766
666
        if not url:
767
667
            try:
769
669
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
670
                errors.UnstackableRepositoryFormat):
771
671
                return
772
 
            self._unstack()
 
672
            url = ''
 
673
            # XXX: Lock correctness - should unlock our old repo if we were
 
674
            # locked.
 
675
            # repositories don't offer an interface to remove fallback
 
676
            # repositories today; take the conceptually simpler option and just
 
677
            # reopen it.
 
678
            self.repository = self.bzrdir.find_repository()
 
679
            self.repository.lock_write()
 
680
            # for every revision reference the branch has, ensure it is pulled
 
681
            # in.
 
682
            source_repository = self._get_fallback_repository(old_url)
 
683
            for revision_id in chain([self.last_revision()],
 
684
                self.tags.get_reverse_tag_dict()):
 
685
                self.repository.fetch(source_repository, revision_id,
 
686
                    find_ghosts=True)
773
687
        else:
774
688
            self._activate_fallback_location(url)
775
689
        # write this out after the repository is stacked to avoid setting a
776
690
        # stacked config that doesn't work.
777
691
        self._set_config_location('stacked_on_location', url)
778
692
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
693
 
834
694
    def _set_tags_bytes(self, bytes):
835
695
        """Mirror method for _get_tags_bytes.
915
775
 
916
776
    def unbind(self):
917
777
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
778
        raise errors.UpgradeRequired(self.base)
919
779
 
920
780
    def last_revision(self):
921
781
        """Return last revision id, or NULL_REVISION."""
1081
941
        try:
1082
942
            return urlutils.join(self.base[:-1], parent)
1083
943
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
944
            raise errors.InaccessibleParent(parent, self.base)
1085
945
 
1086
946
    def _get_parent_location(self):
1087
947
        raise NotImplementedError(self._get_parent_location)
1172
1032
        params = ChangeBranchTipParams(
1173
1033
            self, old_revno, new_revno, old_revid, new_revid)
1174
1034
        for hook in hooks:
1175
 
            hook(params)
 
1035
            try:
 
1036
                hook(params)
 
1037
            except errors.TipChangeRejected:
 
1038
                raise
 
1039
            except Exception:
 
1040
                exc_info = sys.exc_info()
 
1041
                hook_name = Branch.hooks.get_hook_name(hook)
 
1042
                raise errors.HookFailed(
 
1043
                    'pre_change_branch_tip', hook_name, exc_info)
1176
1044
 
1177
1045
    @needs_write_lock
1178
1046
    def update(self):
1227
1095
        revision_id: if not None, the revision history in the new branch will
1228
1096
                     be truncated to end with revision_id.
1229
1097
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1098
        result = to_bzrdir.create_branch()
1234
1099
        result.lock_write()
1235
1100
        try:
1303
1168
        target._set_all_reference_info(target_reference_dict)
1304
1169
 
1305
1170
    @needs_read_lock
1306
 
    def check(self, refs):
 
1171
    def check(self):
1307
1172
        """Check consistency of the branch.
1308
1173
 
1309
1174
        In particular this checks that revisions given in the revision-history
1312
1177
 
1313
1178
        Callers will typically also want to check the repository.
1314
1179
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1180
        :return: A BranchCheckResult.
1318
1181
        """
1319
 
        result = BranchCheckResult(self)
 
1182
        ret = BranchCheckResult(self)
 
1183
        mainline_parent_id = None
1320
1184
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
1185
        real_rev_history = []
 
1186
        try:
 
1187
            for revid in self.repository.iter_reverse_revision_history(
 
1188
                last_revision_id):
 
1189
                real_rev_history.append(revid)
 
1190
        except errors.RevisionNotPresent:
 
1191
            ret.ghosts_in_mainline = True
 
1192
        else:
 
1193
            ret.ghosts_in_mainline = False
 
1194
        real_rev_history.reverse()
 
1195
        if len(real_rev_history) != last_revno:
 
1196
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1197
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1198
        # TODO: We should probably also check that real_rev_history actually
 
1199
        #       matches self.revision_history()
 
1200
        for revision_id in real_rev_history:
 
1201
            try:
 
1202
                revision = self.repository.get_revision(revision_id)
 
1203
            except errors.NoSuchRevision, e:
 
1204
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1205
                            % revision_id)
 
1206
            # In general the first entry on the revision history has no parents.
 
1207
            # But it's not illegal for it to have parents listed; this can happen
 
1208
            # in imports from Arch when the parents weren't reachable.
 
1209
            if mainline_parent_id is not None:
 
1210
                if mainline_parent_id not in revision.parent_ids:
 
1211
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1212
                                        "parents of {%s}"
 
1213
                                        % (mainline_parent_id, revision_id))
 
1214
            mainline_parent_id = revision_id
 
1215
        return ret
1332
1216
 
1333
1217
    def _get_checkout_format(self):
1334
1218
        """Return the most suitable metadir for a checkout of this branch.
1359
1243
        # clone call. Or something. 20090224 RBC/spiv.
1360
1244
        if revision_id is None:
1361
1245
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1246
        try:
 
1247
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1248
                revision_id=revision_id, stacked_on=stacked_on,
 
1249
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1250
        except errors.FileExists:
 
1251
            if not use_existing_dir:
 
1252
                raise
 
1253
        except errors.NoSuchFile:
 
1254
            if not create_prefix:
 
1255
                raise
1365
1256
        return dir_to.open_branch()
1366
1257
 
1367
1258
    def create_checkout(self, to_location, revision_id=None,
1386
1277
        if lightweight:
1387
1278
            format = self._get_checkout_format()
1388
1279
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1280
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1281
        else:
1392
1282
            format = self._get_checkout_format()
1393
1283
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1325
    def supports_tags(self):
1436
1326
        return self._format.supports_tags()
1437
1327
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1328
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1329
                                         other_branch):
1452
1330
        """Ensure that revision_b is a descendant of revision_a.
1516
1394
        return not (self == other)
1517
1395
 
1518
1396
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1397
    def find_format(klass, a_bzrdir):
1520
1398
        """Return the format for the branch object in a_bzrdir."""
1521
1399
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1400
            transport = a_bzrdir.get_branch_transport(None)
 
1401
            format_string = transport.get("format").read()
1524
1402
            return klass._formats[format_string]
1525
1403
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1404
            raise errors.NotBranchError(path=transport.base)
1527
1405
        except KeyError:
1528
1406
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1407
 
1565
1443
        """Return the short format description for this format."""
1566
1444
        raise NotImplementedError(self.get_format_description)
1567
1445
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1446
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1447
                           set_format=True):
1578
1448
        """Initialize a branch in a bzrdir, with specified files
1579
1449
 
1580
1450
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1451
        :param utf8_files: The files to create as a list of
1582
1452
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1453
        :param set_format: If True, set the format with
1585
1454
            self.get_format_string.  (BzrBranch4 has its format set
1586
1455
            elsewhere)
1587
1456
        :return: a branch in this format
1588
1457
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1458
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1459
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1460
        lock_map = {
1592
1461
            'metadir': ('lock', lockdir.LockDir),
1593
1462
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1483
        finally:
1615
1484
            if lock_taken:
1616
1485
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1486
        return self.open(a_bzrdir, _found=True)
1620
1487
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1488
    def initialize(self, a_bzrdir):
 
1489
        """Create a branch of this format in a_bzrdir."""
1626
1490
        raise NotImplementedError(self.initialize)
1627
1491
 
1628
1492
    def is_supported(self):
1658
1522
        """
1659
1523
        raise NotImplementedError(self.network_name)
1660
1524
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1525
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1526
        """Return the branch object for a_bzrdir
1663
1527
 
1664
1528
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1529
        :param _found: a private parameter, do not use it. It is used to
1667
1530
            indicate if format probing has already be done.
1668
1531
        :param ignore_fallbacks: when set, no fallback branches will be opened
1776
1639
            "multiple hooks installed for transform_fallback_location, "
1777
1640
            "all are called with the url returned from the previous hook."
1778
1641
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1642
 
1797
1643
 
1798
1644
# install the default hooks into the Branch class.
1837
1683
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1684
 
1839
1685
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1686
class BzrBranchFormat4(BranchFormat):
1919
1687
    """Bzr branch format 4.
1920
1688
 
1927
1695
        """See BranchFormat.get_format_description()."""
1928
1696
        return "Branch format 4"
1929
1697
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1698
    def initialize(self, a_bzrdir):
1931
1699
        """Create a branch of this format in a_bzrdir."""
1932
1700
        utf8_files = [('revision-history', ''),
1933
1701
                      ('branch-name', ''),
1934
1702
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1703
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1704
                                       lock_type='branch4', set_format=False)
1937
1705
 
1938
1706
    def __init__(self):
1943
1711
        """The network name for this format is the control dirs disk label."""
1944
1712
        return self._matchingbzrdir.get_format_string()
1945
1713
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1714
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1715
        """See BranchFormat.open()."""
1948
1716
        if not _found:
1949
1717
            # we are being called directly and must probe.
1951
1719
        return BzrBranch(_format=self,
1952
1720
                         _control_files=a_bzrdir._control_files,
1953
1721
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1722
                         _repository=a_bzrdir.open_repository())
1956
1723
 
1957
1724
    def __str__(self):
1972
1739
        """
1973
1740
        return self.get_format_string()
1974
1741
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1742
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1743
        """See BranchFormat.open()."""
1977
1744
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1745
            format = BranchFormat.find_format(a_bzrdir)
1979
1746
            if format.__class__ != self.__class__:
1980
1747
                raise AssertionError("wrong format %r found for %r" %
1981
1748
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1749
        try:
 
1750
            transport = a_bzrdir.get_branch_transport(None)
1984
1751
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1752
                                                         lockdir.LockDir)
1986
1753
            return self._branch_class()(_format=self,
1987
1754
                              _control_files=control_files,
1988
 
                              name=name,
1989
1755
                              a_bzrdir=a_bzrdir,
1990
1756
                              _repository=a_bzrdir.find_repository(),
1991
1757
                              ignore_fallbacks=ignore_fallbacks)
1992
1758
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1759
            raise errors.NotBranchError(path=transport.base)
1994
1760
 
1995
1761
    def __init__(self):
1996
1762
        super(BranchFormatMetadir, self).__init__()
2025
1791
        """See BranchFormat.get_format_description()."""
2026
1792
        return "Branch format 5"
2027
1793
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1794
    def initialize(self, a_bzrdir):
2029
1795
        """Create a branch of this format in a_bzrdir."""
2030
1796
        utf8_files = [('revision-history', ''),
2031
1797
                      ('branch-name', ''),
2032
1798
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1799
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1800
 
2035
1801
    def supports_tags(self):
2036
1802
        return False
2058
1824
        """See BranchFormat.get_format_description()."""
2059
1825
        return "Branch format 6"
2060
1826
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1827
    def initialize(self, a_bzrdir):
2062
1828
        """Create a branch of this format in a_bzrdir."""
2063
1829
        utf8_files = [('last-revision', '0 null:\n'),
2064
1830
                      ('branch.conf', ''),
2065
1831
                      ('tags', ''),
2066
1832
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1833
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1834
 
2069
1835
    def make_tags(self, branch):
2070
1836
        """See bzrlib.branch.BranchFormat.make_tags()."""
2088
1854
        """See BranchFormat.get_format_description()."""
2089
1855
        return "Branch format 8"
2090
1856
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1857
    def initialize(self, a_bzrdir):
2092
1858
        """Create a branch of this format in a_bzrdir."""
2093
1859
        utf8_files = [('last-revision', '0 null:\n'),
2094
1860
                      ('branch.conf', ''),
2095
1861
                      ('tags', ''),
2096
1862
                      ('references', '')
2097
1863
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1864
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1865
 
2100
1866
    def __init__(self):
2101
1867
        super(BzrBranchFormat8, self).__init__()
2124
1890
    This format was introduced in bzr 1.6.
2125
1891
    """
2126
1892
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1893
    def initialize(self, a_bzrdir):
2128
1894
        """Create a branch of this format in a_bzrdir."""
2129
1895
        utf8_files = [('last-revision', '0 null:\n'),
2130
1896
                      ('branch.conf', ''),
2131
1897
                      ('tags', ''),
2132
1898
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1899
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1900
 
2135
1901
    def _branch_class(self):
2136
1902
        return BzrBranch7
2171
1937
    def get_reference(self, a_bzrdir):
2172
1938
        """See BranchFormat.get_reference()."""
2173
1939
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1940
        return transport.get('location').read()
2175
1941
 
2176
1942
    def set_reference(self, a_bzrdir, to_branch):
2177
1943
        """See BranchFormat.set_reference()."""
2178
1944
        transport = a_bzrdir.get_branch_transport(None)
2179
1945
        location = transport.put_bytes('location', to_branch.base)
2180
1946
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1947
    def initialize(self, a_bzrdir, target_branch=None):
2182
1948
        """Create a branch of this format in a_bzrdir."""
2183
1949
        if target_branch is None:
2184
1950
            # this format does not implement branch itself, thus the implicit
2185
1951
            # creation contract must see it as uninitializable
2186
1952
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1953
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1954
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1955
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1956
            target_branch.bzrdir.root_transport.base)
2191
1957
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1958
        return self.open(
 
1959
            a_bzrdir, _found=True,
2194
1960
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1961
 
2198
1962
    def __init__(self):
2199
1963
        super(BranchReferenceFormat, self).__init__()
2205
1969
        def clone(to_bzrdir, revision_id=None,
2206
1970
            repository_policy=None):
2207
1971
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1972
            return format.initialize(to_bzrdir, a_branch)
2209
1973
            # cannot obey revision_id limits when cloning a reference ...
2210
1974
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1975
            # emit some sort of warning/error to the caller ?!
2212
1976
        return clone
2213
1977
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1978
    def open(self, a_bzrdir, _found=False, location=None,
2215
1979
             possible_transports=None, ignore_fallbacks=False):
2216
1980
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1981
 
2218
1982
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1983
        :param _found: a private parameter, do not use it. It is used to
2221
1984
            indicate if format probing has already be done.
2222
1985
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1990
        :param possible_transports: An optional reusable transports list.
2228
1991
        """
2229
1992
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1993
            format = BranchFormat.find_format(a_bzrdir)
2231
1994
            if format.__class__ != self.__class__:
2232
1995
                raise AssertionError("wrong format %r found for %r" %
2233
1996
                    (format, self))
2235
1998
            location = self.get_reference(a_bzrdir)
2236
1999
        real_bzrdir = bzrdir.BzrDir.open(
2237
2000
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
2001
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2002
        # this changes the behaviour of result.clone to create a new reference
2241
2003
        # rather than a copy of the content of the branch.
2242
2004
        # I did not use a proxy object because that needs much more extensive
2269
2031
BranchFormat.register_format(__format6)
2270
2032
BranchFormat.register_format(__format7)
2271
2033
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
2034
BranchFormat.set_default_format(__format6)
2273
2035
_legacy_formats = [BzrBranchFormat4(),
2274
2036
    ]
2275
2037
network_format_registry.register(
2276
2038
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2039
 
2278
2040
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
    def __str__(self):
2292
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
 
            self.unlock)
2294
 
 
2295
 
 
2296
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2041
class BzrBranch(Branch):
2297
2042
    """A branch stored in the actual filesystem.
2298
2043
 
2299
2044
    Note that it's "local" in the context of the filesystem; it doesn't
2305
2050
    :ivar repository: Repository for this branch.
2306
2051
    :ivar base: The url of the base directory for this branch; the one
2307
2052
        containing the .bzr directory.
2308
 
    :ivar name: Optional colocated branch name as it exists in the control
2309
 
        directory.
2310
2053
    """
2311
2054
 
2312
2055
    def __init__(self, _format=None,
2313
 
                 _control_files=None, a_bzrdir=None, name=None,
2314
 
                 _repository=None, ignore_fallbacks=False):
 
2056
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2057
                 ignore_fallbacks=False):
2315
2058
        """Create new branch object at a particular location."""
2316
2059
        if a_bzrdir is None:
2317
2060
            raise ValueError('a_bzrdir must be supplied')
2318
2061
        else:
2319
2062
            self.bzrdir = a_bzrdir
2320
2063
        self._base = self.bzrdir.transport.clone('..').base
2321
 
        self.name = name
2322
2064
        # XXX: We should be able to just do
2323
2065
        #   self.base = self.bzrdir.root_transport.base
2324
2066
        # but this does not quite work yet -- mbp 20080522
2331
2073
        Branch.__init__(self)
2332
2074
 
2333
2075
    def __str__(self):
2334
 
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
 
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
2076
        return '%s(%r)' % (self.__class__.__name__, self.base)
2339
2077
 
2340
2078
    __repr__ = __str__
2341
2079
 
2352
2090
        return self.control_files.is_locked()
2353
2091
 
2354
2092
    def lock_write(self, token=None):
2355
 
        """Lock the branch for write operations.
2356
 
 
2357
 
        :param token: A token to permit reacquiring a previously held and
2358
 
            preserved lock.
2359
 
        :return: A BranchWriteLockResult.
2360
 
        """
2361
 
        if not self.is_locked():
2362
 
            self._note_lock('w')
2363
2093
        # All-in-one needs to always unlock/lock.
2364
2094
        repo_control = getattr(self.repository, 'control_files', None)
2365
2095
        if self.control_files == repo_control or not self.is_locked():
2366
 
            self.repository._warn_if_deprecated(self)
2367
2096
            self.repository.lock_write()
2368
2097
            took_lock = True
2369
2098
        else:
2370
2099
            took_lock = False
2371
2100
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
2101
            return self.control_files.lock_write(token=token)
2374
2102
        except:
2375
2103
            if took_lock:
2376
2104
                self.repository.unlock()
2377
2105
            raise
2378
2106
 
2379
2107
    def lock_read(self):
2380
 
        """Lock the branch for read operations.
2381
 
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
2384
 
        """
2385
 
        if not self.is_locked():
2386
 
            self._note_lock('r')
2387
2108
        # All-in-one needs to always unlock/lock.
2388
2109
        repo_control = getattr(self.repository, 'control_files', None)
2389
2110
        if self.control_files == repo_control or not self.is_locked():
2390
 
            self.repository._warn_if_deprecated(self)
2391
2111
            self.repository.lock_read()
2392
2112
            took_lock = True
2393
2113
        else:
2394
2114
            took_lock = False
2395
2115
        try:
2396
2116
            self.control_files.lock_read()
2397
 
            return self
2398
2117
        except:
2399
2118
            if took_lock:
2400
2119
                self.repository.unlock()
2401
2120
            raise
2402
2121
 
2403
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2404
2122
    def unlock(self):
2405
2123
        try:
2406
2124
            self.control_files.unlock()
2569
2287
        return result
2570
2288
 
2571
2289
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2290
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2291
 
2574
2292
    def set_push_location(self, location):
2575
2293
        """See Branch.set_push_location."""
2765
2483
        if _mod_revision.is_null(last_revision):
2766
2484
            return
2767
2485
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2486
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2487
 
2770
2488
    def _gen_revision_history(self):
2771
2489
        """Generate the revision history from last revision
2871
2589
        if branch_location is None:
2872
2590
            return Branch.reference_parent(self, file_id, path,
2873
2591
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2592
        branch_location = urlutils.join(self.base, branch_location)
2875
2593
        return Branch.open(branch_location,
2876
2594
                           possible_transports=possible_transports)
2877
2595
 
2923
2641
        return stacked_url
2924
2642
 
2925
2643
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2644
        value = self.get_config().get_user_option('append_revisions_only')
 
2645
        return value == 'True'
2928
2646
 
2929
2647
    @needs_write_lock
2930
2648
    def generate_revision_history(self, revision_id, last_rev=None,
2992
2710
    """
2993
2711
 
2994
2712
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2713
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2714
 
2997
2715
 
2998
2716
######################################################################
3077
2795
 
3078
2796
    def __init__(self, branch):
3079
2797
        self.branch = branch
3080
 
        self.errors = []
 
2798
        self.ghosts_in_mainline = False
3081
2799
 
3082
2800
    def report_results(self, verbose):
3083
2801
        """Report the check results via trace.note.
3085
2803
        :param verbose: Requests more detailed display of what was checked,
3086
2804
            if any.
3087
2805
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
3089
 
            self.branch._format)
3090
 
        for error in self.errors:
3091
 
            note('found error:%s', error)
 
2806
        note('checked branch %s format %s',
 
2807
             self.branch.base,
 
2808
             self.branch._format)
 
2809
        if self.ghosts_in_mainline:
 
2810
            note('branch contains ghosts in mainline')
3092
2811
 
3093
2812
 
3094
2813
class Converter5to6(object):
3420
3139
        if local and not bound_location:
3421
3140
            raise errors.LocalRequiresBoundBranch()
3422
3141
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3142
        if not local and bound_location and self.source.base != bound_location:
3424
3143
            # not pulling from master, so we need to update master.
3425
3144
            master_branch = self.target.get_master_branch(possible_transports)
3426
3145
            master_branch.lock_write()