/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: Vincent Ladeuil
  • Date: 2009-12-23 16:02:27 UTC
  • mto: (4597.3.46 description)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20091223160227-g74kl2zokg92zsmk
doc/es/user-guide/resolving_conflicts.txt is really the translation of
bzrlib/help-topics/en/conflicts.txt.

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
49
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
53
53
from bzrlib import registry
54
54
from bzrlib.symbol_versioning import (
55
55
    deprecated_in,
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
64
 
65
65
 
66
 
class Branch(bzrdir.ControlComponent):
 
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):
67
79
    """Branch holding a history of revisions.
68
80
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
81
    base
 
82
        Base directory/url of the branch.
72
83
 
73
84
    hooks: An instance of BranchHooks.
74
85
    """
76
87
    # - RBC 20060112
77
88
    base = None
78
89
 
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
90
    def __init__(self, *ignored, **ignored_too):
88
91
        self.tags = self._format.make_tags(self)
89
92
        self._revision_history_cache = None
104
107
        """Activate the branch/repository from url as a fallback repository."""
105
108
        repo = self._get_fallback_repository(url)
106
109
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
164
167
        """
165
168
        control = bzrdir.BzrDir.open(base, _unsupported,
166
169
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
170
        return control.open_branch(_unsupported)
168
171
 
169
172
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
173
    def open_from_transport(transport, _unsupported=False):
171
174
        """Open the branch rooted at transport"""
172
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
176
        return control.open_branch(_unsupported)
174
177
 
175
178
    @staticmethod
176
179
    def open_containing(url, possible_transports=None):
214
217
    def _get_fallback_repository(self, url):
215
218
        """Get the repository we fallback to at url."""
216
219
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
218
221
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
222
        return a_bzrdir.open_branch().repository
220
223
 
221
224
    def _get_tags_bytes(self):
222
225
        """Get the bytes of a serialised tags dict.
283
286
        new_history.reverse()
284
287
        return new_history
285
288
 
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
 
        """
 
289
    def lock_write(self):
293
290
        raise NotImplementedError(self.lock_write)
294
291
 
295
292
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
293
        raise NotImplementedError(self.lock_read)
301
294
 
302
295
    def unlock(self):
427
420
            * 'include' - the stop revision is the last item in the result
428
421
            * 'with-merges' - include the stop revision and all of its
429
422
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
423
        :param direction: either 'reverse' or 'forward':
433
424
            * reverse means return the start_revision_id first, i.e.
434
425
              start at the most recent revision and go backwards in history
456
447
        # start_revision_id.
457
448
        if self._merge_sorted_revisions_cache is None:
458
449
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
461
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                last_revision)
 
454
                last_key)
463
455
        filtered = self._filter_merge_sorted_revisions(
464
456
            self._merge_sorted_revisions_cache, start_revision_id,
465
457
            stop_revision_id, stop_rule)
466
 
        # Make sure we don't return revisions that are not part of the
467
 
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
469
458
        if direction == 'reverse':
470
459
            return filtered
471
460
        if direction == 'forward':
508
497
                       node.end_of_merge)
509
498
                if rev_id == stop_revision_id:
510
499
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
500
        elif stop_rule == 'with-merges':
524
501
            stop_rev = self.repository.get_revision(stop_revision_id)
525
502
            if stop_rev.parent_ids:
548
525
        else:
549
526
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
527
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
552
 
        # If we started from a dotted revno, we want to consider it as a tip
553
 
        # and don't want to yield revisions that are not part of its
554
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
 
        # uninteresting descendants of the first parent of our tip before the
556
 
        # tip itself.
557
 
        first = rev_iter.next()
558
 
        (rev_id, merge_depth, revno, end_of_merge) = first
559
 
        yield first
560
 
        if not merge_depth:
561
 
            # We start at a mainline revision so by definition, all others
562
 
            # revisions in rev_iter are ancestors
563
 
            for node in rev_iter:
564
 
                yield node
565
 
 
566
 
        clean = False
567
 
        whitelist = set()
568
 
        pmap = self.repository.get_parent_map([rev_id])
569
 
        parents = pmap.get(rev_id, [])
570
 
        if parents:
571
 
            whitelist.update(parents)
572
 
        else:
573
 
            # If there is no parents, there is nothing of interest left
574
 
 
575
 
            # FIXME: It's hard to test this scenario here as this code is never
576
 
            # called in that case. -- vila 20100322
577
 
            return
578
 
 
579
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
580
 
            if not clean:
581
 
                if rev_id in whitelist:
582
 
                    pmap = self.repository.get_parent_map([rev_id])
583
 
                    parents = pmap.get(rev_id, [])
584
 
                    whitelist.remove(rev_id)
585
 
                    whitelist.update(parents)
586
 
                    if merge_depth == 0:
587
 
                        # We've reached the mainline, there is nothing left to
588
 
                        # filter
589
 
                        clean = True
590
 
                else:
591
 
                    # A revision that is not part of the ancestry of our
592
 
                    # starting revision.
593
 
                    continue
594
 
            yield (rev_id, merge_depth, revno, end_of_merge)
595
 
 
596
528
    def leave_lock_in_place(self):
597
529
        """Tell this branch object not to release the physical lock when this
