~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Aaron Bentley
  • Date: 2009-08-24 16:56:26 UTC
  • mto: This revision was merged to the branch mainline in revision 4641.
  • Revision ID: aaron@aaronbentley.com-20090824165626-rrxbl8hvxkofbj7l
Update from review.

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(), """
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
        self.open_repository()._format.check_conversion_target(target_repo_format)
176
134
 
177
135
    @staticmethod
178
136
    def _check_supported(format, allow_unsupported,
294
252
                # copied, and finally if we are copying up to a specific
295
253
                # revision_id then we can use the pending-ancestry-result which
296
254
                # 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
 
255
                if (result_repo.bzrdir.root_transport.base ==
 
256
                    result.root_transport.base and not require_stacking and
299
257
                    revision_id is not None):
300
258
                    fetch_spec = graph.PendingAncestryResult(
301
259
                        [revision_id], local_repo)
388
346
                for subdir in sorted(subdirs, reverse=True):
389
347
                    pending.append(current_transport.clone(subdir))
390
348
 
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
349
    @staticmethod
401
350
    def find_branches(transport):
402
351
        """Find all branches under a transport.
414
363
            except errors.NoRepositoryPresent:
415
364
                pass
416
365
            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):
 
366
                return False, (None, repository)
 
367
            try:
 
368
                branch = bzrdir.open_branch()
 
369
            except errors.NotBranchError:
 
370
                return True, (None, None)
 
371
            else:
 
372
                return True, (branch, None)
 
373
        branches = []
 
374
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
375
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
376
                branches.extend(repo.find_branches())
 
377
            if branch is not None:
 
378
                branches.append(branch)
 
379
        return branches
427
380
 
428
381
    def destroy_repository(self):
429
382
        """Destroy the repository in this BzrDir"""
430
383
        raise NotImplementedError(self.destroy_repository)
431
384
 
432
 
    def create_branch(self, name=None):
 
385
    def create_branch(self):
433
386
        """Create a branch in this BzrDir.
434
387
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
388
        The bzrdir's format will control what branch format is created.
439
389
        For more control see BranchFormatXX.create(a_bzrdir).
440
390
        """
441
391
        raise NotImplementedError(self.create_branch)
442
392
 
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
 
        """
 
393
    def destroy_branch(self):
 
394
        """Destroy the branch in this BzrDir"""
449
395
        raise NotImplementedError(self.destroy_branch)
450
396
 
451
397
    @staticmethod
491
437
            stop = False
492
438
            stack_on = config.get_default_stack_on()
493
439
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
 
440
                stack_on_pwd = found_bzrdir.root_transport.base
495
441
                stop = True
496
442
            # does it have a repository ?
497
443
            try:
499
445
            except errors.NoRepositoryPresent:
500
446
                repository = None
501
447
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
 
448
                if ((found_bzrdir.root_transport.base !=
 
449
                     self.root_transport.base) and not repository.is_shared()):
504
450
                    # Don't look higher, can't use a higher shared repo.
505
451
                    repository = None
506
452
                    stop = True
620
566
 
621
567
        :return: Tuple with old path name and new path name
622
568
        """
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
569
        pb = ui.ui_factory.nested_progress_bar()
633
570
        try:
634
571
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
572
            # already exists, but it should instead either remove it or make
636
573
            # a new backup directory.
637
574
            #
 
575
            # FIXME: bug 262450 -- the backup directory should have the same
 
576
            # permissions as the .bzr directory (probably a bug in copy_tree)
638
577
            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)
 
578
            new_path = self.root_transport.abspath('backup.bzr')
 
579
            pb.note('making backup of %s' % (old_path,))
 
580
            pb.note('  to %s' % (new_path,))
 
581
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
642
582
            return (old_path, new_path)
643
583
        finally:
644
584
            pb.finished()
702
642
            if stop:
703
643
                return result
704
644
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
645
            if (found_bzrdir.root_transport.base == next_transport.base):
706
646
                # top of the file system
707
647
                return None
708
648
            # find the next containing bzrdir
725
665
                repository = found_bzrdir.open_repository()
726
666
            except errors.NoRepositoryPresent:
727
667
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
668
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
669
                return repository, True
