~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-06 10:12:42 UTC
  • mto: This revision was merged to the branch mainline in revision 5135.
  • Revision ID: v.ladeuil+lp@free.fr-20100406101242-rcg0zelo6y2ca808
Some more cleanup and typos.

Show diffs side-by-side

added added

removed removed

Lines of Context:
60
60
from bzrlib.workingtree import WorkingTree
61
61
""")
62
62
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
63
from bzrlib.commands import Command, display_command
68
64
from bzrlib.option import (
69
65
    ListOption,
70
66
    Option,
239
235
# opens the branch?)
240
236
 
241
237
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
238
    """Display status summary.
243
239
 
244
240
    This reports on versioned and unknown files, reporting them
245
241
    grouped by state.  Possible states are:
332
328
 
333
329
 
334
330
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
331
    """Write out metadata for a revision.
336
332
 
337
333
    The revision to print can either be specified by a specific
338
334
    revision identifier, or you can use --revision.
390
386
        
391
387
 
392
388
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
389
    """Dump the contents of a btree index file to stdout.
394
390
 
395
391
    PATH is a btree index file, it can be any URL. This includes things like
396
392
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
471
467
 
472
468
 
473
469
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
470
    """Remove the working tree from a given branch/checkout.
475
471
 
476
472
    Since a lightweight checkout is little more than a working tree
477
473
    this will refuse to run against one.
504
500
                if (working.has_changes()):
505
501
                    raise errors.UncommittedChanges(working)
506
502
 
507
 
            if working.user_url != working.branch.user_url:
 
503
            working_path = working.bzrdir.root_transport.base
 
504
            branch_path = working.branch.bzrdir.root_transport.base
 
505
            if working_path != branch_path:
508
506
                raise errors.BzrCommandError("You cannot remove the working tree"
509
507
                                             " from a lightweight checkout")
510
508
 
512
510
 
513
511
 
514
512
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
513
    """Show current revision number.
516
514
 
517
515
    This is equal to the number of revisions on this branch.
518
516
    """
528
526
        if tree:
529
527
            try:
530
528
                wt = WorkingTree.open_containing(location)[0]
531
 
                self.add_cleanup(wt.lock_read().unlock)
 
529
                wt.lock_read()
532
530
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
531
                raise errors.NoWorkingTree(location)
 
532
            self.add_cleanup(wt.unlock)
534
533
            revid = wt.last_revision()
535
534
            try:
536
535
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
539
538
            revno = ".".join(str(n) for n in revno_t)
540
539
        else:
541
540
            b = Branch.open_containing(location)[0]
542
 
            self.add_cleanup(b.lock_read().unlock)
 
541
            b.lock_read()
 
542
            self.add_cleanup(b.unlock)
543
543
            revno = b.revno()
544
544
        self.cleanup_now()
545
545
        self.outf.write(str(revno) + '\n')
546
546
 
547
547
 
548
548
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
549
    """Show revision number and revision id for a given revision identifier.
550
550
    """
551
551
    hidden = True
552
552
    takes_args = ['revision_info*']
568
568
        try:
569
569
            wt = WorkingTree.open_containing(directory)[0]
570
570
            b = wt.branch
571
 
            self.add_cleanup(wt.lock_read().unlock)
 
571
            wt.lock_read()
 
572
            self.add_cleanup(wt.unlock)
572
573
        except (errors.NoWorkingTree, errors.NotLocalUrl):
573
574
            wt = None
574
575
            b = Branch.open_containing(directory)[0]
575
 
            self.add_cleanup(b.lock_read().unlock)
 
576
            b.lock_read()
 
577
            self.add_cleanup(b.unlock)
576
578
        revision_ids = []
577
579
        if revision is not None:
578
580
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
606
608
 
607
609
 
608
610
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
611
    """Add specified files or directories.
610
612
 
611
613
    In non-recursive mode, all the named items are added, regardless
612
614
    of whether they were previously ignored.  A warning is given if
677
679
                should_print=(not is_quiet()))
678
680
 
679
681
        if base_tree:
680
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
682
            base_tree.lock_read()
 
683
            self.add_cleanup(base_tree.unlock)
681
684
        tree, file_list = tree_files_for_add(file_list)
682
685
        added, ignored = tree.smart_add(file_list, not
683
686
            no_recurse, action=action, save=not dry_run)
691
694
 
692
695
 
693
696
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
697
    """Create a new versioned directory.
695
698
 
696
699
    This is equivalent to creating the directory and then adding it.
697
700
    """
713
716
 
714
717
 
715
718
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
719
    """Show path of a file relative to root"""
717
720
 
718
721
    takes_args = ['filename']
719
722
    hidden = True
728
731
 
729
732
 
730
733
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
734
    """Show inventory of the current working copy or a revision.
732
735
 
733
736
    It is possible to limit the output to a particular entry
734
737
    type using the --kind option.  For example: --kind file.
755
758
 
756
759
        revision = _get_one_revision('inventory', revision)
757
760
        work_tree, file_list = tree_files(file_list)
758
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
761
        work_tree.lock_read()
 
762
        self.add_cleanup(work_tree.unlock)
759
763
        if revision is not None:
760
764
            tree = revision.as_tree(work_tree.branch)
761
765
 
762
766
            extra_trees = [work_tree]
763
 
            self.add_cleanup(tree.lock_read().unlock)
 
767
            tree.lock_read()
 
768
            self.add_cleanup(tree.unlock)
764
769
        else:
765
770
            tree = work_tree
766
771
            extra_trees = []
787
792
 
788
793
 
789
794
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
795
    """Move or rename a file.
791
796
 
792
797
    :Usage:
793
798
        bzr mv OLDNAME NEWNAME
826
831
        if len(names_list) < 2:
827
832
            raise errors.BzrCommandError("missing file argument")
828
833
        tree, rel_names = tree_files(names_list, canonicalize=False)
829
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
834
        tree.lock_tree_write()
 
835
        self.add_cleanup(tree.unlock)
830
836
        self._run(tree, names_list, rel_names, after)
831
837
 