598
530
        object is unlocked.
615
547
        :param other: The branch to bind to
616
548
        :type other: Branch
617
549
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
 
550
        raise errors.UpgradeRequired(self.base)
619
551
 
620
552
    def set_append_revisions_only(self, enabled):
621
553
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
 
554
            raise errors.UpgradeRequired(self.base)
623
555
        if enabled:
624
556
            value = 'True'
625
557
        else:
673
605
    def get_old_bound_location(self):
674
606
        """Return the URL of the branch we used to be bound to
675
607
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
608
        raise errors.UpgradeRequired(self.base)
677
609
 
678
610
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
611
                           timezone=None, committer=None, revprops=None,
757
689
            stacking.
758
690
        """
759
691
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
692
            raise errors.UnstackableBranchFormat(self._format, self.base)
761
693
        # XXX: Changing from one fallback repository to another does not check
762
694
        # that all the data you need is present in the new fallback.
763
695
        # Possibly it should.
914
846
 
915
847
    def unbind(self):
916
848
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
849
        raise errors.UpgradeRequired(self.base)
918
850
 
919
851
    def last_revision(self):
920
852
        """Return last revision id, or NULL_REVISION."""
1080
1012
        try:
1081
1013
            return urlutils.join(self.base[:-1], parent)
1082
1014
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1015
            raise errors.InaccessibleParent(parent, self.base)
1084
1016
 
1085
1017
    def _get_parent_location(self):
1086
1018
        raise NotImplementedError(self._get_parent_location)
1171
1103
        params = ChangeBranchTipParams(
1172
1104
            self, old_revno, new_revno, old_revid, new_revid)
1173
1105
        for hook in hooks:
1174
 
            hook(params)
 
1106
            try:
 
1107
                hook(params)
 
1108
            except errors.TipChangeRejected:
 
1109
                raise
 
1110
            except Exception:
 
1111
                exc_info = sys.exc_info()
 
1112
                hook_name = Branch.hooks.get_hook_name(hook)
 
1113
                raise errors.HookFailed(
 
1114
                    'pre_change_branch_tip', hook_name, exc_info)
1175
1115
 
1176
1116
    @needs_write_lock
1177
1117
    def update(self):
1385
1325
        if lightweight:
1386
1326
            format = self._get_checkout_format()
1387
1327
            checkout = format.initialize_on_transport(t)
1388
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1389
 
                target_branch=self)
 
1328
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1390
1329
        else:
1391
1330
            format = self._get_checkout_format()
1392
1331
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1434
1373
    def supports_tags(self):
1435
1374
        return self._format.supports_tags()
1436
1375
 
1437
 
    def automatic_tag_name(self, revision_id):
