/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: Martin Pool
  • Date: 2010-04-01 04:38:26 UTC
  • mto: This revision was merged to the branch mainline in revision 5128.
  • Revision ID: mbp@sourcefrog.net-20100401043826-zl8mv33nrmd1hcxp
Lazy-load sign-my-commits

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(
1427
1448
        else:
1428
1449
            revision_id = branch.last_revision()
1429
1450
        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))
 
1451
            revno = branch.revision_id_to_revno(revision_id)
 
1452
            note("Tree is up to date at revision %d of branch %s" %
 
1453
                (revno, branch_location))
1433
1454
            return 0
1434
1455
        view_info = _get_view_info_for_change_reporter(tree)
1435
1456
        change_reporter = delta._ChangeReporter(
1447
1468
                                  "bzr update --revision only works"
1448
1469
                                  " for a revision in the branch history"
1449
1470
                                  % (e.revision))
1450
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1471
        revno = tree.branch.revision_id_to_revno(
1451
1472
            _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:
 
1473
        note('Updated to revision %d of branch %s' %
 
1474
             (revno, branch_location))
 
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.
1933
1954
            help='Use this command to compare files.',
1934
1955
            type=unicode,
1935
1956
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1957
        ]
1941
1958
    aliases = ['di', 'dif']
1942
1959
    encoding_type = 'exact'
1943
1960
 
1944
1961
    @display_command
1945
1962
    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)
 
1963
            prefix=None, old=None, new=None, using=None):
 
1964
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1949
1965
 
1950
1966
        if (prefix is None) or (prefix == '0'):
1951
1967
            # diff -p0 format
1965
1981
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1982
                                         ' one or two revision specifiers')
1967
1983
 
1968
 
        if using is not None and format is not None:
1969
 
            raise errors.BzrCommandError('--using and --format are mutually '
1970
 
                'exclusive.')
1971
 
 
1972
1984
        (old_tree, new_tree,
1973
1985
         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)
 
1986
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1987
            file_list, revision, old, new, apply_view=True)
1976
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1989
                               specific_files=specific_files,
1978
1990
                               external_diff_options=diff_options,
1979
1991
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1992
                               extra_trees=extra_trees, using=using)
1982
1993
 
1983
1994
 
1984
1995
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1996
    """List files deleted in the working tree.
1986
1997
    """
1987
1998
    # TODO: Show files deleted since a previous revision, or
1988
1999
    # between two revisions.
1991
2002
    # level of effort but possibly much less IO.  (Or possibly not,
1992
2003
    # if the directories are very large...)
1993
2004
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
2005
    takes_options = ['show-ids']
1995
2006
 
1996
2007
    @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)
 
2008
    def run(self, show_ids=False):
 
2009
        tree = WorkingTree.open_containing(u'.')[0]
 
2010
        tree.lock_read()
 
2011
        self.add_cleanup(tree.unlock)
2000
2012
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
2013
        old.lock_read()
 
2014
        self.add_cleanup(old.unlock)
2002
2015
        for path, ie in old.inventory.iter_entries():
2003
2016
            if not tree.has_id(ie.file_id):
2004
2017
                self.outf.write(path)
2009
2022
 
2010
2023
 
2011
2024
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
2025
    """List files modified in working tree.
2013
2026
    """
2014
2027
 
2015
2028
    hidden = True
2016
2029
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
2030
    takes_options = [
 
2031
            Option('null',
 
2032
                   help='Write an ascii NUL (\\0) separator '
 
2033
                   'between files rather than a newline.')
 
2034
            ]
2018
2035
 
2019
2036
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2037
    def run(self, null=False):
 
2038
        tree = WorkingTree.open_containing(u'.')[0]
2022
2039
        td = tree.changes_from(tree.basis_tree())
2023
2040
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2041
            if null:
2028
2045
 
2029
2046
 
2030
2047
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2048
    """List files added in working tree.
2032
2049
    """
2033
2050
 
2034
2051
    hidden = True
2035
2052
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2053
    takes_options = [
 
2054
            Option('null',
 
2055
                   help='Write an ascii NUL (\\0) separator '
 
2056
                   'between files rather than a newline.')
 
2057
            ]
2037
2058
 
2038
2059
    @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)
 
2060
    def run(self, null=False):
 
2061
        wt = WorkingTree.open_containing(u'.')[0]
 
2062
        wt.lock_read()
 
2063
        self.add_cleanup(wt.unlock)
2042
2064
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2065
        basis.lock_read()
 
2066
        self.add_cleanup(basis.unlock)
