/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: Andrew Bennetts
  • Date: 2010-03-11 04:33:41 UTC
  • mfrom: (4797.33.4 2.1)
  • mto: This revision was merged to the branch mainline in revision 5082.
  • Revision ID: andrew.bennetts@canonical.com-20100311043341-rzdik83fnactjsxs
Merge lp:bzr/2.1, including fixes for #496813, #526211, #526353.

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
468
456
        for node in bt.iter_all_entries():
469
457
            # Node is made up of:
470
458
            # (index, key, value, [references])
471
 
            try:
472
 
                refs = node[3]
473
 
            except IndexError:
474
 
                refs_as_tuples = None
475
 
            else:
476
 
                refs_as_tuples = static_tuple.as_tuples(refs)
 
459
            refs_as_tuples = static_tuple.as_tuples(node[3])
477
460
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
461
            self.outf.write('%s\n' % (as_tuple,))
479
462
 
480
463
 
481
464
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
465
    """Remove the working tree from a given branch/checkout.
483
466
 
484
467
    Since a lightweight checkout is little more than a working tree
485
468
    this will refuse to run against one.
512
495
                if (working.has_changes()):
513
496
                    raise errors.UncommittedChanges(working)
514
497
 
515
 
            if working.user_url != working.branch.user_url:
 
498
            working_path = working.bzrdir.root_transport.base
 
499
            branch_path = working.branch.bzrdir.root_transport.base
 
500
            if working_path != branch_path:
516
501
                raise errors.BzrCommandError("You cannot remove the working tree"
517
502
                                             " from a lightweight checkout")
518
503
 
520
505
 
521
506
 
522
507
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
508
    """Show current revision number.
524
509
 
525
510
    This is equal to the number of revisions on this branch.
526
511
    """
536
521
        if tree:
537
522
            try:
538
523
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
524
                wt.lock_read()
540
525
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
526
                raise errors.NoWorkingTree(location)
 
527
            self.add_cleanup(wt.unlock)
542
528
            revid = wt.last_revision()
543
529
            try:
544
530
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
533
            revno = ".".join(str(n) for n in revno_t)
548
534
        else:
549
535
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
536
            b.lock_read()
 
537
            self.add_cleanup(b.unlock)
551
538
            revno = b.revno()
552
539
        self.cleanup_now()
553
540
        self.outf.write(str(revno) + '\n')
554
541
 
555
542
 
556
543
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
544
    """Show revision number and revision id for a given revision identifier.
558
545
    """
559
546
    hidden = True
560
547
    takes_args = ['revision_info*']
561
548
    takes_options = [
562
549
        'revision',
563
 
        custom_help('directory',
 
550
        Option('directory',
564
551
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
 
552
                 'rather than the one containing the working directory.',
 
553
            short_name='d',
 
554
            type=unicode,
 
555
            ),
566
556
        Option('tree', help='Show revno of working tree'),
567
557
        ]
568
558
 
573
563
        try:
574
564
            wt = WorkingTree.open_containing(directory)[0]
575
565
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
566
            wt.lock_read()
 
567
            self.add_cleanup(wt.unlock)
577
568
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
569
            wt = None
579
570
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
571
            b.lock_read()
 
572
            self.add_cleanup(b.unlock)
581
573
        revision_ids = []
582
574
        if revision is not None:
583
575
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
603
 
612
604
 
613
605
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
606
    """Add specified files or directories.
615
607
 
616
608
    In non-recursive mode, all the named items are added, regardless
617
609
    of whether they were previously ignored.  A warning is given if
682
674
                should_print=(not is_quiet()))
683
675
 
684
676
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
677
            base_tree.lock_read()
 
678
            self.add_cleanup(base_tree.unlock)
686
679
        tree, file_list = tree_files_for_add(file_list)
687
680
        added, ignored = tree.smart_add(file_list, not
688
681
            no_recurse, action=action, save=not dry_run)
696
689
 
697
690
 
698
691
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
692
    """Create a new versioned directory.
700
693
 
701
694
    This is equivalent to creating the directory and then adding it.
702
695
    """
718
711
 
719
712
 
720
713
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
714
    """Show path of a file relative to root"""
722
715
 
723
716
    takes_args = ['filename']
724
717
    hidden = True
733
726
 
734
727
 
735
728
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
729
    """Show inventory of the current working copy or a revision.
737
730
 
738
731
    It is possible to limit the output to a particular entry
739
732
    type using the --kind option.  For example: --kind file.
760
753
 
761
754
        revision = _get_one_revision('inventory', revision)
762
755
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
756
        work_tree.lock_read()
 
757
        self.add_cleanup(work_tree.unlock)
764
758
        if revision is not None:
765
759
            tree = revision.as_tree(work_tree.branch)
766
760
 
767
761
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
762
            tree.lock_read()
 
763
            self.add_cleanup(tree.unlock)
769
764
        else:
770
765
            tree = work_tree
771
766
            extra_trees = []
792
787
 
793
788
 
794
789
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
790
    """Move or rename a file.
796
791
 
797
792
    :Usage:
798
793
        bzr mv OLDNAME NEWNAME
831
826
        if len(names_list) < 2:
832
827
            raise errors.BzrCommandError("missing file argument")
833
828
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
829
        tree.lock_tree_write()
 
830
        self.add_cleanup(tree.unlock)
835
831
        self._run(tree, names_list, rel_names, after)
836
832
 
837
833
    def run_auto(self, names_list, after, dry_run):
842
838
            raise errors.BzrCommandError('--after cannot be specified with'
843
839
                                         ' --auto.')
844
840
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
841
        work_tree.lock_tree_write()
 
842
        self.add_cleanup(work_tree.unlock)
846
843
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
844
 
848
845
    def _run(self, tree, names_list, rel_names, after):
927
924
 
928
925
 
929
926
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
927
    """Turn this branch into a mirror of another branch.
931
928
 
932
929
    By default, this command only works on branches that have not diverged.
933
930
    Branches are considered diverged if the destination branch's most recent 
956
953
    takes_options = ['remember', 'overwrite', 'revision',
957
954
        custom_help('verbose',
958
955
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
956
        Option('directory',
960
957
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
958
                 'rather than the one containing the working directory.',
 
959
            short_name='d',
 
960
            type=unicode,
 
961
            ),
962
962
        Option('local',
963
963
            help="Perform a local pull in a bound "
964
964
                 "branch.  Local pulls are not applied to "
979
979
        try:
980
980
            tree_to = WorkingTree.open_containing(directory)[0]
981
981
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
982
        except errors.NoWorkingTree:
984
983
            tree_to = None
985
984
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
985
        
988
986
        if local and not branch_to.get_bound_location():
989
987
            raise errors.LocalRequiresBoundBranch()
990
988
 
1020
1018
        else:
1021
1019
            branch_from = Branch.open(location,
1022
1020
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
1021
 
1025
1022
            if branch_to.get_parent() is None or remember:
1026
1023
                branch_to.set_parent(branch_from.base)
1027
1024
 
 
1025
        if branch_from is not branch_to:
 
1026
            branch_from.lock_read()
 
1027
            self.add_cleanup(branch_from.unlock)
1028
1028
        if revision is not None:
1029
1029
            revision_id = revision.as_revision_id(branch_from)
1030
1030
 
 
1031
        branch_to.lock_write()
 
1032
        self.add_cleanup(branch_to.unlock)
1031
1033
        if tree_to is not None:
1032
1034
            view_info = _get_view_info_for_change_reporter(tree_to)
1033
1035
            change_reporter = delta._ChangeReporter(
1048
1050
 
1049
1051
 
1050
1052
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1053
    """Update a mirror of this branch.
