/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
64
 
65
65
 
66
 
# TODO: Maybe include checks for common corruption of newlines, etc?
67
 
 
68
 
# TODO: Some operations like log might retrieve the same revisions
69
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
70
 
# cache in memory to make this faster.  In general anything can be
71
 
# cached in memory between lock and unlock operations. .. nb thats
72
 
# what the transaction identity map provides
73
 
 
74
 
 
75
 
######################################################################
76
 
# branch objects
77
 
 
78
 
class Branch(object):
 
66
class Branch(bzrdir.ControlComponent):
79
67
    """Branch holding a history of revisions.
80
68
 
81
 
    base
82
 
        Base directory/url of the branch.
 
69
    :ivar base:
 
70
        Base directory/url of the branch; using control_url and
 
71
        control_transport is more standardized.
83
72
 
84
73
    hooks: An instance of BranchHooks.
85
74
    """
87
76
    # - RBC 20060112
88
77
    base = None
89
78
 
 
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
 
90
87
    def __init__(self, *ignored, **ignored_too):
91
88
        self.tags = self._format.make_tags(self)
92
89
        self._revision_history_cache = None
107
104
        """Activate the branch/repository from url as a fallback repository."""
108
105
        repo = self._get_fallback_repository(url)
109
106
        if repo.has_same_location(self.repository):
110
 
            raise errors.UnstackableLocationError(self.base, url)
 
107
            raise errors.UnstackableLocationError(self.user_url, url)
111
108
        self.repository.add_fallback_repository(repo)
112
109
 
113
110
    def break_lock(self):
167
164
        """
168
165
        control = bzrdir.BzrDir.open(base, _unsupported,
169
166
                                     possible_transports=possible_transports)
170
 
        return control.open_branch(_unsupported)
 
167
        return control.open_branch(unsupported=_unsupported)
171
168
 
172
169
    @staticmethod
173
 
    def open_from_transport(transport, _unsupported=False):
 
170
    def open_from_transport(transport, name=None, _unsupported=False):
174
171
        """Open the branch rooted at transport"""
175
172
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
 
        return control.open_branch(_unsupported)
 
173
        return control.open_branch(name=name, unsupported=_unsupported)
177
174
 
178
175
    @staticmethod
179
176
    def open_containing(url, possible_transports=None):
217
214
    def _get_fallback_repository(self, url):
218
215
        """Get the repository we fallback to at url."""
219
216
        url = urlutils.join(self.base, url)
220
 
        a_bzrdir = bzrdir.BzrDir.open(url,
 
217
        a_branch = Branch.open(url,
221
218
            possible_transports=[self.bzrdir.root_transport])
222
 
        return a_bzrdir.open_branch().repository
 
219
        return a_branch.repository
223
220
 
224
221
    def _get_tags_bytes(self):
225
222
        """Get the bytes of a serialised tags dict.
420
417
            * 'include' - the stop revision is the last item in the result
421
418
            * 'with-merges' - include the stop revision and all of its
422
419
              merged revisions in the result
 
420
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
421
              that are in both ancestries
423
422
        :param direction: either 'reverse' or 'forward':
424
423
            * reverse means return the start_revision_id first, i.e.
425
424
              start at the most recent revision and go backwards in history
447
446
        # start_revision_id.
448
447
        if self._merge_sorted_revisions_cache is None:
449
448
            last_revision = self.last_revision()
450
 
            last_key = (last_revision,)
451
 
            known_graph = self.repository.revisions.get_known_graph_ancestry(
452
 
                [last_key])
 
449
            known_graph = self.repository.get_known_graph_ancestry(
 
450
                [last_revision])
453
451
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
 
                last_key)
 
452
                last_revision)
455
453
        filtered = self._filter_merge_sorted_revisions(
456
454
            self._merge_sorted_revisions_cache, start_revision_id,
457
455
            stop_revision_id, stop_rule)
 
456
        # Make sure we don't return revisions that are not part of the
 
457
        # start_revision_id ancestry.
 
458
        filtered = self._filter_start_non_ancestors(filtered)
458
459
        if direction == 'reverse':
459
460
            return filtered
460
461
        if direction == 'forward':
497
498
                       node.end_of_merge)
498
499
                if rev_id == stop_revision_id:
499
500
                    return
 
501
        elif stop_rule == 'with-merges-without-common-ancestry':
 
