/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/bzrdir.py

  • Committer: Ian Clatworthy
  • Date: 2009-07-02 08:26:00 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090702082600-qwb1evvvfa8ctnye
first draft of a 2.0 Upgrade Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-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
29
29
 
30
30
import os
31
31
import sys
32
 
import warnings
33
32
 
34
33
from bzrlib.lazy_import import lazy_import
35
34
lazy_import(globals(), """
71
70
    do_catching_redirections,
72
71
    get_transport,
73
72
    local,
 
73
    remote as remote_transport,
74
74
    )
75
75
from bzrlib.weave import Weave
76
76
""")
78
78
from bzrlib.trace import (
79
79
    mutter,
80
80
    note,
81
 
    warning,
82
81
    )
83
82
 
84
83
from bzrlib import (
86
85
    registry,
87
86
    symbol_versioning,
88
87
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
97
 
    They all expose two urls and transports: the *user* URL is the 
98
 
    one that stops above the control directory (eg .bzr) and that 
99
 
    should normally be used in messages, and the *control* URL is
100
 
    under that in eg .bzr/checkout and is used to read the control
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
88
 
 
89
 
 
90
class BzrDir(object):
125
91
    """A .bzr control diretory.
126
92
 
127
93
    BzrDir instances let you create or open any of the things that can be
163
129
        return True
164
130
 
165
131
    def check_conversion_target(self, target_format):
166
 
        """Check that a bzrdir as a whole can be converted to a new format."""
167
 
        # The only current restriction is that the repository content can be 
168
 
        # fetched compatibly with the target.
169
132
        target_repo_format = target_format.repository_format
170
 
        try:
171
 
            self.open_repository()._format.check_conversion_target(
172
 
                target_repo_format)
173
 
        except errors.NoRepositoryPresent:
174
 
            # No repo, no problem.
175
 
            pass
 
133
        source_repo_format = self._format.repository_format
 
134
        source_repo_format.check_conversion_target(target_repo_format)
176
135
 
177
136
    @staticmethod
178
137
    def _check_supported(format, allow_unsupported,
294
253
                # copied, and finally if we are copying up to a specific
295
254
                # revision_id then we can use the pending-ancestry-result which
296
255
                # does not require traversing all of history to describe it.
297
 
                if (result_repo.user_url == result.user_url
298
 
                    and not require_stacking and
 
256
                if (result_repo.bzrdir.root_transport.base ==
 
257
                    result.root_transport.base and not require_stacking and
299
258
                    revision_id is not None):
300
259
                    fetch_spec = graph.PendingAncestryResult(
301
260
                        [revision_id], local_repo)
388
347
                for subdir in sorted(subdirs, reverse=True):
389
348
                    pending.append(current_transport.clone(subdir))
390
349
 
391
 
    def list_branches(self):
392
 
        """Return a sequence of all branches local to this control directory.
393
 
 
394
 
        """
395
 
        try:
396
 
            return [self.open_branch()]
397
 
        except errors.NotBranchError:
398
 
            return []
399
 
 
400
350
    @staticmethod
401
351
    def find_branches(transport):
402
352
        """Find all branches under a transport.
414
364
            except errors.NoRepositoryPresent:
415
365
                pass
416
366
            else:
417
 
                return False, ([], repository)
418
 
            return True, (bzrdir.list_branches(), None)
419
 
        ret = []
420
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
421
 
                                                  evaluate=evaluate):
 
367
                return False, (None, repository)
 
368
            try:
 
369
                branch = bzrdir.open_branch()
 
370
            except errors.NotBranchError:
 
371
                return True, (None, None)
 
372
            else:
 
373
                return True, (branch, None)
 
374
        branches = []
 
375
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
376
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
377
                branches.extend(repo.find_branches())
 
378
            if branch is not None:
 
379
                branches.append(branch)
 
380
        return branches
427
381
 
428
382
    def destroy_repository(self):
429
383
        """Destroy the repository in this BzrDir"""
430
384
        raise NotImplementedError(self.destroy_repository)
431
385
 
432
 
    def create_branch(self, name=None):
 
386
    def create_branch(self):
433
387
        """Create a branch in this BzrDir.
434
388
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
389
        The bzrdir's format will control what branch format is created.
439
390
        For more control see BranchFormatXX.create(a_bzrdir).
440
391
        """
441
392
        raise NotImplementedError(self.create_branch)
442
393
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
 
394
    def destroy_branch(self):
 
395
        """Destroy the branch in this BzrDir"""
449
396
        raise NotImplementedError(self.destroy_branch)
450
397
 
451
398
    @staticmethod
491
438
            stop = False
492
439
            stack_on = config.get_default_stack_on()
493
440
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
 
441
                stack_on_pwd = found_bzrdir.root_transport.base
