/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-04-09 03:58:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5146.
  • Revision ID: robertc@robertcollins.net-20100409035814-eqayfeknoncyoctr
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre
2.1 method of calling run() to perform testing or direct use via the API
is now possible again. As part of this, the _operation attribute on
Command is now transient and only exists for the duration of ``run()``.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
232
232
    return view_info
233
233
 
234
234
 
235
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
 
    """Open the tree or branch containing the specified file, unless
237
 
    the --directory option is used to specify a different branch."""
238
 
    if directory is not None:
239
 
        return (None, Branch.open(directory), filename)
240
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
241
 
 
242
 
 
243
235
# TODO: Make sure no commands unconditionally use the working directory as a
244
236
# branch.  If a filename argument is used, the first of them should be used to
245
237
# specify the branch.  (Perhaps this can be factored out into some kind of
247
239
# opens the branch?)
248
240
 
249
241
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
242
    """Display status summary.
251
243
 
252
244
    This reports on versioned and unknown files, reporting them
253
245
    grouped by state.  Possible states are:
340
332
 
341
333
 
342
334
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
335
    """Write out metadata for a revision.
344
336
 
345
337
    The revision to print can either be specified by a specific
346
338
    revision identifier, or you can use --revision.
348
340
 
349
341
    hidden = True
350
342
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
343
    takes_options = ['revision']
352
344
    # cat-revision is more for frontends so should be exact
353
345
    encoding = 'strict'
354
346
 
361
353
        self.outf.write(revtext.decode('utf-8'))
362
354
 
363
355
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
356
    def run(self, revision_id=None, revision=None):
365
357
        if revision_id is not None and revision is not None:
366
358
            raise errors.BzrCommandError('You can only supply one of'
367
359
                                         ' revision_id or --revision')
368
360
        if revision_id is None and revision is None:
369
361
            raise errors.BzrCommandError('You must supply either'
370
362
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
 
363
        b = WorkingTree.open_containing(u'.')[0].branch
372
364
 
373
365
        revisions = b.repository.revisions
374
366
        if revisions is None:
398
390
        
399
391
 
400
392
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
393
    """Dump the contents of a btree index file to stdout.
402
394
 
403
395
    PATH is a btree index file, it can be any URL. This includes things like
404
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
479
471
 
480
472
 
481
473
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
474
    """Remove the working tree from a given branch/checkout.
483
475
 
484
476
    Since a lightweight checkout is little more than a working tree
485
477
    this will refuse to run against one.
512
504
                if (working.has_changes()):
513
505
                    raise errors.UncommittedChanges(working)
514
506
 
515
 
            if working.user_url != working.branch.user_url:
 
507
            working_path = working.bzrdir.root_transport.base
 
508
            branch_path = working.branch.bzrdir.root_transport.base
 
509
            if working_path != branch_path:
516
510
                raise errors.BzrCommandError("You cannot remove the working tree"
517
511
                                             " from a lightweight checkout")
518
512
 
520
514
 
521
515
 
522
516
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
517
    """Show current revision number.
524
518
 
525
519
    This is equal to the number of revisions on this branch.
526
520
    """
536
530
        if tree:
537
531
            try:
538
532
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
533
                wt.lock_read()
540
534
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
535
                raise errors.NoWorkingTree(location)
 
536
            self.add_cleanup(wt.unlock)
542
537
            revid = wt.last_revision()
543
538
            try:
544
539
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
542
            revno = ".".join(str(n) for n in revno_t)
548
543
        else:
549
544
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
545
            b.lock_read()
 
546
            self.add_cleanup(b.unlock)
551
547
            revno = b.revno()
552
548
        self.cleanup_now()
553
549
        self.outf.write(str(revno) + '\n')
554
550
 
555
551
 
556
552
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
553
    """Show revision number and revision id for a given revision identifier.
558
554
    """
559
555
    hidden = True
560
556
    takes_args = ['revision_info*']
561
557
    takes_options = [
562
558
        'revision',
563
 
        custom_help('directory',
 
559
        Option('directory',
564
560
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
 
561
                 'rather than the one containing the working directory.',
 
562
            short_name='d',
 
563
            type=unicode,
 
564
            ),
566
565
        Option('tree', help='Show revno of working tree'),
567
566
        ]
568
567
 
573
572
        try:
574
573
            wt = WorkingTree.open_containing(directory)[0]
575
574
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
575
            wt.lock_read()
 
576
            self.add_cleanup(wt.unlock)
577
577
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
578
            wt = None
579
579
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
580
            b.lock_read()
 
581
            self.add_cleanup(b.unlock)
581
582
        revision_ids = []
582
583
        if revision is not None:
583
584
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
612
 
612
613
 
613
614
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
615
    """Add specified files or directories.
615
616
 
616
617
    In non-recursive mode, all the named items are added, regardless
617
618
    of whether they were previously ignored.  A warning is given if
682
683
                should_print=(not is_quiet()))
683
684
 
684
685
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
686
            base_tree.lock_read()
 
687
            self.add_cleanup(base_tree.unlock)
686
688
        tree, file_list = tree_files_for_add(file_list)
687
689
        added, ignored = tree.smart_add(file_list, not
688
690
            no_recurse, action=action, save=not dry_run)
696
698
 
697
699
 
698
700
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
701
    """Create a new versioned directory.
700
702
 
701
703
    This is equivalent to creating the directory and then adding it.
702
704
    """
718
720
 
719
721
 
720
722
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
723
    """Show path of a file relative to root"""
722
724
 
723
725
    takes_args = ['filename']
724
726
    hidden = True
733
735
 
734
736
 
735
737
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
738
    """Show inventory of the current working copy or a revision.
737
739
 
738
740
    It is possible to limit the output to a particular entry
739
741
    type using the --kind option.  For example: --kind file.
760
762
 
761
763
        revision = _get_one_revision('inventory', revision)
762
764
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
765
        work_tree.lock_read()
 
766
        self.add_cleanup(work_tree.unlock)
764
767
        if revision is not None:
765
768
            tree = revision.as_tree(work_tree.branch)
766
769
 
767
770
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
771
            tree.lock_read()
 
772
            self.add_cleanup(tree.unlock)
769
773
        else:
770
774
            tree = work_tree
771
775
            extra_trees = []
792
796
 
793
797
 
794
798
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
799
    """Move or rename a file.
796
800
 
797
801
    :Usage:
798
802
        bzr mv OLDNAME NEWNAME
831
835
        if len(names_list) < 2:
832
836
            raise errors.BzrCommandError("missing file argument")
833
837
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
838
        tree.lock_tree_write()
 
839
        self.add_cleanup(tree.unlock)
835
840
        self._run(tree, names_list, rel_names, after)
836
841
 
837
842
    def run_auto(self, names_list, after, dry_run):
842
847
            raise errors.BzrCommandError('--after cannot be specified with'
843
848
                                         ' --auto.')
844
849
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
850
        work_tree.lock_tree_write()
 
851
        self.add_cleanup(work_tree.unlock)
846
852
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
853
 
848
854
    def _run(self, tree, names_list, rel_names, after):
927
933
 
928
934
 
929
935
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
936
    """Turn this branch into a mirror of another branch.
931
937
 
932
938
    By default, this command only works on branches that have not diverged.
933
939
    Branches are considered diverged if the destination branch's most recent 
956
962
    takes_options = ['remember', 'overwrite', 'revision',
957
963
        custom_help('verbose',
958
964
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
965
        Option('directory',
960
966
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
967
                 'rather than the one containing the working directory.',
 
968
            short_name='d',
 
969
            type=unicode,
 
970
            ),
962
971
        Option('local',
963
972
            help="Perform a local pull in a bound "
964
973
                 "branch.  Local pulls are not applied to "
979
988
        try:
980
989
            tree_to = WorkingTree.open_containing(directory)[0]
981
990
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
991
        except errors.NoWorkingTree:
984
992
            tree_to = None
985
993
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
994
        
988
995
        if local and not branch_to.get_bound_location():
989
996
            raise errors.LocalRequiresBoundBranch()
990
997
 
1020
1027
        else:
1021
1028
            branch_from = Branch.open(location,
1022
1029
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
1030
 
1025
1031
            if branch_to.get_parent() is None or remember:
1026
1032
                branch_to.set_parent(branch_from.base)
1027
1033
 
 
1034
        if branch_from is not branch_to:
 
1035
            branch_from.lock_read()
 
1036
            self.add_cleanup(branch_from.unlock)
1028
1037
        if revision is not None:
1029
1038
            revision_id = revision.as_revision_id(branch_from)
1030
1039
 
 
1040
        branch_to.lock_write()
 
1041
        self.add_cleanup(branch_to.unlock)
1031
1042
        if tree_to is not None:
1032
1043
            view_info = _get_view_info_for_change_reporter(tree_to)
1033
1044
            change_reporter = delta._ChangeReporter(
1048
1059
 
1049
1060
 
1050
1061
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1062
    """Update a mirror of this branch.
1052
1063
 
1053
1064
    The target branch will not have its working tree populated because this
1054
1065
    is both expensive, and is not supported on remote file systems.
1078
1089
        Option('create-prefix',
1079
1090
               help='Create the path leading up to the branch '
1080
1091
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1092
        Option('directory',
1082
1093
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1094
                 'rather than the one containing the working directory.',
 
1095
            short_name='d',
 
1096
            type=unicode,
 
1097
            ),
1084
1098
        Option('use-existing-dir',
1085
1099
               help='By default push will fail if the target'
1086
1100
                    ' directory exists, but does not already'
1112
1126
        # Get the source branch
1113
1127
        (tree, br_from,
1114
1128
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1129
        if strict is None:
 
1130
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1131
        if strict is None: strict = True # default value
1115
1132
        # Get the tip's revision_id
1116
1133
        revision = _get_one_revision('push', revision)
1117
1134
        if revision is not None:
1118
1135
            revision_id = revision.in_history(br_from).rev_id
1119
1136
        else:
1120
1137
            revision_id = None
1121
 
        if tree is not None and revision_id is None:
1122
 
            tree.check_changed_or_out_of_date(
1123
 
                strict, 'push_strict',
1124
 
                more_error='Use --no-strict to force the push.',
1125
 
                more_warning='Uncommitted changes will not be pushed.')
 
1138
        if strict and tree is not None and revision_id is None:
 
1139
            if (tree.has_changes()):
 
1140
                raise errors.UncommittedChanges(
 
1141
                    tree, more='Use --no-strict to force the push.')
 
1142
            if tree.last_revision() != tree.branch.last_revision():
 
1143
                # The tree has lost sync with its branch, there is little
 
1144
                # chance that the user is aware of it but he can still force
 
1145
                # the push with --no-strict
 
1146
                raise errors.OutOfDateTree(
 
1147
                    tree, more='Use --no-strict to force the push.')
 
1148
 
1126
1149
        # Get the stacked_on branch, if any
1127
1150
        if stacked_on is not None:
1128
1151
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1183
 
1161
1184
 
1162
1185
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1186
    """Create a new branch that is a copy of an existing branch.
1164
1187
 
1165
1188
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1189
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1229
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1230
            from_location)
1208
1231
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1232
        br_from.lock_read()
 
1233
        self.add_cleanup(br_from.unlock)
1210
1234
        if revision is not None:
1211
1235
            revision_id = revision.as_revision_id(br_from)
1212
1236
        else:
1272
1296
 
1273
1297
 
1274
1298
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1299
    """Create a new checkout of an existing branch.
1276
1300
 
1277
1301
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1302
    the branch found in '.'. This is useful if you have removed the working tree
1336
1360
            except errors.NoWorkingTree:
1337
1361
                source.bzrdir.create_workingtree(revision_id)
1338
1362
                return
1339
 
 
1340
 
        if not lightweight:
1341
 
            message = ('Copying history to "%s". '
1342
 
                'To checkout without local history use --lightweight.' % to_location)
1343
 
            ui.ui_factory.show_message(message)
1344
1363
        source.create_checkout(to_location, revision_id, lightweight,
1345
1364
                               accelerator_tree, hardlink)
1346
1365
 
1347
1366
 
1348
1367
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1368
    """Show list of renamed files.
1350
1369
    """
1351
1370
    # TODO: Option to show renames between two historical versions.
1352
1371
 
1357
1376
    @display_command
1358
1377
    def run(self, dir=u'.'):
1359
1378
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1379
        tree.lock_read()
 
1380
        self.add_cleanup(tree.unlock)
1361
1381
        new_inv = tree.inventory
1362
1382
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1383
        old_tree.lock_read()
 
1384
        self.add_cleanup(old_tree.unlock)
1364
1385
        old_inv = old_tree.inventory
1365
1386
        renames = []
1366
1387
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1397
 
1377
1398
 
1378
1399
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1400
    """Update a tree to have the latest code committed to its branch.
1380
1401
 
1381
1402
    This will perform a merge into the working tree, and may generate
1382
1403
    conflicts. If you have any local changes, you will still
1404
1425
        master = branch.get_master_branch(
1405
1426
            possible_transports=possible_transports)
1406
1427
        if master is not None:
 
1428
            tree.lock_write()
1407
1429
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1430
        else:
 
1431
            tree.lock_tree_write()
1410
1432
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1433
        self.add_cleanup(tree.unlock)
1413
1434
        # get rid of the final '/' and be ready for display
1414
1435
        branch_location = urlutils.unescape_for_display(
1451
1472
            _mod_revision.ensure_null(tree.last_revision()))
1452
1473
        note('Updated to revision %s of branch %s' %
1453
1474
             ('.'.join(map(str, revno)), branch_location))
1454
 
        parent_ids = tree.get_parent_ids()
1455
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1475
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1456
1476
            note('Your local commits will now show as pending merges with '
1457
1477
                 "'bzr status', and can be committed with 'bzr commit'.")
1458
1478
        if conflicts != 0:
1462
1482
 
1463
1483
 
1464
1484
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1485
    """Show information about a working tree, branch or repository.
1466
1486
 
1467
1487
    This command will show all known locations and formats associated to the
1468
1488
    tree, branch or repository.
1506
1526
 
1507
1527
 
1508
1528
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1529
    """Remove files or directories.
1510
1530
 
1511
1531
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1532
    them if they can easily be recovered using revert. If no options or
1534
1554
        if file_list is not None:
1535
1555
            file_list = [f for f in file_list]
1536
1556
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1557
        tree.lock_write()
 
1558
        self.add_cleanup(tree.unlock)
1538
1559
        # Heuristics should probably all move into tree.remove_smart or
1539
1560
        # some such?
1540
1561
        if new:
1559
1580
 
1560
1581
 
1561
1582
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1583
    """Print file_id of a particular file or directory.
1563
1584
 
1564
1585
    The file_id is assigned when the file is first added and remains the
1565
1586
    same through all revisions where the file exists, even when it is
1581
1602
 
1582
1603
 
1583
1604
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1605
    """Print path of file_ids to a file or directory.
1585
1606
 
1586
1607
    This prints one line for each directory down to the target,
1587
1608
    starting at the branch root.
1603
1624
 
1604
1625
 
1605
1626
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1627
    """Reconcile bzr metadata in a branch.
1607
1628
 
1608
1629
    This can correct data mismatches that may have been caused by
1609
1630
    previous ghost operations or bzr upgrades. You should only
1631
1652
 
1632
1653
 
1633
1654
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1655
    """Display the list of revision ids on a branch."""
1635
1656
 
1636
1657
    _see_also = ['log']
1637
1658
    takes_args = ['location?']
1647
1668
 
1648
1669
 
1649
1670
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1671
    """List all revisions merged into this branch."""
1651
1672
 
1652
1673
    _see_also = ['log', 'revision-history']
1653
1674
    takes_args = ['location?']
1672
1693
 
1673
1694
 
1674
1695
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1696
    """Make a directory into a versioned branch.
1676
1697
 
1677
1698
    Use this to create an empty branch, or before importing an
1678
1699
    existing project.
1781
1802
 
1782
1803
 
1783
1804
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1805
    """Create a shared repository for branches to share storage space.
1785
1806
 
1786
1807
    New branches created under the repository directory will store their
1787
1808
    revisions in the repository, not in the branch directory.  For branches
1841
1862
 
1842
1863
 
1843
1864
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1865
    """Show differences in the working tree, between revisions or branches.
1845
1866
 
1846
1867
    If no arguments are given, all changes for the current tree are listed.
1847
1868
    If files are given, only the changes in those files are listed.
1944
1965
    @display_command
1945
1966
    def run(self, revision=None, file_list=None, diff_options=None,
1946
1967
            prefix=None, old=None, new=None, using=None, format=None):
1947
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1968
        from bzrlib.diff import (get_trees_and_branches_to_diff,
1948
1969
            show_diff_trees)
1949
1970
 
1950
1971
        if (prefix is None) or (prefix == '0'):
1971
1992
 
1972
1993
        (old_tree, new_tree,
1973
1994
         old_branch, new_branch,
1974
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1975
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1995
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1996
            file_list, revision, old, new, apply_view=True)
1976
1997
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1998
                               specific_files=specific_files,
1978
1999
                               external_diff_options=diff_options,
1982
2003
 
1983
2004
 
1984
2005
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
2006
    """List files deleted in the working tree.
1986
2007
    """
1987
2008
    # TODO: Show files deleted since a previous revision, or
1988
2009
    # between two revisions.
1991
2012
    # level of effort but possibly much less IO.  (Or possibly not,
1992
2013
    # if the directories are very large...)
1993
2014
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
2015
    takes_options = ['show-ids']
1995
2016
 
1996
2017
    @display_command
1997
 
    def run(self, show_ids=False, directory=u'.'):
1998
 
        tree = WorkingTree.open_containing(directory)[0]
1999
 
        self.add_cleanup(tree.lock_read().unlock)
 
2018
    def run(self, show_ids=False):
 
2019
        tree = WorkingTree.open_containing(u'.')[0]
 
2020
        tree.lock_read()
 
2021
        self.add_cleanup(tree.unlock)
2000
2022
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
2023
        old.lock_read()
 
2024
        self.add_cleanup(old.unlock)
2002
2025
        for path, ie in old.inventory.iter_entries():
2003
2026
            if not tree.has_id(ie.file_id):
2004
2027
                self.outf.write(path)
2009
2032
 
2010
2033
 
2011
2034
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
2035
    """List files modified in working tree.
2013
2036
    """
2014
2037
 
2015
2038
    hidden = True
2016
2039
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
2040
    takes_options = [
 
2041
            Option('null',
 
2042
                   help='Write an ascii NUL (\\0) separator '
 
2043
                   'between files rather than a newline.')
 
2044
            ]
2018
2045
 
2019
2046
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2047
    def run(self, null=False):
 
2048
        tree = WorkingTree.open_containing(u'.')[0]
2022
2049
        td = tree.changes_from(tree.basis_tree())
2023
2050
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2051
            if null:
2028
2055
 
2029
2056
 
2030
2057
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2058
    """List files added in working tree.
2032
2059
    """
2033
2060
 
2034
2061
    hidden = True
2035
2062
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2063
    takes_options = [
 
2064
            Option('null',
 
2065
                   help='Write an ascii NUL (\\0) separator '
 
2066
                   'between files rather than a newline.')
 
2067
            ]
2037
2068
 
2038
2069
    @display_command
2039
 
    def run(self, null=False, directory=u'.'):
2040
 
        wt = WorkingTree.open_containing(directory)[0]
2041
 
        self.add_cleanup(wt.lock_read().unlock)
 
2070
    def run(self, null=False):
 
2071
        wt = WorkingTree.open_containing(u'.')[0]
 
2072
        wt.lock_read()
 
2073
        self.add_cleanup(wt.unlock)
2042
2074
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2075
        basis.lock_read()
 
2076
        self.add_cleanup(basis.unlock)
2044
2077
        basis_inv = basis.inventory
2045
2078
        inv = wt.inventory
2046
2079
        for file_id in inv:
2049
2082
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2083
                continue
2051
2084
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2085
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2086
                continue
2054
2087
            if null:
2055
2088
                self.outf.write(path + '\0')
2058
2091
 
2059
2092
 
2060
2093
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2094
    """Show the tree root directory.
2062
2095
 
2063
2096
    The root is the nearest enclosing directory with a .bzr control
2064
2097
    directory."""
2088
2121
 
2089
2122
 
2090
2123
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2124
    """Show historical log for a branch or subset of a branch.
2092
2125
 
2093
2126
    log is bzr's default tool for exploring the history of a branch.
2094
2127
    The branch to use is taken from the first parameter. If no parameters
2255
2288
                   help='Show just the specified revision.'
2256
2289
                   ' See also "help revisionspec".'),
2257
2290
            'log-format',
2258
 
            RegistryOption('authors',
2259
 
                'What names to list as authors - first, all or committer.',
2260
 
                title='Authors',
2261
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2262
 
            ),
2263
2291
            Option('levels',
2264
2292
                   short_name='n',
2265
2293
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2308
                   help='Show changes made in each revision as a patch.'),
2281
2309
            Option('include-merges',
2282
2310
                   help='Show merged revisions like --levels 0 does.'),
2283
 
            Option('exclude-common-ancestry',
2284
 
                   help='Display only the revisions that are not part'
2285
 
                   ' of both ancestries (require -rX..Y)'
2286
 
                   )
2287
2311
            ]
2288
2312
    encoding_type = 'replace'
2289
2313
 
2299
2323
            message=None,
2300
2324
            limit=None,
2301
2325
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2326
            include_merges=False):
2306
2327
        from bzrlib.log import (
2307
2328
            Logger,
2308
2329
            make_log_request_dict,
2309
2330
            _get_info_for_log_files,
2310
2331
            )
2311
2332
        direction = (forward and 'forward') or 'reverse'
2312
 
        if (exclude_common_ancestry
2313
 
            and (revision is None or len(revision) != 2)):
2314
 
            raise errors.BzrCommandError(
2315
 
                '--exclude-common-ancestry requires -r with two revisions')
2316
2333
        if include_merges:
2317
2334
            if levels is None:
2318
2335
                levels = 0
2334
2351
        if file_list:
2335
2352
            # find the file ids to log and check for directory filtering
2336
2353
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2354
                revision, file_list)
 
2355
            self.add_cleanup(b.unlock)
2338
2356
            for relpath, file_id, kind in file_info_list:
2339
2357
                if file_id is None:
2340
2358
                    raise errors.BzrCommandError(
2358
2376
                location = '.'
2359
2377
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2378
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2379
            b.lock_read()
 
2380
            self.add_cleanup(b.unlock)
2362
2381
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2382
 
2364
2383
        # Decide on the type of delta & diff filtering to use
2384
2403
                        show_timezone=timezone,
2385
2404
                        delta_format=get_verbosity_level(),
2386
2405
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2406
                        show_advice=levels is None)
2389
2407
 
2390
2408
        # Choose the algorithm for doing the logging. It's annoying
2391
2409
        # having multiple code paths like this but necessary until
2410
2428
            direction=direction, specific_fileids=file_ids,
2411
2429
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2430
            message_search=message, delta_type=delta_type,
2413
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2414
 
            exclude_common_ancestry=exclude_common_ancestry,
2415
 
            )
 
2431
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2432
        Logger(b, rqst).show(lf)
2417
2433
 
2418
2434
 
2476
2492
 
2477
2493
 
2478
2494
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2495
    """Return revision-ids which affected a particular file.
2480
2496
 
2481
2497
    A more user-friendly interface is "bzr log FILE".
2482
2498
    """
2489
2505
        tree, relpath = WorkingTree.open_containing(filename)
2490
2506
        file_id = tree.path2id(relpath)
2491
2507
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2508
        b.lock_read()
 
2509
        self.add_cleanup(b.unlock)
2493
2510
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2511
        for revno, revision_id, what in touching_revs:
2495
2512
            self.outf.write("%6d %s\n" % (revno, what))
2496
2513
 
2497
2514
 
2498
2515
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2516
    """List files in a tree.
2500
2517
    """
2501
2518
 
2502
2519
    _see_also = ['status', 'cat']
2508
2525
                   help='Recurse into subdirectories.'),
2509
2526
            Option('from-root',
2510
2527
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2528
            Option('unknown', help='Print unknown files.'),
2513
2529
            Option('versioned', help='Print versioned files.',
2514
2530
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2531
            Option('ignored', help='Print ignored files.'),
 
2532
            Option('null',
 
2533
                   help='Write an ascii NUL (\\0) separator '
 
2534
                   'between files rather than a newline.'),
 
2535
            Option('kind',
2518
2536
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2537
                   type=unicode),
2520
 
            'null',
2521
2538
            'show-ids',
2522
 
            'directory',
2523
2539
            ]
2524
2540
    @display_command
2525
2541
    def run(self, revision=None, verbose=False,
2526
2542
            recursive=False, from_root=False,
2527
2543
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2544
            null=False, kind=None, show_ids=False, path=None):
2529
2545
 
2530
2546
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2547
            raise errors.BzrCommandError('invalid kind specified')
2543
2559
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2560
                                             ' and PATH')
2545
2561
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2562
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2563
            fs_path)
2548
2564
 
2549
2565
        # Calculate the prefix to use
2550
2566
        prefix = None
2565
2581
                view_str = views.view_display_str(view_files)
2566
2582
                note("Ignoring files outside view. View is %s" % view_str)
2567
2583
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2584
        tree.lock_read()
 
2585
        self.add_cleanup(tree.unlock)
2569
2586
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2587
            from_dir=relpath, recursive=recursive):
2571
2588
            # Apply additional masking
2613
2630
 
2614
2631
 
2615
2632
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2633
    """List unknown files.
2617
2634
    """
2618
2635
 
2619
2636
    hidden = True
2620
2637
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2638
 
2623
2639
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2640
    def run(self):
 
2641
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2642
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2643
 
2628
2644
 
2629
2645
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2646
    """Ignore specified files or patterns.
2631
2647
 
2632
2648
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2649
 
2642
2658
    using this command or directly by using an editor, be sure to commit
2643
2659
    it.
2644
2660
    
2645
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2646
 
    the global ignore file can be found in the application data directory as
2647
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2648
 
    Global ignores are not touched by this command. The global ignore file
2649
 
    can be edited directly using an editor.
2650
 
 
2651
2661
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2662
    precedence over regular ignores.  Such exceptions are used to specify
2653
2663
    files that should be versioned which would otherwise be ignored.
2693
2703
 
2694
2704
    _see_also = ['status', 'ignored', 'patterns']
2695
2705
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2706
    takes_options = [
 
2707
        Option('old-default-rules',
 
2708
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2709
        ]
2700
2710
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2711
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2712
        from bzrlib import ignores
2704
 
        if default_rules is not None:
2705
 
            # dump the default rules and exit
2706
 
            for pattern in ignores.USER_DEFAULTS:
 
2713
        if old_default_rules is not None:
 
2714
            # dump the rules and exit
 
2715
            for pattern in ignores.OLD_DEFAULTS:
2707
2716
                self.outf.write("%s\n" % pattern)
2708
2717
            return
2709
2718
        if not name_pattern_list:
2710
2719
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2720
                                  "NAME_PATTERN or --old-default-rules")
2712
2721
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2722
                             for p in name_pattern_list]
2714
2723
        for name_pattern in name_pattern_list:
2716
2725
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2726
                raise errors.BzrCommandError(
2718
2727
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2728
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2729
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2730
        ignored = globbing.Globster(name_pattern_list)
2722
2731
        matches = []
2736
2745
 
2737
2746
 
2738
2747
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2748
    """List ignored files and the patterns that matched them.
2740
2749
 
2741
2750
    List all the ignored files and the ignore pattern that caused the file to
2742
2751
    be ignored.
2748
2757
 
2749
2758
    encoding_type = 'replace'
2750
2759
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2760
 
2753
2761
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2762
    def run(self):
 
2763
        tree = WorkingTree.open_containing(u'.')[0]
 
2764
        tree.lock_read()
 
2765
        self.add_cleanup(tree.unlock)
2757
2766
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2767
            if file_class != 'I':
2759
2768
                continue
2763
2772
 
2764
2773
 
2765
2774
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2775
    """Lookup the revision-id from a revision-number
2767
2776
 
2768
2777
    :Examples:
2769
2778
        bzr lookup-revision 33
2770
2779
    """
2771
2780
    hidden = True
2772
2781
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2782
 
2775
2783
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2784
    def run(self, revno):
2777
2785
        try:
2778
2786
            revno = int(revno)
2779
2787
        except ValueError:
2780
2788
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
2789
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2790
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2783
2791
        self.outf.write("%s\n" % revid)
2784
2792
 
2785
2793
 
2786
2794
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2795
    """Export current or past revision to a destination directory or archive.
2788
2796
 
2789
2797
    If no revision is specified this exports the last committed revision.
2790
2798
 
2812
2820
      =================       =========================
2813
2821
    """
2814
2822
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2823
    takes_options = [
2816
2824
        Option('format',
2817
2825
               help="Type of file to export to.",
2818
2826
               type=unicode),
2827
2835
                    'revision in which it was changed.'),
2828
2836
        ]
2829
2837
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2838
        root=None, filters=False, per_file_timestamps=False):
2831
2839
        from bzrlib.export import export
2832
2840
 
2833
2841
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2842
            tree = WorkingTree.open_containing(u'.')[0]
2835
2843
            b = tree.branch
2836
2844
            subdir = None
2837
2845
        else:
2847
2855
 
2848
2856
 
2849
2857
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2858
    """Write the contents of a file as of a given revision to standard output.
2851
2859
 
2852
2860
    If no revision is nominated, the last revision is used.
2853
2861
 
2856
2864
    """
2857
2865
 
2858
2866
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2867
    takes_options = [
2860
2868
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2869
        Option('filters', help='Apply content filters to display the '
2862
2870
                'convenience form.'),
2867
2875
 
2868
2876
    @display_command
2869
2877
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2878
            filters=False):
2871
2879
        if revision is not None and len(revision) != 1:
2872
2880
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2881
                                         " one revision specifier")
2874
2882
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2883
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2884
        branch.lock_read()
 
2885
        self.add_cleanup(branch.unlock)
2877
2886
        return self._run(tree, branch, relpath, filename, revision,
2878
2887
                         name_from_revision, filters)
2879
2888
 
2882
2891
        if tree is None:
2883
2892
            tree = b.basis_tree()
2884
2893
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2894
        rev_tree.lock_read()
 
2895
        self.add_cleanup(rev_tree.unlock)
2886
2896
 
2887
2897
        old_file_id = rev_tree.path2id(relpath)
2888
2898
 
2931
2941
 
2932
2942
 
2933
2943
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2944
    """Show the offset in seconds from GMT to local time."""
2935
2945
    hidden = True
2936
2946
    @display_command
2937
2947
    def run(self):
2940
2950
 
2941
2951
 
2942
2952
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2953
    """Commit changes into a new revision.
2944
2954
 
2945
2955
    An explanatory message needs to be given for each commit. This is
2946
2956
    often done by using the --message option (getting the message from the
3054
3064
                         "the master branch until a normal commit "
3055
3065
                         "is performed."
3056
3066
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3067
             Option('show-diff',
3058
3068
                    help='When no message is supplied, show the diff along'
3059
3069
                    ' with the status summary in the message editor.'),
3060
3070
             ]
3206
3216
 
3207
3217
 
3208
3218
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3219
    """Validate working tree structure, branch consistency and repository history.
3210
3220
 
3211
3221
    This command checks various invariants about branch and repository storage
3212
3222
    to detect data corruption or bzr bugs.
3276
3286
 
3277
3287
 
3278
3288
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3289
    """Upgrade branch storage to current format.
3280
3290
 
3281
3291
    The check command or bzr developers may sometimes advise you to run
3282
3292
    this command. When the default format has changed you may also be warned
3300
3310
 
3301
3311
 
3302
3312
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3313
    """Show or set bzr user id.
3304
3314
 
3305
3315
    :Examples:
3306
3316
        Show the email of the current user::
3350
3360
 
3351
3361
 
3352
3362
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3363
    """Print or set the branch nickname.
3354
3364
 
3355
3365
    If unset, the tree root directory name is used as the nickname.
3356
3366
    To print the current nickname, execute with no argument.
3361
3371
 
3362
3372
    _see_also = ['info']
3363
3373
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3374
    def run(self, nickname=None):
 
3375
        branch = Branch.open_containing(u'.')[0]
3367
3376
        if nickname is None:
3368
3377
            self.printme(branch)
3369
3378
        else:
3375
3384
 
3376
3385
 
3377
3386
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3387
    """Set/unset and display aliases.
3379
3388
 
3380
3389
    :Examples:
3381
3390
        Show the current aliases::
3445
3454
 
3446
3455
 
3447
3456
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3457
    """Run internal test suite.
3449
3458
 
3450
3459
    If arguments are given, they are regular expressions that say which tests
3451
3460
    should run.  Tests matching any expression are run, and other tests are
3592
3601
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3602
                    "needs to be installed to use --subunit.")
3594
3603
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3595
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3596
 
            # stdout, which would corrupt the subunit stream. 
3597
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3598
 
                import msvcrt
3599
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3600
3604
        if parallel:
3601
3605
            self.additional_selftest_args.setdefault(
3602
3606
                'suite_decorators', []).append(parallel)
3633
3637
 
3634
3638
 
3635
3639
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3640
    """Show version of bzr."""
3637
3641
 
3638
3642
    encoding_type = 'replace'
3639
3643
    takes_options = [
3650
3654
 
3651
3655
 
3652
3656
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3657
    """Statement of optimism."""
3654
3658
 
3655
3659
    hidden = True
3656
3660
 
3660
3664
 
3661
3665
 
3662
3666
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3667
    """Find and print a base revision for merging two branches."""
3664
3668
    # TODO: Options to specify revisions on either side, as if
3665
3669
    #       merging only part of the history.
3666
3670
    takes_args = ['branch', 'other']
3672
3676
 
3673
3677
        branch1 = Branch.open_containing(branch)[0]
3674
3678
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3679
        branch1.lock_read()
 
3680
        self.add_cleanup(branch1.unlock)
 
3681
        branch2.lock_read()
 
3682
        self.add_cleanup(branch2.unlock)
3677
3683
        last1 = ensure_null(branch1.last_revision())
3678
3684
        last2 = ensure_null(branch2.last_revision())
3679
3685
 
3684
3690
 
3685
3691
 
3686
3692
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3693
    """Perform a three-way merge.
3688
3694
 
3689
3695
    The source of the merge can be specified either in the form of a branch,
3690
3696
    or in the form of a path to a file containing a merge directive generated
3773
3779
                ' completely merged into the source, pull from the'
3774
3780
                ' source rather than merging.  When this happens,'
3775
3781
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3782
        Option('directory',
3777
3783
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3784
                    'rather than the one containing the working directory.',
 
3785
               short_name='d',
 
3786
               type=unicode,
 
3787
               ),
3779
3788
        Option('preview', help='Instead of merging, show a diff of the'
3780
3789
               ' merge.'),
3781
3790
        Option('interactive', help='Select changes interactively.',
3814
3823
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3824
        pb = ui.ui_factory.nested_progress_bar()
3816
3825
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3826
        tree.lock_write()
 
3827
        self.add_cleanup(tree.unlock)
3818
3828
        if location is not None:
3819
3829
            try:
3820
3830
                mergeable = bundle.read_mergeable_from_url(location,
4041
4051
 
4042
4052
 
4043
4053
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
4054
    """Redo a merge.
4045
4055
 
4046
4056
    Use this if you want to try a different merge technique while resolving
4047
4057
    conflicts.  Some merge techniques are better than others, and remerge
4076
4086
        if merge_type is None:
4077
4087
            merge_type = _mod_merge.Merge3Merger
4078
4088
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4089
        tree.lock_write()
 
4090
        self.add_cleanup(tree.unlock)
4080
4091
        parents = tree.get_parent_ids()
4081
4092
        if len(parents) != 2:
4082
4093
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4146
 
4136
4147
 
4137
4148
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4149
    """Revert files to a previous revision.
4139
4150
 
4140
4151
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4152
    will be reverted.  If the revision is not specified with '--revision', the
4192
4203
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4204
            forget_merges=None):
4194
4205
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4206
        tree.lock_write()
 
4207
        self.add_cleanup(tree.unlock)
4196
4208
        if forget_merges:
4197
4209
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4210
        else:
4206
4218
 
4207
4219
 
4208
4220
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4221
    """Test reporting of assertion failures"""
4210
4222
    # intended just for use in testing
4211
4223
 
4212
4224
    hidden = True
4216
4228
 
4217
4229
 
4218
4230
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4231
    """Show help on a command or other topic.
4220
4232
    """
4221
4233
 
4222
4234
    _see_also = ['topics']
4235
4247
 
4236
4248
 
4237
4249
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4250
    """Show appropriate completions for context.
4239
4251
 
4240
4252
    For a list of all available commands, say 'bzr shell-complete'.
4241
4253
    """
4250
4262
 
4251
4263
 
4252
4264
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4265
    """Show unmerged/unpulled revisions between two branches.
4254
4266
 
4255
4267
    OTHER_BRANCH may be local or remote.
4256
4268
 
4334
4346
            restrict = 'remote'
4335
4347
 
4336
4348
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4349
        parent = local_branch.get_parent()
4340
4350
        if other_branch is None:
4341
4351
            other_branch = parent
4350
4360
        remote_branch = Branch.open(other_branch)
4351
4361
        if remote_branch.base == local_branch.base:
4352
4362
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4363
 
 
4364
        local_branch.lock_read()
 
4365
        self.add_cleanup(local_branch.unlock)
4356
4366
        local_revid_range = _revision_range_to_revid_range(
4357
4367
            _get_revision_range(my_revision, local_branch,
4358
4368
                self.name()))
4359
4369
 
 
4370
        remote_branch.lock_read()
 
4371
        self.add_cleanup(remote_branch.unlock)
4360
4372
        remote_revid_range = _revision_range_to_revid_range(
4361
4373
            _get_revision_range(revision,
4362
4374
                remote_branch, self.name()))
4412
4424
            message("Branches are up to date.\n")
4413
4425
        self.cleanup_now()
4414
4426
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4427
            local_branch.lock_write()
 
4428
            self.add_cleanup(local_branch.unlock)
4416
4429
            # handle race conditions - a parent might be set while we run.
4417
4430
            if local_branch.get_parent() is None:
4418
4431
                local_branch.set_parent(remote_branch.base)
4420
4433
 
4421
4434
 
4422
4435
class cmd_pack(Command):
4423
 
    __doc__ = """Compress the data within a repository.
4424
 
 
4425
 
    This operation compresses the data within a bazaar repository. As
4426
 
    bazaar supports automatic packing of repository, this operation is
4427
 
    normally not required to be done manually.
4428
 
 
4429
 
    During the pack operation, bazaar takes a backup of existing repository
4430
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4431
 
    automatically when it is safe to do so. To save disk space by removing
4432
 
    the backed up pack files, the --clean-obsolete-packs option may be
4433
 
    used.
4434
 
 
4435
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4436
 
    during or immediately after repacking, you may be left with a state
4437
 
    where the deletion has been written to disk but the new packs have not
4438
 
    been. In this case the repository may be unusable.
4439
 
    """
 
4436
    """Compress the data within a repository."""
4440
4437
 
4441
4438
    _see_also = ['repositories']
4442
4439
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4440
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4441
    def run(self, branch_or_repo='.'):
4448
4442
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4443
        try:
4450
4444
            branch = dir.open_branch()
4451
4445
            repository = branch.repository
4452
4446
        except errors.NotBranchError:
4453
4447
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4448
        repository.pack()
4455
4449
 
4456
4450
 
4457
4451
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4452
    """List the installed plugins.
4459
4453
 
4460
4454
    This command displays the list of installed plugins including
4461
4455
    version of plugin and a short description of each.
4500
4494
 
4501
4495
 
4502
4496
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4497
    """Show testament (signing-form) of a revision."""
4504
4498
    takes_options = [
4505
4499
            'revision',
4506
4500
            Option('long', help='Produce long-format testament.'),
4518
4512
            b = Branch.open_containing(branch)[0]
4519
4513
        else:
4520
4514
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4515
        b.lock_read()
 
4516
        self.add_cleanup(b.unlock)
4522
4517
        if revision is None:
4523
4518
            rev_id = b.last_revision()
4524
4519
        else:
4531
4526
 
4532
4527
 
4533
4528
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4529
    """Show the origin of each line in a file.
4535
4530
 
4536
4531
    This prints out the given file with an annotation on the left side
4537
4532
    indicating which revision, author and date introduced the change.
4548
4543
                     Option('long', help='Show commit date in annotations.'),
4549
4544
                     'revision',
4550
4545
                     'show-ids',
4551
 
                     'directory',
4552
4546
                     ]
4553
4547
    encoding_type = 'exact'
4554
4548
 
4555
4549
    @display_command
4556
4550
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4551
            show_ids=False):
4558
4552
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4553
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4554
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4555
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4556
            wt.lock_read()
 
4557
            self.add_cleanup(wt.unlock)
4563
4558
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4559
            branch.lock_read()
 
4560
            self.add_cleanup(branch.unlock)
4565
4561
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4562
        tree.lock_read()
 
4563
        self.add_cleanup(tree.unlock)
4567
4564
        if wt is not None:
4568
4565
            file_id = wt.path2id(relpath)
4569
4566
        else:
4582
4579
 
4583
4580
 
4584
4581
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4582
    """Create a digital signature for an existing revision."""
4586
4583
    # TODO be able to replace existing ones.
4587
4584
 
4588
4585
    hidden = True # is this right ?
4589
4586
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4587
    takes_options = ['revision']
4591
4588
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4589
    def run(self, revision_id_list=None, revision=None):
4593
4590
        if revision_id_list is not None and revision is not None:
4594
4591
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4592
        if revision_id_list is None and revision is None:
4596
4593
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4597
 
        b = WorkingTree.open_containing(directory)[0].branch
4598
 
        self.add_cleanup(b.lock_write().unlock)
 
4594
        b = WorkingTree.open_containing(u'.')[0].branch
 
4595
        b.lock_write()
 
4596
        self.add_cleanup(b.unlock)
4599
4597
        return self._run(b, revision_id_list, revision)
4600
4598
 
4601
4599
    def _run(self, b, revision_id_list, revision):
4647
4645
 
4648
4646
 
4649
4647
class cmd_bind(Command):
4650
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4651
 
    If no branch is supplied, rebind to the last bound location.
 
4648
    """Convert the current branch into a checkout of the supplied branch.
4652
4649
 
4653
4650
    Once converted into a checkout, commits must succeed on the master branch
4654
4651
    before they will be applied to the local branch.
4660
4657
 
4661
4658
    _see_also = ['checkouts', 'unbind']
4662
4659
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4660
    takes_options = []
4664
4661
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4662
    def run(self, location=None):
 
4663
        b, relpath = Branch.open_containing(u'.')
4667
4664
        if location is None:
4668
4665
            try:
4669
4666
                location = b.get_old_bound_location()
4688
4685
 
4689
4686
 
4690
4687
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4688
    """Convert the current checkout into a regular branch.
4692
4689
 
4693
4690
    After unbinding, the local branch is considered independent and subsequent
4694
4691
    commits will be local only.
4696
4693
 
4697
4694
    _see_also = ['checkouts', 'bind']
4698
4695
    takes_args = []
4699
 
    takes_options = ['directory']
 
4696
    takes_options = []
4700
4697
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4698
    def run(self):
 
4699
        b, relpath = Branch.open_containing(u'.')
4703
4700
        if not b.unbind():
4704
4701
            raise errors.BzrCommandError('Local branch is not bound')
4705
4702
 
4706
4703
 
4707
4704
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4705
    """Remove the last committed revision.
4709
4706
 
4710
4707
    --verbose will print out what is being removed.
4711
4708
    --dry-run will go through all the motions, but not actually
4751
4748
            b = control.open_branch()
4752
4749
 
4753
4750
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4751
            tree.lock_write()
 
4752
            self.add_cleanup(tree.unlock)
4755
4753
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4754
            b.lock_write()
 
4755
            self.add_cleanup(b.unlock)
4757
4756
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4757
 
4759
4758
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4810
 
4812
4811
 
4813
4812
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4813
    """Break a dead lock on a repository, branch or working directory.
4815
4814
 
4816
4815
    CAUTION: Locks should only be broken when you are sure that the process
4817
4816
    holding the lock has been stopped.
4836
4835
 
4837
4836
 
4838
4837
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4838
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4839
 
4841
4840
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4841
    """
4850
4849
 
4851
4850
 
4852
4851
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4852
    """Run the bzr server."""
4854
4853
 
4855
4854
    aliases = ['server']
4856
4855
 
4867
4866
                    'result in a dynamically allocated port.  The default port '
4868
4867
                    'depends on the protocol.',
4869
4868
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4869
        Option('directory',
 
4870
               help='Serve contents of this directory.',
 
4871
               type=unicode),
4872
4872
        Option('allow-writes',
4873
4873
               help='By default the server is a readonly server.  Supplying '
4874
4874
                    '--allow-writes enables write access to the contents of '
4915
4915
 
4916
4916
 
4917
4917
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4918
    """Combine a tree into its containing tree.
4919
4919
 
4920
4920
    This command requires the target tree to be in a rich-root format.
4921
4921
 
4961
4961
 
4962
4962
 
4963
4963
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4964
    """Split a subdirectory of a tree into a separate tree.
4965
4965
 
4966
4966
    This command will produce a target tree in a format that supports
4967
4967
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4987
 
4988
4988
 
4989
4989
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4990
    """Generate a merge directive for auto-merge tools.
4991
4991
 
4992
4992
    A directive requests a merge to be performed, and also provides all the
4993
4993
    information necessary to do so.  This means it must either include a
5086
5086
 
5087
5087
 
5088
5088
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5089
    """Mail or create a merge-directive for submitting changes.
5090
5090
 
5091
5091
    A merge directive provides many things needed for requesting merges:
5092
5092
 
5203
5203
 
5204
5204
 
5205
5205
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5206
    """Create a merge-directive for submitting changes.
5207
5207
 
5208
5208
    A merge directive provides many things needed for requesting merges:
5209
5209
 
5276
5276
 
5277
5277
 
5278
5278
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5279
    """Create, remove or modify a tag naming a revision.
5280
5280
 
5281
5281
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5282
    (--revision) option can be given -rtag:X, where X is any previously
5303
5303
        Option('delete',
5304
5304
            help='Delete this tag rather than placing it.',
5305
5305
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5306
        Option('directory',
 
5307
            help='Branch in which to place the tag.',
 
5308
            short_name='d',
 
5309
            type=unicode,
 
5310
            ),
5308
5311
        Option('force',
5309
5312
            help='Replace existing tags.',
5310
5313
            ),
5318
5321
            revision=None,
5319
5322
            ):
5320
5323
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5324
        branch.lock_write()
 
5325
        self.add_cleanup(branch.unlock)
5322
5326
        if delete:
5323
5327
            if tag_name is None:
5324
5328
                raise errors.BzrCommandError("No tag specified to delete.")
5345
5349
 
5346
5350
 
5347
5351
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5352
    """List tags.
5349
5353
 
5350
5354
    This command shows a table of tag names and the revisions they reference.
5351
5355
    """
5352
5356
 
5353
5357
    _see_also = ['tag']
5354
5358
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5359
        Option('directory',
 
5360
            help='Branch whose tags should be displayed.',
 
5361
            short_name='d',
 
5362
            type=unicode,
 
5363
            ),
5357
5364
        RegistryOption.from_kwargs('sort',
5358
5365
            'Sort tags by different criteria.', title='Sorting',
5359
5366
            alpha='Sort tags lexicographically (default).',
5376
5383
        if not tags:
5377
5384
            return
5378
5385
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5386
        branch.lock_read()
 
5387
        self.add_cleanup(branch.unlock)
5380
5388
        if revision:
5381
5389
            graph = branch.repository.get_graph()
5382
5390
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5423
 
5416
5424
 
5417
5425
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5426
    """Reconfigure the type of a bzr directory.
5419
5427
 
5420
5428
    A target configuration must be specified.
5421
5429
 
5506
5514
 
5507
5515
 
5508
5516
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5517
    """Set the branch of a checkout and update.
5510
5518
 
5511
5519
    For lightweight checkouts, this changes the branch being referenced.
5512
5520
    For heavyweight checkouts, this checks that there are no local commits
5602
5610
 
5603
5611
 
5604
5612
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5613
    """Manage filtered views.
5606
5614
 
5607
5615
    Views provide a mask over the tree so that users can focus on
5608
5616
    a subset of a tree when doing their work. After creating a view,
5756
5764
 
5757
5765
 
5758
5766
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5767
    """Show hooks."""
5760
5768
 
5761
5769
    hidden = True
5762
5770
 
5776
5784
 
5777
5785
 
5778
5786
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
 
5787
    """Remove a branch.
5780
5788
 
5781
5789
    This will remove the branch from the specified location but 
5782
5790
    will keep any working tree or repository in place.
5801
5809
        
5802
5810
 
5803
5811
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5812
    """Temporarily set aside some changes from the current tree.
5805
5813
 
5806
5814
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5815
    ie. out of the way, until a later time when you can bring them back from
5860
5868
 
5861
5869
    def run_for_list(self):
5862
5870
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5871
        tree.lock_read()
 
5872
        self.add_cleanup(tree.unlock)
5864
5873
        manager = tree.get_shelf_manager()
5865
5874
        shelves = manager.active_shelves()
5866
5875
        if len(shelves) == 0:
5875
5884
 
5876
5885
 
5877
5886
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5887
    """Restore shelved changes.
5879
5888
 
5880
5889
    By default, the most recently shelved changes are restored. However if you
5881
5890
    specify a shelf by id those changes will be restored instead.  This works
5907
5916
 
5908
5917
 
5909
5918
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5919
    """Remove unwanted files from working tree.
5911
5920
 
5912
5921
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5922
    files are never deleted.
5921
5930
 
5922
5931
    To check what clean-tree will do, use --dry-run.
5923
5932
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5933
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5934
                     Option('detritus', help='Delete conflict files, merge'
5927
5935
                            ' backups, and failed selftest dirs.'),
5928
5936
                     Option('unknown',
5931
5939
                            ' deleting them.'),
5932
5940
                     Option('force', help='Do not prompt before deleting.')]
5933
5941
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5942
            force=False):
5935
5943
        from bzrlib.clean_tree import clean_tree
5936
5944
        if not (unknown or ignored or detritus):
5937
5945
            unknown = True
5938
5946
        if dry_run:
5939
5947
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5948
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5949
                   dry_run=dry_run, no_prompt=force)
5942
5950
 
5943
5951
 
5944
5952
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5953
    """list, view and set branch locations for nested trees.
5946
5954
 
5947
5955
    If no arguments are provided, lists the branch locations for nested trees.
5948
5956
    If one argument is provided, display the branch location for that tree.