/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-02-23 02:32:52 UTC
  • mto: This revision was merged to the branch mainline in revision 5054.
  • Revision ID: mbp@sourcefrog.net-20100223023252-zk4ds0sbeuga82et
Clarify Launchpad setup example

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
 
355
 
    def print_revision(self, revisions, revid):
356
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
357
 
        record = stream.next()
358
 
        if record.storage_kind == 'absent':
359
 
            raise errors.NoSuchRevision(revisions, revid)
360
 
        revtext = record.get_bytes_as('fulltext')
361
 
        self.outf.write(revtext.decode('utf-8'))
362
 
 
363
343
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
344
    def run(self, revision_id=None, revision=None):
365
345
        if revision_id is not None and revision is not None:
366
346
            raise errors.BzrCommandError('You can only supply one of'
367
347
                                         ' revision_id or --revision')
368
348
        if revision_id is None and revision is None:
369
349
            raise errors.BzrCommandError('You must supply either'
370
350
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
372
 
 
373
 
        revisions = b.repository.revisions
374
 
        if revisions is None:
375
 
            raise errors.BzrCommandError('Repository %r does not support '
376
 
                'access to raw revision texts')
377
 
 
378
 
        b.repository.lock_read()
379
 
        try:
380
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
381
 
            if revision_id is not None:
382
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
383
 
                try:
384
 
                    self.print_revision(revisions, revision_id)
385
 
                except errors.NoSuchRevision:
386
 
                    msg = "The repository %s contains no revision %s." % (
387
 
                        b.repository.base, revision_id)
388
 
                    raise errors.BzrCommandError(msg)
389
 
            elif revision is not None:
390
 
                for rev in revision:
391
 
                    if rev is None:
392
 
                        raise errors.BzrCommandError(
393
 
                            'You cannot specify a NULL revision.')
394
 
                    rev_id = rev.as_revision_id(b)
395
 
                    self.print_revision(revisions, rev_id)
396
 
        finally:
397
 
            b.repository.unlock()
398
 
        
 
351
        b = WorkingTree.open_containing(u'.')[0].branch
 
352
 
 
353
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
354
        if revision_id is not None:
 
355
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
356
            try:
 
357
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
358
            except errors.NoSuchRevision:
 
359
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
360
                    revision_id)
 
361
                raise errors.BzrCommandError(msg)
 
362
        elif revision is not None:
 
363
            for rev in revision:
 
364
                if rev is None:
 
365
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
366
                                                 ' revision.')
 
367
                rev_id = rev.as_revision_id(b)
 
368
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
369
 
399
370
 
400
371
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
372
    """Dump the contents of a btree index file to stdout.
402
373
 
403
374
    PATH is a btree index file, it can be any URL. This includes things like
404
375
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
468
439
        for node in bt.iter_all_entries():
469
440
            # Node is made up of:
470
441
            # (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)
 
442
            refs_as_tuples = static_tuple.as_tuples(node[3])
477
443
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
444
            self.outf.write('%s\n' % (as_tuple,))
479
445
 
480
446
 
481
447
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
448
    """Remove the working tree from a given branch/checkout.
483
449
 
484
450
    Since a lightweight checkout is little more than a working tree
485
451
    this will refuse to run against one.
512
478
                if (working.has_changes()):
513
479
                    raise errors.UncommittedChanges(working)
514
480
 
515
 
            if working.user_url != working.branch.user_url:
 
481
            working_path = working.bzrdir.root_transport.base
 
482
            branch_path = working.branch.bzrdir.root_transport.base
 
483
            if working_path != branch_path:
516
484
                raise errors.BzrCommandError("You cannot remove the working tree"
517
485
                                             " from a lightweight checkout")
518
486
 
520
488
 
521
489
 
522
490
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
491
    """Show current revision number.
524
492
 
525
493
    This is equal to the number of revisions on this branch.
526
494
    """
536
504
        if tree:
537
505
            try:
538
506
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
507
                wt.lock_read()
540
508
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
509
                raise errors.NoWorkingTree(location)
 
510
            self.add_cleanup(wt.unlock)
542
511
            revid = wt.last_revision()
543
512
            try:
544
513
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
516
            revno = ".".join(str(n) for n in revno_t)
548
517
        else:
549
518
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
519
            b.lock_read()
 
520
            self.add_cleanup(b.unlock)
551
521
            revno = b.revno()
552
522
        self.cleanup_now()
553
523
        self.outf.write(str(revno) + '\n')
554
524
 
555
525
 
556
526
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
527
    """Show revision number and revision id for a given revision identifier.
558
528
    """
559
529
    hidden = True
560
530
    takes_args = ['revision_info*']