1052
1054
 
1053
1055
    The target branch will not have its working tree populated because this
1054
1056
    is both expensive, and is not supported on remote file systems.
1078
1080
        Option('create-prefix',
1079
1081
               help='Create the path leading up to the branch '
1080
1082
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1083
        Option('directory',
1082
1084
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1085
                 'rather than the one containing the working directory.',
 
1086
            short_name='d',
 
1087
            type=unicode,
 
1088
            ),
1084
1089
        Option('use-existing-dir',
1085
1090
               help='By default push will fail if the target'
1086
1091
                    ' directory exists, but does not already'
1112
1117
        # Get the source branch
1113
1118
        (tree, br_from,
1114
1119
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1120
        if strict is None:
 
1121
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1122
        if strict is None: strict = True # default value
1115
1123
        # Get the tip's revision_id
1116
1124
        revision = _get_one_revision('push', revision)
1117
1125
        if revision is not None:
1118
1126
            revision_id = revision.in_history(br_from).rev_id
1119
1127
        else:
1120
1128
            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.')
 
1129
        if strict and tree is not None and revision_id is None:
 
1130
            if (tree.has_changes()):
 
1131
                raise errors.UncommittedChanges(
 
1132
                    tree, more='Use --no-strict to force the push.')
 
1133
            if tree.last_revision() != tree.branch.last_revision():
 
1134
                # The tree has lost sync with its branch, there is little
 
1135
                # chance that the user is aware of it but he can still force
 
1136
                # the push with --no-strict
 
1137
                raise errors.OutOfDateTree(
 
1138
                    tree, more='Use --no-strict to force the push.')
 
1139
 
1126
1140
        # Get the stacked_on branch, if any
1127
1141
        if stacked_on is not None:
1128
1142
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1174
 
1161
1175
 
1162
1176
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1177
    """Create a new branch that is a copy of an existing branch.
1164
1178
 
1165
1179
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1180
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1220
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1221
            from_location)
1208
1222
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1223
        br_from.lock_read()
 
1224
        self.add_cleanup(br_from.unlock)
1210
1225
        if revision is not None:
1211
1226
            revision_id = revision.as_revision_id(br_from)
1212
1227
        else:
1272
1287
 
1273
1288
 
1274
1289
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1290
    """Create a new checkout of an existing branch.
1276
1291
 
1277
1292
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1293
    the branch found in '.'. This is useful if you have removed the working tree
1336
1351
            except errors.NoWorkingTree:
1337
1352
                source.bzrdir.create_workingtree(revision_id)
1338
1353
                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
1354
        source.create_checkout(to_location, revision_id, lightweight,
1345
1355
                               accelerator_tree, hardlink)
1346
1356
 
1347
1357
 
1348
1358
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1359
    """Show list of renamed files.
1350
1360
    """
1351
1361
    # TODO: Option to show renames between two historical versions.
1352
1362
 
1357
1367
    @display_command
1358
1368
    def run(self, dir=u'.'):
1359
1369
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1370
        tree.lock_read()
 
1371
        self.add_cleanup(tree.unlock)
1361
1372
        new_inv = tree.inventory
1362
1373
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1374
        old_tree.lock_read()
 
1375
        self.add_cleanup(old_tree.unlock)
1364
1376
        old_inv = old_tree.inventory
1365
1377
        renames = []
1366
1378
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1388
 
1377
1389
 
1378
1390
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1391
    """Update a tree to have the latest code committed to its branch.
1380
1392
 
1381
1393
    This will perform a merge into the working tree, and may generate
1382
1394
    conflicts. If you have any local changes, you will still
1404
1416
        master = branch.get_master_branch(
1405
1417
            possible_transports=possible_transports)
1406
1418
        if master is not None:
 
1419
            tree.lock_write()
1407
1420
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1421
        else:
 
1422
            tree.lock_tree_write()
1410
1423
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1424
        self.add_cleanup(tree.unlock)
1413
1425
        # get rid of the final '/' and be ready for display
1414
 
        branch_location = urlutils.unescape_for_display(
1415
 
            branch_location.rstrip('/'),
1416
 
            self.outf.encoding)
 
1426
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1427
                                                        self.outf.encoding)
1417
1428
        existing_pending_merges = tree.get_parent_ids()[1:]
1418
1429
        if master is None:
1419
1430
            old_tip = None
1427
1438
        else:
1428
1439
            revision_id = branch.last_revision()
1429
1440
        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))
 
1441
            revno = branch.revision_id_to_revno(revision_id)
 
1442
            note("Tree is up to date at revision %d of branch %s" %
 
1443
                (revno, branch_location))
1433
1444
            return 0
1434
1445
        view_info = _get_view_info_for_change_reporter(tree)
1435
1446
        change_reporter = delta._ChangeReporter(
1447
1458
                                  "bzr update --revision only works"
1448
1459
                                  " for a revision in the branch history"
1449
1460
                                  % (e.revision))
1450
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1461
        revno = tree.branch.revision_id_to_revno(
1451
1462
            _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:
 
1463
        note('Updated to revision %d of branch %s' %
 
1464
             (revno, branch_location))
 
1465
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1456
1466
            note('Your local commits will now show as pending merges with '
1457
1467
                 "'bzr status', and can be committed with 'bzr commit'.")
1458
1468
        if conflicts != 0:
1462
1472
 
1463
1473
 
1464
1474
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1475
    """Show information about a working tree, branch or repository.
1466
1476
 
1467
1477
    This command will show all known locations and formats associated to the
1468
1478
    tree, branch or repository.
1506
1516
 
1507
1517
 
1508
1518
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1519
    """Remove files or directories.
1510
1520
 
1511
1521
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1522
    them if they can easily be recovered using revert. If no options or
1534
1544
        if file_list is not None:
1535
1545
            file_list = [f for f in file_list]
1536
1546
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1547
        tree.lock_write()
 
1548
        self.add_cleanup(tree.unlock)
1538
1549
        # Heuristics should probably all move into tree.remove_smart or
1539
1550
        # some such?
1540
1551
        if new:
1559
1570
 
1560
1571
 
1561
1572
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1573
    """Print file_id of a particular file or directory.
1563
1574
 
1564
1575
    The file_id is assigned when the file is first added and remains the
1565
1576
    same through all revisions where the file exists, even when it is
1581
1592
 
1582
1593
 
1583
1594
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1595
    """Print path of file_ids to a file or directory.
1585
1596
 
1586
1597
    This prints one line for each directory down to the target,
1587
1598
    starting at the branch root.
1603
1614
 
1604
1615
 
1605
1616
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1617
    """Reconcile bzr metadata in a branch.
1607
1618
 
1608
1619
    This can correct data mismatches that may have been caused by
1609
1620
    previous ghost operations or bzr upgrades. You should only
1631
1642
 
1632
1643
 
1633
1644
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1645
    """Display the list of revision ids on a branch."""
1635
1646
 
1636
1647
    _see_also = ['log']
1637
1648
    takes_args = ['location?']
1647
1658
 
1648
1659
 
1649
1660
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1661
    """List all revisions merged into this branch."""
1651
1662
 
1652
1663
    _see_also = ['log', 'revision-history']
1653
1664
    takes_args = ['location?']
1672
1683
 
1673
1684
 
1674
1685
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1686
    """Make a directory into a versioned branch.
1676
1687
 
1677
1688
    Use this to create an empty branch, or before importing an
1678
1689
    existing project.
1781
1792
 
1782
1793
 
1783
1794
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1795
    """Create a shared repository for branches to share storage space.
1785
1796
 
1786
1797
    New branches created under the repository directory will store their
1787
1798
    revisions in the repository, not in the branch directory.  For branches
1841
1852
 
1842
1853
 
1843
1854
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1855
    """Show differences in the working tree, between revisions or branches.
1845
1856
 
1846
1857
    If no arguments are given, all changes for the current tree are listed.
1847
1858
    If files are given, only the changes in those files are listed.
1933
1944
            help='Use this command to compare files.',
1934
1945
            type=unicode,
1935
1946
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1947
        ]
1941
1948
    aliases = ['di', 'dif']
1942
1949
    encoding_type = 'exact'
1943
1950
 
1944
1951
    @display_command
1945
1952
    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)
 
1953
            prefix=None, old=None, new=None, using=None):
 
1954
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1949
1955
 
1950
1956
        if (prefix is None) or (prefix == '0'):
1951
1957
            # diff -p0 format
1965
1971
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1972
                                         ' one or two revision specifiers')
1967
1973
 
1968
 
        if using is not None and format is not None:
1969
 
            raise errors.BzrCommandError('--using and --format are mutually '
1970
 
                'exclusive.')
1971
 
 
1972
1974
        (old_tree, new_tree,
1973
1975
         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)
 
1976
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1977
            file_list, revision, old, new, apply_view=True)
1976
1978
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1979
                               specific_files=specific_files,
1978
1980
                               external_diff_options=diff_options,
1979
1981
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1982
                               extra_trees=extra_trees, using=using)
1982
1983
 
1983
1984
 
1984
1985
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1986
    """List files deleted in the working tree.
1986
1987
    """
1987
1988
    # TODO: Show files deleted since a previous revision, or
1988
1989
    # between two revisions.
1991
1992
    # level of effort but possibly much less IO.  (Or possibly not,
1992
1993
    # if the directories are very large...)
1993
1994
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
1995
    takes_options = ['show-ids']
1995
1996
 
1996
1997
    @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)
 
1998
    def run(self, show_ids=False):
 
1999
        tree = WorkingTree.open_containing(u'.')[0]
 
2000
        tree.lock_read()
 
2001
        self.add_cleanup(tree.unlock)
2000
2002
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
2003
        old.lock_read()
 
2004
        self.add_cleanup(old.unlock)
2002
2005
        for path, ie in old.inventory.iter_entries():
2003
2006
            if not tree.has_id(ie.file_id):
2004
2007
                self.outf.write(path)
2009
2012
 
2010
2013
 
2011
2014
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
2015
    """List files modified in working tree.
2013
2016
    """
2014
2017
 
2015
2018
    hidden = True
2016
2019
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
2020
    takes_options = [
 
2021
            Option('null',
 
2022
                   help='Write an ascii NUL (\\0) separator '
 
2023
                   'between files rather than a newline.')
 
2024
            ]
2018
2025
 
2019
2026
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2027
    def run(self, null=False):
 
2028
        tree = WorkingTree.open_containing(u'.')[0]
2022
2029
        td = tree.changes_from(tree.basis_tree())
2023
2030
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2031
            if null:
2028
2035
 
2029
2036
 
2030
2037
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2038
    """List files added in working tree.
2032
2039
    """
2033
2040
 
2034
2041
    hidden = True
2035
2042
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2043
    takes_options = [
 
2044
            Option('null',
 
2045
                   help='Write an ascii NUL (\\0) separator '
 
2046
                   'between files rather than a newline.')
 
2047
            ]
2037
2048
 
2038
2049
    @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)
 
2050
    def run(self, null=False):
 
2051
        wt = WorkingTree.open_containing(u'.')[0]
 
2052
        wt.lock_read()
 
2053
        self.add_cleanup(wt.unlock)
2042
2054
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2055
        basis.lock_read()
 
2056
        self.add_cleanup(basis.unlock)
2044
2057
        basis_inv = basis.inventory
2045
2058
        inv = wt.inventory
2046
2059
        for file_id in inv:
2049
2062
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2063
                continue
2051
2064
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2065
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2066
                continue
2054
2067
            if null:
2055
2068
                self.outf.write(path + '\0')
2058
2071
 
2059
2072
 
2060
2073
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2074
    """Show the tree root directory.
2062
2075
 
2063
2076
    The root is the nearest enclosing directory with a .bzr control
2064
2077
    directory."""
2088
2101
 
2089
2102
 
2090
2103
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2104
    """Show historical log for a branch or subset of a branch.
2092
2105
 
2093
2106
    log is bzr's default tool for exploring the history of a branch.
2094
2107
    The branch to use is taken from the first parameter. If no parameters
2255
2268
                   help='Show just the specified revision.'
2256
2269
                   ' See also "help revisionspec".'),
2257
2270
            '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
2271
            Option('levels',
2264
2272
                   short_name='n',
2265
2273
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2288
                   help='Show changes made in each revision as a patch.'),
2281
2289
            Option('include-merges',
2282
2290
                   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
2291
            ]
2288
2292
    encoding_type = 'replace'
2289
2293
 
2299
2303
            message=None,
2300
2304
            limit=None,
2301
2305
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2306
            include_merges=False):
2306
2307
        from bzrlib.log import (
2307
2308
            Logger,
2308
2309
            make_log_request_dict,
2309
2310
            _get_info_for_log_files,
2310
2311
            )
2311
2312
        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
2313
        if include_merges:
2317
2314
            if levels is None:
2318
2315
                levels = 0
2334
2331
        if file_list:
2335
2332
            # find the file ids to log and check for directory filtering
2336
2333
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2334
                revision, file_list)
 