495
442
                stop = True
496
443
            # does it have a repository ?
497
444
            try:
499
446
            except errors.NoRepositoryPresent:
500
447
                repository = None
501
448
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
 
449
                if ((found_bzrdir.root_transport.base !=
 
450
                     self.root_transport.base) and not repository.is_shared()):
504
451
                    # Don't look higher, can't use a higher shared repo.
505
452
                    repository = None
506
453
                    stop = True
620
567
 
621
568
        :return: Tuple with old path name and new path name
622
569
        """
623
 
        def name_gen(base='backup.bzr'):
624
 
            counter = 1
625
 
            name = "%s.~%d~" % (base, counter)
626
 
            while self.root_transport.has(name):
627
 
                counter += 1
628
 
                name = "%s.~%d~" % (base, counter)
629
 
            return name
630
 
 
631
 
        backup_dir=name_gen()
632
570
        pb = ui.ui_factory.nested_progress_bar()
633
571
        try:
634
572
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
573
            # already exists, but it should instead either remove it or make
636
574
            # a new backup directory.
637
575
            #
 
576
            # FIXME: bug 262450 -- the backup directory should have the same
 
577
            # permissions as the .bzr directory (probably a bug in copy_tree)
638
578
            old_path = self.root_transport.abspath('.bzr')
639
 
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
641
 
            self.root_transport.copy_tree('.bzr', backup_dir)
 
579
            new_path = self.root_transport.abspath('backup.bzr')
 
580
            pb.note('making backup of %s' % (old_path,))
 
581
            pb.note('  to %s' % (new_path,))
 
582
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
642
583
            return (old_path, new_path)
643
584
        finally:
644
585
            pb.finished()
702
643
            if stop:
703
644
                return result
704
645
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
646
            if (found_bzrdir.root_transport.base == next_transport.base):
706
647
                # top of the file system
707
648
                return None
708
649
            # find the next containing bzrdir
725
666
                repository = found_bzrdir.open_repository()
726
667
            except errors.NoRepositoryPresent:
727
668
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
669
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
670
                return repository, True
730
671
            elif repository.is_shared():
731
672
                return repository, True
737
678
            raise errors.NoRepositoryPresent(self)
738
679
        return found_repo
739
680
 
740
 
    def get_branch_reference(self, name=None):
 
681
    def get_branch_reference(self):
741
682
        """Return the referenced URL for the branch in this bzrdir.
742
683
 
743
 
        :param name: Optional colocated branch name
744
684
        :raises NotBranchError: If there is no Branch.
745
 
        :raises NoColocatedBranchSupport: If a branch name was specified
746
 
            but colocated branches are not supported.
747
685
        :return: The URL the branch in this bzrdir references if it is a
748
686
            reference branch, or None for regular branches.
749
687
        """
750
 
        if name is not None:
751
 
            raise errors.NoColocatedBranchSupport(self)
752
688
        return None
753
689
 
754
 
    def get_branch_transport(self, branch_format, name=None):
 
690
    def get_branch_transport(self, branch_format):
755
691
        """Get the transport for use by branch format in this BzrDir.
756
692
 
757
693
        Note that bzr dirs that do not support format strings will raise
852
788
        :param _transport: the transport this dir is based at.
853
789
        """
854
790
        self._format = _format
855
 
        # these are also under the more standard names of 
856
 
        # control_transport and user_transport
857
791
        self.transport = _transport.clone('.bzr')
858
792
        self.root_transport = _transport
859
793
        self._mode_check_done = False
860
 
        
861
 
    @property 
862
 
    def user_transport(self):
863
 
        return self.root_transport
864
 
        
865
 
    @property
866
 
    def control_transport(self):
867
 
        return self.transport
868
794
 
869
795
    def is_control_filename(self, filename):
870
796
        """True if filename is the name of a path which is reserved for bzrdir's.
945
871
        BzrDir._check_supported(format, _unsupported)
946
872
        return format.open(transport, _found=True)
947
873
 
948
 
    def open_branch(self, name=None, unsupported=False,
949
 
                    ignore_fallbacks=False):
 
874
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
950
875
        """Open the branch object at this BzrDir if one is present.
951
876
 
952
877
        If unsupported is True, then no longer supported branch formats can
999
924
                raise errors.NotBranchError(path=url)
1000
925
            a_transport = new_t
1001
926
 
1002
 
    def _get_tree_branch(self, name=None):
 
927
    def _get_tree_branch(self):
1003
928
        """Return the branch and tree, if any, for this bzrdir.
1004
929
 
1005
 
        :param name: Name of colocated branch to open.
1006
 
 
1007
930
        Return None for tree if not present or inaccessible.
1008
931
        Raise NotBranchError if no branch is present.