561
531
    takes_options = [
562
532
        'revision',
563
 
        custom_help('directory',
 
533
        Option('directory',
564
534
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
 
535
                 'rather than the one containing the working directory.',
 
536
            short_name='d',
 
537
            type=unicode,
 
538
            ),
566
539
        Option('tree', help='Show revno of working tree'),
567
540
        ]
568
541
 
573
546
        try:
574
547
            wt = WorkingTree.open_containing(directory)[0]
575
548
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
549
            wt.lock_read()
 
550
            self.add_cleanup(wt.unlock)
577
551
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
552
            wt = None
579
553
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
554
            b.lock_read()
 
555
            self.add_cleanup(b.unlock)
581
556
        revision_ids = []
582
557
        if revision is not None:
583
558
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
586
 
612
587
 
613
588
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
589
    """Add specified files or directories.
615
590
 
616
591
    In non-recursive mode, all the named items are added, regardless
617
592
    of whether they were previously ignored.  A warning is given if
682
657
                should_print=(not is_quiet()))
683
658
 
684
659
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
660
            base_tree.lock_read()
 
661
            self.add_cleanup(base_tree.unlock)
686
662
        tree, file_list = tree_files_for_add(file_list)
687
663
        added, ignored = tree.smart_add(file_list, not
688
664
            no_recurse, action=action, save=not dry_run)
696
672
 
697
673
 
698
674
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
675
    """Create a new versioned directory.
700
676
 
701
677
    This is equivalent to creating the directory and then adding it.
702
678
    """
706
682
 
707
683
    def run(self, dir_list):
708
684
        for d in dir_list:
 
685
            os.mkdir(d)
709
686
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
687
            wt.add([dd])
 
688
            self.outf.write('added %s\n' % d)
718
689
 
719
690
 
720
691
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
692
    """Show path of a file relative to root"""
722
693
 
723
694
    takes_args = ['filename']
724
695
    hidden = True
733
704
 
734
705
 
735
706
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
707
    """Show inventory of the current working copy or a revision.
737
708
 
738
709
    It is possible to limit the output to a particular entry
739
710
    type using the --kind option.  For example: --kind file.
760
731
 
761
732
        revision = _get_one_revision('inventory', revision)
762
733
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
734
        work_tree.lock_read()
 
735
        self.add_cleanup(work_tree.unlock)
764
736
        if revision is not None:
765
737
            tree = revision.as_tree(work_tree.branch)
766
738
 
767
739
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
740
            tree.lock_read()
 
741
            self.add_cleanup(tree.unlock)
769
742
        else:
770
743
            tree = work_tree
771
744
            extra_trees = []
792
765
 
793
766
 
794
767
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
768
    """Move or rename a file.
796
769
 
797
770
    :Usage:
798
771
        bzr mv OLDNAME NEWNAME
831
804
        if len(names_list) < 2:
832
805
            raise errors.BzrCommandError("missing file argument")
833
806
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
807
        tree.lock_tree_write()
 
808
        self.add_cleanup(tree.unlock)
835
809
        self._run(tree, names_list, rel_names, after)
836
810
 
837
811
    def run_auto(self, names_list, after, dry_run):
842
816
            raise errors.BzrCommandError('--after cannot be specified with'
843
817
                                         ' --auto.')
844
818
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
819
        work_tree.lock_tree_write()
 
820
        self.add_cleanup(work_tree.unlock)
846
821
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
822
 
848
823
    def _run(self, tree, names_list, rel_names, after):
927
902
 
928
903
 
929
904
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
905
    """Turn this branch into a mirror of another branch.
931
906
 
932
907
    By default, this command only works on branches that have not diverged.
933
908
    Branches are considered diverged if the destination branch's most recent 
956
931
    takes_options = ['remember', 'overwrite', 'revision',
957
932
        custom_help('verbose',
958
933
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
934
        Option('directory',
960
935
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
936
                 'rather than the one containing the working directory.',
 
937
            short_name='d',
 
938
            type=unicode,
 
939
            ),
962
940
        Option('local',
963
941
            help="Perform a local pull in a bound "
964
942
                 "branch.  Local pulls are not applied to "
979
957
        try:
980
958
            tree_to = WorkingTree.open_containing(directory)[0]
981
959
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
960
        except errors.NoWorkingTree:
984
961
            tree_to = None
985
962
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
963
        
988
964
        if local and not branch_to.get_bound_location():
989
965
            raise errors.LocalRequiresBoundBranch()
990
966
 
1020
996
        else:
1021
997
            branch_from = Branch.open(location,
1022
998
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
999
 
1025
1000
            if branch_to.get_parent() is None or remember:
1026
1001
                branch_to.set_parent(branch_from.base)
1027
1002
 
 
1003
        if branch_from is not branch_to:
 
1004
            branch_from.lock_read()
 
1005
            self.add_cleanup(branch_from.unlock)
1028
1006
        if revision is not None:
1029
1007
            revision_id = revision.as_revision_id(branch_from)
1030
1008
 
 
1009
        branch_to.lock_write()
 
1010
        self.add_cleanup(branch_to.unlock)
1031
1011
        if tree_to is not None:
1032
1012
            view_info = _get_view_info_for_change_reporter(tree_to)
1033
1013
            change_reporter = delta._ChangeReporter(
1048
1028
 
1049
1029
 
1050
1030
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1031
    """Update a mirror of this branch.
1052
1032
 
1053
1033
    The target branch will not have its working tree populated because this
1054
1034
    is both expensive, and is not supported on remote file systems.
1078
1058
        Option('create-prefix',
1079
1059
               help='Create the path leading up to the branch '
1080
1060
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1061
        Option('directory',
1082
1062
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1063
                 'rather than the one containing the working directory.',
 
1064
            short_name='d',
 
1065
            type=unicode,
 
1066
            ),
1084
1067
        Option('use-existing-dir',
1085
1068
               help='By default push will fail if the target'
1086
1069
                    ' directory exists, but does not already'
1112
1095
        # Get the source branch
1113
1096
        (tree, br_from,
1114
1097
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1098
        if strict is None:
 
1099
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1100
        if strict is None: strict = True # default value
1115
1101
        # Get the tip's revision_id
1116
1102
        revision = _get_one_revision('push', revision)
1117
1103
        if revision is not None:
1118
1104
            revision_id = revision.in_history(br_from).rev_id
1119
1105
        else:
1120
1106
            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.')
 
1107
        if strict and tree is not None and revision_id is None:
 
1108
            if (tree.has_changes()):
 
1109
                raise errors.UncommittedChanges(
 
1110
                    tree, more='Use --no-strict to force the push.')
 
1111
            if tree.last_revision() != tree.branch.last_revision():
 
1112
                # The tree has lost sync with its branch, there is little
 
1113
                # chance that the user is aware of it but he can still force
 
1114
                # the push with --no-strict
 
1115
                raise errors.OutOfDateTree(
 
1116
                    tree, more='Use --no-strict to force the push.')
 
1117
 
1126
1118
        # Get the stacked_on branch, if any
1127
1119
        if stacked_on is not None:
1128
1120
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1152
 
1161
1153
 
1162
1154
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1155
    """Create a new branch that is a copy of an existing branch.
1164
1156
 
1165
1157
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1158
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1198
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1199
            from_location)
1208
1200
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1201
        br_from.lock_read()
 
1202
        self.add_cleanup(br_from.unlock)
1210
1203
        if revision is not None:
1211
1204
            revision_id = revision.as_revision_id(br_from)
1212
1205
        else:
1272
1265
 
1273
1266
 
1274
1267
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1268
    """Create a new checkout of an existing branch.
1276
1269
 
1277
1270
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1271
    the branch found in '.'. This is useful if you have removed the working tree
1336
1329
            except errors.NoWorkingTree:
1337
1330
                source.bzrdir.create_workingtree(revision_id)
1338
1331
                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
1332
        source.create_checkout(to_location, revision_id, lightweight,
1345
1333
                               accelerator_tree, hardlink)
1346
1334
 
1347
1335
 
1348
1336
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1337
    """Show list of renamed files.
1350
1338
    """
1351
1339
    # TODO: Option to show renames between two historical versions.
1352
1340
 
1357
1345
    @display_command
1358
1346
    def run(self, dir=u'.'):
1359
1347
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1348
        tree.lock_read()
 
1349
        self.add_cleanup(tree.unlock)
1361
1350
        new_inv = tree.inventory
1362
1351
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1352
        old_tree.lock_read()
 
1353
        self.add_cleanup(old_tree.unlock)
1364
1354
        old_inv = old_tree.inventory
1365
1355
        renames = []
1366
1356
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1366
 
1377
1367
 
1378
1368
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1369
    """Update a tree to have the latest code committed to its branch.
1380
1370
 
1381
1371
    This will perform a merge into the working tree, and may generate
1382
1372
    conflicts. If you have any local changes, you will still
1404
1394
        master = branch.get_master_branch(
1405
1395
            possible_transports=possible_transports)
1406
1396
        if master is not None:
 
1397
            tree.lock_write()
1407
1398
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1399
        else:
 
1400
            tree.lock_tree_write()
1410
1401
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1402
        self.add_cleanup(tree.unlock)
1413
1403
        # 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)
 
1404
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1405
                                                        self.outf.encoding)
1417
1406
        existing_pending_merges = tree.get_parent_ids()[1:]
1418
1407
        if master is None:
1419
1408
            old_tip = None
1427
1416
        else:
1428
1417
            revision_id = branch.last_revision()
1429
1418
        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))
 
1419
            revno = branch.revision_id_to_revno(revision_id)
 
1420
            note("Tree is up to date at revision %d of branch %s" %
 
1421
                (revno, branch_location))
1433
1422
            return 0
1434
1423
        view_info = _get_view_info_for_change_reporter(tree)
1435
1424
        change_reporter = delta._ChangeReporter(
1447
1436
                                  "bzr update --revision only works"
1448
1437
                                  " for a revision in the branch history"
1449
1438
                                  % (e.revision))
1450
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1439
        revno = tree.branch.revision_id_to_revno(
1451
1440
            _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:
 
1441
        note('Updated to revision %d of branch %s' %
 
1442
             (revno, branch_location))
 
1443
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1456
1444
            note('Your local commits will now show as pending merges with '
1457
1445
                 "'bzr status', and can be committed with 'bzr commit'.")
1458
1446
        if conflicts != 0:
1462
1450
 
1463
1451
 
1464
1452
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1453
    """Show information about a working tree, branch or repository.
1466
1454
 
1467
1455
    This command will show all known locations and formats associated to the
1468
1456
    tree, branch or repository.
1506
1494
 
1507
1495
 
1508
1496
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1497
    """Remove files or directories.
1510
1498
 
1511
1499
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1500
    them if they can easily be recovered using revert. If no options or
1534
1522
        if file_list is not None:
1535
1523
            file_list = [f for f in file_list]
1536
1524
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1525
        tree.lock_write()
 
1526
        self.add_cleanup(tree.unlock)
1538
1527
        # Heuristics should probably all move into tree.remove_smart or
1539
1528
        # some such?
1540
1529
        if new:
1559
1548
 
1560
1549
 
1561
1550
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1551
    """Print file_id of a particular file or directory.
1563
1552
 
1564
1553
    The file_id is assigned when the file is first added and remains the
1565
1554
    same through all revisions where the file exists, even when it is
1581
1570
 
1582
1571
 
1583
1572
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1573
    """Print path of file_ids to a file or directory.
1585
1574
 
1586
1575
    This prints one line for each directory down to the target,
1587
1576
    starting at the branch root.
1603
1592
 
1604
1593
 
1605
1594
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1595
    """Reconcile bzr metadata in a branch.
1607
1596
 
1608
1597
    This can correct data mismatches that may have been caused by
1609
1598
    previous ghost operations or bzr upgrades. You should only
1631
1620
 
1632
1621
 
1633
1622
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1623
    """Display the list of revision ids on a branch."""
1635
1624
 
1636
1625
    _see_also = ['log']
1637
1626
    takes_args = ['location?']
1647
1636
 
1648
1637
 
1649
1638
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1639
    """List all revisions merged into this branch."""
1651
1640
 
1652
1641
    _see_also = ['log', 'revision-history']
1653
1642
    takes_args = ['location?']
1672
1661
 
1673
1662
 
1674
1663
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1664
    """Make a directory into a versioned branch.
1676
1665
 
1677
1666
    Use this to create an empty branch, or before importing an
1678
1667
    existing project.
1781
1770
 
1782
1771
 
1783
1772
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1773
    """Create a shared repository for branches to share storage space.
1785
1774
 
1786
1775
    New branches created under the repository directory will store their
1787
1776
    revisions in the repository, not in the branch directory.  For branches
1841
1830
 
1842
1831
 
1843
1832
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1833
    """Show differences in the working tree, between revisions or branches.
1845
1834
 
1846
1835
    If no arguments are given, all changes for the current tree are listed.
1847
1836
    If files are given, only the changes in those files are listed.
1933
1922
            help='Use this command to compare files.',
1934
1923
            type=unicode,
1935
1924
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1925
        ]
1941
1926
    aliases = ['di', 'dif']
1942
1927
    encoding_type = 'exact'
1943
1928
 
1944
1929
    @display_command
1945
1930
    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)
 
1931
            prefix=None, old=None, new=None, using=None):
 