730
670
            elif repository.is_shared():
731
671
                return repository, True
746
686
        """
747
687
        return None
748
688
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
689
    def get_branch_transport(self, branch_format):
750
690
        """Get the transport for use by branch format in this BzrDir.
751
691
 
752
692
        Note that bzr dirs that do not support format strings will raise
847
787
        :param _transport: the transport this dir is based at.
848
788
        """
849
789
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
790
        self.transport = _transport.clone('.bzr')
853
791
        self.root_transport = _transport
854
792
        self._mode_check_done = False
855
 
        
856
 
    @property 
857
 
    def user_transport(self):
858
 
        return self.root_transport
859
 
        
860
 
    @property
861
 
    def control_transport(self):
862
 
        return self.transport
863
793
 
864
794
    def is_control_filename(self, filename):
865
795
        """True if filename is the name of a path which is reserved for bzrdir's.
940
870
        BzrDir._check_supported(format, _unsupported)
941
871
        return format.open(transport, _found=True)
942
872
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
873
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
945
874
        """Open the branch object at this BzrDir if one is present.
946
875
 
947
876
        If unsupported is True, then no longer supported branch formats can
1085
1014
        """
1086
1015
        raise NotImplementedError(self.open_workingtree)
1087
1016
 
1088
 
    def has_branch(self, name=None):
 
1017
    def has_branch(self):
1089
1018
        """Tell if this bzrdir contains a branch.
1090
1019
 
1091
1020
        Note: if you're going to open the branch, you should just go ahead
1093
1022
        branch and discards it, and that's somewhat expensive.)
1094
1023
        """
1095
1024
        try:
1096
 
            self.open_branch(name)
 
1025
            self.open_branch()
1097
1026
            return True
1098
1027
        except errors.NotBranchError:
1099
1028
            return False
1373
1302
        self.create_hook(hooks.HookPoint('pre_open',
1374
1303
            "Invoked before attempting to open a BzrDir with the transport "
1375
1304
            "that the open will use.", (1, 14), None))
1376
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1377
 
            "Invoked after a repository has been initialized. "
1378
 
            "post_repo_init is called with a "
1379
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1380
 
            (2, 2), None))
1381
1305
 
1382
1306
# install the default hooks
1383
1307
BzrDir.hooks = BzrDirHooks()
1384
1308
 
1385
1309
 
1386
 
class RepoInitHookParams(object):
1387
 
    """Object holding parameters passed to *_repo_init hooks.
1388
 
 
1389
 
    There are 4 fields that hooks may wish to access:
1390
 
 
1391
 
    :ivar repository: Repository created
1392
 
    :ivar format: Repository format
1393
 
    :ivar bzrdir: The bzrdir for the repository
1394
 
    :ivar shared: The repository is shared
1395
 
    """
1396
 
 
1397
 
    def __init__(self, repository, format, a_bzrdir, shared):
1398
 
        """Create a group of RepoInitHook parameters.
1399
 
 
1400
 
        :param repository: Repository created
1401
 
        :param format: Repository format
1402
 
        :param bzrdir: The bzrdir for the repository
1403
 
        :param shared: The repository is shared
1404
 
        """
1405
 
        self.repository = repository
1406
 
        self.format = format
1407
 
        self.bzrdir = a_bzrdir
1408
 
        self.shared = shared
1409
 
 
1410
 
    def __eq__(self, other):
1411
 
        return self.__dict__ == other.__dict__
1412
 
 
1413
 
    def __repr__(self):
1414
 
        if self.repository:
1415
 
            return "<%s for %s>" % (self.__class__.__name__,
1416
 
                self.repository)
1417
 
        else:
1418
 
            return "<%s for %s>" % (self.__class__.__name__,
1419
 
                self.bzrdir)
1420
 
 
1421
 
 
1422
1310
class BzrDirPreSplitOut(BzrDir):
1423
1311
    """A common class for the all-in-one formats."""
1424
1312
 
1463
1351
            tree.clone(result)
1464
1352
        return result
1465
1353
 
1466
 
    def create_branch(self, name=None):
 
1354
    def create_branch(self):
1467
1355
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1356
        return self._format.get_branch_format().initialize(self)
1469
1357
 