1009
932
        :return: (tree, branch)
1012
935
            tree = self.open_workingtree()
1013
936
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1014
937
            tree = None
1015
 
            branch = self.open_branch(name=name)
 
938
            branch = self.open_branch()
1016
939
        else:
1017
 
            if name is not None:
1018
 
                branch = self.open_branch(name=name)
1019
 
            else:
1020
 
                branch = tree.branch
 
940
            branch = tree.branch
1021
941
        return tree, branch
1022
942
 
1023
943
    @classmethod
1095
1015
        """
1096
1016
        raise NotImplementedError(self.open_workingtree)
1097
1017
 
1098
 
    def has_branch(self, name=None):
 
1018
    def has_branch(self):
1099
1019
        """Tell if this bzrdir contains a branch.
1100
1020
 
1101
1021
        Note: if you're going to open the branch, you should just go ahead
1103
1023
        branch and discards it, and that's somewhat expensive.)
1104
1024
        """
1105
1025
        try:
1106
 
            self.open_branch(name)
 
1026
            self.open_branch()
1107
1027
            return True
1108
1028
        except errors.NotBranchError:
1109
1029
            return False
1314
1234
        return result
1315
1235
 
1316
1236
    def push_branch(self, source, revision_id=None, overwrite=False, 
1317
 
        remember=False, create_prefix=False):
 
1237
        remember=False):
1318
1238
        """Push the source branch into this BzrDir."""
1319
1239
        br_to = None
1320
1240
        # If we can open a branch, use its direct repository, otherwise see
1383
1303
        self.create_hook(hooks.HookPoint('pre_open',
1384
1304
            "Invoked before attempting to open a BzrDir with the transport "
1385
1305
            "that the open will use.", (1, 14), None))
1386
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1387
 
            "Invoked after a repository has been initialized. "
1388
 
            "post_repo_init is called with a "
1389
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1390
 
            (2, 2), None))
1391
1306
 
1392
1307
# install the default hooks
1393
1308
BzrDir.hooks = BzrDirHooks()
1394
1309
 
1395
1310
 
1396
 
class RepoInitHookParams(object):
1397
 
    """Object holding parameters passed to *_repo_init hooks.
1398
 
 
1399
 
    There are 4 fields that hooks may wish to access:
1400
 
 
1401
 
    :ivar repository: Repository created
1402
 
    :ivar format: Repository format
1403
 
    :ivar bzrdir: The bzrdir for the repository
1404
 
    :ivar shared: The repository is shared
1405
 
    """
1406
 
 
1407
 
    def __init__(self, repository, format, a_bzrdir, shared):
1408
 
        """Create a group of RepoInitHook parameters.
1409
 
 
1410
 
        :param repository: Repository created
1411
 
        :param format: Repository format
1412
 
        :param bzrdir: The bzrdir for the repository
1413
 
        :param shared: The repository is shared
1414
 
        """
1415
 
        self.repository = repository
1416
 
        self.format = format
1417
 
        self.bzrdir = a_bzrdir
1418
 
        self.shared = shared
1419
 
 
1420
 
    def __eq__(self, other):
1421
 
        return self.__dict__ == other.__dict__
1422
 
 
1423
 
    def __repr__(self):
1424
 
        if self.repository:
1425
 
            return "<%s for %s>" % (self.__class__.__name__,
1426
 
                self.repository)
1427
 
        else:
1428
 
            return "<%s for %s>" % (self.__class__.__name__,
1429
 
                self.bzrdir)
1430
 
 
1431
 
 
1432
1311
class BzrDirPreSplitOut(BzrDir):
1433
1312
    """A common class for the all-in-one formats."""
1434
1313
 
1473
1352
            tree.clone(result)
1474
1353
        return result
1475
1354
 
1476
 
    def create_branch(self, name=None):
 
1355
    def create_branch(self):
1477
1356
        """See BzrDir.create_branch."""
1478
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1357
        return self._format.get_branch_format().initialize(self)
1479
1358
 
1480
 
    def destroy_branch(self, name=None):
 
1359
    def destroy_branch(self):
1481
1360
        """See BzrDir.destroy_branch."""
1482
1361
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1483
1362
 
1506
1385
        # that can do wonky stuff here, and that only
1507
1386
        # happens for creating checkouts, which cannot be
1508
1387
        # done on this format anyway. So - acceptable wart.
1509
 
        if hardlink:
1510
 
            warning("can't support hardlinked working trees in %r"
1511
 
                % (self,))
1512
1388
        try:
1513
1389
            result = self.open_workingtree(recommend_upgrade=False)
1514
1390
        except errors.NoSuchFile:
1539
1415
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1540
1416
                                          self)
1541
1417
 
1542
 
    def get_branch_transport(self, branch_format, name=None):
 
1418
    def get_branch_transport(self, branch_format):
1543
1419
        """See BzrDir.get_branch_transport()."""
1544
 
        if name is not None:
1545
 
            raise errors.NoColocatedBranchSupport(self)
1546
1420
        if branch_format is None:
1547
1421
            return self.transport
1548
1422
        try:
1581
1455
            format = BzrDirFormat.get_default_format()
1582
1456
        return not isinstance(self._format, format.__class__)
1583
1457
 
1584
 
    def open_branch(self, name=None, unsupported=False,
1585
 
                    ignore_fallbacks=False):
 
1458
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1586
1459
        """See BzrDir.open_branch."""
1587
1460
        from bzrlib.branch import BzrBranchFormat4
1588
1461
        format = BzrBranchFormat4()
1589
1462
        self._check_supported(format, unsupported)
1590
 
        return format.open(self, name, _found=True)
 
1463
        return format.open(self, _found=True)
1591
1464
 
1592
1465
    def sprout(self, url, revision_id=None, force_new_repo=False,
1593
1466
               possible_transports=None, accelerator_tree=None,
1654
1527
    This is a deprecated format and may be removed after sept 2006.
1655
1528
    """