1932
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1949
1933
 
1950
1934
        if (prefix is None) or (prefix == '0'):
1951
1935
            # diff -p0 format
1965
1949
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1950
                                         ' one or two revision specifiers')
1967
1951
 
1968
 
        if using is not None and format is not None:
1969
 
            raise errors.BzrCommandError('--using and --format are mutually '
1970
 
                'exclusive.')
1971
 
 
1972
1952
        (old_tree, new_tree,
1973
1953
         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)
 
1954
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1955
            file_list, revision, old, new, apply_view=True)
1976
1956
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1957
                               specific_files=specific_files,
1978
1958
                               external_diff_options=diff_options,
1979
1959
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1960
                               extra_trees=extra_trees, using=using)
1982
1961
 
1983
1962
 
1984
1963
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1964
    """List files deleted in the working tree.
1986
1965
    """
1987
1966
    # TODO: Show files deleted since a previous revision, or
1988
1967
    # between two revisions.
1991
1970
    # level of effort but possibly much less IO.  (Or possibly not,
1992
1971
    # if the directories are very large...)
1993
1972
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
1973
    takes_options = ['show-ids']
1995
1974
 
1996
1975
    @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)
 
1976
    def run(self, show_ids=False):
 
1977
        tree = WorkingTree.open_containing(u'.')[0]
 
1978
        tree.lock_read()
 
1979
        self.add_cleanup(tree.unlock)
2000
1980
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
1981
        old.lock_read()
 
1982
        self.add_cleanup(old.unlock)
2002
1983
        for path, ie in old.inventory.iter_entries():
2003
1984
            if not tree.has_id(ie.file_id):
2004
1985
                self.outf.write(path)
2009
1990
 
2010
1991
 
2011
1992
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
1993
    """List files modified in working tree.
2013
1994
    """
2014
1995
 
2015
1996
    hidden = True
2016
1997
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
1998
    takes_options = [
 
1999
            Option('null',
 
2000
                   help='Write an ascii NUL (\\0) separator '
 
2001
                   'between files rather than a newline.')
 
2002
            ]
2018
2003
 
2019
2004
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2005
    def run(self, null=False):
 
2006
        tree = WorkingTree.open_containing(u'.')[0]
2022
2007
        td = tree.changes_from(tree.basis_tree())
2023
2008
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2009
            if null:
2028
2013
 
2029
2014
 
2030
2015
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2016
    """List files added in working tree.
2032
2017
    """
2033
2018
 
2034
2019
    hidden = True
2035
2020
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2021
    takes_options = [
 
2022
            Option('null',
 
2023
                   help='Write an ascii NUL (\\0) separator '
 
2024
                   'between files rather than a newline.')
 
2025
            ]
2037
2026
 
2038
2027
    @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)
 
2028
    def run(self, null=False):
 
2029
        wt = WorkingTree.open_containing(u'.')[0]
 
2030
        wt.lock_read()
 
2031
        self.add_cleanup(wt.unlock)
2042
2032
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2033
        basis.lock_read()
 
2034
        self.add_cleanup(basis.unlock)
2044
2035
        basis_inv = basis.inventory
2045
2036
        inv = wt.inventory
2046
2037
        for file_id in inv:
2049
2040
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2041
                continue
2051
2042
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2043
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2044
                continue
2054
2045
            if null:
2055
2046
                self.outf.write(path + '\0')
2058
2049
 
2059
2050
 
2060
2051
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2052
    """Show the tree root directory.
2062
2053
 
2063
2054
    The root is the nearest enclosing directory with a .bzr control
2064
2055
    directory."""
2088
2079
 
2089
2080
 