1470
 
    def destroy_branch(self, name=None):
 
1358
    def destroy_branch(self):
1471
1359
        """See BzrDir.destroy_branch."""
1472
1360
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1361
 
1529
1417
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1530
1418
                                          self)
1531
1419
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1420
    def get_branch_transport(self, branch_format):
1533
1421
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1422
        if branch_format is None:
1537
1423
            return self.transport
1538
1424
        try:
1571
1457
            format = BzrDirFormat.get_default_format()
1572
1458
        return not isinstance(self._format, format.__class__)
1573
1459
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1460
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1576
1461
        """See BzrDir.open_branch."""
1577
1462
        from bzrlib.branch import BzrBranchFormat4
1578
1463
        format = BzrBranchFormat4()
1579
1464
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1465
        return format.open(self, _found=True)
1581
1466
 
1582
1467
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1468
               possible_transports=None, accelerator_tree=None,
1644
1529
    This is a deprecated format and may be removed after sept 2006.
1645
1530
    """
1646
1531
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
1532
    def open_repository(self):
1652
1533
        """See BzrDir.open_repository."""
1653
1534
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1669
1550
    This is a deprecated format and may be removed after sept 2006.
1670
1551
    """
1671
1552
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
1553
    def open_repository(self):
1677
1554
        """See BzrDir.open_repository."""
1678
1555
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1700
1577
        """See BzrDir.can_convert_format()."""
1701
1578
        return True
1702
1579
 
1703
 
    def create_branch(self, name=None):
 
1580
    def create_branch(self):
1704
1581
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1582
        return self._format.get_branch_format().initialize(self)
1706
1583
 
1707
 
    def destroy_branch(self, name=None):
 
1584
    def destroy_branch(self):
1708
1585
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1586
        self.transport.delete_tree('branch')
1712
1587
 
1713
1588
    def create_repository(self, shared=False):
1756
1631
        format = BranchFormat.find_format(self)
1757
1632
        return format.get_reference(self)
1758
1633
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1634
    def get_branch_transport(self, branch_format):
1760
1635
        """See BzrDir.get_branch_transport()."""
1761
 
        if name is not None:
1762
 
            raise errors.NoColocatedBranchSupport(self)
1763
1636
        # XXX: this shouldn't implicitly create the directory if it's just
1764
1637
        # promising to get a transport -- mbp 20090727
1765
1638
        if branch_format is None:
1802
1675
            pass
1803
1676
        return self.transport.clone('checkout')
1804
1677
 
1805
 
    def has_workingtree(self):
1806
 
        """Tell if this bzrdir contains a working tree.
1807
 
 
1808
 
        This will still raise an exception if the bzrdir has a workingtree that
1809
 
        is remote & inaccessible.
1810
 
 
1811
 
        Note: if you're going to open the working tree, you should just go
1812
 
        ahead and try, and not ask permission first.
1813
 
        """
1814
 
        from bzrlib.workingtree import WorkingTreeFormat
1815
 
        try:
1816
 
            WorkingTreeFormat.find_format(self)
1817
 
        except errors.NoWorkingTree:
1818
 
            return False
1819
 
        return True
1820
 
 
1821
1678
    def needs_format_conversion(self, format=None):
1822
1679
        """See BzrDir.needs_format_conversion()."""
1823
1680
        if format is None:
1836
1693
                return True
1837
1694
        except errors.NoRepositoryPresent:
1838
1695
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1696
        try:
 
1697
            if not isinstance(self.open_branch()._format,
1841
1698
                              format.get_branch_format().__class__):
1842
1699
                # the branch needs an upgrade.
1843
1700
                return True
 
1701
        except errors.NotBranchError:
 
1702
            pass
1844
1703
        try:
1845
1704
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1705
            if not isinstance(my_wt._format,
1851
1710
            pass
1852
1711
        return False
1853
1712
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1713
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1856
1714
        """See BzrDir.open_branch."""
1857
1715
        format = self.find_branch_format()
1858
1716
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1717
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1861
1718
 
1862
1719
    def open_repository(self, unsupported=False):
1863
1720
        """See BzrDir.open_repository."""
1895
1752
    Once a format is deprecated, just deprecate the initialize and open
1896
1753
    methods on the format class. Do not deprecate the object, as the
1897
1754
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1755
    """
1901
1756
 
1902
1757
    _default_format = None
1919
1774
 
1920
1775
    _lock_file_name = 'branch-lock'
1921
1776
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1777
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1778
    # TransportLock or LockDir
1928
1779
 
1945
1796
    def probe_transport(klass, transport):
1946
1797
        """Return the .bzrdir style format present in a directory."""
1947
1798
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1799
            format_string = transport.get(".bzr/branch-format").read()
1949
1800
        except errors.NoSuchFile:
1950
1801
            raise errors.NotBranchError(path=transport.base)
1951
1802
 
2727
2578
    def convert(self, to_convert, pb):
2728
2579
        """See Converter.convert()."""
2729
2580
        self.bzrdir = to_convert
2730
 
        if pb is not None:
2731
 
            warnings.warn("pb parameter to convert() is deprecated")
2732
 
        self.pb = ui.ui_factory.nested_progress_bar()
2733
 
        try:
2734
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
 
            self._convert_to_weaves()
2738
 
            return BzrDir.open(self.bzrdir.user_url)
2739
 
        finally:
2740
 
            self.pb.finished()
 
2581
        self.pb = pb
 
2582
        self.pb.note('starting upgrade from format 4 to 5')
 
2583
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2584
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2585
        self._convert_to_weaves()
 
2586
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
2587
 
2742
2588
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2589
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
2590
        try:
2745
2591
            # TODO permissions
2746
2592
            stat = self.bzrdir.transport.stat('weaves')
2774
2620
        self.pb.clear()
2775
2621
        self._write_all_weaves()
2776
2622
        self._write_all_revs()
2777
 
        ui.ui_factory.note('upgraded to weaves:')
2778
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2779
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2780
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2623
        self.pb.note('upgraded to weaves:')
 
2624
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2625
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2626
        self.pb.note('  %6d texts', self.text_count)
2781
2627
        self._cleanup_spare_files_after_format4()
2782
2628
        self.branch._transport.put_bytes(
2783
2629
            'branch-format',
2851
2697
                       len(self.known_revisions))
2852
2698
        if not self.branch.repository.has_revision(rev_id):
2853
2699
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
2700
            self.pb.note('revision {%s} not present in branch; '
 
2701
                         'will be converted as a ghost',
2856
2702
                         rev_id)
2857
2703
            self.absent_revisions.add(rev_id)
2858
2704
        else:
2984
2830
    def convert(self, to_convert, pb):
2985
2831
        """See Converter.convert()."""
2986
2832
        self.bzrdir = to_convert
2987
 
        pb = ui.ui_factory.nested_progress_bar()
2988
 
        try:
2989
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
 
            self._convert_to_prefixed()
2991
 
            return BzrDir.open(self.bzrdir.user_url)
2992
 
        finally:
2993
 
            pb.finished()
 
2833
        self.pb = pb
 
2834
        self.pb.note('starting upgrade from format 5 to 6')
 
2835
        self._convert_to_prefixed()
 
2836
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
2837
 
2995
2838
    def _convert_to_prefixed(self):
2996
2839
        from bzrlib.store import TransportStore
2997
2840
        self.bzrdir.transport.delete('branch-format')
2998
2841
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2842
            self.pb.note("adding prefixes to %s" % store_name)
3000
2843
            store_transport = self.bzrdir.transport.clone(store_name)
3001
2844
            store = TransportStore(store_transport, prefixed=True)
3002
2845
            for urlfilename in store_transport.list_dir('.'):
3029
2872
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2873
        from bzrlib.branch import BzrBranchFormat5
3031
2874
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2875
        self.pb = pb
3033
2876
        self.count = 0
3034
2877
        self.total = 20 # the steps we know about
3035
2878
        self.garbage_inventories = []
3036
2879
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
2880
        self.file_mode = self.bzrdir._get_file_mode()
3038
2881
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2882
        self.pb.note('starting upgrade from format 6 to metadir')
3040
2883
        self.bzrdir.transport.put_bytes(
3041
2884
                'branch-format',
3042
2885
                "Converting to format 6",
3092
2935
        else:
3093
2936
            has_checkout = True
3094
2937
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
2938
            self.pb.note('No working tree.')
3096
2939
            # If some checkout files are there, we may as well get rid of them.
3097
2940
            for name, mandatory in checkout_files:
3098
2941
                if name in bzrcontents:
3115
2958
            'branch-format',
3116
2959
            BzrDirMetaFormat1().get_format_string(),
3117
2960
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
2961
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
2962
 
3121
2963
    def make_lock(self, name):
3122
2964
        """Make a lock for the new control dir name."""
3157
2999
    def convert(self, to_convert, pb):
3158
3000
        """See Converter.convert()."""
3159
3001
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
3002
        self.pb = pb
3161
3003
        self.count = 0
3162
3004
        self.total = 1
3163
3005
        self.step('checking repository format')
3168
3010
        else:
3169
3011
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
3012
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
3013
                self.pb.note('starting repository conversion')
3172
3014
                converter = CopyConverter(self.target_format.repository_format)
3173
3015
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
 
3016
        try:
 
3017
            branch = self.bzrdir.open_branch()
 
3018
        except errors.NotBranchError:
 
3019
            pass
 
3020
        else:
3175
3021
            # TODO: conversions of Branch and Tree should be done by
3176
3022
            # InterXFormat lookups/some sort of registry.
3177
3023
            # Avoid circular imports
3219
3065
                isinstance(self.target_format.workingtree_format,
3220
3066
                    workingtree_4.WorkingTreeFormat6)):
3221
3067
                workingtree_4.Converter4or5to6().convert(tree)
3222
 
        self.pb.finished()
3223
3068
        return to_convert
3224
3069
 
3225
3070
 
3232
3077
 
3233
3078
    def __init__(self):
3234
3079
        BzrDirMetaFormat1.__init__(self)
3235
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
 
        # like to believe that format objects are stateless or at least
3237
 
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
3080
        self._network_name = None
3240
3081
 
3241
 
    def __repr__(self):
3242
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3243
 
            self._network_name)
3244
 
 
3245
3082
    def get_format_description(self):
3246
 
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
3248
 
            return 'Remote: ' + real_format.get_format_description()
3249
3083
        return 'bzr remote bzrdir'
3250
3084
 
3251
3085
    def get_format_string(self):
3384
3218
        args.append(self._serialize_NoneString(repo_format_name))
3385
3219
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
3220
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
 
        request_network_name = self._network_name or \
 
3221
        if self._network_name is None:
 
3222
            self._network_name = \
3388
3223
            BzrDirFormat.get_default_format().network_name()
3389
3224
        try:
3390
3225
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
 
                request_network_name, path, *args)
 
3226
                self.network_name(), path, *args)
3392
3227
        except errors.UnknownSmartMethod:
3393
3228
            client._medium._remember_remote_is_before((1,16))
3394
3229
            local_dir_format = BzrDirMetaFormat1()
3644
3479
                experimental_pairs.append((key, help))
3645
3480
            else:
3646
3481
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
 
3482
        output += "\nSee ``bzr help formats`` for more about storage formats."
3648
3483
        other_output = ""
3649
3484
        if len(experimental_pairs) > 0:
3650
3485
            other_output += "Experimental formats are shown below.\n\n"
3663
3498
            other_output += \
3664
3499
                "\nNo deprecated formats are available.\n\n"
3665
3500
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
3501
            "\nSee ``bzr help formats`` for more about storage formats."
3667
3502
 
3668
3503
        if topic == 'other-formats':
3669
3504
            return other_output
3703
3538
            try:
3704
3539
                stack_on = urlutils.rebase_url(self._stack_on,
3705
3540
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
 
3541
                    branch.bzrdir.root_transport.base)
3707
3542
            except errors.InvalidRebaseURLs:
3708
3543
                stack_on = self._get_full_stack_on()
3709
3544
        try:
3838
3673
format_registry.register('weave', BzrDirFormat6,
3839
3674
    'Pre-0.8 format.  Slower than knit and does not'
3840
3675
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
3676
    deprecated=True)
3843
3677
format_registry.register_metadir('metaweave',
3844
3678
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
3679
    'Transitional format in 0.8.  Slower than knit.',
3846
3680
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
3681
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
 
    hidden=True,
3849
3682
    deprecated=True)
3850
3683
format_registry.register_metadir('knit',
3851
3684
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
3685
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
3686
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
3687
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
 
    hidden=True,
3856
3688
    deprecated=True)
3857
3689
format_registry.register_metadir('dirstate',
3858
3690
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
3694
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
3695
    # directly from workingtree_4 triggers a circular import.
3864
3696
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
3697
    deprecated=True)
3867
3698
format_registry.register_metadir('dirstate-tags',
3868
3699
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3871
3702
        ' Incompatible with bzr < 0.15.',
3872
3703
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
3704
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
3705
    deprecated=True)
3876
3706
format_registry.register_metadir('rich-root',
3877
3707
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3879
3709
        ' bzr < 1.0.',
3880
3710
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
3711
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
3712
    deprecated=True)
3884
3713
format_registry.register_metadir('dirstate-with-subtree',
3885
3714
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
3725
    help='New in 0.92: Pack-based format with data compatible with '
3897
3726
        'dirstate-tags format repositories. Interoperates with '
3898
3727
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
 
3728
        'Previously called knitpack-experimental.  '
 
3729
        'For more information, see '
 
3730
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3900
3731
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
3732
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
3733
    )
3905
3736
    help='New in 0.92: Pack-based format with data compatible with '
3906
3737
        'dirstate-with-subtree format repositories. Interoperates with '
3907
3738
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
 
3739
        'Previously called knitpack-experimental.  '
 
3740
        'For more information, see '
 
3741
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3909
3742
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
3743
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
3744
    hidden=True,
3917
3750
         '(needed for bzr-svn and bzr-git).',
3918
3751
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
3752
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
3753
    )
3922
3754
format_registry.register_metadir('1.6',
3923
3755
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3926
3758
         'not present locally.',
3927
3759
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
3760
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
3761
    )
3931
3762
format_registry.register_metadir('1.6.1-rich-root',
3932
3763
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3934
3765
         '(needed for bzr-svn and bzr-git).',
3935
3766
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
3767
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
3768
    )
3939
3769
format_registry.register_metadir('1.9',
3940
3770
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3943
3773
         'performance for most operations.',
3944
3774
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
3775
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
3776
    )
3948
3777
format_registry.register_metadir('1.9-rich-root',
3949
3778
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3951
3780
         '(needed for bzr-svn and bzr-git).',
3952
3781
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
3782
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
3783
    )
3956
3784
format_registry.register_metadir('1.14',
3957
3785
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3973
3801
        'to and from rich-root-pack (and anything compatible with '
3974
3802
        'rich-root-pack) format repositories. Repositories and branches in '
3975
3803
        'this format can only be read by bzr.dev. Please read '
3976
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3804
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3977
3805
        'before use.',
3978
3806
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
3807
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3980
3808
    experimental=True,
3981
3809
    alias=True,
3982
 
    hidden=True,
3983
3810
    )
3984
3811
format_registry.register_metadir('development-subtree',
3985
3812
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3987
3814
        'from pack-0.92-subtree (and anything compatible with '
3988
3815
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
3816
        'this format can only be read by bzr.dev. Please read '
3990
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3817
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3991
3818
        'before use.',
3992
3819
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
3820
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3994
3821
    experimental=True,
3995
 
    hidden=True,
3996
3822
    alias=False, # Restore to being an alias when an actual development subtree format is added
3997
3823
                 # This current non-alias status is simply because we did not introduce a
3998
3824
                 # chk based subtree format.
4003
3829
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
3830
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4005
3831
        'Please read '
4006
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3832
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
4007
3833
        'before use.',
4008
3834
    branch_format='bzrlib.branch.BzrBranchFormat7',
4009
3835
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4015
3841
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
3842
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
3843
        'rich roots. Please read '
4018
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3844
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
4019
3845
        'before use.',
4020
3846
    branch_format='bzrlib.branch.BzrBranchFormat7',
4021
3847
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4042
3868
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
3869
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4044
3870
    alias=True,
4045
 
    hidden=True,
4046
3871
    help='Same as 2a.')
4047
3872
 
4048
3873
# The current format that is made on 'bzr init'.