832
838
    def run_auto(self, names_list, after, dry_run):
837
843
            raise errors.BzrCommandError('--after cannot be specified with'
838
844
                                         ' --auto.')
839
845
        work_tree, file_list = tree_files(names_list, default_branch='.')
840
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
846
        work_tree.lock_tree_write()
 
847
        self.add_cleanup(work_tree.unlock)
841
848
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
842
849
 
843
850
    def _run(self, tree, names_list, rel_names, after):
922
929
 
923
930
 
924
931
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
932
    """Turn this branch into a mirror of another branch.
926
933
 
927
934
    By default, this command only works on branches that have not diverged.
928
935
    Branches are considered diverged if the destination branch's most recent 
977
984
        try:
978
985
            tree_to = WorkingTree.open_containing(directory)[0]
979
986
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
987
        except errors.NoWorkingTree:
982
988
            tree_to = None
983
989
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
 
990
        
986
991
        if local and not branch_to.get_bound_location():
987
992
            raise errors.LocalRequiresBoundBranch()
988
993
 
1018
1023
        else:
1019
1024
            branch_from = Branch.open(location,
1020
1025
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
1026
 
1023
1027
            if branch_to.get_parent() is None or remember:
1024
1028
                branch_to.set_parent(branch_from.base)
1025
1029
 
 
1030
        if branch_from is not branch_to:
 
1031
            branch_from.lock_read()
 
1032
            self.add_cleanup(branch_from.unlock)
1026
1033
        if revision is not None:
1027
1034
            revision_id = revision.as_revision_id(branch_from)
1028
1035
 
 
1036
        branch_to.lock_write()
 
1037
        self.add_cleanup(branch_to.unlock)
1029
1038
        if tree_to is not None:
1030
1039
            view_info = _get_view_info_for_change_reporter(tree_to)
1031
1040
            change_reporter = delta._ChangeReporter(
1046
1055
 
1047
1056
 
1048
1057
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
 
1058
    """Update a mirror of this branch.
1050
1059
 
1051
1060
    The target branch will not have its working tree populated because this
1052
1061
    is both expensive, and is not supported on remote file systems.
1113
1122
        # Get the source branch