2090
2081
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2082
    """Show historical log for a branch or subset of a branch.
2092
2083
 
2093
2084
    log is bzr's default tool for exploring the history of a branch.
2094
2085
    The branch to use is taken from the first parameter. If no parameters
2255
2246
                   help='Show just the specified revision.'
2256
2247
                   ' See also "help revisionspec".'),
2257
2248
            '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
2249
            Option('levels',
2264
2250
                   short_name='n',
2265
2251
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2266
                   help='Show changes made in each revision as a patch.'),
2281
2267
            Option('include-merges',
2282
2268
                   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
2269
            ]
2288
2270
    encoding_type = 'replace'
2289
2271
 
2299
2281
            message=None,
2300
2282
            limit=None,
2301
2283
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2284
            include_merges=False):
2306
2285
        from bzrlib.log import (
2307
2286
            Logger,
2308
2287
            make_log_request_dict,
2309
2288
            _get_info_for_log_files,
2310
2289
            )
2311
2290
        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
2291
        if include_merges:
2317
2292
            if levels is None:
2318
2293
                levels = 0
2334
2309
        if file_list:
2335
2310
            # find the file ids to log and check for directory filtering
2336
2311
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2312
                revision, file_list)
 
2313
            self.add_cleanup(b.unlock)
2338
2314
            for relpath, file_id, kind in file_info_list:
2339
2315
                if file_id is None:
2340
2316
                    raise errors.BzrCommandError(
2358
2334
                location = '.'
2359
2335
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2336
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2337
            b.lock_read()
 
2338
            self.add_cleanup(b.unlock)
2362
2339
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2340
 
2364
2341
        # Decide on the type of delta & diff filtering to use
2384
2361
                        show_timezone=timezone,
2385
2362
                        delta_format=get_verbosity_level(),
2386
2363
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2364
                        show_advice=levels is None)
2389
2365
 
2390
2366
        # Choose the algorithm for doing the logging. It's annoying
2391
2367
        # having multiple code paths like this but necessary until
2410
2386
            direction=direction, specific_fileids=file_ids,
2411
2387
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2388
            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
 
            )
 
2389
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2390
        Logger(b, rqst).show(lf)
2417
2391
 
2418
2392
 
2437
2411
            raise errors.BzrCommandError(
2438
2412
                "bzr %s doesn't accept two revisions in different"
2439
2413
                " 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)
 
2414
        rev1 = start_spec.in_history(branch)
2445
2415
        # Avoid loading all of history when we know a missing
2446
2416
        # end of range means the last revision ...
2447
2417
        if end_spec.spec is None:
2476
2446
 
2477
2447
 
2478
2448
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2449
    """Return revision-ids which affected a particular file.
2480
2450
 
2481
2451
    A more user-friendly interface is "bzr log FILE".
2482
2452
    """
2489
2459
        tree, relpath = WorkingTree.open_containing(filename)
2490
2460
        file_id = tree.path2id(relpath)
2491
2461
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2462
        b.lock_read()
 
2463
        self.add_cleanup(b.unlock)
2493
2464
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2465
        for revno, revision_id, what in touching_revs:
2495
2466
            self.outf.write("%6d %s\n" % (revno, what))
2496
2467
 
2497
2468
 
2498
2469
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2470
    """List files in a tree.
2500
2471
    """
2501
2472
 
2502
2473
    _see_also = ['status', 'cat']
2508
2479
                   help='Recurse into subdirectories.'),
2509
2480
            Option('from-root',
2510
2481
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2482
            Option('unknown', help='Print unknown files.'),
2513
2483
            Option('versioned', help='Print versioned files.',
2514
2484
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2485
            Option('ignored', help='Print ignored files.'),
 
2486
            Option('null',
 
2487
                   help='Write an ascii NUL (\\0) separator '
 
2488
                   'between files rather than a newline.'),
 
2489
            Option('kind',
2518
2490
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2491
                   type=unicode),
2520
 
            'null',
2521
2492
            'show-ids',
2522
 
            'directory',
2523
2493
            ]
2524
2494
    @display_command
2525
2495
    def run(self, revision=None, verbose=False,
2526
2496
            recursive=False, from_root=False,
2527
2497
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2498
            null=False, kind=None, show_ids=False, path=None):
2529
2499
 
2530
2500
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2501
            raise errors.BzrCommandError('invalid kind specified')
2543
2513
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2514
                                             ' and PATH')
2545
2515
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2516
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2517
            fs_path)
2548
2518
 
2549
2519
        # Calculate the prefix to use
2550
2520
        prefix = None
2565
2535
                view_str = views.view_display_str(view_files)
2566
2536
                note("Ignoring files outside view. View is %s" % view_str)
2567
2537
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2538
        tree.lock_read()
 
2539
        self.add_cleanup(tree.unlock)
2569
2540
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2541
            from_dir=relpath, recursive=recursive):
2571
2542
            # Apply additional masking
2613
2584
 
2614
2585
 
2615
2586
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2587
    """List unknown files.
2617
2588
    """
2618
2589
 
2619
2590
    hidden = True
2620
2591
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2592
 
2623
2593
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2594
    def run(self):
 
2595
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2596
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2597
 
2628
2598
 
2629
2599
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2600
    """Ignore specified files or patterns.
2631
2601
 
2632
2602
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2603
 
2642
2612
    using this command or directly by using an editor, be sure to commit
2643
2613
    it.
2644
2614
    
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
2615
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
2616
    precedence over regular ignores.  Such exceptions are used to specify
2653
2617
    files that should be versioned which would otherwise be ignored.
2693
2657
 
2694
2658
    _see_also = ['status', 'ignored', 'patterns']
2695
2659
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2660
    takes_options = [
 
2661
        Option('old-default-rules',
 
2662
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2663
        ]
2700
2664
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2665
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2666
        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:
2707
 
                self.outf.write("%s\n" % pattern)
 
2667
        if old_default_rules is not None:
 
2668
            # dump the rules and exit
 
2669
            for pattern in ignores.OLD_DEFAULTS:
 
2670
                print pattern
2708
2671
            return
2709
2672
        if not name_pattern_list:
2710
2673
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2674
                                  "NAME_PATTERN or --old-default-rules")
2712
2675
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2676
                             for p in name_pattern_list]
2714
2677
        for name_pattern in name_pattern_list:
2716
2679
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2680
                raise errors.BzrCommandError(
2718
2681
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2682
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2683
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2684
        ignored = globbing.Globster(name_pattern_list)
2722
2685
        matches = []
2726
2689
            if id is not None:
2727
2690
                filename = entry[0]
2728
2691
                if ignored.match(filename):
2729
 
                    matches.append(filename)
 
2692
                    matches.append(filename.encode('utf-8'))
2730
2693
        tree.unlock()
2731
2694
        if len(matches) > 0:
2732
 
            self.outf.write("Warning: the following files are version controlled and"
2733
 
                  " match your ignore pattern:\n%s"
2734
 
                  "\nThese files will continue to be version controlled"
2735
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2695
            print "Warning: the following files are version controlled and" \
 
2696
                  " match your ignore pattern:\n%s" \
 
2697
                  "\nThese files will continue to be version controlled" \
 
2698
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2736
2699
 
2737
2700
 
2738
2701
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2702
    """List ignored files and the patterns that matched them.
2740
2703
 
2741
2704
    List all the ignored files and the ignore pattern that caused the file to
2742
2705
    be ignored.
2748
2711
 
2749
2712
    encoding_type = 'replace'
2750
2713
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2714
 
2753
2715
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2716
    def run(self):
 
2717
        tree = WorkingTree.open_containing(u'.')[0]
 
2718
        tree.lock_read()
 
2719
        self.add_cleanup(tree.unlock)
2757
2720
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2721
            if file_class != 'I':
2759
2722
                continue
2763
2726
 
2764
2727
 
2765
2728
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2729
    """Lookup the revision-id from a revision-number
2767
2730
 
2768
2731
    :Examples:
2769
2732
        bzr lookup-revision 33
2770
2733
    """
2771
2734
    hidden = True
2772
2735
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2736
 
2775
2737
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2738
    def run(self, revno):
2777
2739
        try:
2778
2740
            revno = int(revno)
2779
2741
        except ValueError:
2780
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2781
 
                                         % revno)
2782
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2783
 
        self.outf.write("%s\n" % revid)
 
2742
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2743
 
 
2744
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2784
2745
 
2785
2746
 
2786
2747
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2748
    """Export current or past revision to a destination directory or archive.
2788
2749
 
2789
2750
    If no revision is specified this exports the last committed revision.
2790
2751
 
2812
2773
      =================       =========================
2813
2774
    """
2814
2775
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2776
    takes_options = [
2816
2777
        Option('format',
2817
2778
               help="Type of file to export to.",
2818
2779
               type=unicode),
2822
2783
        Option('root',
2823
2784
               type=str,
2824
2785
               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
2786
        ]
2829
2787
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2788
        root=None, filters=False):
2831
2789
        from bzrlib.export import export
2832
2790
 
2833
2791
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2792
            tree = WorkingTree.open_containing(u'.')[0]
2835
2793
            b = tree.branch
2836
2794
            subdir = None
2837
2795
        else:
2840
2798
 
2841
2799
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2842
2800
        try:
2843
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2844
 
                   per_file_timestamps=per_file_timestamps)
 
2801
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2845
2802
        except errors.NoSuchExportFormat, e:
2846
2803
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2847
2804
 
2848
2805
 
2849
2806
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2807
    """Write the contents of a file as of a given revision to standard output.
2851
2808
 
2852
2809
    If no revision is nominated, the last revision is used.
2853
2810
 
2856
2813
    """
2857
2814
 
2858
2815
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2816
    takes_options = [
2860
2817
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2818
        Option('filters', help='Apply content filters to display the '
2862
2819
                'convenience form.'),
2867
2824
 
2868
2825
    @display_command
2869
2826
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2827
            filters=False):
2871
2828
        if revision is not None and len(revision) != 1:
2872
2829
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2830
                                         " one revision specifier")
2874
2831
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2832
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2833
        branch.lock_read()
 
2834
        self.add_cleanup(branch.unlock)
2877
2835
        return self._run(tree, branch, relpath, filename, revision,
2878
2836
                         name_from_revision, filters)
2879
2837
 
2882
2840
        if tree is None:
2883
2841
            tree = b.basis_tree()
2884
2842
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2843
        rev_tree.lock_read()
 
2844
        self.add_cleanup(rev_tree.unlock)
2886
2845
 
2887
2846
        old_file_id = rev_tree.path2id(relpath)
2888
2847
 
2931
2890
 
2932
2891
 
2933
2892
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2893
    """Show the offset in seconds from GMT to local time."""
2935
2894
    hidden = True
2936
2895
    @display_command
2937
2896
    def run(self):
2938
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2897
        print osutils.local_time_offset()
2939
2898
 
2940
2899
 
2941
2900
 
2942
2901
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2902
    """Commit changes into a new revision.
2944
2903
 
2945
2904
    An explanatory message needs to be given for each commit. This is
2946
2905
    often done by using the --message option (getting the message from the
3054
3013
                         "the master branch until a normal commit "
3055
3014
                         "is performed."
3056
3015
                    ),
3057
 
             Option('show-diff', short_name='p',
 
3016
             Option('show-diff',
3058
3017
                    help='When no message is supplied, show the diff along'
3059
3018
                    ' with the status summary in the message editor.'),
3060
3019
             ]
3140
3099
                    '(use --file "%(f)s" to take commit message from that file)'
3141
3100
                    % { 'f': message })
3142
3101
                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
3102
 
3150
3103
        def get_message(commit_obj):
3151
3104
            """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,
 
3105
            my_message = message
 
3106
            if my_message is not None and '\r' in my_message:
 
3107
                my_message = my_message.replace('\r\n', '\n')
 
3108
                my_message = my_message.replace('\r', '\n')
 
3109
            if my_message is None and not file:
 
3110
                t = make_commit_message_template_encoded(tree,
3161
3111
                        selected_list, diff=show_diff,
3162
3112
                        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
3113
                start_message = generate_commit_message_template(commit_obj)
3169
 
                my_message = edit_commit_message_encoded(text,
 
3114
                my_message = edit_commit_message_encoded(t,
3170
3115
                    start_message=start_message)
3171
3116
                if my_message is None:
3172
3117
                    raise errors.BzrCommandError("please specify a commit"
3173
3118
                        " message with either --message or --file")
 
3119
            elif my_message and file:
 
3120
                raise errors.BzrCommandError(
 
3121
                    "please specify either --message or --file")
 
3122
            if file:
 
3123
                my_message = codecs.open(file, 'rt',
 
3124
                                         osutils.get_user_encoding()).read()
3174
3125
            if my_message == "":
3175
3126
                raise errors.BzrCommandError("empty commit message specified")
3176
3127
            return my_message
3188
3139
                        timezone=offset,
3189
3140
                        exclude=safe_relpath_files(tree, exclude))
3190
3141
        except PointlessCommit:
 
3142
            # FIXME: This should really happen before the file is read in;
 
3143
            # perhaps prepare the commit; get the message; then actually commit
3191
3144
            raise errors.BzrCommandError("No changes to commit."
3192
3145
                              " Use --unchanged to commit anyhow.")
3193
3146
        except ConflictsInTree:
3198
3151
            raise errors.BzrCommandError("Commit refused because there are"
3199
3152
                              " unknown files in the working tree.")
3200
3153
        except errors.BoundBranchOutOfDate, e:
3201
 
            e.extra_help = ("\n"
3202
 
                'To commit to master branch, run update and then commit.\n'
3203
 
                'You can also pass --local to commit to continue working '
3204
 
                'disconnected.')
3205
 
            raise
 
3154
            raise errors.BzrCommandError(str(e) + "\n"
 
3155
            'To commit to master branch, run update and then commit.\n'
 
3156
            'You can also pass --local to commit to continue working '
 
3157
            'disconnected.')
3206
3158
 
3207
3159
 
3208
3160
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3161
    """Validate working tree structure, branch consistency and repository history.
3210
3162
 
3211
3163
    This command checks various invariants about branch and repository storage
3212
3164
    to detect data corruption or bzr bugs.
3276
3228
 
3277
3229
 
3278
3230
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3231
    """Upgrade branch storage to current format.
3280
3232
 
3281
3233
    The check command or bzr developers may sometimes advise you to run
3282
3234
    this command. When the default format has changed you may also be warned
3300
3252
 
3301
3253
 
3302
3254
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3255
    """Show or set bzr user id.
3304
3256
 
3305
3257
    :Examples:
3306
3258
        Show the email of the current user::
3350
3302
 
3351
3303
 
3352
3304
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3305
    """Print or set the branch nickname.
3354
3306
 
3355
3307
    If unset, the tree root directory name is used as the nickname.
3356
3308
    To print the current nickname, execute with no argument.
3361
3313
 
3362
3314
    _see_also = ['info']
3363
3315
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3316
    def run(self, nickname=None):
 
3317
        branch = Branch.open_containing(u'.')[0]
3367
3318
        if nickname is None:
3368
3319
            self.printme(branch)
3369
3320
        else:
3371
3322
 
3372
3323
    @display_command
3373
3324
    def printme(self, branch):
3374
 
        self.outf.write('%s\n' % branch.nick)
 
3325
        print branch.nick
3375
3326
 
3376
3327
 
3377
3328
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3329
    """Set/unset and display aliases.
3379
3330
 
3380
3331
    :Examples:
3381
3332
        Show the current aliases::
3445
3396
 
3446
3397
 
3447
3398
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3399
    """Run internal test suite.
3449
3400
 
3450
3401
    If arguments are given, they are regular expressions that say which tests
3451
3402
    should run.  Tests matching any expression are run, and other tests are
3592
3543
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3544
                    "needs to be installed to use --subunit.")
3594
3545
            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
3546
        if parallel:
3601
3547
            self.additional_selftest_args.setdefault(
3602
3548
                'suite_decorators', []).append(parallel)
3633
3579
 
3634
3580
 
3635
3581
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3582
    """Show version of bzr."""
3637
3583
 
3638
3584
    encoding_type = 'replace'
3639
3585
    takes_options = [
3650
3596
 
3651
3597
 
3652
3598
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3599
    """Statement of optimism."""
3654
3600
 
3655
3601
    hidden = True
3656
3602
 
3657
3603
    @display_command
3658
3604
    def run(self):
3659
 
        self.outf.write("It sure does!\n")
 
3605
        print "It sure does!"
3660
3606
 
3661
3607
 
3662
3608
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3609
    """Find and print a base revision for merging two branches."""
3664
3610
    # TODO: Options to specify revisions on either side, as if
3665
3611
    #       merging only part of the history.
3666
3612
    takes_args = ['branch', 'other']
3672
3618
 
3673
3619
        branch1 = Branch.open_containing(branch)[0]
3674
3620
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3621
        branch1.lock_read()
 
3622
        self.add_cleanup(branch1.unlock)
 
3623
        branch2.lock_read()
 
3624
        self.add_cleanup(branch2.unlock)
3677
3625
        last1 = ensure_null(branch1.last_revision())
3678
3626
        last2 = ensure_null(branch2.last_revision())
3679
3627
 
3680
3628
        graph = branch1.repository.get_graph(branch2.repository)
3681
3629
        base_rev_id = graph.find_unique_lca(last1, last2)
3682
3630
 
3683
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3631
        print 'merge base is revision %s' % base_rev_id
3684
3632
 
3685
3633
 
3686
3634
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3635
    """Perform a three-way merge.
3688
3636
 
3689
3637
    The source of the merge can be specified either in the form of a branch,
3690
3638
    or in the form of a path to a file containing a merge directive generated
3773
3721
                ' completely merged into the source, pull from the'
3774
3722
                ' source rather than merging.  When this happens,'
3775
3723
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3724
        Option('directory',
3777
3725
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3726
                    'rather than the one containing the working directory.',
 
3727
               short_name='d',
 
3728
               type=unicode,
 
3729
               ),
3779
3730
        Option('preview', help='Instead of merging, show a diff of the'
3780
3731
               ' merge.'),
3781
3732
        Option('interactive', help='Select changes interactively.',
3814
3765
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3766
        pb = ui.ui_factory.nested_progress_bar()
3816
3767
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3768
        tree.lock_write()
 
3769
        self.add_cleanup(tree.unlock)
3818
3770
        if location is not None:
3819
3771
            try:
3820
3772
                mergeable = bundle.read_mergeable_from_url(location,
4041
3993
 
4042
3994
 
4043
3995
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
3996
    """Redo a merge.
4045
3997
 
4046
3998
    Use this if you want to try a different merge technique while resolving
4047
3999
    conflicts.  Some merge techniques are better than others, and remerge
4072
4024
 
4073
4025
    def run(self, file_list=None, merge_type=None, show_base=False,
4074
4026
            reprocess=False):
4075
 
        from bzrlib.conflicts import restore
4076
4027
        if merge_type is None:
4077
4028
            merge_type = _mod_merge.Merge3Merger
4078
4029
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
4030
        tree.lock_write()
 
4031
        self.add_cleanup(tree.unlock)
4080
4032
        parents = tree.get_parent_ids()
4081
4033
        if len(parents) != 2:
4082
4034
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4087
 
4136
4088
 
4137
4089
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4090
    """Revert files to a previous revision.
4139
4091
 
4140
4092
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4093
    will be reverted.  If the revision is not specified with '--revision', the
4192
4144
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4145
            forget_merges=None):
4194
4146
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4147
        tree.lock_write()
 
4148
        self.add_cleanup(tree.unlock)
4196
4149
        if forget_merges:
4197
4150
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4151
        else:
4206
4159
 
4207
4160
 
4208
4161
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4162
    """Test reporting of assertion failures"""
4210
4163
    # intended just for use in testing
4211
4164
 
4212
4165
    hidden = True
4216
4169
 
4217
4170
 
4218
4171
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4172
    """Show help on a command or other topic.
4220
4173
    """
4221
4174
 
4222
4175
    _see_also = ['topics']
4235
4188
 
4236
4189
 
4237
4190
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4191
    """Show appropriate completions for context.
4239
4192
 
4240
4193
    For a list of all available commands, say 'bzr shell-complete'.
4241
4194
    """
4250
4203
 
4251
4204
 
4252
4205
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4206
    """Show unmerged/unpulled revisions between two branches.
4254
4207
 
4255
4208
    OTHER_BRANCH may be local or remote.
4256
4209
 
4334
4287
            restrict = 'remote'
4335
4288
 
4336
4289
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4290
        parent = local_branch.get_parent()
4340
4291
        if other_branch is None:
4341
4292
            other_branch = parent
4350
4301
        remote_branch = Branch.open(other_branch)
4351
4302
        if remote_branch.base == local_branch.base:
4352
4303
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4304
 
 
4305
        local_branch.lock_read()
 
4306
        self.add_cleanup(local_branch.unlock)
4356
4307
        local_revid_range = _revision_range_to_revid_range(
4357
4308
            _get_revision_range(my_revision, local_branch,
4358
4309
                self.name()))
4359
4310
 
 
4311
        remote_branch.lock_read()
 
4312
        self.add_cleanup(remote_branch.unlock)
4360
4313
        remote_revid_range = _revision_range_to_revid_range(
4361
4314
            _get_revision_range(revision,
4362
4315
                remote_branch, self.name()))
4412
4365
            message("Branches are up to date.\n")
4413
4366
        self.cleanup_now()
4414
4367
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4368
            local_branch.lock_write()
 
4369
            self.add_cleanup(local_branch.unlock)
4416
4370
            # handle race conditions - a parent might be set while we run.
4417
4371
            if local_branch.get_parent() is None:
4418
4372
                local_branch.set_parent(remote_branch.base)
4420
4374
 
4421
4375
 
4422
4376
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
 
    """
 
4377
    """Compress the data within a repository."""
4440
4378
 
4441
4379
    _see_also = ['repositories']
4442
4380
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4381
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4382
    def run(self, branch_or_repo='.'):
4448
4383
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4384
        try:
4450
4385
            branch = dir.open_branch()
4451
4386
            repository = branch.repository
4452
4387
        except errors.NotBranchError:
4453
4388
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4389
        repository.pack()
4455
4390
 
4456
4391
 
4457
4392
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4393
    """List the installed plugins.
4459
4394
 
4460
4395
    This command displays the list of installed plugins including
4461
4396
    version of plugin and a short description of each.
4492
4427
                doc = '(no description)'
4493
4428
            result.append((name_ver, doc, plugin.path()))
4494
4429
        for name_ver, doc, path in sorted(result):
4495
 
            self.outf.write("%s\n" % name_ver)
4496
 
            self.outf.write("   %s\n" % doc)
 
4430
            print name_ver
 
4431
            print '   ', doc
4497
4432
            if verbose:
4498
 
                self.outf.write("   %s\n" % path)
4499
 
            self.outf.write("\n")
 
4433
                print '   ', path
 
4434
            print
4500
4435
 
4501
4436
 
4502
4437
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4438
    """Show testament (signing-form) of a revision."""
4504
4439
    takes_options = [
4505
4440
            'revision',
4506
4441
            Option('long', help='Produce long-format testament.'),
4518
4453
            b = Branch.open_containing(branch)[0]
4519
4454
        else:
4520
4455
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4456
        b.lock_read()
 
4457
        self.add_cleanup(b.unlock)
4522
4458
        if revision is None:
4523
4459
            rev_id = b.last_revision()
4524
4460
        else:
4531
4467
 
4532
4468
 
4533
4469
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4470
    """Show the origin of each line in a file.
4535
4471
 
4536
4472
    This prints out the given file with an annotation on the left side
4537
4473
    indicating which revision, author and date introduced the change.
4548
4484
                     Option('long', help='Show commit date in annotations.'),
4549
4485
                     'revision',
4550
4486
                     'show-ids',
4551
 
                     'directory',
4552
4487
                     ]
4553
4488
    encoding_type = 'exact'
4554
4489
 
4555
4490
    @display_command
4556
4491
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4492
            show_ids=False):