2335
            self.add_cleanup(b.unlock)
2338
2336
            for relpath, file_id, kind in file_info_list:
2339
2337
                if file_id is None:
2340
2338
                    raise errors.BzrCommandError(
2358
2356
                location = '.'
2359
2357
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2358
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2359
            b.lock_read()
 
2360
            self.add_cleanup(b.unlock)
2362
2361
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2362
 
2364
2363
        # Decide on the type of delta & diff filtering to use
2384
2383
                        show_timezone=timezone,
2385
2384
                        delta_format=get_verbosity_level(),
2386
2385
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2386
                        show_advice=levels is None)
2389
2387
 
2390
2388
        # Choose the algorithm for doing the logging. It's annoying
2391
2389
        # having multiple code paths like this but necessary until
2410
2408
            direction=direction, specific_fileids=file_ids,
2411
2409
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2410
            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
 
            )
 
2411
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2412
        Logger(b, rqst).show(lf)
2417
2413
 
2418
2414
 
2437
2433
            raise errors.BzrCommandError(
2438
2434
                "bzr %s doesn't accept two revisions in different"
2439
2435
                " branches." % command_name)
2440
 
        if start_spec.spec is None:
2441
 
            # Avoid loading all the history.
2442
 
            rev1 = RevisionInfo(branch, None, None)