2044
2067
        basis_inv = basis.inventory
2045
2068
        inv = wt.inventory
2046
2069
        for file_id in inv:
2049
2072
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2073
                continue
2051
2074
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2075
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2076
                continue
2054
2077
            if null:
2055
2078
                self.outf.write(path + '\0')
2058
2081
 
2059
2082
 
2060
2083
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2084
    """Show the tree root directory.
2062
2085
 
2063
2086
    The root is the nearest enclosing directory with a .bzr control
2064
2087
    directory."""
2088
2111
 
2089
2112
 
2090
2113
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2114
    """Show historical log for a branch or subset of a branch.
2092
2115
 
2093
2116
    log is bzr's default tool for exploring the history of a branch.
2094
2117
    The branch to use is taken from the first parameter. If no parameters
2255
2278
                   help='Show just the specified revision.'
2256
2279
                   ' See also "help revisionspec".'),
2257
2280
            '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
2281
            Option('levels',
2264
2282
                   short_name='n',
2265
2283
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2298
                   help='Show changes made in each revision as a patch.'),
2281
2299
            Option('include-merges',
2282
2300
                   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
2301
            ]
2288
2302
    encoding_type = 'replace'
2289
2303
 
2299
2313
            message=None,
2300
2314
            limit=None,
2301
2315
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2316
            include_merges=False):
2306
2317
        from bzrlib.log import (
2307
2318
            Logger,
2308
2319
            make_log_request_dict,
2309
2320
            _get_info_for_log_files,
2310
2321
            )
2311
2322
        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
2323
        if include_merges:
2317
2324
            if levels is None:
2318
2325
                levels = 0
2334
2341
        if file_list:
2335
2342
            # find the file ids to log and check for directory filtering
2336
2343
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2344
                revision, file_list)
 
2345
            self.add_cleanup(b.unlock)
2338
2346
            for relpath, file_id, kind in file_info_list:
2339
2347
                if file_id is None:
2340
2348
                    raise errors.BzrCommandError(
2358
2366
                location = '.'
2359
2367
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2368
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2369
            b.lock_read()
 
2370
            self.add_cleanup(b.unlock)
2362
2371
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2372
 
2364
2373
        # Decide on the type of delta & diff filtering to use
2384
2393
                        show_timezone=timezone,
2385
2394
                        delta_format=get_verbosity_level(),
2386
2395
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2396
                        show_advice=levels is None)
2389
2397
 
2390
2398
        # Choose the algorithm for doing the logging. It's annoying
2391
2399
        # having multiple code paths like this but necessary until
2410
2418
            direction=direction, specific_fileids=file_ids,
2411
2419
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2420
            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
 
            )
 
2421
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2422
        Logger(b, rqst).show(lf)
2417
2423
 
2418
2424
 
2476
2482
 
2477
2483
 
2478
2484
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2485
    """Return revision-ids which affected a particular file.
2480
2486
 
2481
2487
    A more user-friendly interface is "bzr log FILE".
2482
2488
    """
2489
2495
        tree, relpath = WorkingTree.open_containing(filename)
2490
2496
        file_id = tree.path2id(relpath)
2491
2497
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2498
        b.lock_read()
 
2499
        self.add_cleanup(b.unlock)
2493
2500
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2501
        for revno, revision_id, what in touching_revs:
2495
2502
            self.outf.write("%6d %s\n" % (revno, what))
2496
2503
 
2497
2504
 
2498
2505
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2506
    """List files in a tree.
2500
2507
    """
2501
2508
 
2502
2509
    _see_also = ['status', 'cat']
2508
2515
                   help='Recurse into subdirectories.'),
2509
2516
            Option('from-root',
2510
2517
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2518
            Option('unknown', help='Print unknown files.'),
2513
2519
            Option('versioned', help='Print versioned files.',
2514
2520
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2521
            Option('ignored', help='Print ignored files.'),
 
2522
            Option('null',
 
2523
                   help='Write an ascii NUL (\\0) separator '
 
2524
                   'between files rather than a newline.'),
 
2525
            Option('kind',
2518
2526
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2527
                   type=unicode),
2520
 
            'null',
2521
2528
            'show-ids',
2522
 
            'directory',
2523
2529
            ]
2524
2530
    @display_command
2525
2531
    def run(self, revision=None, verbose=False,
2526
2532
            recursive=False, from_root=False,
2527
2533
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2534
            null=False, kind=None, show_ids=False, path=None):
2529
2535
 
2530
2536
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2537
            raise errors.BzrCommandError('invalid kind specified')
2543
2549
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2550
                                             ' and PATH')
2545
2551
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2552
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2553
            fs_path)
2548
2554
 
2549
2555
        # Calculate the prefix to use
2550
2556
        prefix = None
2565
2571
                view_str = views.view_display_str(view_files)
2566
2572
                note("Ignoring files outside view. View is %s" % view_str)
2567
2573
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2574
        tree.lock_read()
 
2575
        self.add_cleanup(tree.unlock)
2569
2576
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2577
            from_dir=relpath, recursive=recursive):
2571
2578
            # Apply additional masking
2613
2620
 
2614
2621
 
2615
2622
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2623
    """List unknown files.