4558
4493
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4494
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4495
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4496
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4497
            wt.lock_read()
 
4498
            self.add_cleanup(wt.unlock)
4563
4499
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4500
            branch.lock_read()
 
4501
            self.add_cleanup(branch.unlock)
4565
4502
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4503
        tree.lock_read()
 
4504
        self.add_cleanup(tree.unlock)
4567
4505
        if wt is not None:
4568
4506
            file_id = wt.path2id(relpath)
4569
4507
        else:
4582
4520
 
4583
4521
 
4584
4522
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4523
    """Create a digital signature for an existing revision."""
4586
4524
    # TODO be able to replace existing ones.
4587
4525
 
4588
4526
    hidden = True # is this right ?
4589
4527
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4528
    takes_options = ['revision']
4591
4529
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4530
    def run(self, revision_id_list=None, revision=None):
4593
4531
        if revision_id_list is not None and revision is not None:
4594
4532
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4533
        if revision_id_list is None and revision is None:
4596
4534
            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)
 
4535
        b = WorkingTree.open_containing(u'.')[0].branch
 
4536
        b.lock_write()
 
4537
        self.add_cleanup(b.unlock)
4599
4538
        return self._run(b, revision_id_list, revision)
4600
4539
 
4601
4540
    def _run(self, b, revision_id_list, revision):