2443
 
        else:
2444
 
            rev1 = start_spec.in_history(branch)
 
2436
        rev1 = start_spec.in_history(branch)
2445
2437
        # Avoid loading all of history when we know a missing
2446
2438
        # end of range means the last revision ...
2447
2439
        if end_spec.spec is None:
2476
2468
 
2477
2469
 
2478
2470
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2471
    """Return revision-ids which affected a particular file.
2480
2472
 
2481
2473
    A more user-friendly interface is "bzr log FILE".
2482
2474
    """
2489
2481
        tree, relpath = WorkingTree.open_containing(filename)
2490
2482
        file_id = tree.path2id(relpath)
2491
2483
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2484
        b.lock_read()
 
2485
        self.add_cleanup(b.unlock)
2493
2486
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2487
        for revno, revision_id, what in touching_revs:
2495
2488
            self.outf.write("%6d %s\n" % (revno, what))
2496
2489
 
2497
2490
 
2498
2491
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2492
    """List files in a tree.
2500
2493
    """
2501
2494
 
2502
2495
    _see_also = ['status', 'cat']
2508
2501
                   help='Recurse into subdirectories.'),
2509
2502
            Option('from-root',
2510
2503
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2504
            Option('unknown', help='Print unknown files.'),
2513
2505
            Option('versioned', help='Print versioned files.',
2514
2506
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2507
            Option('ignored', help='Print ignored files.'),
 
2508
            Option('null',
 
2509
                   help='Write an ascii NUL (\\0) separator '
 
2510
                   'between files rather than a newline.'),
 
2511
            Option('kind',
2518
2512
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2513
                   type=unicode),
2520
 
            'null',
2521
2514
            'show-ids',
2522
 
            'directory',
2523
2515
            ]
2524
2516
    @display_command
2525
2517
    def run(self, revision=None, verbose=False,
2526
2518
            recursive=False, from_root=False,
2527
2519
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2520
            null=False, kind=None, show_ids=False, path=None):
2529
2521
 
2530
2522
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2523
            raise errors.BzrCommandError('invalid kind specified')
2543
2535
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2536
                                             ' and PATH')
2545
2537
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2538
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2539
            fs_path)
2548
2540
 
2549
2541
        # Calculate the prefix to use
2550
2542
        prefix = None
2565
2557
                view_str = views.view_display_str(view_files)
2566
2558
                note("Ignoring files outside view. View is %s" % view_str)
2567
2559
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2560
        tree.lock_read()
 
2561
        self.add_cleanup(tree.unlock)
2569
2562
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2563
            from_dir=relpath, recursive=recursive):
2571
2564
            # Apply additional masking
2613
2606
 
2614
2607
 
2615
2608
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2609
    """List unknown files.
2617
2610
    """
2618
2611
 
2619
2612
    hidden = True
2620
2613
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2614
 
2623
2615
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2616
    def run(self):
 
2617
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2618
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2619
 
2628
2620
 
2629
2621
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2622
    """Ignore specified files or patterns.
2631
2623
 
2632
2624
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2625
 
2642
2634
    using this command or directly by using an editor, be sure to commit
2643
2635
    it.
2644
2636
    
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
2637
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2638
    precedence over regular ignores.  Such exceptions are used to specify
2653
2639
    files that should be versioned which would otherwise be ignored.
2693
2679
 
2694
2680
    _see_also = ['status', 'ignored', 'patterns']
2695
2681
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2682
    takes_options = [
 
2683
        Option('old-default-rules',
 
2684
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2685
        ]
2700
2686
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2687
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2688
        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:
 
2689
        if old_default_rules is not None:
 
2690
            # dump the rules and exit
 
2691
            for pattern in ignores.OLD_DEFAULTS:
2707
2692
                self.outf.write("%s\n" % pattern)
2708
2693
            return
2709
2694
        if not name_pattern_list:
2710
2695
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2696
                                  "NAME_PATTERN or --old-default-rules")
2712
2697
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2698
                             for p in name_pattern_list]
2714
2699
        for name_pattern in name_pattern_list:
2716
2701
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2702
                raise errors.BzrCommandError(
2718
2703
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2704
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2705
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2706
        ignored = globbing.Globster(name_pattern_list)
2722
2707
        matches = []
2736
2721
 
2737
2722
 
2738
2723
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2724
    """List ignored files and the patterns that matched them.
2740
2725
 
2741
2726
    List all the ignored files and the ignore pattern that caused the file to
2742
2727
    be ignored.
2748
2733
 
2749
2734
    encoding_type = 'replace'
2750
2735
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2736
 
2753
2737
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2738
    def run(self):
 
2739
        tree = WorkingTree.open_containing(u'.')[0]
 
2740
        tree.lock_read()
 
2741
        self.add_cleanup(tree.unlock)
2757
2742
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2743
            if file_class != 'I':
2759
2744
                continue
2763
2748
 
2764
2749
 
2765
2750
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2751
    """Lookup the revision-id from a revision-number
2767
2752
 
2768
2753
    :Examples:
2769
2754
        bzr lookup-revision 33
2770
2755
    """