1656
1529
 
1657
 
    def has_workingtree(self):
1658
 
        """See BzrDir.has_workingtree."""
1659
 
        return True
1660
 
    
1661
1530
    def open_repository(self):
1662
1531
        """See BzrDir.open_repository."""
1663
1532
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1679
1548
    This is a deprecated format and may be removed after sept 2006.
1680
1549
    """
1681
1550
 
1682
 
    def has_workingtree(self):
1683
 
        """See BzrDir.has_workingtree."""
1684
 
        return True
1685
 
    
1686
1551
    def open_repository(self):
1687
1552
        """See BzrDir.open_repository."""
1688
1553
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1710
1575
        """See BzrDir.can_convert_format()."""
1711
1576
        return True
1712
1577
 
1713
 
    def create_branch(self, name=None):
 
1578
    def create_branch(self):
1714
1579
        """See BzrDir.create_branch."""
1715
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1580
        return self._format.get_branch_format().initialize(self)
1716
1581
 
1717
 
    def destroy_branch(self, name=None):
 
1582
    def destroy_branch(self):
1718
1583
        """See BzrDir.create_branch."""
1719
 
        if name is not None:
1720
 
            raise errors.NoColocatedBranchSupport(self)
1721
1584
        self.transport.delete_tree('branch')
1722
1585
 
1723
1586
    def create_repository(self, shared=False):
1746
1609
    def destroy_workingtree_metadata(self):
1747
1610
        self.transport.delete_tree('checkout')
1748
1611
 
1749
 
    def find_branch_format(self, name=None):
 
1612
    def find_branch_format(self):
1750
1613
        """Find the branch 'format' for this bzrdir.
1751
1614
 
1752
1615
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1753
1616
        """
1754
1617
        from bzrlib.branch import BranchFormat
1755
 
        return BranchFormat.find_format(self, name=name)
 
1618
        return BranchFormat.find_format(self)
1756
1619
 
1757
1620
    def _get_mkdir_mode(self):
1758
1621
        """Figure out the mode to use when creating a bzrdir subdir."""
1760
1623
                                     lockable_files.TransportLock)
1761
1624
        return temp_control._dir_mode
1762
1625
 
1763
 
    def get_branch_reference(self, name=None):
 
1626
    def get_branch_reference(self):
1764
1627
        """See BzrDir.get_branch_reference()."""
1765
1628
        from bzrlib.branch import BranchFormat
1766
 
        format = BranchFormat.find_format(self, name=name)
1767
 
        return format.get_reference(self, name=name)
 
1629
        format = BranchFormat.find_format(self)
 
1630
        return format.get_reference(self)
1768
1631
 
1769
 
    def get_branch_transport(self, branch_format, name=None):
 
1632
    def get_branch_transport(self, branch_format):
1770
1633
        """See BzrDir.get_branch_transport()."""
1771
 
        if name is not None:
1772
 
            raise errors.NoColocatedBranchSupport(self)
1773
 
        # XXX: this shouldn't implicitly create the directory if it's just
1774
 
        # promising to get a transport -- mbp 20090727
1775
1634
        if branch_format is None:
1776
1635
            return self.transport.clone('branch')
1777
1636
        try:
1812
1671
            pass
1813
1672
        return self.transport.clone('checkout')
1814
1673
 
1815
 
    def has_workingtree(self):
1816
 
        """Tell if this bzrdir contains a working tree.
1817
 
 
1818
 
        This will still raise an exception if the bzrdir has a workingtree that
1819
 
        is remote & inaccessible.