4647
4586
 
4648
4587
 
4649
4588
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.
 
4589
    """Convert the current branch into a checkout of the supplied branch.
4652
4590
 
4653
4591
    Once converted into a checkout, commits must succeed on the master branch
4654
4592
    before they will be applied to the local branch.
4660
4598
 
4661
4599
    _see_also = ['checkouts', 'unbind']
4662
4600
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4601
    takes_options = []
4664
4602
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4603
    def run(self, location=None):
 
4604
        b, relpath = Branch.open_containing(u'.')
4667
4605
        if location is None:
4668
4606
            try:
4669
4607
                location = b.get_old_bound_location()
4688
4626
 
4689
4627
 
4690
4628
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4629
    """Convert the current checkout into a regular branch.
4692
4630
 
4693
4631
    After unbinding, the local branch is considered independent and subsequent
4694
4632
    commits will be local only.
4696
4634
 
4697
4635
    _see_also = ['checkouts', 'bind']
4698
4636
    takes_args = []
4699
 
    takes_options = ['directory']
 
4637
    takes_options = []
4700
4638
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4639
    def run(self):
 
4640
        b, relpath = Branch.open_containing(u'.')
4703
4641
        if not b.unbind():
4704
4642
            raise errors.BzrCommandError('Local branch is not bound')
4705
4643
 
4706
4644
 
4707
4645
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4646
    """Remove the last committed revision.
4709
4647
 
4710
4648
    --verbose will print out what is being removed.
4711
4649
    --dry-run will go through all the motions, but not actually
4751
4689
            b = control.open_branch()
4752
4690
 
4753
4691
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4692
            tree.lock_write()
 
4693
            self.add_cleanup(tree.unlock)
4755
4694
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4695
            b.lock_write()
 
4696
            self.add_cleanup(b.unlock)
4757
4697
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4698
 
4759
4699
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4777
4717
                rev_id = b.get_rev_id(revno)
4778
4718
 
4779
4719
        if rev_id is None or _mod_revision.is_null(rev_id):
4780
 
            self.outf.write('No revisions to uncommit.\n')
 
4720
            ui.ui_factory.note('No revisions to uncommit.')
4781
4721
            return 1
4782
4722
 
 
4723
        log_collector = ui.ui_factory.make_output_stream()
4783
4724
        lf = log_formatter('short',
4784
 
                           to_file=self.outf,
 
4725
                           to_file=log_collector,
4785
4726
                           show_timezone='original')
4786
4727
 
4787
4728
        show_log(b,
4792
4733
                 end_revision=last_revno)
4793
4734
 
4794
4735
        if dry_run:
4795
 
            self.outf.write('Dry-run, pretending to remove'
4796
 
                            ' the above revisions.\n')
 
4736
            ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
4797
4737
        else:
4798
 
            self.outf.write('The above revision(s) will be removed.\n')
 
4738
            ui.ui_factory.note('The above revision(s) will be removed.')
4799
4739
 
4800
4740
        if not force:
4801
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4802
 
                self.outf.write('Canceled')
 
4741
            if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
 
4742
                ui.ui_factory.note('Canceled')
4803
4743
                return 0
4804
4744
 
4805
4745
        mutter('Uncommitting from {%s} to {%s}',
4806
4746
               last_rev_id, rev_id)
4807
4747
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4808
4748
                 revno=revno, local=local)
4809
 
        self.outf.write('You can restore the old tip by running:\n'
4810
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4749
        ui.ui_factory.note('You can restore the old tip by running:\n'
 
4750
             '  bzr pull . -r revid:%s' % last_rev_id)
4811
4751
 
4812
4752
 
4813
4753
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4754
    """Break a dead lock on a repository, branch or working directory.
4815
4755
 
4816
4756
    CAUTION: Locks should only be broken when you are sure that the process
4817
4757
    holding the lock has been stopped.
4836
4776
 
4837
4777
 
4838
4778
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4779
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4780
 
4841
4781
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4782
    """
4850
4790
 
4851
4791
 
4852
4792
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4793
    """Run the bzr server."""
4854
4794
 
4855
4795
    aliases = ['server']
4856
4796
 
4867
4807
                    'result in a dynamically allocated port.  The default port '
4868
4808
                    'depends on the protocol.',
4869
4809
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4810
        Option('directory',
 
4811
               help='Serve contents of this directory.',
 
4812
               type=unicode),
4872
4813
        Option('allow-writes',
4873
4814
               help='By default the server is a readonly server.  Supplying '
4874
4815
                    '--allow-writes enables write access to the contents of '
4915
4856
 
4916
4857
 
4917
4858
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4859
    """Combine a tree into its containing tree.
4919
4860
 
4920
4861
    This command requires the target tree to be in a rich-root format.
4921
4862
 
4961
4902
 
4962
4903
 
4963
4904
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4905
    """Split a subdirectory of a tree into a separate tree.
4965
4906
 
4966
4907
    This command will produce a target tree in a format that supports
4967
4908
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4928
 
4988
4929
 
4989
4930
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4931
    """Generate a merge directive for auto-merge tools.