2617
2624
    """
2618
2625
 
2619
2626
    hidden = True
2620
2627
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2628
 
2623
2629
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2630
    def run(self):
 
2631
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2632
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2633
 
2628
2634
 
2629
2635
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2636
    """Ignore specified files or patterns.
2631
2637
 
2632
2638
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2639
 
2642
2648
    using this command or directly by using an editor, be sure to commit
2643
2649
    it.
2644
2650
    
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
2651
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2652
    precedence over regular ignores.  Such exceptions are used to specify
2653
2653
    files that should be versioned which would otherwise be ignored.
2693
2693
 
2694
2694
    _see_also = ['status', 'ignored', 'patterns']
2695
2695
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2696
    takes_options = [
 
2697
        Option('old-default-rules',
 
2698
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2699
        ]
2700
2700
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2701
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2702
        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:
 
2703
        if old_default_rules is not None:
 
2704
            # dump the rules and exit
 
2705
            for pattern in ignores.OLD_DEFAULTS:
2707
2706
                self.outf.write("%s\n" % pattern)
2708
2707
            return
2709
2708
        if not name_pattern_list:
2710
2709
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2710
                                  "NAME_PATTERN or --old-default-rules")
2712
2711
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2712
                             for p in name_pattern_list]
2714
2713
        for name_pattern in name_pattern_list:
2716
2715
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2716
                raise errors.BzrCommandError(
2718
2717
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2718
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2719
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2720
        ignored = globbing.Globster(name_pattern_list)
2722
2721
        matches = []
2736
2735
 
2737
2736
 
2738
2737
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2738
    """List ignored files and the patterns that matched them.
2740
2739
 
2741
2740
    List all the ignored files and the ignore pattern that caused the file to
2742
2741
    be ignored.
2748
2747
 
2749
2748
    encoding_type = 'replace'
2750
2749
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2750
 
2753
2751
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2752
    def run(self):
 
2753
        tree = WorkingTree.open_containing(u'.')[0]
 
2754
        tree.lock_read()
 
2755
        self.add_cleanup(tree.unlock)
2757
2756
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2757
            if file_class != 'I':
2759
2758
                continue
2763
2762
 
2764
2763
 
2765
2764
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2765
    """Lookup the revision-id from a revision-number
2767
2766
 
2768
2767
    :Examples:
2769
2768
        bzr lookup-revision 33
2770
2769
    """
2771
2770
    hidden = True
2772
2771
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2772
 
2775
2773
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2774
    def run(self, revno):
2777
2775
        try:
2778
2776
            revno = int(revno)
2779
2777
        except ValueError:
2780
2778
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
2779
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2780
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2783
2781
        self.outf.write("%s\n" % revid)
2784
2782
 
2785
2783
 
2786
2784
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2785
    """Export current or past revision to a destination directory or archive.
2788
2786
 
2789
2787
    If no revision is specified this exports the last committed revision.
2790
2788
 
2812
2810
      =================       =========================
2813
2811
    """
2814
2812
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2813
    takes_options = [
2816
2814
        Option('format',
2817
2815
               help="Type of file to export to.",
2818
2816
               type=unicode),
2827
2825
                    'revision in which it was changed.'),
2828
2826
        ]
2829
2827
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2828
        root=None, filters=False, per_file_timestamps=False):
2831
2829
        from bzrlib.export import export
2832
2830
 
2833
2831
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2832
            tree = WorkingTree.open_containing(u'.')[0]
2835
2833
            b = tree.branch
2836
2834
            subdir = None
2837
2835
        else:
2847
2845
 
2848
2846
 
2849
2847
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2848
    """Write the contents of a file as of a given revision to standard output.
2851
2849
 
2852
2850
    If no revision is nominated, the last revision is used.
2853
2851
 
2856
2854
    """
2857
2855
 
2858
2856
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2857
    takes_options = [
2860
2858
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2859
        Option('filters', help='Apply content filters to display the '
2862
2860
                'convenience form.'),
2867
2865
 
2868
2866
    @display_command
2869
2867
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2868
            filters=False):
2871
2869
        if revision is not None and len(revision) != 1:
2872
2870
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2871
                                         " one revision specifier")
2874
2872
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2873
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2874
        branch.lock_read()
 
2875
        self.add_cleanup(branch.unlock)
2877
2876
        return self._run(tree, branch, relpath, filename, revision,
2878
2877
                         name_from_revision, filters)
2879
2878
 
2882
2881
        if tree is None:
2883
2882
            tree = b.basis_tree()
2884
2883
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2884
        rev_tree.lock_read()
 
2885
        self.add_cleanup(rev_tree.unlock)
2886
2886
 
2887
2887
        old_file_id = rev_tree.path2id(relpath)
2888
2888
 
2931
2931
 
2932
2932
 
2933
2933
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2934
    """Show the offset in seconds from GMT to local time."""
2935
2935
    hidden = True
2936
2936
    @display_command
2937
2937
    def run(self):
2940
2940
 
2941
2941
 
2942
2942
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2943
    """Commit changes into a new revision.
2944
2944
 
2945
2945
    An explanatory message needs to be given for each commit. This is
2946
2946
    often done by using the --message option (getting the message from the
3054
3054
                         "the master branch until a normal commit "
3055
3055
                         "is performed."
3056
3056
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3057
             Option('show-diff',
3058
3058
                    help='When no message is supplied, show the diff along'
3059
3059
                    ' with the status summary in the message editor.'),
3060
3060
             ]
3140
3140
                    '(use --file "%(f)s" to take commit message from that file)'
3141
3141
                    % { 'f': message })