1820
 
 
1821
 
        Note: if you're going to open the working tree, you should just go
1822
 
        ahead and try, and not ask permission first.
1823
 
        """
1824
 
        from bzrlib.workingtree import WorkingTreeFormat
1825
 
        try:
1826
 
            WorkingTreeFormat.find_format(self)
1827
 
        except errors.NoWorkingTree:
1828
 
            return False
1829
 
        return True
1830
 
 
1831
1674
    def needs_format_conversion(self, format=None):
1832
1675
        """See BzrDir.needs_format_conversion()."""
1833
1676
        if format is None:
1846
1689
                return True
1847
1690
        except errors.NoRepositoryPresent:
1848
1691
            pass
1849
 
        for branch in self.list_branches():
1850
 
            if not isinstance(branch._format,
 
1692
        try:
 
1693
            if not isinstance(self.open_branch()._format,
1851
1694
                              format.get_branch_format().__class__):
1852
1695
                # the branch needs an upgrade.
1853
1696
                return True
 
1697
        except errors.NotBranchError:
 
1698
            pass
1854
1699
        try:
1855
1700
            my_wt = self.open_workingtree(recommend_upgrade=False)
1856
1701
            if not isinstance(my_wt._format,
1861
1706
            pass
1862
1707
        return False
1863
1708
 
1864
 
    def open_branch(self, name=None, unsupported=False,
1865
 
                    ignore_fallbacks=False):
 
1709
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1866
1710
        """See BzrDir.open_branch."""
1867
 
        format = self.find_branch_format(name=name)
 
1711
        format = self.find_branch_format()
1868
1712
        self._check_supported(format, unsupported)
1869
 
        return format.open(self, name=name,
1870
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1713
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1871
1714
 
1872
1715
    def open_repository(self, unsupported=False):
1873
1716
        """See BzrDir.open_repository."""
1905
1748
    Once a format is deprecated, just deprecate the initialize and open
1906
1749
    methods on the format class. Do not deprecate the object, as the
1907
1750
    object will be created every system load.
1908
 
 
1909
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1910
1751
    """
1911
1752
 
1912
1753
    _default_format = None
1929
1770
 
1930
1771
    _lock_file_name = 'branch-lock'
1931
1772
 
1932
 
    colocated_branches = False
1933
 
    """Whether co-located branches are supported for this control dir format.
1934
 
    """
1935
 
 
1936
1773
    # _lock_class must be set in subclasses to the lock type, typ.
1937
1774
    # TransportLock or LockDir
1938
1775
 
1955
1792
    def probe_transport(klass, transport):
1956
1793
        """Return the .bzrdir style format present in a directory."""
1957
1794
        try:
1958
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1795
            format_string = transport.get(".bzr/branch-format").read()
1959
1796
        except errors.NoSuchFile:
1960
1797
            raise errors.NotBranchError(path=transport.base)
1961
1798
 
2737
2574
    def convert(self, to_convert, pb):
2738
2575
        """See Converter.convert()."""
2739
2576
        self.bzrdir = to_convert
2740
 
        if pb is not None:
2741
 
            warnings.warn("pb parameter to convert() is deprecated")
2742
 
        self.pb = ui.ui_factory.nested_progress_bar()
2743
 
        try:
2744
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2745
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2746
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2747
 
            self._convert_to_weaves()
2748
 
            return BzrDir.open(self.bzrdir.user_url)
2749
 
        finally:
2750
 
            self.pb.finished()
 
2577
        self.pb = pb
 
2578
        self.pb.note('starting upgrade from format 4 to 5')
 
2579
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2580
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2581
        self._convert_to_weaves()
 
2582
        return BzrDir.open(self.bzrdir.root_transport.base)
2751
2583
 
2752
2584
    def _convert_to_weaves(self):
2753
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2585
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2754
2586
        try:
2755
2587
            # TODO permissions
2756
2588
            stat = self.bzrdir.transport.stat('weaves')
2784
2616
        self.pb.clear()
2785
2617
        self._write_all_weaves()
2786
2618
        self._write_all_revs()
2787
 
        ui.ui_factory.note('upgraded to weaves:')
2788
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2789
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2790
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2619
        self.pb.note('upgraded to weaves:')
 
2620
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2621
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2622
        self.pb.note('  %6d texts', self.text_count)
2791
2623
        self._cleanup_spare_files_after_format4()
2792
2624
        self.branch._transport.put_bytes(
2793
2625
            'branch-format',
2861
2693
                       len(self.known_revisions))
2862
2694
        if not self.branch.repository.has_revision(rev_id):
2863
2695
            self.pb.clear()
2864
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2865
 
                         'will be converted as a ghost' %
 
2696
            self.pb.note('revision {%s} not present in branch; '
 
2697
                         'will be converted as a ghost',
2866
2698
                         rev_id)