1114
1123
        (tree, br_from,
1115
1124
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1125
        if strict is None:
 
1126
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1127
        if strict is None: strict = True # default value
1116
1128
        # Get the tip's revision_id
1117
1129
        revision = _get_one_revision('push', revision)
1118
1130
        if revision is not None:
1119
1131
            revision_id = revision.in_history(br_from).rev_id
1120
1132
        else:
1121
1133
            revision_id = None
1122
 
        if tree is not None and revision_id is None:
1123
 
            tree.check_changed_or_out_of_date(
1124
 
                strict, 'push_strict',
1125
 
                more_error='Use --no-strict to force the push.',
1126
 
                more_warning='Uncommitted changes will not be pushed.')
 
1134
        if strict and tree is not None and revision_id is None:
 
1135
            if (tree.has_changes()):
 
1136
                raise errors.UncommittedChanges(
 
1137
                    tree, more='Use --no-strict to force the push.')
 
1138
            if tree.last_revision() != tree.branch.last_revision():
 
1139
                # The tree has lost sync with its branch, there is little
 
1140
                # chance that the user is aware of it but he can still force
 
1141
                # the push with --no-strict
 
1142
                raise errors.OutOfDateTree(
 
1143
                    tree, more='Use --no-strict to force the push.')
 
1144
 
1127
1145
        # Get the stacked_on branch, if any
1128
1146
        if stacked_on is not None:
1129
1147
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1179
 
1162
1180
 
1163
1181
class cmd_branch(Command):
1164
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1182
    """Create a new branch that is a copy of an existing branch.
1165
1183
 
1166
1184
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1185
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1207
1225
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1226
            from_location)
1209
1227
        revision = _get_one_revision('branch', revision)
1210
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1228
        br_from.lock_read()
 
1229
        self.add_cleanup(br_from.unlock)
1211
1230
        if revision is not None:
1212
1231
            revision_id = revision.as_revision_id(br_from)
1213
1232
        else:
1273
1292
 
1274
1293
 
1275
1294
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1295
    """Create a new checkout of an existing branch.
1277
1296
 
1278
1297
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1298
    the branch found in '.'. This is useful if you have removed the working tree
1342
1361
 
1343
1362
 
1344
1363
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1364
    """Show list of renamed files.
1346
1365
    """
1347
1366
    # TODO: Option to show renames between two historical versions.
1348
1367
 
1353
1372
    @display_command
1354
1373
    def run(self, dir=u'.'):
1355
1374
        tree = WorkingTree.open_containing(dir)[0]
1356
 
        self.add_cleanup(tree.lock_read().unlock)
 
1375
        tree.lock_read()
 
1376
        self.add_cleanup(tree.unlock)
1357
1377
        new_inv = tree.inventory
1358
1378
        old_tree = tree.basis_tree()
1359
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1379
        old_tree.lock_read()
 
1380
        self.add_cleanup(old_tree.unlock)
1360
1381
        old_inv = old_tree.inventory
1361
1382
        renames = []
1362
1383
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1372
1393
 
1373
1394
 
1374
1395
class cmd_update(Command):
1375
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1396
    """Update a tree to have the latest code committed to its branch.
1376
1397
 
1377
1398
    This will perform a merge into the working tree, and may generate
1378
1399
    conflicts. If you have any local changes, you will still
1400
1421
        master = branch.get_master_branch(
1401
1422
            possible_transports=possible_transports)
1402
1423
        if master is not None:
 
1424
            tree.lock_write()
1403
1425
            branch_location = master.base
1404
 
            tree.lock_write()
1405
1426
        else:
 
1427
            tree.lock_tree_write()
1406
1428
            branch_location = tree.branch.base
1407
 
            tree.lock_tree_write()
1408
1429
        self.add_cleanup(tree.unlock)
1409
1430
        # get rid of the final '/' and be ready for display
1410
 
        branch_location = urlutils.unescape_for_display(
1411
 
            branch_location.rstrip('/'),
1412
 
            self.outf.encoding)
 
1431
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1432
                                                        self.outf.encoding)
1413
1433
        existing_pending_merges = tree.get_parent_ids()[1:]
1414
1434
        if master is None:
1415
1435
            old_tip = None
1423
1443
        else:
1424
1444
            revision_id = branch.last_revision()
1425
1445
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1427
 
            note("Tree is up to date at revision %s of branch %s" %
1428
 
                ('.'.join(map(str, revno)), branch_location))
 
1446
            revno = branch.revision_id_to_revno(revision_id)
 
1447
            note("Tree is up to date at revision %d of branch %s" %
 
1448
                (revno, branch_location))
1429
1449
            return 0
1430
1450
        view_info = _get_view_info_for_change_reporter(tree)
1431
1451
        change_reporter = delta._ChangeReporter(
1443
1463
                                  "bzr update --revision only works"
1444
1464
                                  " for a revision in the branch history"
1445
1465
                                  % (e.revision))
1446
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1466
        revno = tree.branch.revision_id_to_revno(
1447
1467
            _mod_revision.ensure_null(tree.last_revision()))
1448
 
        note('Updated to revision %s of branch %s' %
1449
 
             ('.'.join(map(str, revno)), branch_location))
1450
 
        parent_ids = tree.get_parent_ids()
1451
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1468
        note('Updated to revision %d of branch %s' %
 
1469
             (revno, branch_location))
 
1470
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1452
1471
            note('Your local commits will now show as pending merges with '
1453
1472
                 "'bzr status', and can be committed with 'bzr commit'.")
1454
1473
        if conflicts != 0:
1458
1477
 
1459
1478
 
1460
1479
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1480
    """Show information about a working tree, branch or repository.
1462
1481
 
1463
1482
    This command will show all known locations and formats associated to the
1464
1483
    tree, branch or repository.
1502
1521
 
1503
1522
 
1504
1523
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1524
    """Remove files or directories.
1506
1525
 
1507
1526
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1527
    them if they can easily be recovered using revert. If no options or
1530
1549
        if file_list is not None:
1531
1550
            file_list = [f for f in file_list]
1532
1551
 
1533
 
        self.add_cleanup(tree.lock_write().unlock)
 
1552
        tree.lock_write()
 
1553
        self.add_cleanup(tree.unlock)
1534
1554
        # Heuristics should probably all move into tree.remove_smart or
1535
1555
        # some such?
1536
1556
        if new:
1555
1575
 
1556
1576
 
1557
1577
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1578
    """Print file_id of a particular file or directory.
1559
1579
 
1560
1580
    The file_id is assigned when the file is first added and remains the
1561
1581
    same through all revisions where the file exists, even when it is
1577
1597
 
1578
1598
 
1579
1599
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1600
    """Print path of file_ids to a file or directory.
1581
1601
 
1582
1602
    This prints one line for each directory down to the target,
1583
1603
    starting at the branch root.
1599
1619
 
1600
1620
 
1601
1621
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1622
    """Reconcile bzr metadata in a branch.
1603
1623
 
1604
1624
    This can correct data mismatches that may have been caused by
1605
1625
    previous ghost operations or bzr upgrades. You should only
1627
1647
 
1628
1648
 
1629
1649
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1650
    """Display the list of revision ids on a branch."""
1631
1651
 
1632
1652
    _see_also = ['log']
1633
1653
    takes_args = ['location?']
1643
1663
 
1644
1664
 
1645
1665
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1666
    """List all revisions merged into this branch."""
1647
1667
 
1648
1668
    _see_also = ['log', 'revision-history']
1649
1669
    takes_args = ['location?']
1668
1688
 
1669
1689
 
1670
1690
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1691
    """Make a directory into a versioned branch.
1672
1692
 
1673
1693
    Use this to create an empty branch, or before importing an
1674
1694
    existing project.
1777
1797
 
1778
1798
 
1779
1799
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1800
    """Create a shared repository for branches to share storage space.
1781
1801
 
1782
1802
    New branches created under the repository directory will store their
1783
1803
    revisions in the repository, not in the branch directory.  For branches
1837
1857
 
1838
1858
 
1839
1859
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1860
    """Show differences in the working tree, between revisions or branches.
1841
1861
 
1842
1862
    If no arguments are given, all changes for the current tree are listed.
1843
1863
    If files are given, only the changes in those files are listed.
1929
1949
            help='Use this command to compare files.',
1930
1950
            type=unicode,
1931
1951
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1952
        ]
1937
1953
    aliases = ['di', 'dif']
1938
1954
    encoding_type = 'exact'
1939
1955
 
1940
1956
    @display_command
1941
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1942
 
            prefix=None, old=None, new=None, using=None, format=None):
1943
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
 
            show_diff_trees)
 
1958
            prefix=None, old=None, new=None, using=None):
 
1959
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1945
1960
 
1946
1961
        if (prefix is None) or (prefix == '0'):
1947
1962
            # diff -p0 format
1961
1976
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1977
                                         ' one or two revision specifiers')
1963
1978
 
1964
 
        if using is not None and format is not None:
1965
 
            raise errors.BzrCommandError('--using and --format are mutually '
1966
 
                'exclusive.')
1967
 
 
1968
1979
        (old_tree, new_tree,
1969
1980
         old_branch, new_branch,
1970
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1981
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1982
            file_list, revision, old, new, apply_view=True)
1972
1983
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1984
                               specific_files=specific_files,
1974
1985
                               external_diff_options=diff_options,
1975
1986
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1987
                               extra_trees=extra_trees, using=using)
1978
1988
 
1979
1989
 
1980
1990
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1991
    """List files deleted in the working tree.
1982
1992
    """
1983
1993
    # TODO: Show files deleted since a previous revision, or
1984
1994
    # between two revisions.
1992
2002
    @display_command
1993
2003
    def run(self, show_ids=False):
1994
2004
        tree = WorkingTree.open_containing(u'.')[0]
1995
 
        self.add_cleanup(tree.lock_read().unlock)
 
2005
        tree.lock_read()
 
2006
        self.add_cleanup(tree.unlock)
1996
2007
        old = tree.basis_tree()
1997
 
        self.add_cleanup(old.lock_read().unlock)
 
2008
        old.lock_read()
 
2009
        self.add_cleanup(old.unlock)
1998
2010
        for path, ie in old.inventory.iter_entries():
1999
2011
            if not tree.has_id(ie.file_id):
2000
2012
                self.outf.write(path)
2005
2017
 
2006
2018
 
2007
2019
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
2020
    """List files modified in working tree.
2009
2021
    """
2010
2022
 
2011
2023
    hidden = True
2028
2040
 
2029
2041
 
2030
2042
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2043
    """List files added in working tree.
2032
2044
    """
2033
2045
 
2034
2046
    hidden = True
2042
2054
    @display_command
2043
2055
    def run(self, null=False):
2044
2056
        wt = WorkingTree.open_containing(u'.')[0]
2045
 
        self.add_cleanup(wt.lock_read().unlock)
 
2057
        wt.lock_read()
 
2058
        self.add_cleanup(wt.unlock)
2046
2059
        basis = wt.basis_tree()
2047
 
        self.add_cleanup(basis.lock_read().unlock)
 
2060
        basis.lock_read()
 
2061
        self.add_cleanup(basis.unlock)
2048
2062
        basis_inv = basis.inventory
2049
2063
        inv = wt.inventory
2050
2064
        for file_id in inv:
2062
2076
 
2063
2077
 
2064
2078
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
2079
    """Show the tree root directory.
2066
2080
 
2067
2081
    The root is the nearest enclosing directory with a .bzr control
2068
2082
    directory."""
2092
2106
 
2093
2107
 
2094
2108
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2109
    """Show historical log for a branch or subset of a branch.
2096
2110
 
2097
2111
    log is bzr's default tool for exploring the history of a branch.
2098
2112
    The branch to use is taken from the first parameter. If no parameters
2279
2293
                   help='Show changes made in each revision as a patch.'),
