/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: Jelmer Vernooij
  • Date: 2010-03-31 16:29:25 UTC
  • mto: This revision was merged to the branch mainline in revision 5197.
  • Revision ID: jelmer@samba.org-20100331162925-vu738ae1329vwla0
Remove more unused imports in the tests.

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,
232
228
    return view_info
233
229
 
234
230
 
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
231
# TODO: Make sure no commands unconditionally use the working directory as a
244
232
# branch.  If a filename argument is used, the first of them should be used to
245
233
# specify the branch.  (Perhaps this can be factored out into some kind of
247
235
# opens the branch?)
248
236
 
249
237
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
238
    """Display status summary.
251
239
 
252
240
    This reports on versioned and unknown files, reporting them
253
241
    grouped by state.  Possible states are:
340
328
 
341
329
 
342
330
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
331
    """Write out metadata for a revision.
344
332
 
345
333
    The revision to print can either be specified by a specific
346
334
    revision identifier, or you can use --revision.
348
336
 
349
337
    hidden = True
350
338
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
339
    takes_options = ['revision']
352
340
    # cat-revision is more for frontends so should be exact
353
341
    encoding = 'strict'
354
342
 
361
349
        self.outf.write(revtext.decode('utf-8'))
362
350
 
363
351
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
352
    def run(self, revision_id=None, revision=None):
365
353
        if revision_id is not None and revision is not None:
366
354
            raise errors.BzrCommandError('You can only supply one of'
367
355
                                         ' revision_id or --revision')
368
356
        if revision_id is None and revision is None:
369
357
            raise errors.BzrCommandError('You must supply either'
370
358
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
 
359
        b = WorkingTree.open_containing(u'.')[0].branch
372
360
 
373
361
        revisions = b.repository.revisions
374
362
        if revisions is None:
398
386
        
399
387
 
400
388
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
389
    """Dump the contents of a btree index file to stdout.
402
390
 
403
391
    PATH is a btree index file, it can be any URL. This includes things like
404
392
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
479
467
 
480
468
 
481
469
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
470
    """Remove the working tree from a given branch/checkout.
483
471
 
484
472
    Since a lightweight checkout is little more than a working tree
485
473
    this will refuse to run against one.
512
500
                if (working.has_changes()):
513
501
                    raise errors.UncommittedChanges(working)
514
502
 
515
 
            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:
516
506
                raise errors.BzrCommandError("You cannot remove the working tree"
517
507
                                             " from a lightweight checkout")
518
508
 
520
510
 
521
511
 
522
512
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
513
    """Show current revision number.
524
514
 
525
515
    This is equal to the number of revisions on this branch.
526
516
    """
536
526
        if tree:
537
527
            try:
538
528
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
529
                wt.lock_read()
540
530
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
531
                raise errors.NoWorkingTree(location)
 
532
            self.add_cleanup(wt.unlock)
542
533
            revid = wt.last_revision()
543
534
            try:
544
535
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
538
            revno = ".".join(str(n) for n in revno_t)
548
539
        else:
549
540
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
541
            b.lock_read()
 
542
            self.add_cleanup(b.unlock)
551
543
            revno = b.revno()
552
544
        self.cleanup_now()
553
545
        self.outf.write(str(revno) + '\n')
554
546
 
555
547
 
556
548
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
549
    """Show revision number and revision id for a given revision identifier.
558
550
    """
559
551
    hidden = True
560
552
    takes_args = ['revision_info*']
561
553
    takes_options = [
562
554
        'revision',
563
 
        custom_help('directory',
 
555
        Option('directory',
564
556
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
 
557
                 'rather than the one containing the working directory.',
 
558
            short_name='d',
 
559
            type=unicode,
 
560
            ),
566
561
        Option('tree', help='Show revno of working tree'),
567
562
        ]
568
563
 
573
568
        try:
574
569
            wt = WorkingTree.open_containing(directory)[0]
575
570
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
571
            wt.lock_read()
 
572
            self.add_cleanup(wt.unlock)
577
573
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
574
            wt = None
579
575
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
576
            b.lock_read()
 
577
            self.add_cleanup(b.unlock)
581
578
        revision_ids = []
582
579
        if revision is not None:
583
580
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
608
 
612
609
 
613
610
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
611
    """Add specified files or directories.
615
612
 
616
613
    In non-recursive mode, all the named items are added, regardless
617
614
    of whether they were previously ignored.  A warning is given if
682
679
                should_print=(not is_quiet()))
683
680
 
684
681
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
682
            base_tree.lock_read()
 
683
            self.add_cleanup(base_tree.unlock)
686
684
        tree, file_list = tree_files_for_add(file_list)
687
685
        added, ignored = tree.smart_add(file_list, not
688
686
            no_recurse, action=action, save=not dry_run)
696
694
 
697
695
 
698
696
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
697
    """Create a new versioned directory.
700
698
 
701
699
    This is equivalent to creating the directory and then adding it.
702
700
    """
718
716
 
719
717
 
720
718
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
719
    """Show path of a file relative to root"""
722
720
 
723
721
    takes_args = ['filename']
724
722
    hidden = True
733
731
 
734
732
 
735
733
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
734
    """Show inventory of the current working copy or a revision.
737
735
 
738
736
    It is possible to limit the output to a particular entry
739
737
    type using the --kind option.  For example: --kind file.
760
758
 
761
759
        revision = _get_one_revision('inventory', revision)
762
760
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
761
        work_tree.lock_read()
 
762
        self.add_cleanup(work_tree.unlock)
764
763
        if revision is not None:
765
764
            tree = revision.as_tree(work_tree.branch)
766
765
 
767
766
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
767
            tree.lock_read()
 
768
            self.add_cleanup(tree.unlock)
769
769
        else:
770
770
            tree = work_tree
771
771
            extra_trees = []
792
792
 
793
793
 
794
794
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
795
    """Move or rename a file.
796
796
 
797
797
    :Usage:
798
798
        bzr mv OLDNAME NEWNAME
831
831
        if len(names_list) < 2:
832
832
            raise errors.BzrCommandError("missing file argument")
833
833
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
834
        tree.lock_tree_write()
 
835
        self.add_cleanup(tree.unlock)
835
836
        self._run(tree, names_list, rel_names, after)
836
837
 
837
838
    def run_auto(self, names_list, after, dry_run):
842
843
            raise errors.BzrCommandError('--after cannot be specified with'
843
844
                                         ' --auto.')
844
845
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
846
        work_tree.lock_tree_write()
 
847
        self.add_cleanup(work_tree.unlock)
846
848
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
849
 
848
850
    def _run(self, tree, names_list, rel_names, after):
927
929
 
928
930
 
929
931
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
932
    """Turn this branch into a mirror of another branch.
931
933
 
932
934
    By default, this command only works on branches that have not diverged.
933
935
    Branches are considered diverged if the destination branch's most recent 
956
958
    takes_options = ['remember', 'overwrite', 'revision',
957
959
        custom_help('verbose',
958
960
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
961
        Option('directory',
960
962
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
963
                 'rather than the one containing the working directory.',
 
964
            short_name='d',
 
965
            type=unicode,
 
966
            ),
962
967
        Option('local',
963
968
            help="Perform a local pull in a bound "
964
969
                 "branch.  Local pulls are not applied to "
979
984
        try:
980
985
            tree_to = WorkingTree.open_containing(directory)[0]
981
986
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
987
        except errors.NoWorkingTree:
984
988
            tree_to = None
985
989
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
990
        
988
991
        if local and not branch_to.get_bound_location():
989
992
            raise errors.LocalRequiresBoundBranch()
990
993
 
1020
1023
        else:
1021
1024
            branch_from = Branch.open(location,
1022
1025
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
1026
 
1025
1027
            if branch_to.get_parent() is None or remember:
1026
1028
                branch_to.set_parent(branch_from.base)
1027
1029
 
 
1030
        if branch_from is not branch_to:
 
1031
            branch_from.lock_read()
 
1032
            self.add_cleanup(branch_from.unlock)
1028
1033
        if revision is not None:
1029
1034
            revision_id = revision.as_revision_id(branch_from)
1030
1035
 
 
1036
        branch_to.lock_write()
 
1037
        self.add_cleanup(branch_to.unlock)
1031
1038
        if tree_to is not None:
1032
1039
            view_info = _get_view_info_for_change_reporter(tree_to)
1033
1040
            change_reporter = delta._ChangeReporter(
1048
1055
 
1049
1056
 
1050
1057
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1058
    """Update a mirror of this branch.
1052
1059
 
1053
1060
    The target branch will not have its working tree populated because this
1054
1061
    is both expensive, and is not supported on remote file systems.
1078
1085
        Option('create-prefix',
1079
1086
               help='Create the path leading up to the branch '
1080
1087
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1088
        Option('directory',
1082
1089
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1090
                 'rather than the one containing the working directory.',
 
1091
            short_name='d',
 
1092
            type=unicode,
 
1093
            ),
1084
1094
        Option('use-existing-dir',
1085
1095
               help='By default push will fail if the target'
1086
1096
                    ' directory exists, but does not already'
1112
1122
        # Get the source branch
1113
1123
        (tree, br_from,
1114
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
1115
1128
        # Get the tip's revision_id
1116
1129
        revision = _get_one_revision('push', revision)
1117
1130
        if revision is not None:
1118
1131
            revision_id = revision.in_history(br_from).rev_id
1119
1132
        else:
1120
1133
            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.')
 
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
 
1126
1145
        # Get the stacked_on branch, if any
1127
1146
        if stacked_on is not None:
1128
1147
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1179
 
1161
1180
 
1162
1181
class cmd_branch(Command):
1163
 
    __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.
1164
1183
 
1165
1184
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1185
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1225
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1226
            from_location)
1208
1227
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1228
        br_from.lock_read()
 
1229
        self.add_cleanup(br_from.unlock)
1210
1230
        if revision is not None:
1211
1231
            revision_id = revision.as_revision_id(br_from)
1212
1232
        else:
1272
1292
 
1273
1293
 
1274
1294
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1295
    """Create a new checkout of an existing branch.
1276
1296
 
1277
1297
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1298
    the branch found in '.'. This is useful if you have removed the working tree
1336
1356
            except errors.NoWorkingTree:
1337
1357
                source.bzrdir.create_workingtree(revision_id)
1338
1358
                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
1359
        source.create_checkout(to_location, revision_id, lightweight,
1345
1360
                               accelerator_tree, hardlink)
1346
1361
 
1347
1362
 
1348
1363
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1364
    """Show list of renamed files.
1350
1365
    """
1351
1366
    # TODO: Option to show renames between two historical versions.
1352
1367
 
1357
1372
    @display_command
1358
1373
    def run(self, dir=u'.'):
1359
1374
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1375
        tree.lock_read()
 
1376
        self.add_cleanup(tree.unlock)
1361
1377
        new_inv = tree.inventory
1362
1378
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1379
        old_tree.lock_read()
 
1380
        self.add_cleanup(old_tree.unlock)
1364
1381
        old_inv = old_tree.inventory
1365
1382
        renames = []
1366
1383
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1393
 
1377
1394
 
1378
1395
class cmd_update(Command):
1379
 
    __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.
1380
1397
 
1381
1398
    This will perform a merge into the working tree, and may generate
1382
1399
    conflicts. If you have any local changes, you will still
1404
1421
        master = branch.get_master_branch(
1405
1422
            possible_transports=possible_transports)
1406
1423
        if master is not None:
 
1424
            tree.lock_write()
1407
1425
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1426
        else:
 
1427
            tree.lock_tree_write()
1410
1428
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1429
        self.add_cleanup(tree.unlock)
1413
1430
        # get rid of the final '/' and be ready for display
1414
1431
        branch_location = urlutils.unescape_for_display(
1427
1444
        else:
1428
1445
            revision_id = branch.last_revision()
1429
1446
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1430
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1431
 
            note("Tree is up to date at revision %s of branch %s" %
1432
 
                ('.'.join(map(str, revno)), branch_location))
 
1447
            revno = branch.revision_id_to_revno(revision_id)
 
1448
            note("Tree is up to date at revision %d of branch %s" %
 
1449
                (revno, branch_location))
1433
1450
            return 0
1434
1451
        view_info = _get_view_info_for_change_reporter(tree)
1435
1452
        change_reporter = delta._ChangeReporter(
1447
1464
                                  "bzr update --revision only works"
1448
1465
                                  " for a revision in the branch history"
1449
1466
                                  % (e.revision))
1450
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1467
        revno = tree.branch.revision_id_to_revno(
1451
1468
            _mod_revision.ensure_null(tree.last_revision()))
1452
 
        note('Updated to revision %s of branch %s' %
1453
 
             ('.'.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:
 
1469
        note('Updated to revision %d of branch %s' %
 
1470
             (revno, branch_location))
 
1471
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1456
1472
            note('Your local commits will now show as pending merges with '
1457
1473
                 "'bzr status', and can be committed with 'bzr commit'.")
1458
1474
        if conflicts != 0:
1462
1478
 
1463
1479
 
1464
1480
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1481
    """Show information about a working tree, branch or repository.
1466
1482
 
1467
1483
    This command will show all known locations and formats associated to the
1468
1484
    tree, branch or repository.
1506
1522
 
1507
1523
 
1508
1524
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1525
    """Remove files or directories.
1510
1526
 
1511
1527
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1528
    them if they can easily be recovered using revert. If no options or
1534
1550
        if file_list is not None:
1535
1551
            file_list = [f for f in file_list]
1536
1552
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1553
        tree.lock_write()
 
1554
        self.add_cleanup(tree.unlock)
1538
1555
        # Heuristics should probably all move into tree.remove_smart or
1539
1556
        # some such?
1540
1557
        if new:
1559
1576
 
1560
1577
 
1561
1578
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1579
    """Print file_id of a particular file or directory.
1563
1580
 
1564
1581
    The file_id is assigned when the file is first added and remains the
1565
1582
    same through all revisions where the file exists, even when it is
1581
1598
 
1582
1599
 
1583
1600
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1601
    """Print path of file_ids to a file or directory.
1585
1602
 
1586
1603
    This prints one line for each directory down to the target,
1587
1604
    starting at the branch root.
1603
1620
 
1604
1621
 
1605
1622
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1623
    """Reconcile bzr metadata in a branch.
1607
1624
 
1608
1625
    This can correct data mismatches that may have been caused by
1609
1626
    previous ghost operations or bzr upgrades. You should only
1631
1648
 
1632
1649
 
1633
1650
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1651
    """Display the list of revision ids on a branch."""
1635
1652
 
1636
1653
    _see_also = ['log']
1637
1654
    takes_args = ['location?']
1647
1664
 
1648
1665
 
1649
1666
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1667
    """List all revisions merged into this branch."""
1651
1668
 
1652
1669
    _see_also = ['log', 'revision-history']
1653
1670
    takes_args = ['location?']
1672
1689
 
1673
1690
 
1674
1691
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1692
    """Make a directory into a versioned branch.
1676
1693
 
1677
1694
    Use this to create an empty branch, or before importing an
1678
1695
    existing project.
1781
1798
 
1782
1799
 
1783
1800
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1801
    """Create a shared repository for branches to share storage space.
1785
1802
 
1786
1803
    New branches created under the repository directory will store their
1787
1804
    revisions in the repository, not in the branch directory.  For branches
1841
1858
 
1842
1859
 
1843
1860
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1861
    """Show differences in the working tree, between revisions or branches.
1845
1862
 
1846
1863
    If no arguments are given, all changes for the current tree are listed.
1847
1864
    If files are given, only the changes in those files are listed.
1933
1950
            help='Use this command to compare files.',
1934
1951
            type=unicode,
1935
1952
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1953
        ]
1941
1954
    aliases = ['di', 'dif']
1942
1955
    encoding_type = 'exact'
1943
1956
 
1944
1957
    @display_command
1945
1958
    def run(self, revision=None, file_list=None, diff_options=None,
1946
 
            prefix=None, old=None, new=None, using=None, format=None):
1947
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1948
 
            show_diff_trees)
 
1959
            prefix=None, old=None, new=None, using=None):
 
1960
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1949
1961
 
1950
1962
        if (prefix is None) or (prefix == '0'):
1951
1963
            # diff -p0 format
1965
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1978
                                         ' one or two revision specifiers')
1967
1979
 
1968
 
        if using is not None and format is not None:
1969
 
            raise errors.BzrCommandError('--using and --format are mutually '
1970
 
                'exclusive.')
1971
 
 
1972
1980
        (old_tree, new_tree,
1973
1981
         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)
 
1982
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1983
            file_list, revision, old, new, apply_view=True)
1976
1984
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1985
                               specific_files=specific_files,
1978
1986
                               external_diff_options=diff_options,
1979
1987
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1988
                               extra_trees=extra_trees, using=using)
1982
1989
 
1983
1990
 
1984
1991
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1992
    """List files deleted in the working tree.
1986
1993
    """
1987
1994
    # TODO: Show files deleted since a previous revision, or
1988
1995
    # between two revisions.
1991
1998
    # level of effort but possibly much less IO.  (Or possibly not,
1992
1999
    # if the directories are very large...)
1993
2000
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
2001
    takes_options = ['show-ids']
1995
2002
 
1996
2003
    @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)
 
2004
    def run(self, show_ids=False):
 
2005
        tree = WorkingTree.open_containing(u'.')[0]
 
2006
        tree.lock_read()
 
2007
        self.add_cleanup(tree.unlock)
2000
2008
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
2009
        old.lock_read()
 
2010
        self.add_cleanup(old.unlock)
2002
2011
        for path, ie in old.inventory.iter_entries():
2003
2012
            if not tree.has_id(ie.file_id):
2004
2013
                self.outf.write(path)
2009
2018
 
2010
2019
 
2011
2020
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
2021
    """List files modified in working tree.
2013
2022
    """
2014
2023
 
2015
2024
    hidden = True
2016
2025
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
2026
    takes_options = [
 
2027
            Option('null',
 
2028
                   help='Write an ascii NUL (\\0) separator '
 
2029
                   'between files rather than a newline.')
 
2030
            ]
2018
2031
 
2019
2032
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2033
    def run(self, null=False):
 
2034
        tree = WorkingTree.open_containing(u'.')[0]
2022
2035
        td = tree.changes_from(tree.basis_tree())
2023
2036
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2037
            if null:
2028
2041
 
2029
2042
 
2030
2043
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2044
    """List files added in working tree.
2032
2045
    """
2033
2046
 
2034
2047
    hidden = True
2035
2048
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2049
    takes_options = [
 
2050
            Option('null',
 
2051
                   help='Write an ascii NUL (\\0) separator '
 
2052
                   'between files rather than a newline.')
 
2053
            ]
2037
2054
 
2038
2055
    @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)
 
2056
    def run(self, null=False):
 
2057
        wt = WorkingTree.open_containing(u'.')[0]
 
2058
        wt.lock_read()
 
2059
        self.add_cleanup(wt.unlock)
2042
2060
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2061
        basis.lock_read()
 
2062
        self.add_cleanup(basis.unlock)
2044
2063
        basis_inv = basis.inventory
2045
2064
        inv = wt.inventory
2046
2065
        for file_id in inv:
2049
2068
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2069
                continue
2051
2070
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2071
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2072
                continue
2054
2073
            if null:
2055
2074
                self.outf.write(path + '\0')
2058
2077
 
2059
2078
 
2060
2079
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2080
    """Show the tree root directory.
2062
2081
 
2063
2082
    The root is the nearest enclosing directory with a .bzr control
2064
2083
    directory."""
2088
2107
 
2089
2108
 
2090
2109
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2110
    """Show historical log for a branch or subset of a branch.
2092
2111
 
2093
2112
    log is bzr's default tool for exploring the history of a branch.
2094
2113
    The branch to use is taken from the first parameter. If no parameters
2255
2274
                   help='Show just the specified revision.'
2256
2275
                   ' See also "help revisionspec".'),
2257
2276
            '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
2277
            Option('levels',
2264
2278
                   short_name='n',
2265
2279
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2294
                   help='Show changes made in each revision as a patch.'),
2281
2295
            Option('include-merges',
2282
2296
                   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
2297
            ]
2288
2298
    encoding_type = 'replace'
2289
2299
 
2299
2309
            message=None,
2300
2310
            limit=None,
2301
2311
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2312
            include_merges=False):
2306
2313
        from bzrlib.log import (
2307
2314
            Logger,
2308
2315
            make_log_request_dict,
2309
2316
            _get_info_for_log_files,
2310
2317
            )
2311
2318
        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
2319
        if include_merges:
2317
2320
            if levels is None:
2318
2321
                levels = 0
2334
2337
        if file_list:
2335
2338
            # find the file ids to log and check for directory filtering
2336
2339
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2340
                revision, file_list)
 
2341
            self.add_cleanup(b.unlock)
2338
2342
            for relpath, file_id, kind in file_info_list:
2339
2343
                if file_id is None:
2340
2344
                    raise errors.BzrCommandError(
2358
2362
                location = '.'
2359
2363
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2364
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2365
            b.lock_read()
 
2366
            self.add_cleanup(b.unlock)
2362
2367
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2368
 
2364
2369
        # Decide on the type of delta & diff filtering to use
2384
2389
                        show_timezone=timezone,
2385
2390
                        delta_format=get_verbosity_level(),
2386
2391
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2392
                        show_advice=levels is None)
2389
2393
 
2390
2394
        # Choose the algorithm for doing the logging. It's annoying
2391
2395
        # having multiple code paths like this but necessary until
2410
2414
            direction=direction, specific_fileids=file_ids,
2411
2415
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2416
            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
 
            )
 
2417
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2418
        Logger(b, rqst).show(lf)
2417
2419
 
2418
2420
 
2476
2478
 
2477
2479
 
2478
2480
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2481
    """Return revision-ids which affected a particular file.
2480
2482
 
2481
2483
    A more user-friendly interface is "bzr log FILE".
2482
2484
    """
2489
2491
        tree, relpath = WorkingTree.open_containing(filename)
2490
2492
        file_id = tree.path2id(relpath)
2491
2493
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2494
        b.lock_read()
 
2495
        self.add_cleanup(b.unlock)
2493
2496
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2497
        for revno, revision_id, what in touching_revs:
2495
2498
            self.outf.write("%6d %s\n" % (revno, what))
2496
2499
 
2497
2500
 
2498
2501
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2502
    """List files in a tree.
2500
2503
    """
2501
2504
 
2502
2505
    _see_also = ['status', 'cat']
2508
2511
                   help='Recurse into subdirectories.'),
2509
2512
            Option('from-root',
2510
2513
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2514
            Option('unknown', help='Print unknown files.'),
2513
2515
            Option('versioned', help='Print versioned files.',
2514
2516
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2517
            Option('ignored', help='Print ignored files.'),
 
2518
            Option('null',
 
2519
                   help='Write an ascii NUL (\\0) separator '
 
2520
                   'between files rather than a newline.'),
 
2521
            Option('kind',
2518
2522
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2523
                   type=unicode),
2520
 
            'null',
2521
2524
            'show-ids',
2522
 
            'directory',
2523
2525
            ]
2524
2526
    @display_command
2525
2527
    def run(self, revision=None, verbose=False,
2526
2528
            recursive=False, from_root=False,
2527
2529
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2530
            null=False, kind=None, show_ids=False, path=None):
2529
2531
 
2530
2532
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2533
            raise errors.BzrCommandError('invalid kind specified')
2543
2545
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2546
                                             ' and PATH')
2545
2547
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2548
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2549
            fs_path)
2548
2550
 
2549
2551
        # Calculate the prefix to use
2550
2552
        prefix = None
2565
2567
                view_str = views.view_display_str(view_files)
2566
2568
                note("Ignoring files outside view. View is %s" % view_str)
2567
2569
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2570
        tree.lock_read()
 
2571
        self.add_cleanup(tree.unlock)
2569
2572
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2573
            from_dir=relpath, recursive=recursive):
2571
2574
            # Apply additional masking
2613
2616
 
2614
2617
 
2615
2618
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2619
    """List unknown files.
2617
2620
    """
2618
2621
 
2619
2622
    hidden = True
2620
2623
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2624
 
2623
2625
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2626
    def run(self):
 
2627
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2628
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2629
 
2628
2630
 
2629
2631
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2632
    """Ignore specified files or patterns.
2631
2633
 
2632
2634
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2635
 
2642
2644
    using this command or directly by using an editor, be sure to commit
2643
2645
    it.
2644
2646
    
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
2647
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2648
    precedence over regular ignores.  Such exceptions are used to specify
2653
2649
    files that should be versioned which would otherwise be ignored.
2693
2689
 
2694
2690
    _see_also = ['status', 'ignored', 'patterns']
2695
2691
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2692
    takes_options = [
 
2693
        Option('old-default-rules',
 
2694
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2695
        ]
2700
2696
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2697
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2698
        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:
 
2699
        if old_default_rules is not None:
 
2700
            # dump the rules and exit
 
2701
            for pattern in ignores.OLD_DEFAULTS:
2707
2702
                self.outf.write("%s\n" % pattern)
2708
2703
            return
2709
2704
        if not name_pattern_list:
2710
2705
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2706
                                  "NAME_PATTERN or --old-default-rules")
2712
2707
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2708
                             for p in name_pattern_list]
2714
2709
        for name_pattern in name_pattern_list:
2716
2711
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2712
                raise errors.BzrCommandError(
2718
2713
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2714
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2715
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2716
        ignored = globbing.Globster(name_pattern_list)
2722
2717
        matches = []
2736
2731
 
2737
2732
 
2738
2733
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2734
    """List ignored files and the patterns that matched them.
2740
2735
 
2741
2736
    List all the ignored files and the ignore pattern that caused the file to
2742
2737
    be ignored.
2748
2743
 
2749
2744
    encoding_type = 'replace'
2750
2745
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2746
 
2753
2747
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2748
    def run(self):
 
2749
        tree = WorkingTree.open_containing(u'.')[0]
 
2750
        tree.lock_read()
 
2751
        self.add_cleanup(tree.unlock)
2757
2752
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2753
            if file_class != 'I':
2759
2754
                continue
2763
2758
 
2764
2759
 
2765
2760
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2761
    """Lookup the revision-id from a revision-number
2767
2762
 
2768
2763
    :Examples:
2769
2764
        bzr lookup-revision 33
2770
2765
    """
2771
2766
    hidden = True
2772
2767
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2768
 
2775
2769
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2770
    def run(self, revno):
2777
2771
        try:
2778
2772
            revno = int(revno)
2779
2773
        except ValueError:
2780
2774
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
2775
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2776
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2783
2777
        self.outf.write("%s\n" % revid)
2784
2778
 
2785
2779
 
2786
2780
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2781
    """Export current or past revision to a destination directory or archive.
2788
2782
 
2789
2783
    If no revision is specified this exports the last committed revision.
2790
2784
 
2812
2806
      =================       =========================
2813
2807
    """
2814
2808
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2809
    takes_options = [
2816
2810
        Option('format',
2817
2811
               help="Type of file to export to.",
2818
2812
               type=unicode),
2827
2821
                    'revision in which it was changed.'),
2828
2822
        ]
2829
2823
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2824
        root=None, filters=False, per_file_timestamps=False):
2831
2825
        from bzrlib.export import export
2832
2826
 
2833
2827
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2828
            tree = WorkingTree.open_containing(u'.')[0]
2835
2829
            b = tree.branch
2836
2830
            subdir = None
2837
2831
        else:
2847
2841
 
2848
2842
 
2849
2843
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2844
    """Write the contents of a file as of a given revision to standard output.
2851
2845
 
2852
2846
    If no revision is nominated, the last revision is used.
2853
2847
 
2856
2850
    """
2857
2851
 
2858
2852
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2853
    takes_options = [
2860
2854
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2855
        Option('filters', help='Apply content filters to display the '
2862
2856
                'convenience form.'),
2867
2861
 
2868
2862
    @display_command
2869
2863
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2864
            filters=False):
2871
2865
        if revision is not None and len(revision) != 1:
2872
2866
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2867
                                         " one revision specifier")
2874
2868
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2869
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2870
        branch.lock_read()
 
2871
        self.add_cleanup(branch.unlock)
2877
2872
        return self._run(tree, branch, relpath, filename, revision,
2878
2873
                         name_from_revision, filters)
2879
2874
 
2882
2877
        if tree is None:
2883
2878
            tree = b.basis_tree()
2884
2879
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2880
        rev_tree.lock_read()
 
2881
        self.add_cleanup(rev_tree.unlock)
2886
2882
 
2887
2883
        old_file_id = rev_tree.path2id(relpath)
2888
2884
 
2931
2927
 
2932
2928
 
2933
2929
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2930
    """Show the offset in seconds from GMT to local time."""
2935
2931
    hidden = True
2936
2932
    @display_command
2937
2933
    def run(self):
2940
2936
 
2941
2937
 
2942
2938
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2939
    """Commit changes into a new revision.
2944
2940
 
2945
2941
    An explanatory message needs to be given for each commit. This is
2946
2942
    often done by using the --message option (getting the message from the
3054
3050
                         "the master branch until a normal commit "
3055
3051
                         "is performed."
3056
3052
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3053
             Option('show-diff',
3058
3054
                    help='When no message is supplied, show the diff along'
3059
3055
                    ' with the status summary in the message editor.'),
3060
3056
             ]
3140
3136
                    '(use --file "%(f)s" to take commit message from that file)'
3141
3137
                    % { 'f': message })
3142
3138
                ui.ui_factory.show_warning(warning_msg)
3143
 
            if '\r' in message:
3144
 
                message = message.replace('\r\n', '\n')
3145
 
                message = message.replace('\r', '\n')
3146
 
            if file:
3147
 
                raise errors.BzrCommandError(
3148
 
                    "please specify either --message or --file")
3149
3139
 
3150
3140
        def get_message(commit_obj):
3151
3141
            """Callback to get commit message"""
3152
 
            if file:
3153
 
                my_message = codecs.open(
3154
 
                    file, 'rt', osutils.get_user_encoding()).read()
3155
 
            elif message is not None:
3156
 
                my_message = message
3157
 
            else:
3158
 
                # No message supplied: make one up.
3159
 
                # text is the status of the tree
3160
 
                text = make_commit_message_template_encoded(tree,
 
3142
            my_message = message
 
3143
            if my_message is not None and '\r' in my_message:
 
3144
                my_message = my_message.replace('\r\n', '\n')
 
3145
                my_message = my_message.replace('\r', '\n')
 
3146
            if my_message is None and not file:
 
3147
                t = make_commit_message_template_encoded(tree,
3161
3148
                        selected_list, diff=show_diff,
3162
3149
                        output_encoding=osutils.get_user_encoding())
3163
 
                # start_message is the template generated from hooks
3164
 
                # XXX: Warning - looks like hooks return unicode,
3165
 
                # make_commit_message_template_encoded returns user encoding.
3166
 
                # We probably want to be using edit_commit_message instead to
3167
 
                # avoid this.
3168
3150
                start_message = generate_commit_message_template(commit_obj)
3169
 
                my_message = edit_commit_message_encoded(text,
 
3151
                my_message = edit_commit_message_encoded(t,
3170
3152
                    start_message=start_message)
3171
3153
                if my_message is None:
3172
3154
                    raise errors.BzrCommandError("please specify a commit"
3173
3155
                        " message with either --message or --file")
 
3156
            elif my_message and file:
 
3157
                raise errors.BzrCommandError(
 
3158
                    "please specify either --message or --file")
 
3159
            if file:
 
3160
                my_message = codecs.open(file, 'rt',
 
3161
                                         osutils.get_user_encoding()).read()
3174
3162
            if my_message == "":
3175
3163
                raise errors.BzrCommandError("empty commit message specified")
3176
3164
            return my_message
3188
3176
                        timezone=offset,
3189
3177
                        exclude=safe_relpath_files(tree, exclude))
3190
3178
        except PointlessCommit:
 
3179
            # FIXME: This should really happen before the file is read in;
 
3180
            # perhaps prepare the commit; get the message; then actually commit
3191
3181
            raise errors.BzrCommandError("No changes to commit."
3192
3182
                              " Use --unchanged to commit anyhow.")
3193
3183
        except ConflictsInTree:
3206
3196
 
3207
3197
 
3208
3198
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3199
    """Validate working tree structure, branch consistency and repository history.
3210
3200
 
3211
3201
    This command checks various invariants about branch and repository storage
3212
3202
    to detect data corruption or bzr bugs.
3276
3266
 
3277
3267
 
3278
3268
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3269
    """Upgrade branch storage to current format.
3280
3270
 
3281
3271
    The check command or bzr developers may sometimes advise you to run
3282
3272
    this command. When the default format has changed you may also be warned
3300
3290
 
3301
3291
 
3302
3292
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3293
    """Show or set bzr user id.
3304
3294
 
3305
3295
    :Examples:
3306
3296
        Show the email of the current user::
3350
3340
 
3351
3341
 
3352
3342
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3343
    """Print or set the branch nickname.
3354
3344
 
3355
3345
    If unset, the tree root directory name is used as the nickname.
3356
3346
    To print the current nickname, execute with no argument.
3361
3351
 
3362
3352
    _see_also = ['info']
3363
3353
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3354
    def run(self, nickname=None):
 
3355
        branch = Branch.open_containing(u'.')[0]
3367
3356
        if nickname is None:
3368
3357
            self.printme(branch)
3369
3358
        else:
3375
3364
 
3376
3365
 
3377
3366
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3367
    """Set/unset and display aliases.
3379
3368
 
3380
3369
    :Examples:
3381
3370
        Show the current aliases::
3445
3434
 
3446
3435
 
3447
3436
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3437
    """Run internal test suite.
3449
3438
 
3450
3439
    If arguments are given, they are regular expressions that say which tests
3451
3440
    should run.  Tests matching any expression are run, and other tests are
3592
3581
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3582
                    "needs to be installed to use --subunit.")
3594
3583
            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
3584
        if parallel:
3601
3585
            self.additional_selftest_args.setdefault(
3602
3586
                'suite_decorators', []).append(parallel)
3633
3617
 
3634
3618
 
3635
3619
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3620
    """Show version of bzr."""
3637
3621
 
3638
3622
    encoding_type = 'replace'
3639
3623
    takes_options = [
3650
3634
 
3651
3635
 
3652
3636
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3637
    """Statement of optimism."""
3654
3638
 
3655
3639
    hidden = True
3656
3640
 
3660
3644
 
3661
3645
 
3662
3646
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3647
    """Find and print a base revision for merging two branches."""
3664
3648
    # TODO: Options to specify revisions on either side, as if
3665
3649
    #       merging only part of the history.
3666
3650
    takes_args = ['branch', 'other']
3672
3656
 
3673
3657
        branch1 = Branch.open_containing(branch)[0]
3674
3658
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3659
        branch1.lock_read()
 
3660
        self.add_cleanup(branch1.unlock)
 
3661
        branch2.lock_read()
 
3662
        self.add_cleanup(branch2.unlock)
3677
3663
        last1 = ensure_null(branch1.last_revision())
3678
3664
        last2 = ensure_null(branch2.last_revision())
3679
3665
 
3684
3670
 
3685
3671
 
3686
3672
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3673
    """Perform a three-way merge.
3688
3674
 
3689
3675
    The source of the merge can be specified either in the form of a branch,
3690
3676
    or in the form of a path to a file containing a merge directive generated
3773
3759
                ' completely merged into the source, pull from the'
3774
3760
                ' source rather than merging.  When this happens,'
3775
3761
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3762
        Option('directory',
3777
3763
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3764
                    'rather than the one containing the working directory.',
 
3765
               short_name='d',
 
3766
               type=unicode,
 
3767
               ),
3779
3768
        Option('preview', help='Instead of merging, show a diff of the'
3780
3769
               ' merge.'),
3781
3770
        Option('interactive', help='Select changes interactively.',
3814
3803
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3804
        pb = ui.ui_factory.nested_progress_bar()
3816
3805
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3806
        tree.lock_write()
 
3807
        self.add_cleanup(tree.unlock)
3818
3808
        if location is not None:
3819
3809
            try:
3820
3810
                mergeable = bundle.read_mergeable_from_url(location,
4041
4031
 
4042
4032
 
4043
4033
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
4034
    """Redo a merge.
4045
4035
 
4046
4036
    Use this if you want to try a different merge technique while resolving
4047
4037
    conflicts.  Some merge techniques are better than others, and remerge
4072
4062
 
4073
4063
    def run(self, file_list=None, merge_type=None, show_base=False,
4074
4064
            reprocess=False):
4075
 
        from bzrlib.conflicts import restore
4076
4065
        if merge_type is None:
4077
4066
            merge_type = _mod_merge.Merge3Merger
4078
4067
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4068
        tree.lock_write()
 
4069
        self.add_cleanup(tree.unlock)
4080
4070
        parents = tree.get_parent_ids()
4081
4071
        if len(parents) != 2:
4082
4072
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4125
 
4136
4126
 
4137
4127
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4128
    """Revert files to a previous revision.
4139
4129
 
4140
4130
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4131
    will be reverted.  If the revision is not specified with '--revision', the
4192
4182
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4183
            forget_merges=None):
4194
4184
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4185
        tree.lock_write()
 
4186
        self.add_cleanup(tree.unlock)
4196
4187
        if forget_merges:
4197
4188
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4189
        else:
4206
4197
 
4207
4198
 
4208
4199
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4200
    """Test reporting of assertion failures"""
4210
4201
    # intended just for use in testing
4211
4202
 
4212
4203
    hidden = True
4216
4207
 
4217
4208
 
4218
4209
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4210
    """Show help on a command or other topic.
4220
4211
    """
4221
4212
 
4222
4213
    _see_also = ['topics']
4235
4226
 
4236
4227
 
4237
4228
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4229
    """Show appropriate completions for context.
4239
4230
 
4240
4231
    For a list of all available commands, say 'bzr shell-complete'.
4241
4232
    """
4250
4241
 
4251
4242
 
4252
4243
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4244
    """Show unmerged/unpulled revisions between two branches.
4254
4245
 
4255
4246
    OTHER_BRANCH may be local or remote.
4256
4247
 
4334
4325
            restrict = 'remote'
4335
4326
 
4336
4327
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4328
        parent = local_branch.get_parent()
4340
4329
        if other_branch is None:
4341
4330
            other_branch = parent
4350
4339
        remote_branch = Branch.open(other_branch)
4351
4340
        if remote_branch.base == local_branch.base:
4352
4341
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4342
 
 
4343
        local_branch.lock_read()
 
4344
        self.add_cleanup(local_branch.unlock)
4356
4345
        local_revid_range = _revision_range_to_revid_range(
4357
4346
            _get_revision_range(my_revision, local_branch,
4358
4347
                self.name()))
4359
4348
 
 
4349
        remote_branch.lock_read()
 
4350
        self.add_cleanup(remote_branch.unlock)
4360
4351
        remote_revid_range = _revision_range_to_revid_range(
4361
4352
            _get_revision_range(revision,
4362
4353
                remote_branch, self.name()))
4412
4403
            message("Branches are up to date.\n")
4413
4404
        self.cleanup_now()
4414
4405
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4406
            local_branch.lock_write()
 
4407
            self.add_cleanup(local_branch.unlock)
4416
4408
            # handle race conditions - a parent might be set while we run.
4417
4409
            if local_branch.get_parent() is None:
4418
4410
                local_branch.set_parent(remote_branch.base)
4420
4412
 
4421
4413
 
4422
4414
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
 
    """
 
4415
    """Compress the data within a repository."""
4440
4416
 
4441
4417
    _see_also = ['repositories']
4442
4418
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4419
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4420
    def run(self, branch_or_repo='.'):
4448
4421
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4422
        try:
4450
4423
            branch = dir.open_branch()
4451
4424
            repository = branch.repository
4452
4425
        except errors.NotBranchError:
4453
4426
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4427
        repository.pack()
4455
4428
 
4456
4429
 
4457
4430
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4431
    """List the installed plugins.
4459
4432
 
4460
4433
    This command displays the list of installed plugins including
4461
4434
    version of plugin and a short description of each.
4500
4473
 
4501
4474
 
4502
4475
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4476
    """Show testament (signing-form) of a revision."""
4504
4477
    takes_options = [
4505
4478
            'revision',
4506
4479
            Option('long', help='Produce long-format testament.'),
4518
4491
            b = Branch.open_containing(branch)[0]
4519
4492
        else:
4520
4493
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4494
        b.lock_read()
 
4495
        self.add_cleanup(b.unlock)
4522
4496
        if revision is None:
4523
4497
            rev_id = b.last_revision()
4524
4498
        else:
4531
4505
 
4532
4506
 
4533
4507
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4508
    """Show the origin of each line in a file.
4535
4509
 
4536
4510
    This prints out the given file with an annotation on the left side
4537
4511
    indicating which revision, author and date introduced the change.
4548
4522
                     Option('long', help='Show commit date in annotations.'),
4549
4523
                     'revision',
4550
4524
                     'show-ids',
4551
 
                     'directory',
4552
4525
                     ]
4553
4526
    encoding_type = 'exact'
4554
4527
 
4555
4528
    @display_command
4556
4529
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4530
            show_ids=False):
4558
4531
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4532
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4533
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4534
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4535
            wt.lock_read()
 
4536
            self.add_cleanup(wt.unlock)
4563
4537
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4538
            branch.lock_read()
 
4539
            self.add_cleanup(branch.unlock)
4565
4540
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4541
        tree.lock_read()
 
4542
        self.add_cleanup(tree.unlock)
4567
4543
        if wt is not None:
4568
4544
            file_id = wt.path2id(relpath)
4569
4545
        else:
4582
4558
 
4583
4559
 
4584
4560
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4561
    """Create a digital signature for an existing revision."""
4586
4562
    # TODO be able to replace existing ones.
4587
4563
 
4588
4564
    hidden = True # is this right ?
4589
4565
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4566
    takes_options = ['revision']
4591
4567
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4568
    def run(self, revision_id_list=None, revision=None):
4593
4569
        if revision_id_list is not None and revision is not None:
4594
4570
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4571
        if revision_id_list is None and revision is None:
4596
4572
            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)
 
4573
        b = WorkingTree.open_containing(u'.')[0].branch
 
4574
        b.lock_write()
 
4575
        self.add_cleanup(b.unlock)
4599
4576
        return self._run(b, revision_id_list, revision)
4600
4577
 
4601
4578
    def _run(self, b, revision_id_list, revision):
4647
4624
 
4648
4625
 
4649
4626
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.
 
4627
    """Convert the current branch into a checkout of the supplied branch.
4652
4628
 
4653
4629
    Once converted into a checkout, commits must succeed on the master branch
4654
4630
    before they will be applied to the local branch.
4660
4636
 
4661
4637
    _see_also = ['checkouts', 'unbind']
4662
4638
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4639
    takes_options = []
4664
4640
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4641
    def run(self, location=None):
 
4642
        b, relpath = Branch.open_containing(u'.')
4667
4643
        if location is None:
4668
4644
            try:
4669
4645
                location = b.get_old_bound_location()
4688
4664
 
4689
4665
 
4690
4666
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4667
    """Convert the current checkout into a regular branch.
4692
4668
 
4693
4669
    After unbinding, the local branch is considered independent and subsequent
4694
4670
    commits will be local only.
4696
4672
 
4697
4673
    _see_also = ['checkouts', 'bind']
4698
4674
    takes_args = []
4699
 
    takes_options = ['directory']
 
4675
    takes_options = []
4700
4676
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4677
    def run(self):
 
4678
        b, relpath = Branch.open_containing(u'.')
4703
4679
        if not b.unbind():
4704
4680
            raise errors.BzrCommandError('Local branch is not bound')
4705
4681
 
4706
4682
 
4707
4683
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4684
    """Remove the last committed revision.
4709
4685
 
4710
4686
    --verbose will print out what is being removed.
4711
4687
    --dry-run will go through all the motions, but not actually
4751
4727
            b = control.open_branch()
4752
4728
 
4753
4729
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4730
            tree.lock_write()
 
4731
            self.add_cleanup(tree.unlock)
4755
4732
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4733
            b.lock_write()
 
4734
            self.add_cleanup(b.unlock)
4757
4735
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4736
 
4759
4737
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4789
 
4812
4790
 
4813
4791
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4792
    """Break a dead lock on a repository, branch or working directory.
4815
4793
 
4816
4794
    CAUTION: Locks should only be broken when you are sure that the process
4817
4795
    holding the lock has been stopped.
4836
4814
 
4837
4815
 
4838
4816
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4817
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4818
 
4841
4819
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4820
    """
4850
4828
 
4851
4829
 
4852
4830
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4831
    """Run the bzr server."""
4854
4832
 
4855
4833
    aliases = ['server']
4856
4834
 
4867
4845
                    'result in a dynamically allocated port.  The default port '
4868
4846
                    'depends on the protocol.',
4869
4847
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4848
        Option('directory',
 
4849
               help='Serve contents of this directory.',
 
4850
               type=unicode),
4872
4851
        Option('allow-writes',
4873
4852
               help='By default the server is a readonly server.  Supplying '
4874
4853
                    '--allow-writes enables write access to the contents of '
4915
4894
 
4916
4895
 
4917
4896
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4897
    """Combine a tree into its containing tree.
4919
4898
 
4920
4899
    This command requires the target tree to be in a rich-root format.
4921
4900
 
4961
4940
 
4962
4941
 
4963
4942
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4943
    """Split a subdirectory of a tree into a separate tree.
4965
4944
 
4966
4945
    This command will produce a target tree in a format that supports
4967
4946
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4966
 
4988
4967
 
4989
4968
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4969
    """Generate a merge directive for auto-merge tools.
4991
4970
 
4992
4971
    A directive requests a merge to be performed, and also provides all the
4993
4972
    information necessary to do so.  This means it must either include a
5086
5065
 
5087
5066
 
5088
5067
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5068
    """Mail or create a merge-directive for submitting changes.
5090
5069
 
5091
5070
    A merge directive provides many things needed for requesting merges:
5092
5071
 
5203
5182
 
5204
5183
 
5205
5184
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5185
    """Create a merge-directive for submitting changes.
5207
5186
 
5208
5187
    A merge directive provides many things needed for requesting merges:
5209
5188
 
5276
5255
 
5277
5256
 
5278
5257
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5258
    """Create, remove or modify a tag naming a revision.
5280
5259
 
5281
5260
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5261
    (--revision) option can be given -rtag:X, where X is any previously
5303
5282
        Option('delete',
5304
5283
            help='Delete this tag rather than placing it.',
5305
5284
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5285
        Option('directory',
 
5286
            help='Branch in which to place the tag.',
 
5287
            short_name='d',
 
5288
            type=unicode,
 
5289
            ),
5308
5290
        Option('force',
5309
5291
            help='Replace existing tags.',
5310
5292
            ),
5318
5300
            revision=None,
5319
5301
            ):
5320
5302
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5303
        branch.lock_write()
 
5304
        self.add_cleanup(branch.unlock)
5322
5305
        if delete:
5323
5306
            if tag_name is None:
5324
5307
                raise errors.BzrCommandError("No tag specified to delete.")
5345
5328
 
5346
5329
 
5347
5330
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5331
    """List tags.
5349
5332
 
5350
5333
    This command shows a table of tag names and the revisions they reference.
5351
5334
    """
5352
5335
 
5353
5336
    _see_also = ['tag']
5354
5337
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5338
        Option('directory',
 
5339
            help='Branch whose tags should be displayed.',
 
5340
            short_name='d',
 
5341
            type=unicode,
 
5342
            ),
5357
5343
        RegistryOption.from_kwargs('sort',
5358
5344
            'Sort tags by different criteria.', title='Sorting',
5359
5345
            alpha='Sort tags lexicographically (default).',
5376
5362
        if not tags:
5377
5363
            return
5378
5364
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5365
        branch.lock_read()
 
5366
        self.add_cleanup(branch.unlock)
5380
5367
        if revision:
5381
5368
            graph = branch.repository.get_graph()
5382
5369
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5402
 
5416
5403
 
5417
5404
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5405
    """Reconfigure the type of a bzr directory.
5419
5406
 
5420
5407
    A target configuration must be specified.
5421
5408
 
5506
5493
 
5507
5494
 
5508
5495
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5496
    """Set the branch of a checkout and update.
5510
5497
 
5511
5498
    For lightweight checkouts, this changes the branch being referenced.
5512
5499
    For heavyweight checkouts, this checks that there are no local commits
5602
5589
 
5603
5590
 
5604
5591
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5592
    """Manage filtered views.
5606
5593
 
5607
5594
    Views provide a mask over the tree so that users can focus on
5608
5595
    a subset of a tree when doing their work. After creating a view,
5756
5743
 
5757
5744
 
5758
5745
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5746
    """Show hooks."""
5760
5747
 
5761
5748
    hidden = True
5762
5749
 
5776
5763
 
5777
5764
 
5778
5765
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
 
5766
    """Remove a branch.
5780
5767
 
5781
5768
    This will remove the branch from the specified location but 
5782
5769
    will keep any working tree or repository in place.
5801
5788
        
5802
5789
 
5803
5790
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5791
    """Temporarily set aside some changes from the current tree.
5805
5792
 
5806
5793
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5794
    ie. out of the way, until a later time when you can bring them back from
5860
5847
 
5861
5848
    def run_for_list(self):
5862
5849
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5850
        tree.lock_read()
 
5851
        self.add_cleanup(tree.unlock)
5864
5852
        manager = tree.get_shelf_manager()
5865
5853
        shelves = manager.active_shelves()
5866
5854
        if len(shelves) == 0:
5875
5863
 
5876
5864
 
5877
5865
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5866
    """Restore shelved changes.
5879
5867
 
5880
5868
    By default, the most recently shelved changes are restored. However if you
5881
5869
    specify a shelf by id those changes will be restored instead.  This works
5907
5895
 
5908
5896
 
5909
5897
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5898
    """Remove unwanted files from working tree.
5911
5899
 
5912
5900
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5901
    files are never deleted.
5921
5909
 
5922
5910
    To check what clean-tree will do, use --dry-run.
5923
5911
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5912
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5913
                     Option('detritus', help='Delete conflict files, merge'
5927
5914
                            ' backups, and failed selftest dirs.'),
5928
5915
                     Option('unknown',
5931
5918
                            ' deleting them.'),
5932
5919
                     Option('force', help='Do not prompt before deleting.')]
5933
5920
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5921
            force=False):
5935
5922
        from bzrlib.clean_tree import clean_tree
5936
5923
        if not (unknown or ignored or detritus):
5937
5924
            unknown = True
5938
5925
        if dry_run:
5939
5926
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5927
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5928
                   dry_run=dry_run, no_prompt=force)
5942
5929
 
5943
5930
 
5944
5931
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5932
    """list, view and set branch locations for nested trees.
5946
5933
 
5947
5934
    If no arguments are provided, lists the branch locations for nested trees.
5948
5935
    If one argument is provided, display the branch location for that tree.
5988
5975
            self.outf.write('%s %s\n' % (path, location))
5989
5976
 
5990
5977
 
5991
 
def _register_lazy_builtins():
5992
 
    # register lazy builtins from other modules; called at startup and should
5993
 
    # be only called once.
5994
 
    for (name, aliases, module_name) in [
5995
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5996
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5997
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5998
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5999
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6000
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6001
 
        ]:
6002
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5978
from bzrlib.cmd_version_info import cmd_version_info
 
5979
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5980
from bzrlib.foreign import cmd_dpush
 
5981
from bzrlib.sign_my_commits import cmd_sign_my_commits