2867
2699
            self.absent_revisions.add(rev_id)
2868
2700
        else:
2994
2826
    def convert(self, to_convert, pb):
2995
2827
        """See Converter.convert()."""
2996
2828
        self.bzrdir = to_convert
2997
 
        pb = ui.ui_factory.nested_progress_bar()
2998
 
        try:
2999
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
3000
 
            self._convert_to_prefixed()
3001
 
            return BzrDir.open(self.bzrdir.user_url)
3002
 
        finally:
3003
 
            pb.finished()
 
2829
        self.pb = pb
 
2830
        self.pb.note('starting upgrade from format 5 to 6')
 
2831
        self._convert_to_prefixed()
 
2832
        return BzrDir.open(self.bzrdir.root_transport.base)
3004
2833
 
3005
2834
    def _convert_to_prefixed(self):
3006
2835
        from bzrlib.store import TransportStore
3007
2836
        self.bzrdir.transport.delete('branch-format')
3008
2837
        for store_name in ["weaves", "revision-store"]:
3009
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2838
            self.pb.note("adding prefixes to %s" % store_name)
3010
2839
            store_transport = self.bzrdir.transport.clone(store_name)
3011
2840
            store = TransportStore(store_transport, prefixed=True)
3012
2841
            for urlfilename in store_transport.list_dir('.'):
3039
2868
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3040
2869
        from bzrlib.branch import BzrBranchFormat5
3041
2870
        self.bzrdir = to_convert
3042
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2871
        self.pb = pb
3043
2872
        self.count = 0
3044
2873
        self.total = 20 # the steps we know about
3045
2874
        self.garbage_inventories = []
3046
2875
        self.dir_mode = self.bzrdir._get_dir_mode()
3047
2876
        self.file_mode = self.bzrdir._get_file_mode()
3048
2877
 
3049
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2878
        self.pb.note('starting upgrade from format 6 to metadir')
3050
2879
        self.bzrdir.transport.put_bytes(
3051
2880
                'branch-format',
3052
2881
                "Converting to format 6",
3102
2931
        else:
3103
2932
            has_checkout = True
3104
2933
        if not has_checkout:
3105
 
            ui.ui_factory.note('No working tree.')
 
2934
            self.pb.note('No working tree.')
3106
2935
            # If some checkout files are there, we may as well get rid of them.
3107
2936
            for name, mandatory in checkout_files:
3108
2937
                if name in bzrcontents:
3125
2954
            'branch-format',
3126
2955
            BzrDirMetaFormat1().get_format_string(),
3127
2956
            mode=self.file_mode)
3128
 
        self.pb.finished()
3129
 
        return BzrDir.open(self.bzrdir.user_url)
 
2957
        return BzrDir.open(self.bzrdir.root_transport.base)
3130
2958
 
3131
2959
    def make_lock(self, name):
3132
2960
        """Make a lock for the new control dir name."""
3167
2995
    def convert(self, to_convert, pb):
3168
2996
        """See Converter.convert()."""
3169
2997
        self.bzrdir = to_convert
3170
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2998
        self.pb = pb
3171
2999
        self.count = 0
3172
3000
        self.total = 1
3173
3001
        self.step('checking repository format')
3178
3006
        else:
3179
3007
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
3008
                from bzrlib.repository import CopyConverter
3181
 
                ui.ui_factory.note('starting repository conversion')
 
3009
                self.pb.note('starting repository conversion')
3182
3010
                converter = CopyConverter(self.target_format.repository_format)
3183
3011
                converter.convert(repo, pb)
3184
 
        for branch in self.bzrdir.list_branches():
 
3012
        try:
 
3013
            branch = self.bzrdir.open_branch()
 
3014
        except errors.NotBranchError:
 
3015
            pass
 
3016
        else:
3185
3017
            # TODO: conversions of Branch and Tree should be done by
3186
3018
            # InterXFormat lookups/some sort of registry.
3187
3019
            # Avoid circular imports
3202
3034
                      new is _mod_branch.BzrBranchFormat8):
3203
3035
                    branch_converter = _mod_branch.Converter7to8()
3204
3036
                else:
3205
 
                    raise errors.BadConversionTarget("No converter", new,
3206
 
                        branch._format)
 
3037
                    raise errors.BadConversionTarget("No converter", new)
3207
3038
                branch_converter.convert(branch)
3208
3039
                branch = self.bzrdir.open_branch()
3209
3040
                old = branch._format.__class__
3229
3060
                isinstance(self.target_format.workingtree_format,
3230
3061
                    workingtree_4.WorkingTreeFormat6)):
3231
3062
                workingtree_4.Converter4or5to6().convert(tree)
3232
 
        self.pb.finished()