1438
 
        """Try to automatically find the tag name for a revision.
1439
 
 
1440
 
        :param revision_id: Revision id of the revision.
1441
 
        :return: A tag name or None if no tag name could be determined.
1442
 
        """
1443
 
        for hook in Branch.hooks['automatic_tag_name']:
1444
 
            ret = hook(self, revision_id)
1445
 
            if ret is not None:
1446
 
                return ret
1447
 
        return None
1448
 
 
1449
1376
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1450
1377
                                         other_branch):
1451
1378
        """Ensure that revision_b is a descendant of revision_a.
1515
1442
        return not (self == other)
1516
1443
 
1517
1444
    @classmethod
1518
 
    def find_format(klass, a_bzrdir, name=None):
 
1445
    def find_format(klass, a_bzrdir):
1519
1446
        """Return the format for the branch object in a_bzrdir."""
1520
1447
        try:
1521
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1448
            transport = a_bzrdir.get_branch_transport(None)
1522
1449
            format_string = transport.get_bytes("format")
1523
1450
            return klass._formats[format_string]
1524
1451
        except errors.NoSuchFile:
1525
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1452
            raise errors.NotBranchError(path=transport.base)
1526
1453
        except KeyError:
1527
1454
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1528
1455
 
1564
1491
        """Return the short format description for this format."""
1565
1492
        raise NotImplementedError(self.get_format_description)
1566
1493
 
1567
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
 
        hooks = Branch.hooks['post_branch_init']
1569
 
        if not hooks:
1570
 
            return
1571
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1572
 
        for hook in hooks:
1573
 
            hook(params)
1574
 
 
1575
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
 
                           lock_type='metadir', set_format=True):
 
1494
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1495
                           set_format=True):
1577
1496
        """Initialize a branch in a bzrdir, with specified files
1578
1497
 
1579
1498
        :param a_bzrdir: The bzrdir to initialize the branch in
1580
1499
        :param utf8_files: The files to create as a list of
1581
1500
            (filename, content) tuples
1582
 
        :param name: Name of colocated branch to create, if any
1583
1501
        :param set_format: If True, set the format with
1584
1502
            self.get_format_string.  (BzrBranch4 has its format set
1585
1503
            elsewhere)
1586
1504
        :return: a branch in this format
1587
1505
        """
1588
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1589
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1506
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1507
        branch_transport = a_bzrdir.get_branch_transport(self)
1590
1508
        lock_map = {
1591
1509
            'metadir': ('lock', lockdir.LockDir),
1592
1510
            'branch4': ('branch-lock', lockable_files.TransportLock),
1613
1531
        finally:
1614
1532
            if lock_taken:
1615
1533
                control_files.unlock()
1616
 
        branch = self.open(a_bzrdir, name, _found=True)
1617
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1618
 
        return branch
 
1534
        return self.open(a_bzrdir, _found=True)
1619
1535
 
1620
 
    def initialize(self, a_bzrdir, name=None):
1621
 
        """Create a branch of this format in a_bzrdir.
1622
 
        
1623
 
        :param name: Name of the colocated branch to create.
1624
 
        """
 
1536
    def initialize(self, a_bzrdir):
 
1537
        """Create a branch of this format in a_bzrdir."""
1625
1538
        raise NotImplementedError(self.initialize)
1626
1539
 
1627
1540
    def is_supported(self):
1657
1570
        """
1658
1571
        raise NotImplementedError(self.network_name)
1659
1572
 