2280
2294
            Option('include-merges',
2281
2295
                   help='Show merged revisions like --levels 0 does.'),
2282
 
            Option('exclude-common-ancestry',
2283
 
                   help='Display only the revisions that are not part'
2284
 
                   ' of both ancestries (require -rX..Y)'
2285
 
                   )
2286
2296
            ]
2287
2297
    encoding_type = 'replace'
2288
2298
 
2298
2308
            message=None,
2299
2309
            limit=None,
2300
2310
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
 
2311
            include_merges=False):
2304
2312
        from bzrlib.log import (
2305
2313
            Logger,
2306
2314
            make_log_request_dict,
2307
2315
            _get_info_for_log_files,
2308
2316
            )
2309
2317
        direction = (forward and 'forward') or 'reverse'
2310
 
        if (exclude_common_ancestry
2311
 
            and (revision is None or len(revision) != 2)):
2312
 
            raise errors.BzrCommandError(
2313
 
                '--exclude-common-ancestry requires -r with two revisions')
2314
2318
        if include_merges:
2315
2319
            if levels is None:
2316
2320
                levels = 0
2332
2336
        if file_list:
2333
2337
            # find the file ids to log and check for directory filtering
2334
2338
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
 
                revision, file_list, self.add_cleanup)
 
2339
                revision, file_list)
 
2340
            self.add_cleanup(b.unlock)
2336
2341
            for relpath, file_id, kind in file_info_list:
2337
2342
                if file_id is None:
2338
2343
                    raise errors.BzrCommandError(
2356
2361
                location = '.'
2357
2362
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2363
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
 
2364
            b.lock_read()
 
2365
            self.add_cleanup(b.unlock)
2360
2366
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
2367
 
2362
2368
        # Decide on the type of delta & diff filtering to use
2407
2413
            direction=direction, specific_fileids=file_ids,
2408
2414
            start_revision=rev1, end_revision=rev2, limit=limit,
2409
2415
            message_search=message, delta_type=delta_type,
2410
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
 
            exclude_common_ancestry=exclude_common_ancestry,
2412
 
            )
 
2416
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2413
2417
        Logger(b, rqst).show(lf)
2414
2418
 
2415
2419
 
2473
2477
 
2474
2478
 
2475
2479
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2480
    """Return revision-ids which affected a particular file.
2477
2481
 
2478
2482
    A more user-friendly interface is "bzr log FILE".
2479
2483
    """
2486
2490
        tree, relpath = WorkingTree.open_containing(filename)
2487
2491
        file_id = tree.path2id(relpath)
2488
2492
        b = tree.branch
2489
 
        self.add_cleanup(b.lock_read().unlock)
 
2493
        b.lock_read()
 
2494
        self.add_cleanup(b.unlock)
2490
2495
        touching_revs = log.find_touching_revisions(b, file_id)
2491
2496
        for revno, revision_id, what in touching_revs:
2492
2497
            self.outf.write("%6d %s\n" % (revno, what))
2493
2498
 
2494
2499
 
2495
2500
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2501
    """List files in a tree.
2497
2502
    """
2498
2503
 
2499
2504
    _see_also = ['status', 'cat']
2561
2566
                view_str = views.view_display_str(view_files)
2562
2567
                note("Ignoring files outside view. View is %s" % view_str)
2563
2568
 
2564
 
        self.add_cleanup(tree.lock_read().unlock)
 
2569
        tree.lock_read()
 
2570
        self.add_cleanup(tree.unlock)
2565
2571
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
2572
            from_dir=relpath, recursive=recursive):
2567
2573
            # Apply additional masking
2609
2615
 
2610
2616
 
2611
2617
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2618
    """List unknown files.
2613
2619
    """
2614
2620
 
2615
2621
    hidden = True
2622
2628
 
2623
2629
 