502
            # We want to exclude all revisions that are already part of the
 
503
            # stop_revision_id ancestry.
 
504
            graph = self.repository.get_graph()
 
505
            ancestors = graph.find_unique_ancestors(start_revision_id,
 
506
                                                    [stop_revision_id])
 
507
            for node in rev_iter:
 
508
                rev_id = node.key[-1]
 
509
                if rev_id not in ancestors:
 
510
                    continue
 
511
                yield (rev_id, node.merge_depth, node.revno,
 
512
                       node.end_of_merge)
500
513
        elif stop_rule == 'with-merges':
501
514
            stop_rev = self.repository.get_revision(stop_revision_id)
502
515
            if stop_rev.parent_ids:
503
516
                left_parent = stop_rev.parent_ids[0]
504
517
            else:
505
518
                left_parent = _mod_revision.NULL_REVISION
 
519
            # left_parent is the actual revision we want to stop logging at,
 
520
            # since we want to show the merged revisions after the stop_rev too
 
521
            reached_stop_revision_id = False
 
522
            revision_id_whitelist = []
506
523
            for node in rev_iter:
507
524
                rev_id = node.key[-1]
508
525
                if rev_id == left_parent:
 
526
                    # reached the left parent after the stop_revision
509
527
                    return
510
 
                yield (rev_id, node.merge_depth, node.revno,
 
528
                if (not reached_stop_revision_id or
 
529
                        rev_id in revision_id_whitelist):
 
530
                    yield (rev_id, node.merge_depth, node.revno,
511
531
                       node.end_of_merge)
 
532
                    if reached_stop_revision_id or rev_id == stop_revision_id:
 
533
                        # only do the merged revs of rev_id from now on
 
534
                        rev = self.repository.get_revision(rev_id)
 
535
                        if rev.parent_ids:
 
536
                            reached_stop_revision_id = True
 
537
                            revision_id_whitelist.extend(rev.parent_ids)
512
538
        else:
513
539
            raise ValueError('invalid stop_rule %r' % stop_rule)
514
540
 
 
541
    def _filter_start_non_ancestors(self, rev_iter):
 
542
        # If we started from a dotted revno, we want to consider it as a tip
 
543
        # and don't want to yield revisions that are not part of its
 
544
        # ancestry. Given the order guaranteed by the merge sort, we will see
 
545
        # uninteresting descendants of the first parent of our tip before the
 
546
        # tip itself.
 
547
        first = rev_iter.next()
 
548
        (rev_id, merge_depth, revno, end_of_merge) = first
 
549
        yield first
 
550
        if not merge_depth:
 
551
            # We start at a mainline revision so by definition, all others
 
552
            # revisions in rev_iter are ancestors
 
553
            for node in rev_iter:
 
554
                yield node
 
555
 
 
556
        clean = False
 
557
        whitelist = set()
 
558
        pmap = self.repository.get_parent_map([rev_id])
 
559
        parents = pmap.get(rev_id, [])
 
560
        if parents:
 
561
            whitelist.update(parents)
 
562
        else:
 
563
            # If there is no parents, there is nothing of interest left
 
564
 
 
565
            # FIXME: It's hard to test this scenario here as this code is never
 
566
            # called in that case. -- vila 20100322
 
567
            return
 
568
 
 
569
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
 
570
            if not clean:
 
571
                if rev_id in whitelist:
 
572
                    pmap = self.repository.get_parent_map([rev_id])
 
573
                    parents = pmap.get(rev_id, [])
 
574
                    whitelist.remove(rev_id)
 
575
                    whitelist.update(parents)
 
576
                    if merge_depth == 0:
 
577
                        # We've reached the mainline, there is nothing left to
 
578
                        # filter
 
579
                        clean = True
 
580
                else:
 
581
                    # A revision that is not part of the ancestry of our
 
582
                    # starting revision.
 
583
                    continue
 
584
            yield (rev_id, merge_depth, revno, end_of_merge)
 
585
 
515
586
    def leave_lock_in_place(self):
516
587
        """Tell this branch object not to release the physical lock when this
517
588
        object is unlocked.
534
605
        :param other: The branch to bind to
535
606
        :type other: Branch
536
607
        """
537
 
        raise errors.UpgradeRequired(self.base)
 
608
        raise errors.UpgradeRequired(self.user_url)
538
609
 
539
610
    def set_append_revisions_only(self, enabled):
540
611
        if not self._format.supports_set_append_revisions_only():
541
 
            raise errors.UpgradeRequired(self.base)
 
612
            raise errors.UpgradeRequired(self.user_url)
542
613
        if enabled:
543
614
            value = 'True'
544
615
        else:
592
663
    def get_old_bound_location(self):
593
664
        """Return the URL of the branch we used to be bound to
594
665
        """
595
 
        raise errors.UpgradeRequired(self.base)
 
666
        raise errors.UpgradeRequired(self.user_url)
596
667
 
597
668
    def get_commit_builder(self, parents, config=None, timestamp=None,
598
669
                           timezone=None, committer=None, revprops=None,
676
747
            stacking.
677
748
        """
678
749
        if not self._format.supports_stacking():
679
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
750
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
680
751
        # XXX: Changing from one fallback repository to another does not check
681
752
        # that all the data you need is present in the new fallback.
682
753
        # Possibly it should.
833
904
 
834
905
    def unbind(self):
835
906
        """Older format branches cannot bind or unbind."""
836
 
        raise errors.UpgradeRequired(self.base)
 
907
        raise errors.UpgradeRequired(self.user_url)
837
908
 
838
909
    def last_revision(self):
839
910
        """Return last revision id, or NULL_REVISION."""
999
1070
        try:
1000
1071
            return urlutils.join(self.base[:-1], parent)
1001
1072
        except errors.InvalidURLJoin, e:
1002
 
            raise errors.InaccessibleParent(parent, self.base)
 
1073
            raise errors.InaccessibleParent(parent, self.user_url)
1003
1074
 
1004
1075
    def _get_parent_location(self):
1005
1076
        raise NotImplementedError(self._get_parent_location)
1090
1161
        params = ChangeBranchTipParams(
1091
1162
            self, old_revno, new_revno, old_revid, new_revid)
1092
1163
        for hook in hooks:
1093
 
            try:
1094
 
                hook(params)
1095
 
            except errors.TipChangeRejected:
1096
 
                raise
1097
 
            except Exception:
1098
 
                exc_info = sys.exc_info()
1099
 
                hook_name = Branch.hooks.get_hook_name(hook)
1100
 
                raise errors.HookFailed(
1101
 
                    'pre_change_branch_tip', hook_name, exc_info)
 
1164
            hook(params)
1102
1165
 
1103
1166
    @needs_write_lock
1104
1167
    def update(self):
1285
1348
        # clone call. Or something. 20090224 RBC/spiv.
1286
1349
        if revision_id is None:
1287
1350
            revision_id = self.last_revision()
1288
 
        try:
1289
 
            dir_to = self.bzrdir.clone_on_transport(to_transport,
1290
 
                revision_id=revision_id, stacked_on=stacked_on,
1291
 
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1292
 
        except errors.FileExists:
1293
 
            if not use_existing_dir:
1294
 
                raise
1295
 
        except errors.NoSuchFile:
1296
 
            if not create_prefix:
1297
 
                raise
 
1351
        dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1352
            revision_id=revision_id, stacked_on=stacked_on,
 
1353
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1298
1354
        return dir_to.open_branch()
1299
1355
 
1300
1356
    def create_checkout(self, to_location, revision_id=None,
1319
1375
        if lightweight:
1320
1376
            format = self._get_checkout_format()
1321
1377
            checkout = format.initialize_on_transport(t)
1322
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1378
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1379
                target_branch=self)
1323
1380
        else:
1324
1381
            format = self._get_checkout_format()
1325
1382
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1367
1424
    def supports_tags(self):
1368
1425
        return self._format.supports_tags()
1369
1426
 
 
1427
    def automatic_tag_name(self, revision_id):
 
1428
        """Try to automatically find the tag name for a revision.
 
1429
 
 
1430
        :param revision_id: Revision id of the revision.
 
1431
        :return: A tag name or None if no tag name could be determined.
 
1432
        """
 
1433
        for hook in Branch.hooks['automatic_tag_name']:
 
1434
            ret = hook(self, revision_id)
 
1435
            if ret is not None:
 
1436
                return ret
 
1437
        return None
 
1438
 
1370
1439
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1371
1440
                                         other_branch):
1372
1441
        """Ensure that revision_b is a descendant of revision_a.
1436
1505
        return not (self == other)
1437
1506
 
1438
1507
    @classmethod
1439
 
    def find_format(klass, a_bzrdir):
 
1508
    def find_format(klass, a_bzrdir, name=None):
1440
1509
        """Return the format for the branch object in a_bzrdir."""
1441
1510
        try:
1442
 
            transport = a_bzrdir.get_branch_transport(None)
1443
 
            format_string = transport.get("format").read()
 
1511
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1512
            format_string = transport.get_bytes("format")
1444
1513
            return klass._formats[format_string]
1445
1514
        except errors.NoSuchFile:
1446
 
            raise errors.NotBranchError(path=transport.base)
 
1515
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1447
1516
        except KeyError:
1448
1517
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1449
1518
 
1485
1554
        """Return the short format description for this format."""
1486
1555
        raise NotImplementedError(self.get_format_description)
1487
1556
 
1488
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1489
 
                           set_format=True):
 
1557
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1558
        hooks = Branch.hooks['post_branch_init']
 
1559
        if not hooks:
 
1560
            return
 
1561
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1562
        for hook in hooks:
 
1563
            hook(params)
 
1564
 
 
1565
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1566
                           lock_type='metadir', set_format=True):