1660
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1573
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1661
1574
        """Return the branch object for a_bzrdir
1662
1575
 
1663
1576
        :param a_bzrdir: A BzrDir that contains a branch.
1664
 
        :param name: Name of colocated branch to open
1665
1577
        :param _found: a private parameter, do not use it. It is used to
1666
1578
            indicate if format probing has already be done.
1667
1579
        :param ignore_fallbacks: when set, no fallback branches will be opened
1775
1687
            "multiple hooks installed for transform_fallback_location, "
1776
1688
            "all are called with the url returned from the previous hook."
1777
1689
            "The order is however undefined.", (1, 9), None))
1778
 
        self.create_hook(HookPoint('automatic_tag_name',
1779
 
            "Called to determine an automatic tag name for a revision."
1780
 
            "automatic_tag_name is called with (branch, revision_id) and "
1781
 
            "should return a tag name or None if no tag name could be "
1782
 
            "determined. The first non-None tag name returned will be used.",
1783
 
            (2, 2), None))
1784
 
        self.create_hook(HookPoint('post_branch_init',
1785
 
            "Called after new branch initialization completes. "
1786
 
            "post_branch_init is called with a "
1787
 
            "bzrlib.branch.BranchInitHookParams. "
1788
 
            "Note that init, branch and checkout (both heavyweight and "
1789
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1790
 
        self.create_hook(HookPoint('post_switch',
1791
 
            "Called after a checkout switches branch. "
1792
 
            "post_switch is called with a "
1793
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1794
 
 
1795
1690
 
1796
1691
 
1797
1692
# install the default hooks into the Branch class.
1836
1731
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1837
1732
 
1838
1733
 
1839
 
class BranchInitHookParams(object):
1840
 
    """Object holding parameters passed to *_branch_init hooks.
1841
 
 
1842
 
    There are 4 fields that hooks may wish to access:
1843
 
 
1844
 
    :ivar format: the branch format
1845
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
 
    :ivar name: name of colocated branch, if any (or None)
1847
 
    :ivar branch: the branch created
1848
 
 
1849
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
 
    the checkout, hence they are different from the corresponding fields in
1851
 
    branch, which refer to the original branch.
1852
 
    """
1853
 
 
1854
 
    def __init__(self, format, a_bzrdir, name, branch):
1855
 
        """Create a group of BranchInitHook parameters.
1856
 
 
1857
 
        :param format: the branch format
1858
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1859
 
            initialized
1860
 
        :param name: name of colocated branch, if any (or None)
1861
 
        :param branch: the branch created
1862
 
 
1863
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1864
 
        to the checkout, hence they are different from the corresponding fields
1865
 
        in branch, which refer to the original branch.
1866
 
        """
1867
 
        self.format = format
1868
 
        self.bzrdir = a_bzrdir
1869
 
        self.name = name
1870
 
        self.branch = branch
1871
 
 
1872
 
    def __eq__(self, other):
1873
 
        return self.__dict__ == other.__dict__
1874
 
 
1875
 
    def __repr__(self):
1876
 
        if self.branch:
1877
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1878
 
        else:
1879
 
            return "<%s of format:%s bzrdir:%s>" % (
1880
 
                self.__class__.__name__, self.branch,
1881
 
                self.format, self.bzrdir)
1882
 
 
1883
 
 
1884
 
class SwitchHookParams(object):
1885
 
    """Object holding parameters passed to *_switch hooks.
1886
 
 
1887
 
    There are 4 fields that hooks may wish to access:
1888
 
 
1889
 
    :ivar control_dir: BzrDir of the checkout to change
1890
 
    :ivar to_branch: branch that the checkout is to reference
1891
 
    :ivar force: skip the check for local commits in a heavy checkout
1892
 
    :ivar revision_id: revision ID to switch to (or None)
1893
 
    """
1894
 
 
1895
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1896
 
        """Create a group of SwitchHook parameters.
1897
 
 
1898
 
        :param control_dir: BzrDir of the checkout to change
1899
 
        :param to_branch: branch that the checkout is to reference
1900
 
        :param force: skip the check for local commits in a heavy checkout
1901
 
        :param revision_id: revision ID to switch to (or None)