2624
2630
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2631
    """Ignore specified files or patterns.
2626
2632
 
2627
2633
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2634
 
2637
2643
    using this command or directly by using an editor, be sure to commit
2638
2644
    it.
2639
2645
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
2646
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
2647
    precedence over regular ignores.  Such exceptions are used to specify
2648
2648
    files that should be versioned which would otherwise be ignored.
2689
2689
    _see_also = ['status', 'ignored', 'patterns']
2690
2690
    takes_args = ['name_pattern*']
2691
2691
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2692
        Option('old-default-rules',
 
2693
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2694
        ]
2695
2695
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2696
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2697
        from bzrlib import ignores
2698
 
        if default_rules is not None:
2699
 
            # dump the default rules and exit
2700
 
            for pattern in ignores.USER_DEFAULTS:
 
2698
        if old_default_rules is not None:
 
2699
            # dump the rules and exit
 
2700
            for pattern in ignores.OLD_DEFAULTS:
2701
2701
                self.outf.write("%s\n" % pattern)
2702
2702
            return
2703
2703
        if not name_pattern_list:
2704
2704
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
 
2705
                                  "NAME_PATTERN or --old-default-rules")
2706
2706
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2707
                             for p in name_pattern_list]
2708
2708
        for name_pattern in name_pattern_list:
2730
2730
 
2731
2731
 
2732
2732
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2733
    """List ignored files and the patterns that matched them.
2734
2734
 
2735
2735
    List all the ignored files and the ignore pattern that caused the file to
2736
2736
    be ignored.
2746
2746
    @display_command
2747
2747
    def run(self):
2748
2748
        tree = WorkingTree.open_containing(u'.')[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
 
2749
        tree.lock_read()
 
2750
        self.add_cleanup(tree.unlock)
2750
2751
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
2752
            if file_class != 'I':
2752
2753
                continue
2756
2757
 
2757
2758
 
2758
2759
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2760
    """Lookup the revision-id from a revision-number
2760
2761
 
2761
2762
    :Examples:
2762
2763
        bzr lookup-revision 33
2776
2777
 
2777
2778
 
2778
2779
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2780
    """Export current or past revision to a destination directory or archive.
2780
2781
 
2781
2782
    If no revision is specified this exports the last committed revision.
2782
2783
 
2839
2840
 
2840
2841
 
2841
2842
class cmd_cat(Command):
2842
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2843
    """Write the contents of a file as of a given revision to standard output.
2843
2844
 
2844
2845
    If no revision is nominated, the last revision is used.
2845
2846
 
2865
2866
                                         " one revision specifier")
2866
2867
        tree, branch, relpath = \
2867
2868
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
 
        self.add_cleanup(branch.lock_read().unlock)
 
2869
        branch.lock_read()
 
2870
        self.add_cleanup(branch.unlock)
2869
2871
        return self._run(tree, branch, relpath, filename, revision,
2870
2872
                         name_from_revision, filters)
2871
2873
 
2874
2876
        if tree is None:
2875
2877
            tree = b.basis_tree()
2876
2878
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2879
        rev_tree.lock_read()
 
2880
        self.add_cleanup(rev_tree.unlock)
2878
2881
 
2879
2882
        old_file_id = rev_tree.path2id(relpath)
2880
2883
 
2923
2926
 
2924
2927
 
2925
2928
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2929
    """Show the offset in seconds from GMT to local time."""
2927
2930
    hidden = True
2928
2931
    @display_command
2929
2932
    def run(self):
2932
2935
 
2933
2936
 
2934
2937
class cmd_commit(Command):
2935
 
    __doc__ = """Commit changes into a new revision.
 
2938
    """Commit changes into a new revision.
2936
2939
 
2937
2940
    An explanatory message needs to be given for each commit. This is
2938
2941
    often done by using the --message option (getting the message from the
3046
3049
                         "the master branch until a normal commit "
3047
3050
                         "is performed."
3048
3051
                    ),
3049
 
             Option('show-diff', short_name='p',
 
3052
             Option('show-diff',
3050
3053
                    help='When no message is supplied, show the diff along'
3051
3054
                    ' with the status summary in the message editor.'),
3052
3055
             ]
3132
3135
                    '(use --file "%(f)s" to take commit message from that file)'
3133
3136
                    % { 'f': message })
3134
3137
                ui.ui_factory.show_warning(warning_msg)
3135
 
            if '\r' in message:
3136
 
                message = message.replace('\r\n', '\n')
3137
 
                message = message.replace('\r', '\n')
3138
 
            if file:
3139
 
                raise errors.BzrCommandError(
3140
 
                    "please specify either --message or --file")
3141
3138
 
3142
3139
        def get_message(commit_obj):
3143
3140
            """Callback to get commit message"""
3144
 
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
3147
 
            elif message is not None:
3148
 
                my_message = message
3149
 
            else:
3150
 
                # No message supplied: make one up.
3151
 
                # text is the status of the tree
3152
 
                text = make_commit_message_template_encoded(tree,
 
3141
            my_message = message
 
3142
            if my_message is not None and '\r' in my_message:
 
3143
                my_message = my_message.replace('\r\n', '\n')
 
3144
                my_message = my_message.replace('\r', '\n')
 
3145
            if my_message is None and not file:
 
3146
                t = make_commit_message_template_encoded(tree,
3153
3147
                        selected_list, diff=show_diff,
3154
3148
                        output_encoding=osutils.get_user_encoding())
3155
 
                # start_message is the template generated from hooks
3156
 
                # XXX: Warning - looks like hooks return unicode,
3157
 
                # make_commit_message_template_encoded returns user encoding.
3158
 
                # We probably want to be using edit_commit_message instead to
3159
 
                # avoid this.
3160
3149
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
3150
                my_message = edit_commit_message_encoded(t,
3162
3151
                    start_message=start_message)
3163
3152
                if my_message is None:
3164
3153
                    raise errors.BzrCommandError("please specify a commit"
3165
3154
                        " message with either --message or --file")
 
3155
            elif my_message and file:
 
3156
                raise errors.BzrCommandError(
 
3157
                    "please specify either --message or --file")
 
3158
            if file:
 
3159
                my_message = codecs.open(file, 'rt',
 
3160
                                         osutils.get_user_encoding()).read()
3166
3161
            if my_message == "":
3167
3162
                raise errors.BzrCommandError("empty commit message specified")
3168
3163
            return my_message
3180
3175
                        timezone=offset,
3181
3176
                        exclude=safe_relpath_files(tree, exclude))
3182
3177
        except PointlessCommit:
 
3178
            # FIXME: This should really happen before the file is read in;
 
3179
            # perhaps prepare the commit; get the message; then actually commit
3183
3180
            raise errors.BzrCommandError("No changes to commit."
3184
3181
                              " Use --unchanged to commit anyhow.")
3185
3182
        except ConflictsInTree:
3198
3195
 
3199
3196
 
3200
3197
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3198
    """Validate working tree structure, branch consistency and repository history.
3202
3199
 
3203
3200
    This command checks various invariants about branch and repository storage
3204
3201
    to detect data corruption or bzr bugs.
3268
3265
 
3269
3266
 
3270
3267
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
3268
    """Upgrade branch storage to current format.
3272
3269
 
3273
3270
    The check command or bzr developers may sometimes advise you to run
3274
3271
    this command. When the default format has changed you may also be warned
3292
3289
 
3293
3290
 
3294
3291
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
 
3292
    """Show or set bzr user id.
3296
3293
 
3297
3294
    :Examples:
3298
3295
        Show the email of the current user::
3342
3339
 
3343
3340
 
3344
3341
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
3342
    """Print or set the branch nickname.
3346
3343
 
3347
3344
    If unset, the tree root directory name is used as the nickname.
3348
3345
    To print the current nickname, execute with no argument.
3366
3363
 
3367
3364
 
3368
3365
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
3366
    """Set/unset and display aliases.
3370
3367
 
3371
3368
    :Examples:
3372
3369
        Show the current aliases::
3436
3433
 
3437
3434
 
3438
3435
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
 
3436
    """Run internal test suite.
3440
3437
 
3441
3438
    If arguments are given, they are regular expressions that say which tests
3442
3439
    should run.  Tests matching any expression are run, and other tests are
3583
3580
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3581
                    "needs to be installed to use --subunit.")
3585
3582
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
 
                import msvcrt
3590
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
3583
        if parallel:
3592
3584
            self.additional_selftest_args.setdefault(
3593
3585
                'suite_decorators', []).append(parallel)
3624
3616
 
3625
3617
 
3626
3618
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3619
    """Show version of bzr."""
3628
3620
 
3629
3621
    encoding_type = 'replace'
3630
3622
    takes_options = [
3641
3633
 
3642
3634
 
3643
3635
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3636
    """Statement of optimism."""
3645
3637
 
3646
3638
    hidden = True
3647
3639
 
3651
3643
 
3652
3644
 
3653
3645
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3646
    """Find and print a base revision for merging two branches."""
3655
3647
    # TODO: Options to specify revisions on either side, as if
3656
3648
    #       merging only part of the history.
3657
3649
    takes_args = ['branch', 'other']
3663
3655
 
3664
3656
        branch1 = Branch.open_containing(branch)[0]
3665
3657
        branch2 = Branch.open_containing(other)[0]
3666
 
        self.add_cleanup(branch1.lock_read().unlock)
3667
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3658
        branch1.lock_read()
 
3659
        self.add_cleanup(branch1.unlock)
 
3660
        branch2.lock_read()
 
3661
        self.add_cleanup(branch2.unlock)
3668
3662
        last1 = ensure_null(branch1.last_revision())
3669
3663
        last2 = ensure_null(branch2.last_revision())
3670
3664
 
3675
3669
 
3676
3670
 
3677
3671
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
 
3672
    """Perform a three-way merge.
3679
3673
 
3680
3674
    The source of the merge can be specified either in the form of a branch,
3681
3675
    or in the form of a path to a file containing a merge directive generated
3808
3802
            unversioned_filter=tree.is_ignored, view_info=view_info)