3233
3063
        return to_convert
3234
3064
 
3235
3065
 
3242
3072
 
3243
3073
    def __init__(self):
3244
3074
        BzrDirMetaFormat1.__init__(self)
3245
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3246
 
        # like to believe that format objects are stateless or at least
3247
 
        # immutable,  However, we do at least avoid mutating the name after
3248
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
3075
        self._network_name = None
3250
3076
 
3251
 
    def __repr__(self):
3252
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3253
 
            self._network_name)
3254
 
 
3255
3077
    def get_format_description(self):
3256
 
        if self._network_name:
3257
 
            real_format = network_format_registry.get(self._network_name)
3258
 
            return 'Remote: ' + real_format.get_format_description()
3259
3078
        return 'bzr remote bzrdir'
3260
3079
 
3261
3080
    def get_format_string(self):
3394
3213
        args.append(self._serialize_NoneString(repo_format_name))
3395
3214
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
3215
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
 
        request_network_name = self._network_name or \
 
3216
        if self._network_name is None:
 
3217
            self._network_name = \
3398
3218
            BzrDirFormat.get_default_format().network_name()
3399
3219
        try:
3400
3220
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
 
                request_network_name, path, *args)
 
3221
                self.network_name(), path, *args)
3402
3222
        except errors.UnknownSmartMethod:
3403
3223
            client._medium._remember_remote_is_before((1,16))
3404
3224
            local_dir_format = BzrDirMetaFormat1()
3450
3270
        else:
3451
3271
            remote_repo = None
3452
3272
            policy = None
3453
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3454
3273
        if require_stacking:
3455
3274
            # The repo has already been created, but we need to make sure that
3456
3275
            # we'll make a stackable branch.
3654
3473
                experimental_pairs.append((key, help))
3655
3474
            else:
3656
3475
                output += wrapped(key, help, info)
3657
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
 
3476
        output += "\nSee ``bzr help formats`` for more about storage formats."
3658
3477
        other_output = ""
3659
3478
        if len(experimental_pairs) > 0:
3660
3479
            other_output += "Experimental formats are shown below.\n\n"
3673
3492
            other_output += \
3674
3493
                "\nNo deprecated formats are available.\n\n"
3675
3494
        other_output += \
3676
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
3495
            "\nSee ``bzr help formats`` for more about storage formats."
3677
3496
 
3678
3497
        if topic == 'other-formats':
3679
3498
            return other_output
3713
3532
            try:
3714
3533
                stack_on = urlutils.rebase_url(self._stack_on,
3715
3534
                    self._stack_on_pwd,
3716
 
                    branch.user_url)
 
3535
                    branch.bzrdir.root_transport.base)
3717
3536
            except errors.InvalidRebaseURLs:
3718
3537
                stack_on = self._get_full_stack_on()
3719
3538
        try:
3723
3542
            if self._require_stacking:
3724
3543
                raise
3725
3544
 
3726
 
    def requires_stacking(self):
3727
 
        """Return True if this policy requires stacking."""
3728
 
        return self._stack_on is not None and self._require_stacking
3729
 
 
3730
3545
    def _get_full_stack_on(self):
3731
3546
        """Get a fully-qualified URL for the stack_on location."""
3732
3547
        if self._stack_on is None:
3848
3663
format_registry.register('weave', BzrDirFormat6,
3849
3664
    'Pre-0.8 format.  Slower than knit and does not'
3850
3665
    ' support checkouts or shared repositories.',
3851
 
    hidden=True,
3852
3666
    deprecated=True)
3853
3667
format_registry.register_metadir('metaweave',
3854
3668
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
3669
    'Transitional format in 0.8.  Slower than knit.',
3856
3670
    branch_format='bzrlib.branch.BzrBranchFormat5',
3857
3671
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3858
 
    hidden=True,
3859
3672
    deprecated=True)
3860
3673
format_registry.register_metadir('knit',
3861
3674
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
3675
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3863
3676
    branch_format='bzrlib.branch.BzrBranchFormat5',
3864
3677
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3865
 
    hidden=True,
3866
3678
    deprecated=True)
3867
3679
format_registry.register_metadir('dirstate',
3868
3680
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3872
3684
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3873
3685
    # directly from workingtree_4 triggers a circular import.
3874
3686
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3875
 
    hidden=True,
3876
3687
    deprecated=True)
3877
3688
format_registry.register_metadir('dirstate-tags',
3878
3689
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3881
3692
        ' Incompatible with bzr < 0.15.',
3882
3693
    branch_format='bzrlib.branch.BzrBranchFormat6',
3883
3694
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
 
    hidden=True,
3885
3695
    deprecated=True)