3142
3142
                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
3143
 
3150
3144
        def get_message(commit_obj):
3151
3145
            """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,
 
3146
            my_message = message
 
3147
            if my_message is not None and '\r' in my_message:
 
3148
                my_message = my_message.replace('\r\n', '\n')
 
3149
                my_message = my_message.replace('\r', '\n')
 
3150
            if my_message is None and not file:
 
3151
                t = make_commit_message_template_encoded(tree,
3161
3152
                        selected_list, diff=show_diff,
3162
3153
                        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
3154
                start_message = generate_commit_message_template(commit_obj)
3169
 
                my_message = edit_commit_message_encoded(text,
 
3155
                my_message = edit_commit_message_encoded(t,
3170
3156
                    start_message=start_message)
3171
3157
                if my_message is None:
3172
3158
                    raise errors.BzrCommandError("please specify a commit"
3173
3159
                        " message with either --message or --file")
 
3160
            elif my_message and file:
 
3161
                raise errors.BzrCommandError(
 
3162
                    "please specify either --message or --file")
 
3163
            if file:
 
3164
                my_message = codecs.open(file, 'rt',
 
3165
                                         osutils.get_user_encoding()).read()
3174
3166
            if my_message == "":
3175
3167
                raise errors.BzrCommandError("empty commit message specified")
3176
3168
            return my_message
3188
3180
                        timezone=offset,
3189
3181
                        exclude=safe_relpath_files(tree, exclude))
3190
3182
        except PointlessCommit:
 
3183
            # FIXME: This should really happen before the file is read in;
 
3184
            # perhaps prepare the commit; get the message; then actually commit
3191
3185
            raise errors.BzrCommandError("No changes to commit."
3192
3186
                              " Use --unchanged to commit anyhow.")
3193
3187
        except ConflictsInTree:
3206
3200
 
3207
3201
 
3208
3202
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3203
    """Validate working tree structure, branch consistency and repository history.
3210
3204
 
3211
3205
    This command checks various invariants about branch and repository storage
3212
3206
    to detect data corruption or bzr bugs.
3276
3270
 
3277
3271
 
3278
3272
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3273
    """Upgrade branch storage to current format.
3280
3274
 
3281
3275
    The check command or bzr developers may sometimes advise you to run
3282
3276
    this command. When the default format has changed you may also be warned
3300
3294
 
3301
3295
 
3302
3296
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3297
    """Show or set bzr user id.
3304
3298
 
3305
3299
    :Examples:
3306
3300
        Show the email of the current user::
3350
3344
 
3351
3345
 
3352
3346
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3347
    """Print or set the branch nickname.
3354
3348
 
3355
3349
    If unset, the tree root directory name is used as the nickname.
3356
3350
    To print the current nickname, execute with no argument.
3361
3355
 
3362
3356
    _see_also = ['info']
3363
3357
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3358
    def run(self, nickname=None):
 
3359
        branch = Branch.open_containing(u'.')[0]
3367
3360
        if nickname is None:
3368
3361
            self.printme(branch)
3369
3362
        else:
3375
3368
 
3376
3369
 
3377
3370
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3371
    """Set/unset and display aliases.