1902
 
        """
1903
 
        self.control_dir = control_dir
1904
 
        self.to_branch = to_branch
1905
 
        self.force = force
1906
 
        self.revision_id = revision_id
1907
 
 
1908
 
    def __eq__(self, other):
1909
 
        return self.__dict__ == other.__dict__
1910
 
 
1911
 
    def __repr__(self):
1912
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
 
            self.control_dir, self.to_branch,
1914
 
            self.revision_id)
1915
 
 
1916
 
 
1917
1734
class BzrBranchFormat4(BranchFormat):
1918
1735
    """Bzr branch format 4.
1919
1736
 
1926
1743
        """See BranchFormat.get_format_description()."""
1927
1744
        return "Branch format 4"
1928
1745
 
1929
 
    def initialize(self, a_bzrdir, name=None):
 
1746
    def initialize(self, a_bzrdir):
1930
1747
        """Create a branch of this format in a_bzrdir."""
1931
1748
        utf8_files = [('revision-history', ''),
1932
1749
                      ('branch-name', ''),
1933
1750
                      ]
1934
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1751
        return self._initialize_helper(a_bzrdir, utf8_files,
1935
1752
                                       lock_type='branch4', set_format=False)
1936
1753
 
1937
1754
    def __init__(self):
1942
1759
        """The network name for this format is the control dirs disk label."""
1943
1760
        return self._matchingbzrdir.get_format_string()
1944
1761
 
1945
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1762
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1946
1763
        """See BranchFormat.open()."""
1947
1764
        if not _found:
1948
1765
            # we are being called directly and must probe.
1950
1767
        return BzrBranch(_format=self,
1951
1768
                         _control_files=a_bzrdir._control_files,
1952
1769
                         a_bzrdir=a_bzrdir,
1953
 
                         name=name,
1954
1770
                         _repository=a_bzrdir.open_repository())
1955
1771
 
1956
1772
    def __str__(self):
1971
1787
        """
1972
1788
        return self.get_format_string()
1973
1789
 
1974
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1790
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1975
1791
        """See BranchFormat.open()."""
1976
1792
        if not _found:
1977
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1793
            format = BranchFormat.find_format(a_bzrdir)
1978
1794
            if format.__class__ != self.__class__:
1979
1795
                raise AssertionError("wrong format %r found for %r" %
1980
1796
                    (format, self))
1981
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1982
1797
        try:
 
1798
            transport = a_bzrdir.get_branch_transport(None)
1983
1799
            control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1800
                                                         lockdir.LockDir)
1985
1801
            return self._branch_class()(_format=self,
1986
1802
                              _control_files=control_files,
1987
 
                              name=name,
1988
1803
                              a_bzrdir=a_bzrdir,
1989
1804
                              _repository=a_bzrdir.find_repository(),
1990
1805
                              ignore_fallbacks=ignore_fallbacks)
1991
1806
        except errors.NoSuchFile:
1992
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1807
            raise errors.NotBranchError(path=transport.base)
1993
1808
 
1994
1809
    def __init__(self):
1995
1810
        super(BranchFormatMetadir, self).__init__()
2024
1839
        """See BranchFormat.get_format_description()."""
2025
1840
        return "Branch format 5"
2026
1841
 
2027
 
    def initialize(self, a_bzrdir, name=None):
 
1842
    def initialize(self, a_bzrdir):
2028
1843
        """Create a branch of this format in a_bzrdir."""
2029
1844
        utf8_files = [('revision-history', ''),
2030
1845
                      ('branch-name', ''),
2031
1846
                      ]
2032
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1847
        return self._initialize_helper(a_bzrdir, utf8_files)
2033
1848
 
2034
1849
    def supports_tags(self):
2035
1850
        return False
2057
1872
        """See BranchFormat.get_format_description()."""
2058
1873
        return "Branch format 6"
2059
1874
 
2060
 
    def initialize(self, a_bzrdir, name=None):
 
1875
    def initialize(self, a_bzrdir):
2061
1876
        """Create a branch of this format in a_bzrdir."""
2062
1877
        utf8_files = [('last-revision', '0 null:\n'),
2063
1878
                      ('branch.conf', ''),
2064
1879
                      ('tags', ''),
2065
1880
                      ]
2066
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1881
        return self._initialize_helper(a_bzrdir, utf8_files)
2067
1882
 
2068
1883
    def make_tags(self, branch):
2069
1884
        """See bzrlib.branch.BranchFormat.make_tags()."""
2087
1902
        """See BranchFormat.get_format_description()."""
2088
1903
        return "Branch format 8"
2089
1904
 
2090
 
    def initialize(self, a_bzrdir, name=None):
 
1905
    def initialize(self, a_bzrdir):
2091
1906
        """Create a branch of this format in a_bzrdir."""
2092
1907
        utf8_files = [('last-revision', '0 null:\n'),
2093
1908
                      ('branch.conf', ''),
2094
1909
                      ('tags', ''),
2095
1910
                      ('references', '')
2096
1911
                      ]
2097
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1912
        return self._initialize_helper(a_bzrdir, utf8_files)
2098
1913
 
2099
1914
    def __init__(self):
2100
1915
        super(BzrBranchFormat8, self).__init__()
2123
1938
    This format was introduced in bzr 1.6.
2124
1939
    """