3886
3696
format_registry.register_metadir('rich-root',
3887
3697
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3889
3699
        ' bzr < 1.0.',
3890
3700
    branch_format='bzrlib.branch.BzrBranchFormat6',
3891
3701
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892
 
    hidden=True,
3893
3702
    deprecated=True)
3894
3703
format_registry.register_metadir('dirstate-with-subtree',
3895
3704
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3906
3715
    help='New in 0.92: Pack-based format with data compatible with '
3907
3716
        'dirstate-tags format repositories. Interoperates with '
3908
3717
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
 
        ,
 
3718
        'Previously called knitpack-experimental.  '
 
3719
        'For more information, see '
 
3720
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3910
3721
    branch_format='bzrlib.branch.BzrBranchFormat6',
3911
3722
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3912
3723
    )
3915
3726
    help='New in 0.92: Pack-based format with data compatible with '
3916
3727
        'dirstate-with-subtree format repositories. Interoperates with '
3917
3728
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3918
 
        ,
 
3729
        'Previously called knitpack-experimental.  '
 
3730
        'For more information, see '
 
3731
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3919
3732
    branch_format='bzrlib.branch.BzrBranchFormat6',
3920
3733
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3921
3734
    hidden=True,
3927
3740
         '(needed for bzr-svn and bzr-git).',
3928
3741
    branch_format='bzrlib.branch.BzrBranchFormat6',
3929
3742
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3930
 
    hidden=True,
3931
3743
    )
3932
3744
format_registry.register_metadir('1.6',
3933
3745
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3936
3748
         'not present locally.',
3937
3749
    branch_format='bzrlib.branch.BzrBranchFormat7',
3938
3750
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
 
    hidden=True,
3940
3751
    )
3941
3752
format_registry.register_metadir('1.6.1-rich-root',
3942
3753
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3944
3755
         '(needed for bzr-svn and bzr-git).',
3945
3756
    branch_format='bzrlib.branch.BzrBranchFormat7',
3946
3757
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3947
 
    hidden=True,
3948
3758
    )
3949
3759
format_registry.register_metadir('1.9',
3950
3760
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3953
3763
         'performance for most operations.',
3954
3764
    branch_format='bzrlib.branch.BzrBranchFormat7',
3955
3765
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3956
 
    hidden=True,
3957
3766
    )
3958
3767
format_registry.register_metadir('1.9-rich-root',
3959
3768
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3961
3770
         '(needed for bzr-svn and bzr-git).',
3962
3771
    branch_format='bzrlib.branch.BzrBranchFormat7',
3963
3772
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3964
 
    hidden=True,
3965
3773
    )
3966
3774
format_registry.register_metadir('1.14',
3967
3775
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3983
3791
        'to and from rich-root-pack (and anything compatible with '
3984
3792
        'rich-root-pack) format repositories. Repositories and branches in '
3985
3793
        'this format can only be read by bzr.dev. Please read '
3986
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3794
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3987
3795
        'before use.',
3988
3796
    branch_format='bzrlib.branch.BzrBranchFormat7',
3989
3797
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3990
3798
    experimental=True,
3991
3799
    alias=True,
3992
 
    hidden=True,
3993
3800
    )
3994
3801
format_registry.register_metadir('development-subtree',
3995
3802
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3997
3804
        'from pack-0.92-subtree (and anything compatible with '
3998
3805
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3999
3806
        'this format can only be read by bzr.dev. Please read '
4000
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3807
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
4001
3808
        'before use.',
4002
3809
    branch_format='bzrlib.branch.BzrBranchFormat7',
4003
3810
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4004
3811
    experimental=True,
4005
 
    hidden=True,
4006
3812
    alias=False, # Restore to being an alias when an actual development subtree format is added
4007
3813
                 # This current non-alias status is simply because we did not introduce a
4008
3814
                 # chk based subtree format.
4013
3819
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4014
3820
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4015
3821
        'Please read '
4016
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3822
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
4017
3823
        'before use.',
4018
3824
    branch_format='bzrlib.branch.BzrBranchFormat7',
4019
3825
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4025
3831
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4026
3832
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4027
3833
        'rich roots. Please read '
4028
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3834
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
4029
3835
        'before use.',
4030
3836
    branch_format='bzrlib.branch.BzrBranchFormat7',
4031
3837
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4048
3854
# The following format should be an alias for the rich root equivalent 
4049
3855
# of the default format
4050
3856
format_registry.register_metadir('default-rich-root',
4051
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4052
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4053
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3857
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
3858
    help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
 
3859
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3860
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
4054
3861
    alias=True,
4055
 
    hidden=True,
4056
 
    help='Same as 2a.')
4057
 
 
 
3862
    )
4058
3863
# The current format that is made on 'bzr init'.
4059
 
format_registry.set_default('2a')
 
3864
format_registry.set_default('pack-0.92')