3379
3372
 
3380
3373
    :Examples:
3381
3374
        Show the current aliases::
3445
3438
 
3446
3439
 
3447
3440
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3441
    """Run internal test suite.
3449
3442
 
3450
3443
    If arguments are given, they are regular expressions that say which tests
3451
3444
    should run.  Tests matching any expression are run, and other tests are
3592
3585
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3586
                    "needs to be installed to use --subunit.")
3594
3587
            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
3588
        if parallel:
3601
3589
            self.additional_selftest_args.setdefault(
3602
3590
                'suite_decorators', []).append(parallel)
3633
3621
 
3634
3622
 
3635
3623
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3624
    """Show version of bzr."""
3637
3625
 
3638
3626
    encoding_type = 'replace'
3639
3627
    takes_options = [
3650
3638
 
3651
3639
 
3652
3640
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3641
    """Statement of optimism."""
3654
3642
 
3655
3643
    hidden = True
3656
3644
 
3660
3648
 
3661
3649
 
3662
3650
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3651
    """Find and print a base revision for merging two branches."""
3664
3652
    # TODO: Options to specify revisions on either side, as if
3665
3653
    #       merging only part of the history.
3666
3654
    takes_args = ['branch', 'other']
3672
3660
 
3673
3661
        branch1 = Branch.open_containing(branch)[0]
3674
3662
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3663
        branch1.lock_read()
 
3664
        self.add_cleanup(branch1.unlock)
 
3665
        branch2.lock_read()
 
3666
        self.add_cleanup(branch2.unlock)
3677
3667
        last1 = ensure_null(branch1.last_revision())
3678
3668
        last2 = ensure_null(branch2.last_revision())
3679
3669
 
3684
3674
 
3685
3675
 
3686
3676
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3677
    """Perform a three-way merge.
3688
3678
 
3689
3679
    The source of the merge can be specified either in the form of a branch,
3690
3680
    or in the form of a path to a file containing a merge directive generated
3773
3763
                ' completely merged into the source, pull from the'
3774
3764
                ' source rather than merging.  When this happens,'
3775
3765
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3766
        Option('directory',
3777
3767
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3768
                    'rather than the one containing the working directory.',
 
3769
               short_name='d',
 
3770
               type=unicode,
 
3771
               ),
3779
3772
        Option('preview', help='Instead of merging, show a diff of the'
3780
3773
               ' merge.'),