2125
1940
 
2126
 
    def initialize(self, a_bzrdir, name=None):
 
1941
    def initialize(self, a_bzrdir):
2127
1942
        """Create a branch of this format in a_bzrdir."""
2128
1943
        utf8_files = [('last-revision', '0 null:\n'),
2129
1944
                      ('branch.conf', ''),
2130
1945
                      ('tags', ''),
2131
1946
                      ]
2132
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1947
        return self._initialize_helper(a_bzrdir, utf8_files)
2133
1948
 
2134
1949
    def _branch_class(self):
2135
1950
        return BzrBranch7
2177
1992
        transport = a_bzrdir.get_branch_transport(None)
2178
1993
        location = transport.put_bytes('location', to_branch.base)
2179
1994
 
2180
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1995
    def initialize(self, a_bzrdir, target_branch=None):
2181
1996
        """Create a branch of this format in a_bzrdir."""
2182
1997
        if target_branch is None:
2183
1998
            # this format does not implement branch itself, thus the implicit
2184
1999
            # creation contract must see it as uninitializable
2185
2000
            raise errors.UninitializableFormat(self)
2186
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2001
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
2002
        branch_transport = a_bzrdir.get_branch_transport(self)
2188
2003
        branch_transport.put_bytes('location',
2189
 
            target_branch.bzrdir.user_url)
 
2004
            target_branch.bzrdir.root_transport.base)
2190
2005
        branch_transport.put_bytes('format', self.get_format_string())