2771
2756
    hidden = True
2772
2757
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2758
 
2775
2759
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2760
    def run(self, revno):
2777
2761
        try:
2778
2762
            revno = int(revno)
2779
2763
        except ValueError:
2780
2764
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
2765
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2766
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2783
2767
        self.outf.write("%s\n" % revid)
2784
2768
 
2785
2769
 
2786
2770
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2771
    """Export current or past revision to a destination directory or archive.
2788
2772
 
2789
2773
    If no revision is specified this exports the last committed revision.
2790
2774
 
2812
2796
      =================       =========================
2813
2797
    """
2814
2798
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2799
    takes_options = [
2816
2800
        Option('format',
2817
2801
               help="Type of file to export to.",
2818
2802
               type=unicode),
2822
2806
        Option('root',
2823
2807
               type=str,
2824
2808
               help="Name of the root directory inside the exported file."),
2825
 
        Option('per-file-timestamps',
2826
 
               help='Set modification time of files to that of the last '
2827
 
                    'revision in which it was changed.'),
2828
2809
        ]
2829
2810
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2811
        root=None, filters=False):
2831
2812
        from bzrlib.export import export
2832
2813
 
2833
2814
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2815
            tree = WorkingTree.open_containing(u'.')[0]
2835
2816
            b = tree.branch
2836
2817
            subdir = None
2837
2818
        else:
2840
2821
 
2841
2822
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2842
2823
        try:
2843
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2844
 
                   per_file_timestamps=per_file_timestamps)
 
2824
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2845
2825
        except errors.NoSuchExportFormat, e:
2846
2826
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2847
2827
 
2848
2828
 
2849
2829
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2830
    """Write the contents of a file as of a given revision to standard output.
2851
2831
 
2852
2832
    If no revision is nominated, the last revision is used.
2853
2833
 
2856
2836
    """
2857
2837
 
2858
2838
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2839
    takes_options = [
2860
2840
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2841
        Option('filters', help='Apply content filters to display the '
2862
2842
                'convenience form.'),
2867
2847
 
2868
2848
    @display_command
2869
2849
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2850
            filters=False):
2871
2851
        if revision is not None and len(revision) != 1:
2872
2852
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2853
                                         " one revision specifier")
2874
2854
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2855
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2856
        branch.lock_read()
 
2857
        self.add_cleanup(branch.unlock)
2877
2858
        return self._run(tree, branch, relpath, filename, revision,
2878
2859
                         name_from_revision, filters)
2879
2860
 
2882
2863
        if tree is None:
2883
2864
            tree = b.basis_tree()
2884
2865
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2866
        rev_tree.lock_read()
 
2867
        self.add_cleanup(rev_tree.unlock)
2886
2868
 
2887
2869
        old_file_id = rev_tree.path2id(relpath)
2888
2870
 
2931
2913
 
2932
2914
 
2933
2915
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2916
    """Show the offset in seconds from GMT to local time."""
2935
2917
    hidden = True
2936
2918
    @display_command
2937
2919
    def run(self):
2940
2922
 
2941
2923
 
2942
2924
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2925
    """Commit changes into a new revision.
2944
2926
 
2945
2927
    An explanatory message needs to be given for each commit. This is
2946
2928
    often done by using the --message option (getting the message from the
3054
3036
                         "the master branch until a normal commit "
3055
3037
                         "is performed."
3056
3038
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3039
             Option('show-diff',
3058
3040
                    help='When no message is supplied, show the diff along'
3059
3041
                    ' with the status summary in the message editor.'),
3060
3042
             ]
3140
3122
                    '(use --file "%(f)s" to take commit message from that file)'
3141
3123
                    % { 'f': message })
3142
3124
                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
3125
 
3150
3126
        def get_message(commit_obj):
3151
3127
            """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,
 
3128
            my_message = message
 
3129
            if my_message is not None and '\r' in my_message:
 
3130
                my_message = my_message.replace('\r\n', '\n')
 
3131
                my_message = my_message.replace('\r', '\n')
 
3132
            if my_message is None and not file:
 
3133
                t = make_commit_message_template_encoded(tree,
3161
3134
                        selected_list, diff=show_diff,
3162
3135
                        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
3136
                start_message = generate_commit_message_template(commit_obj)
3169
 
                my_message = edit_commit_message_encoded(text,
 
3137
                my_message = edit_commit_message_encoded(t,
3170
3138
                    start_message=start_message)
3171
3139
                if my_message is None:
3172
3140
                    raise errors.BzrCommandError("please specify a commit"
3173
3141
                        " message with either --message or --file")
 
3142
            elif my_message and file:
 
3143
                raise errors.BzrCommandError(
 
3144
                    "please specify either --message or --file")
 
3145
            if file:
 
3146
                my_message = codecs.open(file, 'rt',
 
3147
                                         osutils.get_user_encoding()).read()
3174
3148
            if my_message == "":
3175
3149
                raise errors.BzrCommandError("empty commit message specified")
3176
3150
            return my_message
3188
3162
                        timezone=offset,
3189
3163
                        exclude=safe_relpath_files(tree, exclude))
3190
3164
        except PointlessCommit:
 
3165
            # FIXME: This should really happen before the file is read in;
 
3166
            # perhaps prepare the commit; get the message; then actually commit
3191
3167
            raise errors.BzrCommandError("No changes to commit."
3192
3168
                              " Use --unchanged to commit anyhow.")
3193
3169
        except ConflictsInTree:
3206
3182
 
3207
3183
 
3208
3184
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3185
    """Validate working tree structure, branch consistency and repository history.
3210
3186
 
3211
3187
    This command checks various invariants about branch and repository storage
3212
3188
    to detect data corruption or bzr bugs.
3276
3252
 
3277
3253
 
3278
3254
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3255
    """Upgrade branch storage to current format.
3280
3256
 
3281
3257
    The check command or bzr developers may sometimes advise you to run
3282
3258
    this command. When the default format has changed you may also be warned
3300
3276
 
3301
3277
 
3302
3278
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3279
    """Show or set bzr user id.
3304
3280
 
3305
3281
    :Examples:
3306
3282
        Show the email of the current user::
3350
3326
 
3351
3327
 
3352
3328
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3329
    """Print or set the branch nickname.
3354
3330
 
3355
3331
    If unset, the tree root directory name is used as the nickname.
3356
3332
    To print the current nickname, execute with no argument.
3361
3337
 
3362
3338
    _see_also = ['info']
3363
3339
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3340
    def run(self, nickname=None):
 
3341
        branch = Branch.open_containing(u'.')[0]
3367
3342
        if nickname is None:
3368
3343
            self.printme(branch)
3369
3344
        else:
3375
3350
 
3376
3351
 
3377
3352
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3353
    """Set/unset and display aliases.
3379
3354
 
3380
3355
    :Examples:
3381
3356
        Show the current aliases::
3445
3420
 
3446
3421
 
3447
3422
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3423
    """Run internal test suite.
3449
3424
 
3450
3425
    If arguments are given, they are regular expressions that say which tests
3451
3426
    should run.  Tests matching any expression are run, and other tests are
3592
3567
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3568
                    "needs to be installed to use --subunit.")