3781
3774
        Option('interactive', help='Select changes interactively.',
3814
3807
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3808
        pb = ui.ui_factory.nested_progress_bar()
3816
3809
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3810
        tree.lock_write()
 
3811
        self.add_cleanup(tree.unlock)
3818
3812
        if location is not None:
3819
3813
            try:
3820
3814
                mergeable = bundle.read_mergeable_from_url(location,
4041
4035
 
4042
4036
 
4043
4037
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
4038
    """Redo a merge.
4045
4039
 
4046
4040
    Use this if you want to try a different merge technique while resolving
4047
4041
    conflicts.  Some merge techniques are better than others, and remerge
4076
4070
        if merge_type is None:
4077
4071
            merge_type = _mod_merge.Merge3Merger
4078
4072
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4073
        tree.lock_write()
 
4074
        self.add_cleanup(tree.unlock)
4080
4075
        parents = tree.get_parent_ids()
4081
4076
        if len(parents) != 2:
4082
4077
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4130
 
4136
4131
 
4137
4132
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4133
    """Revert files to a previous revision.
4139
4134
 
4140
4135
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4136
    will be reverted.  If the revision is not specified with '--revision', the
4192
4187
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4188
            forget_merges=None):
4194
4189
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4190
        tree.lock_write()
 
4191
        self.add_cleanup(tree.unlock)
4196
4192
        if forget_merges:
4197
4193
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4194
        else:
4206
4202
 
4207
4203
 
4208
4204
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4205
    """Test reporting of assertion failures"""
4210
4206
    # intended just for use in testing
4211
4207
 
4212
4208
    hidden = True
4216
4212
 
4217
4213
 
4218
4214
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4215
    """Show help on a command or other topic.
4220
4216
    """
4221
4217
 
4222
4218
    _see_also = ['topics']
4235
4231
 
4236
4232
 
4237
4233
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4234
    """Show appropriate completions for context.
4239
4235
 
4240
4236
    For a list of all available commands, say 'bzr shell-complete'.
4241
4237
    """
4250
4246
 
4251
4247
 
4252
4248
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4249
    """Show unmerged/unpulled revisions between two branches.
4254
4250
 
4255
4251
    OTHER_BRANCH may be local or remote.
4256
4252
 
4334
4330
            restrict = 'remote'
4335
4331
 
4336
4332
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4333
        parent = local_branch.get_parent()
4340
4334
        if other_branch is None:
4341
4335
            other_branch = parent
4350
4344
        remote_branch = Branch.open(other_branch)
4351
4345
        if remote_branch.base == local_branch.base:
4352
4346
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4347
 
 
4348
        local_branch.lock_read()
 
4349
        self.add_cleanup(local_branch.unlock)
4356
4350
        local_revid_range = _revision_range_to_revid_range(
4357
4351
            _get_revision_range(my_revision, local_branch,
4358
4352
                self.name()))
4359
4353
 
 
4354
        remote_branch.lock_read()
 
4355
        self.add_cleanup(remote_branch.unlock)
4360
4356
        remote_revid_range = _revision_range_to_revid_range(
4361
4357
            _get_revision_range(revision,
4362
4358
                remote_branch, self.name()))
4412
4408
            message("Branches are up to date.\n")
4413
4409
        self.cleanup_now()
4414
4410
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4411
            local_branch.lock_write()
 
4412
            self.add_cleanup(local_branch.unlock)
4416
4413
            # handle race conditions - a parent might be set while we run.
4417
4414
            if local_branch.get_parent() is None:
4418
4415
                local_branch.set_parent(remote_branch.base)
4420
4417
 
4421
4418
 
4422
4419
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
 
    """
 
4420
    """Compress the data within a repository."""
4440
4421
 
4441
4422
    _see_also = ['repositories']
4442
4423
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4424
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4425
    def run(self, branch_or_repo='.'):
4448
4426
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4427
        try:
4450
4428
            branch = dir.open_branch()
4451
4429
            repository = branch.repository
4452
4430
        except errors.NotBranchError:
4453
4431
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4432
        repository.pack()
4455
4433
 
4456
4434
 
4457
4435
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4436
    """List the installed plugins.
4459
4437
 
4460
4438
    This command displays the list of installed plugins including
4461
4439
    version of plugin and a short description of each.
4500
4478
 
4501
4479
 
4502
4480
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4481
    """Show testament (signing-form) of a revision."""
4504
4482
    takes_options = [
4505
4483
            'revision',
4506
4484
            Option('long', help='Produce long-format testament.'),
4518
4496
            b = Branch.open_containing(branch)[0]
4519
4497
        else:
4520
4498
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4499
        b.lock_read()
 
4500
        self.add_cleanup(b.unlock)
4522
4501
        if revision is None:
4523
4502
            rev_id = b.last_revision()
4524
4503
        else:
4531
4510
 
4532
4511
 
4533
4512
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4513
    """Show the origin of each line in a file.
4535
4514
 
4536
4515
    This prints out the given file with an annotation on the left side
4537
4516
    indicating which revision, author and date introduced the change.
4548
4527
                     Option('long', help='Show commit date in annotations.'),
4549
4528
                     'revision',
4550
4529
                     'show-ids',
4551
 
                     'directory',
4552
4530
                     ]
4553
4531
    encoding_type = 'exact'
4554
4532
 
4555
4533
    @display_command
4556
4534
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4535
            show_ids=False):
4558
4536
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4537
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4538
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4539
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4540
            wt.lock_read()
 
4541
            self.add_cleanup(wt.unlock)
4563
4542
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4543
            branch.lock_read()
 
4544
            self.add_cleanup(branch.unlock)
4565
4545
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4546
        tree.lock_read()
 
4547
        self.add_cleanup(tree.unlock)
4567
4548
        if wt is not None:
4568
4549
            file_id = wt.path2id(relpath)
4569
4550
        else:
4582
4563
 
4583
4564
 
4584
4565
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4566
    """Create a digital signature for an existing revision."""
4586
4567
    # TODO be able to replace existing ones.
4587
4568
 
4588
4569
    hidden = True # is this right ?
4589
4570
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4571
    takes_options = ['revision']
4591
4572
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4573
    def run(self, revision_id_list=None, revision=None):
4593
4574
        if revision_id_list is not None and revision is not None:
4594
4575
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4576
        if revision_id_list is None and revision is None:
4596
4577
            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)
 
4578
        b = WorkingTree.open_containing(u'.')[0].branch
 