2191
 
        branch = self.open(
2192
 
            a_bzrdir, name, _found=True,
 
2006
        return self.open(
 
2007
            a_bzrdir, _found=True,
2193
2008
            possible_transports=[target_branch.bzrdir.root_transport])
2194
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2195
 
        return branch
2196
2009
 
2197
2010
    def __init__(self):
2198
2011
        super(BranchReferenceFormat, self).__init__()
2204
2017
        def clone(to_bzrdir, revision_id=None,
2205
2018
            repository_policy=None):
2206
2019
            """See Branch.clone()."""
2207
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2020
            return format.initialize(to_bzrdir, a_branch)
2208
2021
            # cannot obey revision_id limits when cloning a reference ...
2209
2022
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2210
2023
            # emit some sort of warning/error to the caller ?!
2211
2024
        return clone
2212
2025
 
2213
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2026
    def open(self, a_bzrdir, _found=False, location=None,
2214
2027
             possible_transports=None, ignore_fallbacks=False):
2215
2028
        """Return the branch that the branch reference in a_bzrdir points at.
2216
2029
 
2217
2030
        :param a_bzrdir: A BzrDir that contains a branch.
2218
 
        :param name: Name of colocated branch to open, if any
2219
2031
        :param _found: a private parameter, do not use it. It is used to
2220
2032
            indicate if format probing has already be done.
2221
2033
        :param ignore_fallbacks: when set, no fallback branches will be opened
2226
2038
        :param possible_transports: An optional reusable transports list.
2227
2039
        """
2228
2040
        if not _found:
2229
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2041
            format = BranchFormat.find_format(a_bzrdir)
2230
2042
            if format.__class__ != self.__class__:
2231
2043
                raise AssertionError("wrong format %r found for %r" %
2232
2044
                    (format, self))
2234
2046
            location = self.get_reference(a_bzrdir)
2235
2047
        real_bzrdir = bzrdir.BzrDir.open(
2236
2048
            location, possible_transports=possible_transports)
2237
 
        result = real_bzrdir.open_branch(name=name, 
2238
 
            ignore_fallbacks=ignore_fallbacks)
 
2049
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2239
2050
        # this changes the behaviour of result.clone to create a new reference
2240
2051
        # rather than a copy of the content of the branch.
2241
2052
        # I did not use a proxy object because that needs much more extensive
2275
2086
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2276
2087
 
2277
2088
 
2278
 
class BranchWriteLockResult(LogicalLockResult):
2279
 
    """The result of write locking a branch.
2280
 
 
2281
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2282
 
        None.
2283
 
    :ivar unlock: A callable which will unlock the lock.
2284
 
    """
2285
 
 
2286
 
    def __init__(self, unlock, branch_token):
2287
 
        LogicalLockResult.__init__(self, unlock)
2288
 
        self.branch_token = branch_token
2289
 
 
2290
 
    def __repr__(self):
2291
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2292
 
            self.unlock)
2293
 
 
2294
 
 
2295
2089
class BzrBranch(Branch, _RelockDebugMixin):
2296
2090
    """A branch stored in the actual filesystem.
2297
2091
 
2304
2098
    :ivar repository: Repository for this branch.
2305
2099
    :ivar base: The url of the base directory for this branch; the one
2306
2100
        containing the .bzr directory.
2307
 
    :ivar name: Optional colocated branch name as it exists in the control
2308
 
        directory.
2309
2101
    """
2310
2102
 
2311
2103
    def __init__(self, _format=None,
2312
 
                 _control_files=None, a_bzrdir=None, name=None,
2313
 
                 _repository=None, ignore_fallbacks=False):
 
2104
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2105
                 ignore_fallbacks=False):
2314
2106
        """Create new branch object at a particular location."""
2315
2107
        if a_bzrdir is None:
2316
2108
            raise ValueError('a_bzrdir must be supplied')
2317
2109
        else:
2318
2110
            self.bzrdir = a_bzrdir
2319
2111
        self._base = self.bzrdir.transport.clone('..').base
2320
 
        self.name = name
2321
2112
        # XXX: We should be able to just do
2322
2113
        #   self.base = self.bzrdir.root_transport.base
2323
2114
        # but this does not quite work yet -- mbp 20080522
2330
2121
        Branch.__init__(self)
2331
2122
 
2332
2123
    def __str__(self):
2333
 
        if self.name is None:
2334
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2335
 
        else:
2336
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2337
 
                self.name)
 
2124
        return '%s(%r)' % (self.__class__.__name__, self.base)
2338
2125
 
2339
2126
    __repr__ = __str__
2340
2127
 
2351
2138
        return self.control_files.is_locked()
2352
2139
 
2353
2140
    def lock_write(self, token=None):
2354
 
        """Lock the branch for write operations.
2355
 
 
2356
 
        :param token: A token to permit reacquiring a previously held and
2357
 
            preserved lock.
2358
 
        :return: A BranchWriteLockResult.
2359
 
        """
2360
2141
        if not self.is_locked():
2361
2142
            self._note_lock('w')
2362
2143
        # All-in-one needs to always unlock/lock.
2363
2144
        repo_control = getattr(self.repository, 'control_files', None)
2364
2145
        if self.control_files == repo_control or not self.is_locked():
2365
 
            self.repository._warn_if_deprecated(self)