1490
1567
        """Initialize a branch in a bzrdir, with specified files
1491
1568
 
1492
1569
        :param a_bzrdir: The bzrdir to initialize the branch in
1493
1570
        :param utf8_files: The files to create as a list of
1494
1571
            (filename, content) tuples
 
1572
        :param name: Name of colocated branch to create, if any
1495
1573
        :param set_format: If True, set the format with
1496
1574
            self.get_format_string.  (BzrBranch4 has its format set
1497
1575
            elsewhere)
1498
1576
        :return: a branch in this format
1499
1577
        """
1500
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1501
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1578
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1579
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1502
1580
        lock_map = {
1503
1581
            'metadir': ('lock', lockdir.LockDir),
1504
1582
            'branch4': ('branch-lock', lockable_files.TransportLock),
1525
1603
        finally:
1526
1604
            if lock_taken:
1527
1605
                control_files.unlock()
1528
 
        return self.open(a_bzrdir, _found=True)
 
1606
        branch = self.open(a_bzrdir, name, _found=True)
 
1607
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1608
        return branch
1529
1609
 
1530
 
    def initialize(self, a_bzrdir):
1531
 
        """Create a branch of this format in a_bzrdir."""
 
1610
    def initialize(self, a_bzrdir, name=None):
 
1611
        """Create a branch of this format in a_bzrdir.
 
1612
        
 
1613
        :param name: Name of the colocated branch to create.
 
1614
        """
1532
1615
        raise NotImplementedError(self.initialize)
1533
1616
 
1534
1617
    def is_supported(self):
1564
1647
        """
1565
1648
        raise NotImplementedError(self.network_name)
1566
1649
 
1567
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1650
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1568
1651
        """Return the branch object for a_bzrdir
1569
1652
 
1570
1653
        :param a_bzrdir: A BzrDir that contains a branch.
 
1654
        :param name: Name of colocated branch to open
1571
1655
        :param _found: a private parameter, do not use it. It is used to
1572
1656
            indicate if format probing has already be done.
1573
1657
        :param ignore_fallbacks: when set, no fallback branches will be opened
1681
1765
            "multiple hooks installed for transform_fallback_location, "
1682
1766
            "all are called with the url returned from the previous hook."
1683
1767
            "The order is however undefined.", (1, 9), None))
 