4579
        b.lock_write()
 
4580
        self.add_cleanup(b.unlock)
4599
4581
        return self._run(b, revision_id_list, revision)
4600
4582
 
4601
4583
    def _run(self, b, revision_id_list, revision):
4647
4629
 
4648
4630
 
4649
4631
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.
 
4632
    """Convert the current branch into a checkout of the supplied branch.
4652
4633
 
4653
4634
    Once converted into a checkout, commits must succeed on the master branch
4654
4635
    before they will be applied to the local branch.
4660
4641
 
4661
4642
    _see_also = ['checkouts', 'unbind']
4662
4643
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4644
    takes_options = []
4664
4645
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4646
    def run(self, location=None):
 
4647
        b, relpath = Branch.open_containing(u'.')
4667
4648
        if location is None:
4668
4649
            try:
4669
4650
                location = b.get_old_bound_location()
4688
4669
 
4689
4670
 
4690
4671
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4672
    """Convert the current checkout into a regular branch.
4692
4673
 
4693
4674
    After unbinding, the local branch is considered independent and subsequent
4694
4675
    commits will be local only.
4696
4677
 
4697
4678
    _see_also = ['checkouts', 'bind']
4698
4679
    takes_args = []
4699
 
    takes_options = ['directory']
 
4680
    takes_options = []
4700
4681
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4682
    def run(self):
 
4683
        b, relpath = Branch.open_containing(u'.')
4703
4684
        if not b.unbind():
4704
4685
            raise errors.BzrCommandError('Local branch is not bound')
4705
4686
 
4706
4687
 
4707
4688
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4689
    """Remove the last committed revision.
4709
4690
 
4710
4691
    --verbose will print out what is being removed.
4711
4692
    --dry-run will go through all the motions, but not actually
4751
4732
            b = control.open_branch()
4752
4733
 
4753
4734
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4735
            tree.lock_write()
 
4736
            self.add_cleanup(tree.unlock)
4755
4737
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4738
            b.lock_write()
 
4739
            self.add_cleanup(b.unlock)
4757
4740
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4741
 
4759
4742
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4794
 
4812
4795
 
4813
4796
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4797
    """Break a dead lock on a repository, branch or working directory.
4815
4798
 
4816
4799
    CAUTION: Locks should only be broken when you are sure that the process
4817
4800
    holding the lock has been stopped.
4836
4819
 
4837
4820
 
4838
4821
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4822
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4823
 
4841
4824
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4825
    """
4850
4833
 
4851
4834
 
4852
4835
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4836
    """Run the bzr server."""
4854
4837
 
4855
4838
    aliases = ['server']
4856
4839
 
4867
4850
                    'result in a dynamically allocated port.  The default port '
4868
4851
                    'depends on the protocol.',
4869
4852
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4853
        Option('directory',
 
4854
               help='Serve contents of this directory.',
 
4855
               type=unicode),
4872
4856
        Option('allow-writes',
4873
4857
               help='By default the server is a readonly server.  Supplying '
4874
4858
                    '--allow-writes enables write access to the contents of '
4915
4899
 
4916
4900
 
4917
4901
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4902
    """Combine a tree into its containing tree.
4919
4903
 
4920
4904
    This command requires the target tree to be in a rich-root format.
4921
4905
 
4961
4945
 
4962
4946
 
4963
4947
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4948
    """Split a subdirectory of a tree into a separate tree.
4965
4949
 
4966
4950
    This command will produce a target tree in a format that supports
4967
4951
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4971
 
4988
4972
 
4989
4973
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4974
    """Generate a merge directive for auto-merge tools.
4991
4975
 
4992
4976
    A directive requests a merge to be performed, and also provides all the
4993
4977
    information necessary to do so.  This means it must either include a
5086
5070
 
5087
5071
 
5088
5072
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5073
    """Mail or create a merge-directive for submitting changes.
5090
5074
 
5091
5075
    A merge directive provides many things needed for requesting merges:
5092
5076
 
5203
5187
 
5204
5188
 
5205
5189
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5190
    """Create a merge-directive for submitting changes.
5207
5191
 
5208
5192
    A merge directive provides many things needed for requesting merges:
5209
5193
 
5276
5260
 
5277
5261
 