2366
2146
            self.repository.lock_write()
2367
2147
            took_lock = True
2368
2148
        else:
2369
2149
            took_lock = False
2370
2150
        try:
2371
 
            return BranchWriteLockResult(self.unlock,
2372
 
                self.control_files.lock_write(token=token))
 
2151
            return self.control_files.lock_write(token=token)
2373
2152
        except:
2374
2153
            if took_lock:
2375
2154
                self.repository.unlock()
2376
2155
            raise
2377
2156
 
2378
2157
    def lock_read(self):
2379
 
        """Lock the branch for read operations.
2380
 
 
2381
 
        :return: A bzrlib.lock.LogicalLockResult.
2382
 
        """
2383
2158
        if not self.is_locked():
2384
2159
            self._note_lock('r')
2385
2160
        # All-in-one needs to always unlock/lock.
2386
2161
        repo_control = getattr(self.repository, 'control_files', None)
2387
2162
        if self.control_files == repo_control or not self.is_locked():
2388
 
            self.repository._warn_if_deprecated(self)
2389
2163
            self.repository.lock_read()
2390
2164
            took_lock = True
2391
2165
        else:
2392
2166
            took_lock = False
2393
2167
        try:
2394
2168
            self.control_files.lock_read()
2395
 
            return LogicalLockResult(self.unlock)
2396
2169
        except:
2397
2170
            if took_lock:
2398
2171
                self.repository.unlock()
2567
2340
        return result
2568
2341
 
2569
2342
    def get_stacked_on_url(self):
2570
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2343
        raise errors.UnstackableBranchFormat(self._format, self.base)
2571
2344
 
2572
2345
    def set_push_location(self, location):
2573
2346
        """See Branch.set_push_location."""
2763
2536
        if _mod_revision.is_null(last_revision):
2764
2537
            return
2765
2538
        if last_revision not in self._lefthand_history(revision_id):
2766
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2539
            raise errors.AppendRevisionsOnlyViolation(self.base)
2767
2540
 
2768
2541
    def _gen_revision_history(self):
2769
2542
        """Generate the revision history from last revision
2869
2642
        if branch_location is None:
2870
2643
            return Branch.reference_parent(self, file_id, path,
2871
2644
                                           possible_transports)
2872
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2645
        branch_location = urlutils.join(self.base, branch_location)
2873
2646
        return Branch.open(branch_location,
2874
2647
                           possible_transports=possible_transports)
2875
2648
 
2921
2694
        return stacked_url
2922
2695
 
2923
2696
    def _get_append_revisions_only(self):
2924
 
        return self.get_config(
2925
 
            ).get_user_option_as_bool('append_revisions_only')
 
2697
        value = self.get_config().get_user_option('append_revisions_only')
 
2698
        return value == 'True'
2926
2699
 
2927
2700
    @needs_write_lock
2928
2701
    def generate_revision_history(self, revision_id, last_rev=None,
2990
2763
    """
2991
2764
 
2992
2765
    def get_stacked_on_url(self):
2993
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2766
        raise errors.UnstackableBranchFormat(self._format, self.base)
2994
2767
 
2995
2768
 
2996
2769
######################################################################
3083
2856
        :param verbose: Requests more detailed display of what was checked,
3084
2857
            if any.
3085
2858
        """
3086
 
        note('checked branch %s format %s', self.branch.user_url,
 
2859
        note('checked branch %s format %s', self.branch.base,
3087
2860
            self.branch._format)
3088
2861
        for error in self.errors:
3089
2862
            note('found error:%s', error)
3418
3191
        if local and not bound_location:
3419
3192
            raise errors.LocalRequiresBoundBranch()
3420
3193
        master_branch = None
3421
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3194
        if not local and bound_location and self.source.base != bound_location:
3422
3195
            # not pulling from master, so we need to update master.
3423
3196
            master_branch = self.target.get_master_branch(possible_transports)
3424
3197
            master_branch.lock_write()