3809
3803
        pb = ui.ui_factory.nested_progress_bar()
3810
3804
        self.add_cleanup(pb.finished)
3811
 
        self.add_cleanup(tree.lock_write().unlock)
 
3805
        tree.lock_write()
 
3806
        self.add_cleanup(tree.unlock)
3812
3807
        if location is not None:
3813
3808
            try:
3814
3809
                mergeable = bundle.read_mergeable_from_url(location,
4035
4030
 
4036
4031
 
4037
4032
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
4033
    """Redo a merge.
4039
4034
 
4040
4035
    Use this if you want to try a different merge technique while resolving
4041
4036
    conflicts.  Some merge techniques are better than others, and remerge
4066
4061
 
4067
4062
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
4063
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
4064
        if merge_type is None:
4071
4065
            merge_type = _mod_merge.Merge3Merger
4072
4066
        tree, file_list = tree_files(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
 
4067
        tree.lock_write()
 
4068
        self.add_cleanup(tree.unlock)
4074
4069
        parents = tree.get_parent_ids()
4075
4070
        if len(parents) != 2:
4076
4071
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4129
4124
 
4130
4125
 
4131
4126
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
4127
    """Revert files to a previous revision.
4133
4128
 
4134
4129
    Giving a list of files will revert only those files.  Otherwise, all files
4135
4130
    will be reverted.  If the revision is not specified with '--revision', the
4186
4181
    def run(self, revision=None, no_backup=False, file_list=None,
4187
4182
            forget_merges=None):
4188
4183
        tree, file_list = tree_files(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4184
        tree.lock_write()
 
4185
        self.add_cleanup(tree.unlock)
4190
4186
        if forget_merges:
4191
4187
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
4188
        else:
4200
4196
 
4201
4197
 
4202
4198
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
4199
    """Test reporting of assertion failures"""
4204
4200
    # intended just for use in testing
4205
4201
 
4206
4202
    hidden = True
4210
4206
 
4211
4207
 
4212
4208
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
4209
    """Show help on a command or other topic.
4214
4210
    """
4215
4211
 
4216
4212
    _see_also = ['topics']
4229
4225
 
4230
4226
 
4231
4227
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
4228
    """Show appropriate completions for context.
4233
4229
 
4234
4230
    For a list of all available commands, say 'bzr shell-complete'.
4235
4231
    """
4244
4240
 
4245
4241
 
4246
4242
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4243
    """Show unmerged/unpulled revisions between two branches.
4248
4244
 
4249
4245
    OTHER_BRANCH may be local or remote.
4250
4246
 
4328
4324
            restrict = 'remote'
4329
4325
 
4330
4326
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
4327
        parent = local_branch.get_parent()
4334
4328
        if other_branch is None:
4335
4329
            other_branch = parent
4344
4338
        remote_branch = Branch.open(other_branch)
4345
4339
        if remote_branch.base == local_branch.base:
4346
4340
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
4341
 
 
4342
        local_branch.lock_read()
 
4343
        self.add_cleanup(local_branch.unlock)
4350
4344
        local_revid_range = _revision_range_to_revid_range(
4351
4345
            _get_revision_range(my_revision, local_branch,
4352
4346
                self.name()))
4353
4347
 
 
4348
        remote_branch.lock_read()
 
4349
        self.add_cleanup(remote_branch.unlock)
4354
4350
        remote_revid_range = _revision_range_to_revid_range(
4355
4351
            _get_revision_range(revision,
4356
4352
                remote_branch, self.name()))
4406
4402
            message("Branches are up to date.\n")
4407
4403
        self.cleanup_now()
4408
4404
        if not status_code and parent is None and other_branch is not None:
4409
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4405
            local_branch.lock_write()
 
4406
            self.add_cleanup(local_branch.unlock)
4410
4407
            # handle race conditions - a parent might be set while we run.
4411
4408
            if local_branch.get_parent() is None:
4412
4409
                local_branch.set_parent(remote_branch.base)
4414
4411
 
4415
4412
 
4416
4413
class cmd_pack(Command):
4417
 
    __doc__ = """Compress the data within a repository.
4418
 
 
4419
 
    This operation compresses the data within a bazaar repository. As
4420
 
    bazaar supports automatic packing of repository, this operation is
4421
 
    normally not required to be done manually.
4422
 
 
4423
 
    During the pack operation, bazaar takes a backup of existing repository
4424
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4425
 
    automatically when it is safe to do so. To save disk space by removing
4426
 
    the backed up pack files, the --clean-obsolete-packs option may be
4427
 
    used.
4428
 
 
4429
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4430
 
    during or immediately after repacking, you may be left with a state
4431
 
    where the deletion has been written to disk but the new packs have not
4432
 
    been. In this case the repository may be unusable.
4433
 
    """
 
4414
    """Compress the data within a repository."""
4434
4415
 
4435
4416
    _see_also = ['repositories']
4436
4417
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
4418
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4419
    def run(self, branch_or_repo='.'):
4442
4420
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
4421
        try:
4444
4422
            branch = dir.open_branch()
4445
4423
            repository = branch.repository
4446
4424
        except errors.NotBranchError:
4447
4425
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4426
        repository.pack()
4449
4427
 
4450
4428
 
4451
4429
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
 
4430
    """List the installed plugins.
4453
4431
 
4454
4432
    This command displays the list of installed plugins including
4455
4433
    version of plugin and a short description of each.
4494
4472
 
4495
4473
 
4496
4474
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4475
    """Show testament (signing-form) of a revision."""
4498
4476
    takes_options = [
4499
4477
            'revision',
4500
4478
            Option('long', help='Produce long-format testament.'),
4512
4490
            b = Branch.open_containing(branch)[0]
4513
4491
        else:
4514
4492
            b = Branch.open(branch)
4515
 
        self.add_cleanup(b.lock_read().unlock)
 
4493
        b.lock_read()
 
4494
        self.add_cleanup(b.unlock)
4516
4495
        if revision is None:
4517
4496
            rev_id = b.last_revision()
4518
4497
        else:
4525
4504
 
4526
4505
 
4527
4506
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4507
    """Show the origin of each line in a file.
4529
4508
 
4530
4509
    This prints out the given file with an annotation on the left side
4531
4510
    indicating which revision, author and date introduced the change.
4552
4531
        wt, branch, relpath = \
4553
4532
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4533
        if wt is not None:
4555
 
            self.add_cleanup(wt.lock_read().unlock)
 
4534
            wt.lock_read()
 
4535
            self.add_cleanup(wt.unlock)
4556
4536
        else:
4557
 
            self.add_cleanup(branch.lock_read().unlock)
 
4537
            branch.lock_read()
 
4538
            self.add_cleanup(branch.unlock)
4558
4539
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
 
        self.add_cleanup(tree.lock_read().unlock)
 
4540
        tree.lock_read()
 
4541
        self.add_cleanup(tree.unlock)
4560
4542
        if wt is not None:
4561
4543
            file_id = wt.path2id(relpath)
4562
4544
        else:
4575
4557
 
4576
4558
 
4577
4559
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4560
    """Create a digital signature for an existing revision."""
4579
4561
    # TODO be able to replace existing ones.
4580
4562
 
4581
4563
    hidden = True # is this right ?
4588
4570
        if revision_id_list is None and revision is None:
4589
4571
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4572
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
 
4573
        b.lock_write()
 
4574
        self.add_cleanup(b.unlock)
4592
4575
        return self._run(b, revision_id_list, revision)
4593
4576
 
4594
4577
    def _run(self, b, revision_id_list, revision):
4640
4623
 
4641
4624
 
4642
4625
class cmd_bind(Command):
4643
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
 
    If no branch is supplied, rebind to the last bound location.
 
4626
    """Convert the current branch into a checkout of the supplied branch.
4645
4627
 
4646
4628
    Once converted into a checkout, commits must succeed on the master branch
4647
4629
    before they will be applied to the local branch.
4681
4663
 
4682
4664
 
4683
4665
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4666
    """Convert the current checkout into a regular branch.
4685
4667
 
4686
4668
    After unbinding, the local branch is considered independent and subsequent
4687
4669
    commits will be local only.
4698
4680
 
4699
4681
 
4700
4682
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4683
    """Remove the last committed revision.
4702
4684
 
4703
4685
    --verbose will print out what is being removed.
4704
4686
    --dry-run will go through all the motions, but not actually
4744
4726
            b = control.open_branch()
4745
4727
 
4746
4728
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4729
            tree.lock_write()
 
4730
            self.add_cleanup(tree.unlock)
4748
4731
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
 
4732
            b.lock_write()
 
4733
            self.add_cleanup(b.unlock)
4750
4734
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4751
4735
 
4752
4736
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4804
4788
 
4805
4789
 
4806
4790
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4791
    """Break a dead lock on a repository, branch or working directory.
4808
4792
 
4809
4793
    CAUTION: Locks should only be broken when you are sure that the process
4810
4794
    holding the lock has been stopped.
4829
4813
 
4830
4814
 
4831
4815
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4816
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4817
 
4834
4818
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4819
    """
4843
4827
 
4844
4828
 
4845
4829
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4830
    """Run the bzr server."""
4847
4831
 
4848
4832
    aliases = ['server']
4849
4833
 
4909
4893
 
4910
4894
 
4911
4895
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
 
4896
    """Combine a tree into its containing tree.
4913
4897
 
4914
4898
    This command requires the target tree to be in a rich-root format.
4915
4899
 
4955
4939
 
4956
4940
 
4957
4941
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4942
    """Split a subdirectory of a tree into a separate tree.
4959
4943
 
4960
4944
    This command will produce a target tree in a format that supports
4961
4945
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4981
4965
 
4982
4966
 
4983
4967
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4968
    """Generate a merge directive for auto-merge tools.
4985
4969
 
4986
4970
    A directive requests a merge to be performed, and also provides all the
4987
4971
    information necessary to do so.  This means it must either include a
5080
5064
 
5081
5065
 
5082
5066
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5067
    """Mail or create a merge-directive for submitting changes.
5084
5068
 
5085
5069
    A merge directive provides many things needed for requesting merges:
5086
5070
 
5197
5181
 
5198
5182
 
5199
5183
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5184
    """Create a merge-directive for submitting changes.
5201
5185
 
5202
5186
    A merge directive provides many things needed for requesting merges:
5203
5187
 
5270
5254
 
5271
5255
 
5272
5256
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5257
    """Create, remove or modify a tag naming a revision.
5274
5258
 
5275
5259
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
5260
    (--revision) option can be given -rtag:X, where X is any previously
5315
5299
            revision=None,
5316
5300
            ):
5317
5301
        branch, relpath = Branch.open_containing(directory)
5318
 
        self.add_cleanup(branch.lock_write().unlock)
 
5302
        branch.lock_write()
 
5303
        self.add_cleanup(branch.unlock)
5319
5304
        if delete:
5320
5305
            if tag_name is None:
5321
5306
                raise errors.BzrCommandError("No tag specified to delete.")
5342
5327
 
5343
5328
 
5344
5329
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
5330
    """List tags.
5346
5331
 
5347
5332
    This command shows a table of tag names and the revisions they reference.
5348
5333
    """
5376
5361
        if not tags:
5377
5362
            return
5378
5363
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5364
        branch.lock_read()
 
5365
        self.add_cleanup(branch.unlock)
5380
5366
        if revision:
5381
5367
            graph = branch.repository.get_graph()
5382
5368
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5401
 
5416
5402
 
5417
5403
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5404
    """Reconfigure the type of a bzr directory.
5419
5405
 
5420
5406
    A target configuration must be specified.
5421
5407
 
5506
5492
 
5507
5493
 
5508
5494
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5495
    """Set the branch of a checkout and update.
5510
5496
 
5511
5497
    For lightweight checkouts, this changes the branch being referenced.
5512
5498
    For heavyweight checkouts, this checks that there are no local commits
5602
5588
 
5603
5589
 
5604
5590
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5591
    """Manage filtered views.
5606
5592
 
5607
5593
    Views provide a mask over the tree so that users can focus on
5608
5594
    a subset of a tree when doing their work. After creating a view,
5756
5742
 
5757
5743
 
5758
5744
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5745
    """Show hooks."""
5760
5746
 
5761
5747
    hidden = True
5762
5748
 
5776
5762
 
5777
5763
 
5778
5764
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
 
5765
    """Remove a branch.
5780
5766
 
5781
5767
    This will remove the branch from the specified location but 
5782
5768
    will keep any working tree or repository in place.
5801
5787
        
5802
5788
 
5803
5789
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5790
    """Temporarily set aside some changes from the current tree.
5805
5791
 
5806
5792
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5793
    ie. out of the way, until a later time when you can bring them back from
5860
5846
 
5861
5847
    def run_for_list(self):
5862
5848
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5849
        tree.lock_read()
 
5850
        self.add_cleanup(tree.unlock)
5864
5851
        manager = tree.get_shelf_manager()
5865
5852
        shelves = manager.active_shelves()
5866
5853
        if len(shelves) == 0:
5875
5862
 
5876
5863
 
5877
5864
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5865
    """Restore shelved changes.
5879
5866
 
5880
5867
    By default, the most recently shelved changes are restored. However if you
5881
5868
    specify a shelf by id those changes will be restored instead.  This works
5907
5894
 
5908
5895
 
5909
5896
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5897
    """Remove unwanted files from working tree.
5911
5898
 
5912
5899
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5900
    files are never deleted.
5941
5928
 
5942
5929
 
5943
5930
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5931
    """list, view and set branch locations for nested trees.
5945
5932
 
5946
5933
    If no arguments are provided, lists the branch locations for nested trees.
5947
5934
    If one argument is provided, display the branch location for that tree.
5987
5974
            self.outf.write('%s %s\n' % (path, location))
5988
5975
 
5989
5976
 
5990
 
def _register_lazy_builtins():
5991
 
    # register lazy builtins from other modules; called at startup and should
5992
 
    # be only called once.
5993
 
    for (name, aliases, module_name) in [
5994
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
 
        ]:
6001
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5977
from bzrlib.cmd_version_info import cmd_version_info
 
5978
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5979
from bzrlib.foreign import cmd_dpush
 
5980
from bzrlib.sign_my_commits import cmd_sign_my_commits