3594
3569
            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
3570
        if parallel:
3601
3571
            self.additional_selftest_args.setdefault(
3602
3572
                'suite_decorators', []).append(parallel)
3633
3603
 
3634
3604
 
3635
3605
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3606
    """Show version of bzr."""
3637
3607
 
3638
3608
    encoding_type = 'replace'
3639
3609
    takes_options = [
3650
3620
 
3651
3621
 
3652
3622
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3623
    """Statement of optimism."""
3654
3624
 
3655
3625
    hidden = True
3656
3626
 
3660
3630
 
3661
3631
 
3662
3632
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3633
    """Find and print a base revision for merging two branches."""
3664
3634
    # TODO: Options to specify revisions on either side, as if
3665
3635
    #       merging only part of the history.
3666
3636
    takes_args = ['branch', 'other']
3672
3642
 
3673
3643
        branch1 = Branch.open_containing(branch)[0]
3674
3644
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3645
        branch1.lock_read()
 
3646
        self.add_cleanup(branch1.unlock)
 
3647
        branch2.lock_read()
 
3648
        self.add_cleanup(branch2.unlock)
3677
3649
        last1 = ensure_null(branch1.last_revision())
3678
3650
        last2 = ensure_null(branch2.last_revision())
3679
3651
 
3684
3656
 
3685
3657
 
3686
3658
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3659
    """Perform a three-way merge.
3688
3660
 
3689
3661
    The source of the merge can be specified either in the form of a branch,
3690
3662
    or in the form of a path to a file containing a merge directive generated
3773
3745
                ' completely merged into the source, pull from the'
3774
3746
                ' source rather than merging.  When this happens,'
3775
3747
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3748
        Option('directory',
3777
3749
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3750
                    'rather than the one containing the working directory.',
 
3751
               short_name='d',
 
3752
               type=unicode,
 
3753
               ),
3779
3754
        Option('preview', help='Instead of merging, show a diff of the'
3780
3755
               ' merge.'),
3781
3756
        Option('interactive', help='Select changes interactively.',
3814
3789
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3790
        pb = ui.ui_factory.nested_progress_bar()
3816
3791
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3792
        tree.lock_write()
 
3793
        self.add_cleanup(tree.unlock)
3818
3794
        if location is not None:
3819
3795
            try:
3820
3796
                mergeable = bundle.read_mergeable_from_url(location,
4041
4017
 
4042
4018
 
4043
4019
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
4020
    """Redo a merge.
4045
4021
 
4046
4022
    Use this if you want to try a different merge technique while resolving
4047
4023
    conflicts.  Some merge techniques are better than others, and remerge
4072
4048
 
4073
4049
    def run(self, file_list=None, merge_type=None, show_base=False,
4074
4050
            reprocess=False):
4075
 
        from bzrlib.conflicts import restore
4076
4051
        if merge_type is None:
4077
4052
            merge_type = _mod_merge.Merge3Merger
4078
4053
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4054
        tree.lock_write()
 
4055
        self.add_cleanup(tree.unlock)
4080
4056
        parents = tree.get_parent_ids()
4081
4057
        if len(parents) != 2:
4082
4058
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4111
 
4136
4112
 
4137
4113
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4114
    """Revert files to a previous revision.
4139
4115
 
4140
4116
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4117
    will be reverted.  If the revision is not specified with '--revision', the
4192
4168
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4169
            forget_merges=None):
4194
4170
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4171
        tree.lock_write()
 
4172
        self.add_cleanup(tree.unlock)
4196
4173
        if forget_merges:
4197
4174
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4175
        else:
4206
4183
 
4207
4184
 
4208
4185
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4186
    """Test reporting of assertion failures"""
4210
4187
    # intended just for use in testing
4211
4188
 
4212
4189
    hidden = True
4216
4193
 
4217
4194
 
4218
4195
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4196
    """Show help on a command or other topic.
4220
4197
    """
4221
4198
 
4222
4199
    _see_also = ['topics']
4235
4212
 
4236
4213
 
4237
4214
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4215
    """Show appropriate completions for context.
4239
4216
 
4240
4217
    For a list of all available commands, say 'bzr shell-complete'.
4241
4218
    """
4250
4227
 
4251
4228
 
4252
4229
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4230
    """Show unmerged/unpulled revisions between two branches.
4254
4231
 
4255
4232
    OTHER_BRANCH may be local or remote.
4256
4233
 
4334
4311
            restrict = 'remote'
4335
4312
 
4336
4313
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4314
        parent = local_branch.get_parent()
4340
4315
        if other_branch is None:
4341
4316
            other_branch = parent
4350
4325
        remote_branch = Branch.open(other_branch)
4351
4326
        if remote_branch.base == local_branch.base:
4352
4327
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4328
 
 
4329
        local_branch.lock_read()
 
4330
        self.add_cleanup(local_branch.unlock)
4356
4331
        local_revid_range = _revision_range_to_revid_range(
4357
4332
            _get_revision_range(my_revision, local_branch,
4358
4333
                self.name()))
4359
4334
 
 
4335
        remote_branch.lock_read()
 
4336
        self.add_cleanup(remote_branch.unlock)
4360
4337
        remote_revid_range = _revision_range_to_revid_range(
4361
4338
            _get_revision_range(revision,
4362
4339
                remote_branch, self.name()))
4412
4389
            message("Branches are up to date.\n")
4413
4390
        self.cleanup_now()
4414
4391
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4392
            local_branch.lock_write()
 
4393
            self.add_cleanup(local_branch.unlock)
4416
4394
            # handle race conditions - a parent might be set while we run.
4417
4395
            if local_branch.get_parent() is None:
4418
4396
                local_branch.set_parent(remote_branch.base)
4420
4398
 
4421
4399
 
4422
4400
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
 
    """
 
4401
    """Compress the data within a repository."""
4440
4402
 
4441
4403
    _see_also = ['repositories']
4442
4404
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4405
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4406
    def run(self, branch_or_repo='.'):
4448
4407
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4408
        try:
4450
4409
            branch = dir.open_branch()
4451
4410
            repository = branch.repository
4452
4411
        except errors.NotBranchError:
4453
4412
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4413
        repository.pack()
4455
4414
 
4456
4415
 
4457
4416
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4417
    """List the installed plugins.
4459
4418
 
4460
4419
    This command displays the list of installed plugins including
4461
4420
    version of plugin and a short description of each.
4500
4459
 
4501
4460
 
4502
4461
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4462
    """Show testament (signing-form) of a revision."""
4504
4463
    takes_options = [
4505
4464
            'revision',
4506
4465
            Option('long', help='Produce long-format testament.'),
4518
4477
            b = Branch.open_containing(branch)[0]
4519
4478
        else:
4520
4479
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4480
        b.lock_read()
 
4481
        self.add_cleanup(b.unlock)
4522
4482
        if revision is None:
4523
4483
            rev_id = b.last_revision()
4524
4484
        else:
4531
4491
 
4532
4492
 
4533
4493
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4494
    """Show the origin of each line in a file.
4535
4495
 
4536
4496
    This prints out the given file with an annotation on the left side
4537
4497
    indicating which revision, author and date introduced the change.
4548
4508
                     Option('long', help='Show commit date in annotations.'),
4549
4509
                     'revision',
4550
4510
                     'show-ids',
4551
 
                     'directory',
4552
4511
                     ]
4553
4512
    encoding_type = 'exact'
4554
4513
 
4555
4514
    @display_command
4556
4515
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4516
            show_ids=False):
4558
4517
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4518
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4519
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4520
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4521
            wt.lock_read()
 
4522
            self.add_cleanup(wt.unlock)
4563
4523
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4524
            branch.lock_read()
 
4525
            self.add_cleanup(branch.unlock)
4565
4526
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4527
        tree.lock_read()
 
4528
        self.add_cleanup(tree.unlock)
4567
4529
        if wt is not None:
4568
4530
            file_id = wt.path2id(relpath)
4569
4531
        else:
4582
4544
 
4583
4545
 
4584
4546
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4547
    """Create a digital signature for an existing revision."""
4586
4548
    # TODO be able to replace existing ones.
4587
4549
 
4588
4550
    hidden = True # is this right ?
4589
4551
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4552
    takes_options = ['revision']
4591
4553
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4554
    def run(self, revision_id_list=None, revision=None):
4593
4555
        if revision_id_list is not None and revision is not None:
4594
4556
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4557
        if revision_id_list is None and revision is None:
4596
4558
            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)
 
4559
        b = WorkingTree.open_containing(u'.')[0].branch
 
4560
        b.lock_write()
 
4561
        self.add_cleanup(b.unlock)
4599
4562
        return self._run(b, revision_id_list, revision)
4600
4563
 
4601
4564
    def _run(self, b, revision_id_list, revision):
4647
4610
 
4648
4611
 
4649
4612
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.
 
4613
    """Convert the current branch into a checkout of the supplied branch.
4652
4614
 
4653
4615
    Once converted into a checkout, commits must succeed on the master branch
4654
4616
    before they will be applied to the local branch.
4660
4622
 
4661
4623
    _see_also = ['checkouts', 'unbind']
4662
4624
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4625
    takes_options = []
4664
4626
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4627
    def run(self, location=None):
 
4628
        b, relpath = Branch.open_containing(u'.')
4667
4629
        if location is None:
4668
4630
            try:
4669
4631
                location = b.get_old_bound_location()
4688
4650
 
4689
4651
 
4690
4652
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4653
    """Convert the current checkout into a regular branch.
4692
4654
 
4693
4655
    After unbinding, the local branch is considered independent and subsequent
4694
4656
    commits will be local only.
4696
4658
 
4697
4659
    _see_also = ['checkouts', 'bind']
4698
4660
    takes_args = []
4699
 
    takes_options = ['directory']
 
4661
    takes_options = []
4700
4662
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4663
    def run(self):
 
4664
        b, relpath = Branch.open_containing(u'.')
4703
4665
        if not b.unbind():
4704
4666
            raise errors.BzrCommandError('Local branch is not bound')
4705
4667
 
4706
4668
 
4707
4669
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4670
    """Remove the last committed revision.
4709
4671
 
4710
4672
    --verbose will print out what is being removed.
4711
4673
    --dry-run will go through all the motions, but not actually
4751
4713
            b = control.open_branch()
4752
4714
 
4753
4715
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4716
            tree.lock_write()
 
4717
            self.add_cleanup(tree.unlock)
4755
4718
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4719
            b.lock_write()
 
4720
            self.add_cleanup(b.unlock)
4757
4721
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4722
 
4759
4723
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4811
4775
 
4812
4776
 
4813
4777
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4778
    """Break a dead lock on a repository, branch or working directory.
4815
4779
 
4816
4780
    CAUTION: Locks should only be broken when you are sure that the process
4817
4781
    holding the lock has been stopped.
4836
4800
 
4837
4801
 
4838
4802
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4803
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4804
 
4841
4805
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4806
    """
4850
4814
 
4851
4815
 
4852
4816
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4817
    """Run the bzr server."""
4854
4818
 
4855
4819
    aliases = ['server']
4856
4820
 
4867
4831
                    'result in a dynamically allocated port.  The default port '
4868
4832
                    'depends on the protocol.',
4869
4833
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4834
        Option('directory',
 
4835
               help='Serve contents of this directory.',
 
4836
               type=unicode),
4872
4837
        Option('allow-writes',
4873
4838
               help='By default the server is a readonly server.  Supplying '
4874
4839
                    '--allow-writes enables write access to the contents of '
4915
4880
 
4916
4881
 
4917
4882
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4883
    """Combine a tree into its containing tree.
4919
4884
 
4920
4885
    This command requires the target tree to be in a rich-root format.
4921
4886
 
4961
4926
 
4962
4927
 
4963
4928
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4929
    """Split a subdirectory of a tree into a separate tree.
4965
4930
 
4966
4931
    This command will produce a target tree in a format that supports
4967
4932
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4952
 
4988
4953
 
4989
4954
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4955
    """Generate a merge directive for auto-merge tools.
4991
4956
 
4992
4957
    A directive requests a merge to be performed, and also provides all the
4993
4958
    information necessary to do so.  This means it must either include a
5086
5051
 
5087
5052
 
5088
5053
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5054
    """Mail or create a merge-directive for submitting changes.
5090
5055
 
5091
5056
    A merge directive provides many things needed for requesting merges:
5092
5057
 
5174
5139
               short_name='f',
5175
5140
               type=unicode),
5176
5141
        Option('output', short_name='o',
5177
 
               help='Write merge directive to this file or directory; '
 
5142
               help='Write merge directive to this file; '
5178
5143
                    'use - for stdout.',
5179
5144
               type=unicode),
5180
5145
        Option('strict',
5203
5168
 
5204
5169
 
5205
5170
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5171
    """Create a merge-directive for submitting changes.
5207
5172
 
5208
5173
    A merge directive provides many things needed for requesting merges:
5209
5174
 
5276
5241
 
5277
5242
 
5278
5243
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5244
    """Create, remove or modify a tag naming a revision.
5280
5245
 
5281
5246
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5247
    (--revision) option can be given -rtag:X, where X is any previously
5290
5255
 
5291
5256
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5292
5257
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5293
 
 
5294
 
    If no tag name is specified it will be determined through the 
5295
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5296
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5297
 
    details.
5298
5258
    """
5299
5259
 
5300
5260
    _see_also = ['commit', 'tags']
5301
 
    takes_args = ['tag_name?']
 
5261
    takes_args = ['tag_name']
5302
5262
    takes_options = [
5303
5263
        Option('delete',
5304
5264
            help='Delete this tag rather than placing it.',
5305
5265
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5266
        Option('directory',
 
5267
            help='Branch in which to place the tag.',
 
5268
            short_name='d',
 
5269
            type=unicode,
 
5270
            ),
5308
5271
        Option('force',
5309
5272
            help='Replace existing tags.',
5310
5273
            ),
5311
5274
        'revision',
5312
5275
        ]
5313
5276
 
5314
 
    def run(self, tag_name=None,
 
5277
    def run(self, tag_name,
5315
5278
            delete=None,
5316
5279
            directory='.',
5317
5280
            force=None,
5318
5281
            revision=None,
5319
5282
            ):
5320
5283
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5284
        branch.lock_write()
 
5285
        self.add_cleanup(branch.unlock)
5322
5286
        if delete:
5323
 
            if tag_name is None:
5324
 
                raise errors.BzrCommandError("No tag specified to delete.")
5325
5287
            branch.tags.delete_tag(tag_name)
5326
5288
            self.outf.write('Deleted tag %s.\n' % tag_name)
5327
5289
        else:
5333
5295
                revision_id = revision[0].as_revision_id(branch)
5334
5296
            else:
5335
5297
                revision_id = branch.last_revision()
5336
 
            if tag_name is None:
5337
 
                tag_name = branch.automatic_tag_name(revision_id)
5338
 
                if tag_name is None:
5339
 
                    raise errors.BzrCommandError(
5340
 
                        "Please specify a tag name.")
5341
5298
            if (not force) and branch.tags.has_tag(tag_name):
5342
5299
                raise errors.TagAlreadyExists(tag_name)
5343
5300
            branch.tags.set_tag(tag_name, revision_id)
5345
5302
 
5346
5303
 
5347
5304
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5305
    """List tags.
5349
5306
 
5350
5307
    This command shows a table of tag names and the revisions they reference.
5351
5308
    """
5352
5309
 
5353
5310
    _see_also = ['tag']
5354
5311
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5312
        Option('directory',
 
5313
            help='Branch whose tags should be displayed.',
 
5314
            short_name='d',
 
5315
            type=unicode,
 
5316
            ),
5357
5317
        RegistryOption.from_kwargs('sort',
5358
5318
            'Sort tags by different criteria.', title='Sorting',
5359
5319
            alpha='Sort tags lexicographically (default).',
5376
5336
        if not tags:
5377
5337
            return
5378
5338
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5339
        branch.lock_read()
 
5340
        self.add_cleanup(branch.unlock)
5380
5341
        if revision:
5381
5342
            graph = branch.repository.get_graph()
5382
5343
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5376
 
5416
5377
 
5417
5378
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5379
    """Reconfigure the type of a bzr directory.
5419
5380
 
5420
5381
    A target configuration must be specified.
5421
5382
 
5506
5467
 
5507
5468
 
5508
5469
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5470
    """Set the branch of a checkout and update.
5510
5471
 
5511
5472
    For lightweight checkouts, this changes the branch being referenced.
5512
5473
    For heavyweight checkouts, this checks that there are no local commits
5602
5563
 
5603
5564
 
5604
5565
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5566
    """Manage filtered views.
5606
5567
 
5607
5568
    Views provide a mask over the tree so that users can focus on
5608
5569
    a subset of a tree when doing their work. After creating a view,
5756
5717
 
5757
5718
 
5758
5719
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5720
    """Show hooks."""
5760
5721
 
5761
5722
    hidden = True
5762
5723
 
5775
5736
                    self.outf.write("    <no hooks installed>\n")
5776
5737
 
5777
5738
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5739
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5740
    """Temporarily set aside some changes from the current tree.
5805
5741
 
5806
5742
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5743
    ie. out of the way, until a later time when you can bring them back from
5860
5796
 
5861
5797
    def run_for_list(self):
5862
5798
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5799
        tree.lock_read()
 
5800
        self.add_cleanup(tree.unlock)
5864
5801
        manager = tree.get_shelf_manager()
5865
5802
        shelves = manager.active_shelves()
5866
5803
        if len(shelves) == 0:
5875
5812
 
5876
5813
 
5877
5814
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5815
    """Restore shelved changes.
5879
5816
 
5880
5817
    By default, the most recently shelved changes are restored. However if you
5881
5818
    specify a shelf by id those changes will be restored instead.  This works
5907
5844
 
5908
5845
 
5909
5846
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5847
    """Remove unwanted files from working tree.
5911
5848
 
5912
5849
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5850
    files are never deleted.
5921
5858
 
5922
5859
    To check what clean-tree will do, use --dry-run.
5923
5860
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5861
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5862
                     Option('detritus', help='Delete conflict files, merge'
5927
5863
                            ' backups, and failed selftest dirs.'),
5928
5864
                     Option('unknown',
5931
5867
                            ' deleting them.'),
5932
5868
                     Option('force', help='Do not prompt before deleting.')]
5933
5869
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5870
            force=False):
5935
5871
        from bzrlib.clean_tree import clean_tree
5936
5872
        if not (unknown or ignored or detritus):
5937
5873
            unknown = True
5938
5874
        if dry_run:
5939
5875
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5876
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5877
                   dry_run=dry_run, no_prompt=force)
5942
5878
 
5943
5879
 
5944
5880
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5881
    """list, view and set branch locations for nested trees.
5946
5882
 
5947
5883
    If no arguments are provided, lists the branch locations for nested trees.
5948
5884
    If one argument is provided, display the branch location for that tree.
5988
5924
            self.outf.write('%s %s\n' % (path, location))
5989
5925
 
5990
5926
 
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)
 
5927
# these get imported and then picked up by the scan for cmd_*
 
5928
# TODO: Some more consistent way to split command definitions across files;
 
5929
# we do need to load at least some information about them to know of
 
5930
# aliases.  ideally we would avoid loading the implementation until the
 
5931
# details were needed.
 
5932
from bzrlib.cmd_version_info import cmd_version_info
 
5933
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5934
from bzrlib.bundle.commands import (
 
5935
    cmd_bundle_info,
 
5936
    )
 
5937
from bzrlib.foreign import cmd_dpush
 
5938
from bzrlib.sign_my_commits import cmd_sign_my_commits