1768
        self.create_hook(HookPoint('automatic_tag_name',
 
1769
            "Called to determine an automatic tag name for a revision."
 
1770
            "automatic_tag_name is called with (branch, revision_id) and "
 
1771
            "should return a tag name or None if no tag name could be "
 
1772
            "determined. The first non-None tag name returned will be used.",
 
1773
            (2, 2), None))
 
1774
        self.create_hook(HookPoint('post_branch_init',
 
1775
            "Called after new branch initialization completes. "
 
1776
            "post_branch_init is called with a "
 
1777
            "bzrlib.branch.BranchInitHookParams. "
 
1778
            "Note that init, branch and checkout (both heavyweight and "
 
1779
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1780
        self.create_hook(HookPoint('post_switch',
 
1781
            "Called after a checkout switches branch. "
 
1782
            "post_switch is called with a "
 
1783
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1784
 
1684
1785
 
1685
1786
 
1686
1787
# install the default hooks into the Branch class.
1725
1826
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1726
1827
 
1727
1828
 
 
1829
class BranchInitHookParams(object):
 
1830
    """Object holding parameters passed to *_branch_init hooks.
 
1831
 
 
1832
    There are 4 fields that hooks may wish to access:
 
1833
 
 
1834
    :ivar format: the branch format
 
1835
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1836
    :ivar name: name of colocated branch, if any (or None)
 
1837
    :ivar branch: the branch created
 
1838
 
 
1839
    Note that for lightweight checkouts, the bzrdir and format fields refer to
 
1840
    the checkout, hence they are different from the corresponding fields in
 
1841
    branch, which refer to the original branch.
 
1842
    """
 
1843
 
 
1844
    def __init__(self, format, a_bzrdir, name, branch):
 
1845
        """Create a group of BranchInitHook parameters.
 
1846
 
 
1847
        :param format: the branch format
 
1848
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1849
            initialized
 
1850
        :param name: name of colocated branch, if any (or None)
 
1851
        :param branch: the branch created
 
1852
 
 
1853
        Note that for lightweight checkouts, the bzrdir and format fields refer
 
1854
        to the checkout, hence they are different from the corresponding fields
 
1855
        in branch, which refer to the original branch.
 
1856
        """
 
1857
        self.format = format
 
1858
        self.bzrdir = a_bzrdir
 
1859
        self.name = name
 
1860
        self.branch = branch
 
1861
 
 
1862
    def __eq__(self, other):
 
1863
        return self.__dict__ == other.__dict__
 
1864
 
 
1865
    def __repr__(self):
 
1866
        if self.branch:
 
1867
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1868
        else:
 
1869
            return "<%s of format:%s bzrdir:%s>" % (
 
1870
                self.__class__.__name__, self.branch,
 
1871
                self.format, self.bzrdir)
 
1872
 
 
1873
 
 
1874
class SwitchHookParams(object):
 
1875
    """Object holding parameters passed to *_switch hooks.
 
1876
 
 
1877
    There are 4 fields that hooks may wish to access:
 
1878
 
 
1879
    :ivar control_dir: BzrDir of the checkout to change
 
1880
    :ivar to_branch: branch that the checkout is to reference
 
1881
    :ivar force: skip the check for local commits in a heavy checkout
 
1882
    :ivar revision_id: revision ID to switch to (or None)
 
1883
    """
 
1884
 
 
1885
    def __init__(self, control_dir, to_branch, force, revision_id):
 
1886
        """Create a group of SwitchHook parameters.
 
1887
 
 
1888
        :param control_dir: BzrDir of the checkout to change
 
1889
        :param to_branch: branch that the checkout is to reference
 
1890
        :param force: skip the check for local commits in a heavy checkout
 
1891
        :param revision_id: revision ID to switch to (or None)
 
1892
        """
 
1893
        self.control_dir = control_dir
 
1894
        self.to_branch = to_branch
 
1895
        self.force = force
 
1896
        self.revision_id = revision_id
 
1897
 
 
1898
    def __eq__(self, other):
 
1899
        return self.__dict__ == other.__dict__
 
1900
 
 
1901
    def __repr__(self):
 
1902
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
 
1903
            self.control_dir, self.to_branch,
 
1904
            self.revision_id)
 
1905
 
 
1906
 
1728
1907
class BzrBranchFormat4(BranchFormat):
1729
1908
    """Bzr branch format 4.
1730
1909
 
1737
1916
        """See BranchFormat.get_format_description()."""
1738
1917
        return "Branch format 4"
1739
1918
 
1740
 
    def initialize(self, a_bzrdir):
 
1919
    def initialize(self, a_bzrdir, name=None):
1741
1920
        """Create a branch of this format in a_bzrdir."""
1742
1921
        utf8_files = [('revision-history', ''),
1743
1922
                      ('branch-name', ''),
1744
1923
                      ]
1745
 
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1924
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1746
1925
                                       lock_type='branch4', set_format=False)
1747
1926
 
1748
1927
    def __init__(self):
1753
1932
        """The network name for this format is the control dirs disk label."""
1754
1933
        return self._matchingbzrdir.get_format_string()
1755
1934
 
1756
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1935
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1757
1936
        """See BranchFormat.open()."""
1758
1937
        if not _found:
1759
1938
            # we are being called directly and must probe.
1761
1940
        return BzrBranch(_format=self,
1762
1941
                         _control_files=a_bzrdir._control_files,
1763
1942
                         a_bzrdir=a_bzrdir,
 
1943
                         name=name,
1764
1944
                         _repository=a_bzrdir.open_repository())
1765
1945
 
1766
1946
    def __str__(self):
1781
1961
        """
1782
1962
        return self.get_format_string()
1783
1963
 
1784
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1964
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1785
1965
        """See BranchFormat.open()."""
1786
1966
        if not _found:
1787
 
            format = BranchFormat.find_format(a_bzrdir)
 
1967
            format = BranchFormat.find_format(a_bzrdir, name=name)
1788
1968
            if format.__class__ != self.__class__:
1789
1969
                raise AssertionError("wrong format %r found for %r" %
1790
1970
                    (format, self))
 
1971
        transport = a_bzrdir.get_branch_transport(None, name=name)
1791
1972
        try:
1792
 
            transport = a_bzrdir.get_branch_transport(None)
1793
1973
            control_files = lockable_files.LockableFiles(transport, 'lock',
1794
1974
                                                         lockdir.LockDir)
1795
1975
            return self._branch_class()(_format=self,
1796
1976
                              _control_files=control_files,
 
1977
                              name=name,
1797
1978
                              a_bzrdir=a_bzrdir,
1798
1979
                              _repository=a_bzrdir.find_repository(),
1799
1980
                              ignore_fallbacks=ignore_fallbacks)
1800
1981
        except errors.NoSuchFile:
1801
 
            raise errors.NotBranchError(path=transport.base)
 
1982
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1802
1983
 
1803
1984
    def __init__(self):
1804
1985
        super(BranchFormatMetadir, self).__init__()
1833
2014
        """See BranchFormat.get_format_description()."""
1834
2015
        return "Branch format 5"
1835
2016
 
1836
 
    def initialize(self, a_bzrdir):
 
2017
    def initialize(self, a_bzrdir, name=None):
1837
2018
        """Create a branch of this format in a_bzrdir."""
1838
2019
        utf8_files = [('revision-history', ''),
1839
2020
                      ('branch-name', ''),
1840
2021
                      ]
1841
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2022
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1842
2023
 
1843
2024
    def supports_tags(self):
1844
2025
        return False
1866
2047
        """See BranchFormat.get_format_description()."""
1867
2048
        return "Branch format 6"
1868
2049
 
1869
 
    def initialize(self, a_bzrdir):
 
2050
    def initialize(self, a_bzrdir, name=None):
1870
2051
        """Create a branch of this format in a_bzrdir."""
1871
2052
        utf8_files = [('last-revision', '0 null:\n'),
1872
2053
                      ('branch.conf', ''),
1873
2054
                      ('tags', ''),
1874
2055
                      ]
1875
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2056
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1876
2057
 
1877
2058
    def make_tags(self, branch):
1878
2059
        """See bzrlib.branch.BranchFormat.make_tags()."""
1896
2077
        """See BranchFormat.get_format_description()."""
1897
2078
        return "Branch format 8"
1898
2079
 
1899
 
    def initialize(self, a_bzrdir):
 
2080
    def initialize(self, a_bzrdir, name=None):
1900
2081
        """Create a branch of this format in a_bzrdir."""
1901
2082
        utf8_files = [('last-revision', '0 null:\n'),
1902
2083
                      ('branch.conf', ''),
1903
2084
                      ('tags', ''),
1904
2085
                      ('references', '')
1905
2086
                      ]
1906
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2087
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1907
2088
 
1908
2089
    def __init__(self):
1909
2090
        super(BzrBranchFormat8, self).__init__()
1932
2113
    This format was introduced in bzr 1.6.
1933
2114
    """
1934
2115
 
1935
 
    def initialize(self, a_bzrdir):
 
2116
    def initialize(self, a_bzrdir, name=None):
1936
2117
        """Create a branch of this format in a_bzrdir."""
1937
2118
        utf8_files = [('last-revision', '0 null:\n'),
1938
2119
                      ('branch.conf', ''),
1939
2120
                      ('tags', ''),
1940
2121
                      ]
1941
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1942
2123
 
1943
2124
    def _branch_class(self):
1944
2125
        return BzrBranch7
1979
2160
    def get_reference(self, a_bzrdir):
1980
2161
        """See BranchFormat.get_reference()."""
1981
2162
        transport = a_bzrdir.get_branch_transport(None)
1982
 
        return transport.get('location').read()
 
2163
        return transport.get_bytes('location')
1983
2164
 
1984
2165
    def set_reference(self, a_bzrdir, to_branch):
1985
2166
        """See BranchFormat.set_reference()."""
1986
2167
        transport = a_bzrdir.get_branch_transport(None)
1987
2168
        location = transport.put_bytes('location', to_branch.base)
1988
2169
 
1989
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2170
    def initialize(self, a_bzrdir, name=None, target_branch=None):
1990
2171
        """Create a branch of this format in a_bzrdir."""
1991
2172
        if target_branch is None:
1992
2173
            # this format does not implement branch itself, thus the implicit
1993
2174
            # creation contract must see it as uninitializable
1994
2175
            raise errors.UninitializableFormat(self)
1995
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1996
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2176
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2177
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1997
2178
        branch_transport.put_bytes('location',
1998
 
            target_branch.bzrdir.root_transport.base)
 
2179
            target_branch.bzrdir.user_url)
1999
2180
        branch_transport.put_bytes('format', self.get_format_string())
2000
 
        return self.open(
2001
 
            a_bzrdir, _found=True,
 
2181
        branch = self.open(
 
2182
            a_bzrdir, name, _found=True,
2002
2183
            possible_transports=[target_branch.bzrdir.root_transport])
 
2184
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2185
        return branch
2003
2186
 
2004
2187
    def __init__(self):
2005
2188
        super(BranchReferenceFormat, self).__init__()
2011
2194
        def clone(to_bzrdir, revision_id=None,
2012
2195
            repository_policy=None):
2013
2196
            """See Branch.clone()."""
2014
 
            return format.initialize(to_bzrdir, a_branch)
 
2197
            return format.initialize(to_bzrdir, target_branch=a_branch)
2015
2198
            # cannot obey revision_id limits when cloning a reference ...
2016
2199
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2017
2200
            # emit some sort of warning/error to the caller ?!
2018
2201
        return clone
2019
2202
 
2020
 
    def open(self, a_bzrdir, _found=False, location=None,
 
2203
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2021
2204
             possible_transports=None, ignore_fallbacks=False):
2022
2205
        """Return the branch that the branch reference in a_bzrdir points at.
2023
2206
 
2024
2207
        :param a_bzrdir: A BzrDir that contains a branch.
 
2208
        :param name: Name of colocated branch to open, if any
2025
2209
        :param _found: a private parameter, do not use it. It is used to
2026
2210
            indicate if format probing has already be done.
2027
2211
        :param ignore_fallbacks: when set, no fallback branches will be opened
2032
2216
        :param possible_transports: An optional reusable transports list.
2033
2217
        """
2034
2218
        if not _found:
2035
 
            format = BranchFormat.find_format(a_bzrdir)
 
2219
            format = BranchFormat.find_format(a_bzrdir, name=name)
2036
2220
            if format.__class__ != self.__class__:
2037
2221
                raise AssertionError("wrong format %r found for %r" %
2038
2222
                    (format, self))
2040
2224
            location = self.get_reference(a_bzrdir)
2041
2225
        real_bzrdir = bzrdir.BzrDir.open(
2042
2226
            location, possible_transports=possible_transports)
2043
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2227
        result = real_bzrdir.open_branch(name=name, 
 
2228
            ignore_fallbacks=ignore_fallbacks)
2044
2229
        # this changes the behaviour of result.clone to create a new reference
2045
2230
        # rather than a copy of the content of the branch.
2046
2231
        # I did not use a proxy object because that needs much more extensive
2092
2277
    :ivar repository: Repository for this branch.
2093
2278
    :ivar base: The url of the base directory for this branch; the one
2094
2279
        containing the .bzr directory.
 
2280
    :ivar name: Optional colocated branch name as it exists in the control
 
2281
        directory.
2095
2282
    """
2096
2283
 
2097
2284
    def __init__(self, _format=None,
2098
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2099
 
                 ignore_fallbacks=False):
 
2285
                 _control_files=None, a_bzrdir=None, name=None,
 
2286
                 _repository=None, ignore_fallbacks=False):
2100
2287
        """Create new branch object at a particular location."""
2101
2288
        if a_bzrdir is None:
2102
2289
            raise ValueError('a_bzrdir must be supplied')
2103
2290
        else:
2104
2291
            self.bzrdir = a_bzrdir
2105
2292
        self._base = self.bzrdir.transport.clone('..').base
 
2293
        self.name = name
2106
2294
        # XXX: We should be able to just do
2107
2295
        #   self.base = self.bzrdir.root_transport.base
2108
2296
        # but this does not quite work yet -- mbp 20080522
2115
2303
        Branch.__init__(self)
2116
2304
 
2117
2305
    def __str__(self):
2118
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2306
        if self.name is None:
 
2307
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2308
        else:
 
2309
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
 
2310
                self.name)
2119
2311
 
2120
2312
    __repr__ = __str__
2121
2313
 
2137
2329
        # All-in-one needs to always unlock/lock.
2138
2330
        repo_control = getattr(self.repository, 'control_files', None)
2139
2331
        if self.control_files == repo_control or not self.is_locked():
 
2332
            self.repository._warn_if_deprecated(self)
2140
2333
            self.repository.lock_write()
2141
2334
            took_lock = True
2142
2335
        else:
2154
2347
        # All-in-one needs to always unlock/lock.
2155
2348
        repo_control = getattr(self.repository, 'control_files', None)
2156
2349
        if self.control_files == repo_control or not self.is_locked():
 
2350
            self.repository._warn_if_deprecated(self)
2157
2351
            self.repository.lock_read()
2158
2352
            took_lock = True
2159
2353
        else:
2334
2528
        return result
2335
2529
 
2336
2530
    def get_stacked_on_url(self):
2337
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2531
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2338
2532
 
2339
2533
    def set_push_location(self, location):
2340
2534
        """See Branch.set_push_location."""
2530
2724
        if _mod_revision.is_null(last_revision):
2531
2725
            return
2532
2726
        if last_revision not in self._lefthand_history(revision_id):
2533
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2727
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2534
2728
 
2535
2729
    def _gen_revision_history(self):
2536
2730
        """Generate the revision history from last revision
2636
2830
        if branch_location is None:
2637
2831
            return Branch.reference_parent(self, file_id, path,
2638
2832
                                           possible_transports)
2639
 
        branch_location = urlutils.join(self.base, branch_location)
 
2833
        branch_location = urlutils.join(self.user_url, branch_location)
2640
2834
        return Branch.open(branch_location,
2641
2835
                           possible_transports=possible_transports)
2642
2836
 
2688
2882
        return stacked_url
2689
2883
 
2690
2884
    def _get_append_revisions_only(self):
2691
 
        value = self.get_config().get_user_option('append_revisions_only')
2692
 
        return value == 'True'
 
2885
        return self.get_config(
 
2886
            ).get_user_option_as_bool('append_revisions_only')
2693
2887
 
2694
2888
    @needs_write_lock
2695
2889
    def generate_revision_history(self, revision_id, last_rev=None,
2757
2951
    """
2758
2952
 
2759
2953
    def get_stacked_on_url(self):
2760
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2954
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2761
2955
 
2762
2956
 
2763
2957
######################################################################
2850
3044
        :param verbose: Requests more detailed display of what was checked,
2851
3045
            if any.
2852
3046
        """
2853
 
        note('checked branch %s format %s', self.branch.base,
 
3047
        note('checked branch %s format %s', self.branch.user_url,
2854
3048
            self.branch._format)
2855
3049
        for error in self.errors:
2856
3050
            note('found error:%s', error)
3185
3379
        if local and not bound_location:
3186
3380
            raise errors.LocalRequiresBoundBranch()
3187
3381
        master_branch = None
3188
 
        if not local and bound_location and self.source.base != bound_location:
 
3382
        if not local and bound_location and self.source.user_url != bound_location:
3189
3383
            # not pulling from master, so we need to update master.
3190
3384
            master_branch = self.target.get_master_branch(possible_transports)
3191
3385
            master_branch.lock_write()