4991
4932
 
4992
4933
    A directive requests a merge to be performed, and also provides all the
4993
4934
    information necessary to do so.  This means it must either include a
5086
5027
 
5087
5028
 
5088
5029
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5030
    """Mail or create a merge-directive for submitting changes.
5090
5031
 
5091
5032
    A merge directive provides many things needed for requesting merges:
5092
5033
 
5174
5115
               short_name='f',
5175
5116
               type=unicode),
5176
5117
        Option('output', short_name='o',
5177
 
               help='Write merge directive to this file or directory; '
 
5118
               help='Write merge directive to this file; '
5178
5119
                    'use - for stdout.',
5179
5120
               type=unicode),
5180
5121
        Option('strict',
5203
5144
 
5204
5145
 
5205
5146
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5147
    """Create a merge-directive for submitting changes.
5207
5148
 
5208
5149
    A merge directive provides many things needed for requesting merges:
5209
5150
 
5276
5217
 
5277
5218
 
5278
5219
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5220
    """Create, remove or modify a tag naming a revision.
5280
5221
 
5281
5222
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5223
    (--revision) option can be given -rtag:X, where X is any previously
5290
5231
 
5291
5232
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5292
5233
    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
5234
    """
5299
5235
 
5300
5236
    _see_also = ['commit', 'tags']
5301
 
    takes_args = ['tag_name?']
 
5237
    takes_args = ['tag_name']
5302
5238
    takes_options = [
5303
5239
        Option('delete',
5304
5240
            help='Delete this tag rather than placing it.',
5305
5241
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5242
        Option('directory',
 
5243
            help='Branch in which to place the tag.',
 
5244
            short_name='d',
 
5245
            type=unicode,
 
5246
            ),
5308
5247
        Option('force',
5309
5248
            help='Replace existing tags.',
5310
5249
            ),
5311
5250
        'revision',
5312
5251
        ]
5313
5252
 
5314
 
    def run(self, tag_name=None,
 
5253
    def run(self, tag_name,
5315
5254
            delete=None,
5316
5255
            directory='.',
5317
5256
            force=None,
5318
5257
            revision=None,
5319
5258
            ):
5320
5259
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5260
        branch.lock_write()
 
5261
        self.add_cleanup(branch.unlock)
5322
5262
        if delete:
5323
 
            if tag_name is None:
5324
 
                raise errors.BzrCommandError("No tag specified to delete.")
5325
5263
            branch.tags.delete_tag(tag_name)
5326
5264
            self.outf.write('Deleted tag %s.\n' % tag_name)
5327
5265
        else:
5333
5271
                revision_id = revision[0].as_revision_id(branch)
5334
5272
            else:
5335
5273
                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
5274
            if (not force) and branch.tags.has_tag(tag_name):
5342
5275
                raise errors.TagAlreadyExists(tag_name)
5343
5276
            branch.tags.set_tag(tag_name, revision_id)
5345
5278
 
5346
5279
 
5347
5280
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5281
    """List tags.
5349
5282
 
5350
5283
    This command shows a table of tag names and the revisions they reference.
5351
5284
    """
5352
5285
 
5353
5286
    _see_also = ['tag']
5354
5287
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5288
        Option('directory',
 
5289
            help='Branch whose tags should be displayed.',
 
5290
            short_name='d',
 
5291
            type=unicode,
 
5292
            ),
5357
5293
        RegistryOption.from_kwargs('sort',
5358
5294
            'Sort tags by different criteria.', title='Sorting',
5359
5295
            alpha='Sort tags lexicographically (default).',
5376
5312
        if not tags:
5377
5313
            return
5378
5314
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5315
        branch.lock_read()
 
5316
        self.add_cleanup(branch.unlock)
5380
5317
        if revision:
5381
5318
            graph = branch.repository.get_graph()
5382
5319
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5352
 
5416
5353
 
5417
5354
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5355
    """Reconfigure the type of a bzr directory.
5419
5356
 
5420
5357
    A target configuration must be specified.
5421
5358
 
5506
5443
 
5507
5444
 
5508
5445
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5446
    """Set the branch of a checkout and update.
5510
5447
 
5511
5448
    For lightweight checkouts, this changes the branch being referenced.
5512
5449
    For heavyweight checkouts, this checks that there are no local commits
5602
5539
 
5603
5540
 
5604
5541
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5542
    """Manage filtered views.
5606
5543
 
5607
5544
    Views provide a mask over the tree so that users can focus on
5608
5545
    a subset of a tree when doing their work. After creating a view,
5756
5693
 
5757
5694
 
5758
5695
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5696
    """Show hooks."""
5760
5697
 
5761
5698
    hidden = True
5762
5699
 
5775
5712
                    self.outf.write("    <no hooks installed>\n")
5776
5713
 
5777
5714
 
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
5715
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5716
    """Temporarily set aside some changes from the current tree.
5805
5717
 
5806
5718
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5719
    ie. out of the way, until a later time when you can bring them back from
5860
5772
 
5861
5773
    def run_for_list(self):
5862
5774
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5775
        tree.lock_read()
 
5776
        self.add_cleanup(tree.unlock)
5864
5777
        manager = tree.get_shelf_manager()
5865
5778
        shelves = manager.active_shelves()
5866
5779
        if len(shelves) == 0:
5875
5788
 
5876
5789
 
5877
5790
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5791
    """Restore shelved changes.
5879
5792
 
5880
5793
    By default, the most recently shelved changes are restored. However if you
5881
5794
    specify a shelf by id those changes will be restored instead.  This works
5907
5820
 
5908
5821
 
5909
5822
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5823
    """Remove unwanted files from working tree.
5911
5824
 
5912
5825
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5826
    files are never deleted.
5921
5834
 
5922
5835
    To check what clean-tree will do, use --dry-run.
5923
5836
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5837
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5838
                     Option('detritus', help='Delete conflict files, merge'
5927
5839
                            ' backups, and failed selftest dirs.'),
5928
5840
                     Option('unknown',
5931
5843
                            ' deleting them.'),
5932
5844
                     Option('force', help='Do not prompt before deleting.')]
5933
5845
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5846
            force=False):
5935
5847
        from bzrlib.clean_tree import clean_tree
5936
5848
        if not (unknown or ignored or detritus):
5937
5849
            unknown = True
5938
5850
        if dry_run:
5939
5851
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5852
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5853
                   dry_run=dry_run, no_prompt=force)
5942
5854
 
5943
5855
 
5944
5856
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5857
    """list, view and set branch locations for nested trees.
5946
5858
 
5947
5859
    If no arguments are provided, lists the branch locations for nested trees.
5948
5860
    If one argument is provided, display the branch location for that tree.
5988
5900
            self.outf.write('%s %s\n' % (path, location))
5989
5901
 
5990
5902
 
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)
 
5903
# these get imported and then picked up by the scan for cmd_*
 
5904
# TODO: Some more consistent way to split command definitions across files;
 
5905
# we do need to load at least some information about them to know of
 
5906
# aliases.  ideally we would avoid loading the implementation until the
 
5907
# details were needed.
 
5908
from bzrlib.cmd_version_info import cmd_version_info
 
5909
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5910
from bzrlib.bundle.commands import (
 
5911
    cmd_bundle_info,
 
5912
    )
 
5913
from bzrlib.foreign import cmd_dpush
 
5914
from bzrlib.sign_my_commits import cmd_sign_my_commits