5278
5262
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5263
    """Create, remove or modify a tag naming a revision.
5280
5264
 
5281
5265
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5266
    (--revision) option can be given -rtag:X, where X is any previously
5303
5287
        Option('delete',
5304
5288
            help='Delete this tag rather than placing it.',
5305
5289
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5290
        Option('directory',
 
5291
            help='Branch in which to place the tag.',
 
5292
            short_name='d',
 
5293
            type=unicode,
 
5294
            ),
5308
5295
        Option('force',
5309
5296
            help='Replace existing tags.',
5310
5297
            ),
5318
5305
            revision=None,
5319
5306
            ):
5320
5307
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5308
        branch.lock_write()
 
5309
        self.add_cleanup(branch.unlock)
5322
5310
        if delete:
5323
5311
            if tag_name is None:
5324
5312
                raise errors.BzrCommandError("No tag specified to delete.")
5345
5333
 
5346
5334
 
5347
5335
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5336
    """List tags.
5349
5337
 
5350
5338
    This command shows a table of tag names and the revisions they reference.
5351
5339
    """
5352
5340
 
5353
5341
    _see_also = ['tag']
5354
5342
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5343
        Option('directory',
 
5344
            help='Branch whose tags should be displayed.',
 
5345
            short_name='d',
 
5346
            type=unicode,
 
5347
            ),
5357
5348
        RegistryOption.from_kwargs('sort',
5358
5349
            'Sort tags by different criteria.', title='Sorting',
5359
5350
            alpha='Sort tags lexicographically (default).',
5376
5367
        if not tags:
5377
5368
            return
5378
5369
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5370
        branch.lock_read()
 
5371
        self.add_cleanup(branch.unlock)
5380
5372
        if revision:
5381
5373
            graph = branch.repository.get_graph()
5382
5374
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5407
 
5416
5408
 
5417
5409
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5410
    """Reconfigure the type of a bzr directory.
5419
5411
 
5420
5412
    A target configuration must be specified.
5421
5413
 
5506
5498
 
5507
5499
 
5508
5500
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5501
    """Set the branch of a checkout and update.
5510
5502
 
5511
5503
    For lightweight checkouts, this changes the branch being referenced.
5512
5504
    For heavyweight checkouts, this checks that there are no local commits
5602
5594
 
5603
5595
 
5604
5596
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5597
    """Manage filtered views.
5606
5598
 
5607
5599
    Views provide a mask over the tree so that users can focus on
5608
5600
    a subset of a tree when doing their work. After creating a view,
5756
5748
 
5757
5749
 
5758
5750
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5751
    """Show hooks."""
5760
5752
 
5761
5753
    hidden = True
5762
5754
 
5776
5768
 
5777
5769
 
5778
5770
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
 
5771
    """Remove a branch.
5780
5772
 
5781
5773
    This will remove the branch from the specified location but 
5782
5774
    will keep any working tree or repository in place.
5801
5793
        
5802
5794
 
5803
5795
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5796
    """Temporarily set aside some changes from the current tree.
5805
5797
 
5806
5798
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5799
    ie. out of the way, until a later time when you can bring them back from
5860
5852
 
5861
5853
    def run_for_list(self):
5862
5854
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5855
        tree.lock_read()
 
5856
        self.add_cleanup(tree.unlock)
5864
5857
        manager = tree.get_shelf_manager()
5865
5858
        shelves = manager.active_shelves()
5866
5859
        if len(shelves) == 0:
5875
5868
 
5876
5869
 
5877
5870
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5871
    """Restore shelved changes.
5879
5872
 
5880
5873
    By default, the most recently shelved changes are restored. However if you
5881
5874
    specify a shelf by id those changes will be restored instead.  This works
5907
5900
 
5908
5901
 
5909
5902
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5903
    """Remove unwanted files from working tree.
5911
5904
 
5912
5905
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5906
    files are never deleted.
5921
5914
 
5922
5915
    To check what clean-tree will do, use --dry-run.
5923
5916
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5917
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5918
                     Option('detritus', help='Delete conflict files, merge'
5927
5919
                            ' backups, and failed selftest dirs.'),
5928
5920
                     Option('unknown',
5931
5923
                            ' deleting them.'),
5932
5924
                     Option('force', help='Do not prompt before deleting.')]
5933
5925
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5926
            force=False):
5935
5927
        from bzrlib.clean_tree import clean_tree
5936
5928
        if not (unknown or ignored or detritus):
5937
5929
            unknown = True
5938
5930
        if dry_run:
5939
5931
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5932
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5933
                   dry_run=dry_run, no_prompt=force)
5942
5934
 
5943
5935
 
5944
5936
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5937
    """list, view and set branch locations for nested trees.
5946
5938
 
5947
5939
    If no arguments are provided, lists the branch locations for nested trees.
5948
5940
    If one argument is provided, display the branch location for that tree.