/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-01-15 05:33:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5019.
  • Revision ID: mbp@sourcefrog.net-20100115053328-z8lykwv6zmkmkp9p
Further progress bar string-pulling

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
54
54
    )
55
55
from bzrlib.branch import Branch
56
56
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
58
from bzrlib.smtp_connection import SMTPConnection
60
59
from bzrlib.workingtree import WorkingTree
61
60
""")
62
61
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
62
from bzrlib.commands import Command, display_command
68
63
from bzrlib.option import (
69
64
    ListOption,
70
65
    Option,
232
227
    return view_info
233
228
 
234
229
 
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
230
# TODO: Make sure no commands unconditionally use the working directory as a
244
231
# branch.  If a filename argument is used, the first of them should be used to
245
232
# specify the branch.  (Perhaps this can be factored out into some kind of
247
234
# opens the branch?)
248
235
 
249
236
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
237
    """Display status summary.
251
238
 
252
239
    This reports on versioned and unknown files, reporting them
253
240
    grouped by state.  Possible states are:
340
327
 
341
328
 
342
329
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
330
    """Write out metadata for a revision.
344
331
 
345
332
    The revision to print can either be specified by a specific
346
333
    revision identifier, or you can use --revision.
348
335
 
349
336
    hidden = True
350
337
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
338
    takes_options = ['revision']
352
339
    # cat-revision is more for frontends so should be exact
353
340
    encoding = 'strict'
354
341
 
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
342
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
343
    def run(self, revision_id=None, revision=None):
365
344
        if revision_id is not None and revision is not None:
366
345
            raise errors.BzrCommandError('You can only supply one of'
367
346
                                         ' revision_id or --revision')
368
347
        if revision_id is None and revision is None:
369
348
            raise errors.BzrCommandError('You must supply either'
370
349
                                         ' --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
 
        
 
350
        b = WorkingTree.open_containing(u'.')[0].branch
 
351
 
 
352
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
353
        if revision_id is not None:
 
354
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
355
            try:
 
356
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
357
            except errors.NoSuchRevision:
 
358
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
359
                    revision_id)
 
360
                raise errors.BzrCommandError(msg)
 
361
        elif revision is not None:
 
362
            for rev in revision:
 
363
                if rev is None:
 
364
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
365
                                                 ' revision.')
 
366
                rev_id = rev.as_revision_id(b)
 
367
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
368
 
399
369
 
400
370
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
371
    """Dump the contents of a btree index file to stdout.
402
372
 
403
373
    PATH is a btree index file, it can be any URL. This includes things like
404
374
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
468
438
        for node in bt.iter_all_entries():
469
439
            # Node is made up of:
470
440
            # (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)
 
441
            refs_as_tuples = static_tuple.as_tuples(node[3])
477
442
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
443
            self.outf.write('%s\n' % (as_tuple,))
479
444
 
480
445
 
481
446
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
447
    """Remove the working tree from a given branch/checkout.
483
448
 
484
449
    Since a lightweight checkout is little more than a working tree
485
450
    this will refuse to run against one.
487
452
    To re-create the working tree, use "bzr checkout".
488
453
    """
489
454
    _see_also = ['checkout', 'working-trees']
490
 
    takes_args = ['location*']
 
455
    takes_args = ['location?']
491
456
    takes_options = [
492
457
        Option('force',
493
458
               help='Remove the working tree even if it has '
494
459
                    'uncommitted changes.'),
495
460
        ]
496
461
 
497
 
    def run(self, location_list, force=False):
498
 
        if not location_list:
499
 
            location_list=['.']
500
 
 
501
 
        for location in location_list:
502
 
            d = bzrdir.BzrDir.open(location)
503
 
            
504
 
            try:
505
 
                working = d.open_workingtree()
506
 
            except errors.NoWorkingTree:
507
 
                raise errors.BzrCommandError("No working tree to remove")
508
 
            except errors.NotLocalUrl:
509
 
                raise errors.BzrCommandError("You cannot remove the working tree"
510
 
                                             " of a remote path")
511
 
            if not force:
512
 
                if (working.has_changes()):
513
 
                    raise errors.UncommittedChanges(working)
514
 
 
515
 
            if working.user_url != working.branch.user_url:
516
 
                raise errors.BzrCommandError("You cannot remove the working tree"
517
 
                                             " from a lightweight checkout")
518
 
 
519
 
            d.destroy_workingtree()
 
462
    def run(self, location='.', force=False):
 
463
        d = bzrdir.BzrDir.open(location)
 
464
 
 
465
        try:
 
466
            working = d.open_workingtree()
 
467
        except errors.NoWorkingTree:
 
468
            raise errors.BzrCommandError("No working tree to remove")
 
469
        except errors.NotLocalUrl:
 
470
            raise errors.BzrCommandError("You cannot remove the working tree"
 
471
                                         " of a remote path")
 
472
        if not force:
 
473
            if (working.has_changes()):
 
474
                raise errors.UncommittedChanges(working)
 
475
 
 
476
        working_path = working.bzrdir.root_transport.base
 
477
        branch_path = working.branch.bzrdir.root_transport.base
 
478
        if working_path != branch_path:
 
479
            raise errors.BzrCommandError("You cannot remove the working tree"
 
480
                                         " from a lightweight checkout")
 
481
 
 
482
        d.destroy_workingtree()
520
483
 
521
484
 
522
485
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
486
    """Show current revision number.
524
487
 
525
488
    This is equal to the number of revisions on this branch.
526
489
    """
536
499
        if tree:
537
500
            try:
538
501
                wt = WorkingTree.open_containing(location)[0]
539
 
                self.add_cleanup(wt.lock_read().unlock)
 
502
                wt.lock_read()
540
503
            except (errors.NoWorkingTree, errors.NotLocalUrl):
541
504
                raise errors.NoWorkingTree(location)
 
505
            self.add_cleanup(wt.unlock)
542
506
            revid = wt.last_revision()
543
507
            try:
544
508
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
511
            revno = ".".join(str(n) for n in revno_t)
548
512
        else:
549
513
            b = Branch.open_containing(location)[0]
550
 
            self.add_cleanup(b.lock_read().unlock)
 
514
            b.lock_read()
 
515
            self.add_cleanup(b.unlock)
551
516
            revno = b.revno()
552
517
        self.cleanup_now()
553
518
        self.outf.write(str(revno) + '\n')
554
519
 
555
520
 
556
521
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
522
    """Show revision number and revision id for a given revision identifier.
558
523
    """
559
524
    hidden = True
560
525
    takes_args = ['revision_info*']
561
526
    takes_options = [
562
527
        'revision',
563
 
        custom_help('directory',
 
528
        Option('directory',
564
529
            help='Branch to examine, '
565
 
                 'rather than the one containing the working directory.'),
 
530
                 'rather than the one containing the working directory.',
 
531
            short_name='d',
 
532
            type=unicode,
 
533
            ),
566
534
        Option('tree', help='Show revno of working tree'),
567
535
        ]
568
536
 
573
541
        try:
574
542
            wt = WorkingTree.open_containing(directory)[0]
575
543
            b = wt.branch
576
 
            self.add_cleanup(wt.lock_read().unlock)
 
544
            wt.lock_read()
 
545
            self.add_cleanup(wt.unlock)
577
546
        except (errors.NoWorkingTree, errors.NotLocalUrl):
578
547
            wt = None
579
548
            b = Branch.open_containing(directory)[0]
580
 
            self.add_cleanup(b.lock_read().unlock)
 
549
            b.lock_read()
 
550
            self.add_cleanup(b.unlock)
581
551
        revision_ids = []
582
552
        if revision is not None:
583
553
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
611
581
 
612
582
 
613
583
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
584
    """Add specified files or directories.
615
585
 
616
586
    In non-recursive mode, all the named items are added, regardless
617
587
    of whether they were previously ignored.  A warning is given if
682
652
                should_print=(not is_quiet()))
683
653
 
684
654
        if base_tree:
685
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
655
            base_tree.lock_read()
 
656
            self.add_cleanup(base_tree.unlock)
686
657
        tree, file_list = tree_files_for_add(file_list)
687
658
        added, ignored = tree.smart_add(file_list, not
688
659
            no_recurse, action=action, save=not dry_run)
696
667
 
697
668
 
698
669
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
670
    """Create a new versioned directory.
700
671
 
701
672
    This is equivalent to creating the directory and then adding it.
702
673
    """
706
677
 
707
678
    def run(self, dir_list):
708
679
        for d in dir_list:
 
680
            os.mkdir(d)
709
681
            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)
 
682
            wt.add([dd])
 
683
            self.outf.write('added %s\n' % d)
718
684
 
719
685
 
720
686
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
687
    """Show path of a file relative to root"""
722
688
 
723
689
    takes_args = ['filename']
724
690
    hidden = True
733
699
 
734
700
 
735
701
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
702
    """Show inventory of the current working copy or a revision.
737
703
 
738
704
    It is possible to limit the output to a particular entry
739
705
    type using the --kind option.  For example: --kind file.
760
726
 
761
727
        revision = _get_one_revision('inventory', revision)
762
728
        work_tree, file_list = tree_files(file_list)
763
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
729
        work_tree.lock_read()
 
730
        self.add_cleanup(work_tree.unlock)
764
731
        if revision is not None:
765
732
            tree = revision.as_tree(work_tree.branch)
766
733
 
767
734
            extra_trees = [work_tree]
768
 
            self.add_cleanup(tree.lock_read().unlock)
 
735
            tree.lock_read()
 
736
            self.add_cleanup(tree.unlock)
769
737
        else:
770
738
            tree = work_tree
771
739
            extra_trees = []
792
760
 
793
761
 
794
762
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
796
764
 
797
765
    :Usage:
798
766
        bzr mv OLDNAME NEWNAME
831
799
        if len(names_list) < 2:
832
800
            raise errors.BzrCommandError("missing file argument")
833
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
834
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
802
        tree.lock_tree_write()
 
803
        self.add_cleanup(tree.unlock)
835
804
        self._run(tree, names_list, rel_names, after)
836
805
 
837
806
    def run_auto(self, names_list, after, dry_run):
842
811
            raise errors.BzrCommandError('--after cannot be specified with'
843
812
                                         ' --auto.')
844
813
        work_tree, file_list = tree_files(names_list, default_branch='.')
845
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
814
        work_tree.lock_tree_write()
 
815
        self.add_cleanup(work_tree.unlock)
846
816
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
847
817
 
848
818
    def _run(self, tree, names_list, rel_names, after):
927
897
 
928
898
 
929
899
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
900
    """Turn this branch into a mirror of another branch.
931
901
 
932
902
    By default, this command only works on branches that have not diverged.
933
903
    Branches are considered diverged if the destination branch's most recent 
956
926
    takes_options = ['remember', 'overwrite', 'revision',
957
927
        custom_help('verbose',
958
928
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
929
        Option('directory',
960
930
            help='Branch to pull into, '
961
 
                 'rather than the one containing the working directory.'),
 
931
                 'rather than the one containing the working directory.',
 
932
            short_name='d',
 
933
            type=unicode,
 
934
            ),
962
935
        Option('local',
963
936
            help="Perform a local pull in a bound "
964
937
                 "branch.  Local pulls are not applied to "
979
952
        try:
980
953
            tree_to = WorkingTree.open_containing(directory)[0]
981
954
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
955
        except errors.NoWorkingTree:
984
956
            tree_to = None
985
957
            branch_to = Branch.open_containing(directory)[0]
986
 
            self.add_cleanup(branch_to.lock_write().unlock)
987
 
 
 
958
        
988
959
        if local and not branch_to.get_bound_location():
989
960
            raise errors.LocalRequiresBoundBranch()
990
961
 
1020
991
        else:
1021
992
            branch_from = Branch.open(location,
1022
993
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
994
 
1025
995
            if branch_to.get_parent() is None or remember:
1026
996
                branch_to.set_parent(branch_from.base)
1027
997
 
 
998
        if branch_from is not branch_to:
 
999
            branch_from.lock_read()
 
1000
            self.add_cleanup(branch_from.unlock)
1028
1001
        if revision is not None:
1029
1002
            revision_id = revision.as_revision_id(branch_from)
1030
1003
 
 
1004
        branch_to.lock_write()
 
1005
        self.add_cleanup(branch_to.unlock)
1031
1006
        if tree_to is not None:
1032
1007
            view_info = _get_view_info_for_change_reporter(tree_to)
1033
1008
            change_reporter = delta._ChangeReporter(
1048
1023
 
1049
1024
 
1050
1025
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
 
1026
    """Update a mirror of this branch.
1052
1027
 
1053
1028
    The target branch will not have its working tree populated because this
1054
1029
    is both expensive, and is not supported on remote file systems.
1078
1053
        Option('create-prefix',
1079
1054
               help='Create the path leading up to the branch '
1080
1055
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
1056
        Option('directory',
1082
1057
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
1058
                 'rather than the one containing the working directory.',
 
1059
            short_name='d',
 
1060
            type=unicode,
 
1061
            ),
1084
1062
        Option('use-existing-dir',
1085
1063
               help='By default push will fail if the target'
1086
1064
                    ' directory exists, but does not already'
1112
1090
        # Get the source branch
1113
1091
        (tree, br_from,
1114
1092
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1093
        if strict is None:
 
1094
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1095
        if strict is None: strict = True # default value
1115
1096
        # Get the tip's revision_id
1116
1097
        revision = _get_one_revision('push', revision)
1117
1098
        if revision is not None:
1118
1099
            revision_id = revision.in_history(br_from).rev_id
1119
1100
        else:
1120
1101
            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.')
 
1102
        if strict and tree is not None and revision_id is None:
 
1103
            if (tree.has_changes()):
 
1104
                raise errors.UncommittedChanges(
 
1105
                    tree, more='Use --no-strict to force the push.')
 
1106
            if tree.last_revision() != tree.branch.last_revision():
 
1107
                # The tree has lost sync with its branch, there is little
 
1108
                # chance that the user is aware of it but he can still force
 
1109
                # the push with --no-strict
 
1110
                raise errors.OutOfDateTree(
 
1111
                    tree, more='Use --no-strict to force the push.')
 
1112
 
1126
1113
        # Get the stacked_on branch, if any
1127
1114
        if stacked_on is not None:
1128
1115
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1147
 
1161
1148
 
1162
1149
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1150
    """Create a new branch that is a copy of an existing branch.
1164
1151
 
1165
1152
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1153
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1193
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
1194
            from_location)
1208
1195
        revision = _get_one_revision('branch', revision)
1209
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1196
        br_from.lock_read()
 
1197
        self.add_cleanup(br_from.unlock)
1210
1198
        if revision is not None:
1211
1199
            revision_id = revision.as_revision_id(br_from)
1212
1200
        else:
1272
1260
 
1273
1261
 
1274
1262
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
1263
    """Create a new checkout of an existing branch.
1276
1264
 
1277
1265
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
1266
    the branch found in '.'. This is useful if you have removed the working tree
1336
1324
            except errors.NoWorkingTree:
1337
1325
                source.bzrdir.create_workingtree(revision_id)
1338
1326
                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
1327
        source.create_checkout(to_location, revision_id, lightweight,
1345
1328
                               accelerator_tree, hardlink)
1346
1329
 
1347
1330
 
1348
1331
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1332
    """Show list of renamed files.
1350
1333
    """
1351
1334
    # TODO: Option to show renames between two historical versions.
1352
1335
 
1357
1340
    @display_command
1358
1341
    def run(self, dir=u'.'):
1359
1342
        tree = WorkingTree.open_containing(dir)[0]
1360
 
        self.add_cleanup(tree.lock_read().unlock)
 
1343
        tree.lock_read()
 
1344
        self.add_cleanup(tree.unlock)
1361
1345
        new_inv = tree.inventory
1362
1346
        old_tree = tree.basis_tree()
1363
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1347
        old_tree.lock_read()
 
1348
        self.add_cleanup(old_tree.unlock)
1364
1349
        old_inv = old_tree.inventory
1365
1350
        renames = []
1366
1351
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
1361
 
1377
1362
 
1378
1363
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1364
    """Update a tree to have the latest code committed to its branch.
1380
1365
 
1381
1366
    This will perform a merge into the working tree, and may generate
1382
1367
    conflicts. If you have any local changes, you will still
1404
1389
        master = branch.get_master_branch(
1405
1390
            possible_transports=possible_transports)
1406
1391
        if master is not None:
 
1392
            tree.lock_write()
1407
1393
            branch_location = master.base
1408
 
            tree.lock_write()
1409
1394
        else:
 
1395
            tree.lock_tree_write()
1410
1396
            branch_location = tree.branch.base
1411
 
            tree.lock_tree_write()
1412
1397
        self.add_cleanup(tree.unlock)
1413
1398
        # 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)
 
1399
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1400
                                                        self.outf.encoding)
1417
1401
        existing_pending_merges = tree.get_parent_ids()[1:]
1418
1402
        if master is None:
1419
1403
            old_tip = None
1427
1411
        else:
1428
1412
            revision_id = branch.last_revision()
1429
1413
        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))
 
1414
            revno = branch.revision_id_to_revno(revision_id)
 
1415
            note("Tree is up to date at revision %d of branch %s" %
 
1416
                (revno, branch_location))
1433
1417
            return 0
1434
1418
        view_info = _get_view_info_for_change_reporter(tree)
1435
1419
        change_reporter = delta._ChangeReporter(
1447
1431
                                  "bzr update --revision only works"
1448
1432
                                  " for a revision in the branch history"
1449
1433
                                  % (e.revision))
1450
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1434
        revno = tree.branch.revision_id_to_revno(
1451
1435
            _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:
 
1436
        note('Updated to revision %d of branch %s' %
 
1437
             (revno, branch_location))
 
1438
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1456
1439
            note('Your local commits will now show as pending merges with '
1457
1440
                 "'bzr status', and can be committed with 'bzr commit'.")
1458
1441
        if conflicts != 0:
1462
1445
 
1463
1446
 
1464
1447
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1448
    """Show information about a working tree, branch or repository.
1466
1449
 
1467
1450
    This command will show all known locations and formats associated to the
1468
1451
    tree, branch or repository.
1506
1489
 
1507
1490
 
1508
1491
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
 
1492
    """Remove files or directories.
1510
1493
 
1511
1494
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
1495
    them if they can easily be recovered using revert. If no options or
1534
1517
        if file_list is not None:
1535
1518
            file_list = [f for f in file_list]
1536
1519
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
 
1520
        tree.lock_write()
 
1521
        self.add_cleanup(tree.unlock)
1538
1522
        # Heuristics should probably all move into tree.remove_smart or
1539
1523
        # some such?
1540
1524
        if new:
1559
1543
 
1560
1544
 
1561
1545
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1546
    """Print file_id of a particular file or directory.
1563
1547
 
1564
1548
    The file_id is assigned when the file is first added and remains the
1565
1549
    same through all revisions where the file exists, even when it is
1581
1565
 
1582
1566
 
1583
1567
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1568
    """Print path of file_ids to a file or directory.
1585
1569
 
1586
1570
    This prints one line for each directory down to the target,
1587
1571
    starting at the branch root.
1603
1587
 
1604
1588
 
1605
1589
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1590
    """Reconcile bzr metadata in a branch.
1607
1591
 
1608
1592
    This can correct data mismatches that may have been caused by
1609
1593
    previous ghost operations or bzr upgrades. You should only
1631
1615
 
1632
1616
 
1633
1617
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1618
    """Display the list of revision ids on a branch."""
1635
1619
 
1636
1620
    _see_also = ['log']
1637
1621
    takes_args = ['location?']
1647
1631
 
1648
1632
 
1649
1633
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1634
    """List all revisions merged into this branch."""
1651
1635
 
1652
1636
    _see_also = ['log', 'revision-history']
1653
1637
    takes_args = ['location?']
1672
1656
 
1673
1657
 
1674
1658
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1659
    """Make a directory into a versioned branch.
1676
1660
 
1677
1661
    Use this to create an empty branch, or before importing an
1678
1662
    existing project.
1781
1765
 
1782
1766
 
1783
1767
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1768
    """Create a shared repository for branches to share storage space.
1785
1769
 
1786
1770
    New branches created under the repository directory will store their
1787
1771
    revisions in the repository, not in the branch directory.  For branches
1841
1825
 
1842
1826
 
1843
1827
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1828
    """Show differences in the working tree, between revisions or branches.
1845
1829
 
1846
1830
    If no arguments are given, all changes for the current tree are listed.
1847
1831
    If files are given, only the changes in those files are listed.
1933
1917
            help='Use this command to compare files.',
1934
1918
            type=unicode,
1935
1919
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1920
        ]
1941
1921
    aliases = ['di', 'dif']
1942
1922
    encoding_type = 'exact'
1943
1923
 
1944
1924
    @display_command
1945
1925
    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)
 
1926
            prefix=None, old=None, new=None, using=None):
 
1927
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1949
1928
 
1950
1929
        if (prefix is None) or (prefix == '0'):
1951
1930
            # diff -p0 format
1965
1944
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1945
                                         ' one or two revision specifiers')
1967
1946
 
1968
 
        if using is not None and format is not None:
1969
 
            raise errors.BzrCommandError('--using and --format are mutually '
1970
 
                'exclusive.')
1971
 
 
1972
1947
        (old_tree, new_tree,
1973
1948
         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)
 
1949
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1950
            file_list, revision, old, new, apply_view=True)
1976
1951
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
1952
                               specific_files=specific_files,
1978
1953
                               external_diff_options=diff_options,
1979
1954
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1955
                               extra_trees=extra_trees, using=using)
1982
1956
 
1983
1957
 
1984
1958
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1959
    """List files deleted in the working tree.
1986
1960
    """
1987
1961
    # TODO: Show files deleted since a previous revision, or
1988
1962
    # between two revisions.
1991
1965
    # level of effort but possibly much less IO.  (Or possibly not,
1992
1966
    # if the directories are very large...)
1993
1967
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
1968
    takes_options = ['show-ids']
1995
1969
 
1996
1970
    @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)
 
1971
    def run(self, show_ids=False):
 
1972
        tree = WorkingTree.open_containing(u'.')[0]
 
1973
        tree.lock_read()
 
1974
        self.add_cleanup(tree.unlock)
2000
1975
        old = tree.basis_tree()
2001
 
        self.add_cleanup(old.lock_read().unlock)
 
1976
        old.lock_read()
 
1977
        self.add_cleanup(old.unlock)
2002
1978
        for path, ie in old.inventory.iter_entries():
2003
1979
            if not tree.has_id(ie.file_id):
2004
1980
                self.outf.write(path)
2009
1985
 
2010
1986
 
2011
1987
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
1988
    """List files modified in working tree.
2013
1989
    """
2014
1990
 
2015
1991
    hidden = True
2016
1992
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
1993
    takes_options = [
 
1994
            Option('null',
 
1995
                   help='Write an ascii NUL (\\0) separator '
 
1996
                   'between files rather than a newline.')
 
1997
            ]
2018
1998
 
2019
1999
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
2000
    def run(self, null=False):
 
2001
        tree = WorkingTree.open_containing(u'.')[0]
2022
2002
        td = tree.changes_from(tree.basis_tree())
2023
2003
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
2004
            if null:
2028
2008
 
2029
2009
 
2030
2010
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2011
    """List files added in working tree.
2032
2012
    """
2033
2013
 
2034
2014
    hidden = True
2035
2015
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
2016
    takes_options = [
 
2017
            Option('null',
 
2018
                   help='Write an ascii NUL (\\0) separator '
 
2019
                   'between files rather than a newline.')
 
2020
            ]
2037
2021
 
2038
2022
    @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)
 
2023
    def run(self, null=False):
 
2024
        wt = WorkingTree.open_containing(u'.')[0]
 
2025
        wt.lock_read()
 
2026
        self.add_cleanup(wt.unlock)
2042
2027
        basis = wt.basis_tree()
2043
 
        self.add_cleanup(basis.lock_read().unlock)
 
2028
        basis.lock_read()
 
2029
        self.add_cleanup(basis.unlock)
2044
2030
        basis_inv = basis.inventory
2045
2031
        inv = wt.inventory
2046
2032
        for file_id in inv:
2049
2035
            if inv.is_root(file_id) and len(basis_inv) == 0:
2050
2036
                continue
2051
2037
            path = inv.id2path(file_id)
2052
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2038
            if not os.access(osutils.abspath(path), os.F_OK):
2053
2039
                continue
2054
2040
            if null:
2055
2041
                self.outf.write(path + '\0')
2058
2044
 
2059
2045
 
2060
2046
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
2047
    """Show the tree root directory.
2062
2048
 
2063
2049
    The root is the nearest enclosing directory with a .bzr control
2064
2050
    directory."""
2088
2074
 
2089
2075
 
2090
2076
class cmd_log(Command):
2091
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2077
    """Show historical log for a branch or subset of a branch.
2092
2078
 
2093
2079
    log is bzr's default tool for exploring the history of a branch.
2094
2080
    The branch to use is taken from the first parameter. If no parameters
2205
2191
    :Tips & tricks:
2206
2192
 
2207
2193
      GUI tools and IDEs are often better at exploring history than command
2208
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2209
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2210
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2211
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2194
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2195
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2196
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2197
 
 
2198
      Web interfaces are often better at exploring history than command line
 
2199
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2200
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2212
2201
 
2213
2202
      You may find it useful to add the aliases below to ``bazaar.conf``::
2214
2203
 
2255
2244
                   help='Show just the specified revision.'
2256
2245
                   ' See also "help revisionspec".'),
2257
2246
            '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
2247
            Option('levels',
2264
2248
                   short_name='n',
2265
2249
                   help='Number of levels to display - 0 for all, 1 for flat.',
2280
2264
                   help='Show changes made in each revision as a patch.'),
2281
2265
            Option('include-merges',
2282
2266
                   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
2267
            ]
2288
2268
    encoding_type = 'replace'
2289
2269
 
2299
2279
            message=None,
2300
2280
            limit=None,
2301
2281
            show_diff=False,
2302
 
            include_merges=False,
2303
 
            authors=None,
2304
 
            exclude_common_ancestry=False,
2305
 
            ):
 
2282
            include_merges=False):
2306
2283
        from bzrlib.log import (
2307
2284
            Logger,
2308
2285
            make_log_request_dict,
2309
2286
            _get_info_for_log_files,
2310
2287
            )
2311
2288
        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
2289
        if include_merges:
2317
2290
            if levels is None:
2318
2291
                levels = 0
2334
2307
        if file_list:
2335
2308
            # find the file ids to log and check for directory filtering
2336
2309
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2337
 
                revision, file_list, self.add_cleanup)
 
2310
                revision, file_list)
 
2311
            self.add_cleanup(b.unlock)
2338
2312
            for relpath, file_id, kind in file_info_list:
2339
2313
                if file_id is None:
2340
2314
                    raise errors.BzrCommandError(
2358
2332
                location = '.'
2359
2333
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
2334
            b = dir.open_branch()
2361
 
            self.add_cleanup(b.lock_read().unlock)
 
2335
            b.lock_read()
 
2336
            self.add_cleanup(b.unlock)
2362
2337
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2363
2338
 
2364
2339
        # Decide on the type of delta & diff filtering to use
2384
2359
                        show_timezone=timezone,
2385
2360
                        delta_format=get_verbosity_level(),
2386
2361
                        levels=levels,
2387
 
                        show_advice=levels is None,
2388
 
                        author_list_handler=authors)
 
2362
                        show_advice=levels is None)
2389
2363
 
2390
2364
        # Choose the algorithm for doing the logging. It's annoying
2391
2365
        # having multiple code paths like this but necessary until
2410
2384
            direction=direction, specific_fileids=file_ids,
2411
2385
            start_revision=rev1, end_revision=rev2, limit=limit,
2412
2386
            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
 
            )
 
2387
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2416
2388
        Logger(b, rqst).show(lf)
2417
2389
 
2418
2390
 
2437
2409
            raise errors.BzrCommandError(
2438
2410
                "bzr %s doesn't accept two revisions in different"
2439
2411
                " 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)
 
2412
        rev1 = start_spec.in_history(branch)
2445
2413
        # Avoid loading all of history when we know a missing
2446
2414
        # end of range means the last revision ...
2447
2415
        if end_spec.spec is None:
2476
2444
 
2477
2445
 
2478
2446
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2447
    """Return revision-ids which affected a particular file.
2480
2448
 
2481
2449
    A more user-friendly interface is "bzr log FILE".
2482
2450
    """
2489
2457
        tree, relpath = WorkingTree.open_containing(filename)
2490
2458
        file_id = tree.path2id(relpath)
2491
2459
        b = tree.branch
2492
 
        self.add_cleanup(b.lock_read().unlock)
 
2460
        b.lock_read()
 
2461
        self.add_cleanup(b.unlock)
2493
2462
        touching_revs = log.find_touching_revisions(b, file_id)
2494
2463
        for revno, revision_id, what in touching_revs:
2495
2464
            self.outf.write("%6d %s\n" % (revno, what))
2496
2465
 
2497
2466
 
2498
2467
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
2468
    """List files in a tree.
2500
2469
    """
2501
2470
 
2502
2471
    _see_also = ['status', 'cat']
2508
2477
                   help='Recurse into subdirectories.'),
2509
2478
            Option('from-root',
2510
2479
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
2480
            Option('unknown', help='Print unknown files.'),
2513
2481
            Option('versioned', help='Print versioned files.',
2514
2482
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
2483
            Option('ignored', help='Print ignored files.'),
 
2484
            Option('null',
 
2485
                   help='Write an ascii NUL (\\0) separator '
 
2486
                   'between files rather than a newline.'),
 
2487
            Option('kind',
2518
2488
                   help='List entries of a particular kind: file, directory, symlink.',
2519
2489
                   type=unicode),
2520
 
            'null',
2521
2490
            'show-ids',
2522
 
            'directory',
2523
2491
            ]
2524
2492
    @display_command
2525
2493
    def run(self, revision=None, verbose=False,
2526
2494
            recursive=False, from_root=False,
2527
2495
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2496
            null=False, kind=None, show_ids=False, path=None):
2529
2497
 
2530
2498
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
2499
            raise errors.BzrCommandError('invalid kind specified')
2543
2511
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
2512
                                             ' and PATH')
2545
2513
            fs_path = path
2546
 
        tree, branch, relpath = \
2547
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2514
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2515
            fs_path)
2548
2516
 
2549
2517
        # Calculate the prefix to use
2550
2518
        prefix = None
2565
2533
                view_str = views.view_display_str(view_files)
2566
2534
                note("Ignoring files outside view. View is %s" % view_str)
2567
2535
 
2568
 
        self.add_cleanup(tree.lock_read().unlock)
 
2536
        tree.lock_read()
 
2537
        self.add_cleanup(tree.unlock)
2569
2538
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2570
2539
            from_dir=relpath, recursive=recursive):
2571
2540
            # Apply additional masking
2613
2582
 
2614
2583
 
2615
2584
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
2585
    """List unknown files.
2617
2586
    """
2618
2587
 
2619
2588
    hidden = True
2620
2589
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
2590
 
2623
2591
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2592
    def run(self):
 
2593
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
2594
            self.outf.write(osutils.quotefn(f) + '\n')
2627
2595
 
2628
2596
 
2629
2597
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
2598
    """Ignore specified files or patterns.
2631
2599
 
2632
2600
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
2601
 
2641
2609
    After adding, editing or deleting that file either indirectly by
2642
2610
    using this command or directly by using an editor, be sure to commit
2643
2611
    it.
2644
 
    
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
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2652
 
    precedence over regular ignores.  Such exceptions are used to specify
2653
 
    files that should be versioned which would otherwise be ignored.
2654
 
    
2655
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2656
 
    precedence over the '!' exception patterns.
2657
2612
 
2658
2613
    Note: ignore patterns containing shell wildcards must be quoted from
2659
2614
    the shell on Unix.
2663
2618
 
2664
2619
            bzr ignore ./Makefile
2665
2620
 
2666
 
        Ignore .class files in all directories...::
 
2621
        Ignore class files in all directories::
2667
2622
 
2668
2623
            bzr ignore "*.class"
2669
2624
 
2670
 
        ...but do not ignore "special.class"::
2671
 
 
2672
 
            bzr ignore "!special.class"
2673
 
 
2674
2625
        Ignore .o files under the lib directory::
2675
2626
 
2676
2627
            bzr ignore "lib/**/*.o"
2682
2633
        Ignore everything but the "debian" toplevel directory::
2683
2634
 
2684
2635
            bzr ignore "RE:(?!debian/).*"
2685
 
        
2686
 
        Ignore everything except the "local" toplevel directory,
2687
 
        but always ignore "*~" autosave files, even under local/::
2688
 
        
2689
 
            bzr ignore "*"
2690
 
            bzr ignore "!./local"
2691
 
            bzr ignore "!!*~"
2692
2636
    """
2693
2637
 
2694
2638
    _see_also = ['status', 'ignored', 'patterns']
2695
2639
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
2640
    takes_options = [
 
2641
        Option('old-default-rules',
 
2642
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
2643
        ]
2700
2644
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
 
2645
    def run(self, name_pattern_list=None, old_default_rules=None):
2703
2646
        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)
 
2647
        if old_default_rules is not None:
 
2648
            # dump the rules and exit
 
2649
            for pattern in ignores.OLD_DEFAULTS:
 
2650
                print pattern
2708
2651
            return
2709
2652
        if not name_pattern_list:
2710
2653
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
 
2654
                                  "NAME_PATTERN or --old-default-rules")
2712
2655
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2656
                             for p in name_pattern_list]
2714
2657
        for name_pattern in name_pattern_list:
2716
2659
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
2660
                raise errors.BzrCommandError(
2718
2661
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2662
        tree, relpath = WorkingTree.open_containing(u'.')
2720
2663
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2721
2664
        ignored = globbing.Globster(name_pattern_list)
2722
2665
        matches = []
2726
2669
            if id is not None:
2727
2670
                filename = entry[0]
2728
2671
                if ignored.match(filename):
2729
 
                    matches.append(filename)
 
2672
                    matches.append(filename.encode('utf-8'))
2730
2673
        tree.unlock()
2731
2674
        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),))
 
2675
            print "Warning: the following files are version controlled and" \
 
2676
                  " match your ignore pattern:\n%s" \
 
2677
                  "\nThese files will continue to be version controlled" \
 
2678
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2736
2679
 
2737
2680
 
2738
2681
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2682
    """List ignored files and the patterns that matched them.
2740
2683
 
2741
2684
    List all the ignored files and the ignore pattern that caused the file to
2742
2685
    be ignored.
2748
2691
 
2749
2692
    encoding_type = 'replace'
2750
2693
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
2752
2694
 
2753
2695
    @display_command
2754
 
    def run(self, directory=u'.'):
2755
 
        tree = WorkingTree.open_containing(directory)[0]
2756
 
        self.add_cleanup(tree.lock_read().unlock)
 
2696
    def run(self):
 
2697
        tree = WorkingTree.open_containing(u'.')[0]
 
2698
        tree.lock_read()
 
2699
        self.add_cleanup(tree.unlock)
2757
2700
        for path, file_class, kind, file_id, entry in tree.list_files():
2758
2701
            if file_class != 'I':
2759
2702
                continue
2763
2706
 
2764
2707
 
2765
2708
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2709
    """Lookup the revision-id from a revision-number
2767
2710
 
2768
2711
    :Examples:
2769
2712
        bzr lookup-revision 33
2770
2713
    """
2771
2714
    hidden = True
2772
2715
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
2716
 
2775
2717
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2718
    def run(self, revno):
2777
2719
        try:
2778
2720
            revno = int(revno)
2779
2721
        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)
 
2722
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2723
 
 
2724
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2784
2725
 
2785
2726
 
2786
2727
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2728
    """Export current or past revision to a destination directory or archive.
2788
2729
 
2789
2730
    If no revision is specified this exports the last committed revision.
2790
2731
 
2812
2753
      =================       =========================
2813
2754
    """
2814
2755
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2756
    takes_options = [
2816
2757
        Option('format',
2817
2758
               help="Type of file to export to.",
2818
2759
               type=unicode),
2822
2763
        Option('root',
2823
2764
               type=str,
2824
2765
               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
2766
        ]
2829
2767
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2768
        root=None, filters=False):
2831
2769
        from bzrlib.export import export
2832
2770
 
2833
2771
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2772
            tree = WorkingTree.open_containing(u'.')[0]
2835
2773
            b = tree.branch
2836
2774
            subdir = None
2837
2775
        else:
2840
2778
 
2841
2779
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2842
2780
        try:
2843
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2844
 
                   per_file_timestamps=per_file_timestamps)
 
2781
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2845
2782
        except errors.NoSuchExportFormat, e:
2846
2783
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2847
2784
 
2848
2785
 
2849
2786
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2787
    """Write the contents of a file as of a given revision to standard output.
2851
2788
 
2852
2789
    If no revision is nominated, the last revision is used.
2853
2790
 
2856
2793
    """
2857
2794
 
2858
2795
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2796
    takes_options = [
2860
2797
        Option('name-from-revision', help='The path name in the old tree.'),
2861
2798
        Option('filters', help='Apply content filters to display the '
2862
2799
                'convenience form.'),
2867
2804
 
2868
2805
    @display_command
2869
2806
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2807
            filters=False):
2871
2808
        if revision is not None and len(revision) != 1:
2872
2809
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2810
                                         " one revision specifier")
2874
2811
        tree, branch, relpath = \
2875
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2876
 
        self.add_cleanup(branch.lock_read().unlock)
 
2812
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2813
        branch.lock_read()
 
2814
        self.add_cleanup(branch.unlock)
2877
2815
        return self._run(tree, branch, relpath, filename, revision,
2878
2816
                         name_from_revision, filters)
2879
2817
 
2882
2820
        if tree is None:
2883
2821
            tree = b.basis_tree()
2884
2822
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2823
        rev_tree.lock_read()
 
2824
        self.add_cleanup(rev_tree.unlock)
2886
2825
 
2887
2826
        old_file_id = rev_tree.path2id(relpath)
2888
2827
 
2931
2870
 
2932
2871
 
2933
2872
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2873
    """Show the offset in seconds from GMT to local time."""
2935
2874
    hidden = True
2936
2875
    @display_command
2937
2876
    def run(self):
2938
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2877
        print osutils.local_time_offset()
2939
2878
 
2940
2879
 
2941
2880
 
2942
2881
class cmd_commit(Command):
2943
 
    __doc__ = """Commit changes into a new revision.
 
2882
    """Commit changes into a new revision.
2944
2883
 
2945
2884
    An explanatory message needs to be given for each commit. This is
2946
2885
    often done by using the --message option (getting the message from the
3054
2993
                         "the master branch until a normal commit "
3055
2994
                         "is performed."
3056
2995
                    ),
3057
 
             Option('show-diff', short_name='p',
 
2996
             Option('show-diff',
3058
2997
                    help='When no message is supplied, show the diff along'
3059
2998
                    ' with the status summary in the message editor.'),
3060
2999
             ]
3140
3079
                    '(use --file "%(f)s" to take commit message from that file)'
3141
3080
                    % { 'f': message })
3142
3081
                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
3082
 
3150
3083
        def get_message(commit_obj):
3151
3084
            """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,
 
3085
            my_message = message
 
3086
            if my_message is not None and '\r' in my_message:
 
3087
                my_message = my_message.replace('\r\n', '\n')
 
3088
                my_message = my_message.replace('\r', '\n')
 
3089
            if my_message is None and not file:
 
3090
                t = make_commit_message_template_encoded(tree,
3161
3091
                        selected_list, diff=show_diff,
3162
3092
                        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
3093
                start_message = generate_commit_message_template(commit_obj)
3169
 
                my_message = edit_commit_message_encoded(text,
 
3094
                my_message = edit_commit_message_encoded(t,
3170
3095
                    start_message=start_message)
3171
3096
                if my_message is None:
3172
3097
                    raise errors.BzrCommandError("please specify a commit"
3173
3098
                        " message with either --message or --file")
 
3099
            elif my_message and file:
 
3100
                raise errors.BzrCommandError(
 
3101
                    "please specify either --message or --file")
 
3102
            if file:
 
3103
                my_message = codecs.open(file, 'rt',
 
3104
                                         osutils.get_user_encoding()).read()
3174
3105
            if my_message == "":
3175
3106
                raise errors.BzrCommandError("empty commit message specified")
3176
3107
            return my_message
3188
3119
                        timezone=offset,
3189
3120
                        exclude=safe_relpath_files(tree, exclude))
3190
3121
        except PointlessCommit:
 
3122
            # FIXME: This should really happen before the file is read in;
 
3123
            # perhaps prepare the commit; get the message; then actually commit
3191
3124
            raise errors.BzrCommandError("No changes to commit."
3192
3125
                              " Use --unchanged to commit anyhow.")
3193
3126
        except ConflictsInTree:
3198
3131
            raise errors.BzrCommandError("Commit refused because there are"
3199
3132
                              " unknown files in the working tree.")
3200
3133
        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
 
3134
            raise errors.BzrCommandError(str(e) + "\n"
 
3135
            'To commit to master branch, run update and then commit.\n'
 
3136
            'You can also pass --local to commit to continue working '
 
3137
            'disconnected.')
3206
3138
 
3207
3139
 
3208
3140
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3141
    """Validate working tree structure, branch consistency and repository history.
3210
3142
 
3211
3143
    This command checks various invariants about branch and repository storage
3212
3144
    to detect data corruption or bzr bugs.
3276
3208
 
3277
3209
 
3278
3210
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
3211
    """Upgrade branch storage to current format.
3280
3212
 
3281
3213
    The check command or bzr developers may sometimes advise you to run
3282
3214
    this command. When the default format has changed you may also be warned
3300
3232
 
3301
3233
 
3302
3234
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
 
3235
    """Show or set bzr user id.
3304
3236
 
3305
3237
    :Examples:
3306
3238
        Show the email of the current user::
3350
3282
 
3351
3283
 
3352
3284
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3285
    """Print or set the branch nickname.
3354
3286
 
3355
3287
    If unset, the tree root directory name is used as the nickname.
3356
3288
    To print the current nickname, execute with no argument.
3361
3293
 
3362
3294
    _see_also = ['info']
3363
3295
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3296
    def run(self, nickname=None):
 
3297
        branch = Branch.open_containing(u'.')[0]
3367
3298
        if nickname is None:
3368
3299
            self.printme(branch)
3369
3300
        else:
3371
3302
 
3372
3303
    @display_command
3373
3304
    def printme(self, branch):
3374
 
        self.outf.write('%s\n' % branch.nick)
 
3305
        print branch.nick
3375
3306
 
3376
3307
 
3377
3308
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3309
    """Set/unset and display aliases.
3379
3310
 
3380
3311
    :Examples:
3381
3312
        Show the current aliases::
3445
3376
 
3446
3377
 
3447
3378
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3379
    """Run internal test suite.
3449
3380
 
3450
3381
    If arguments are given, they are regular expressions that say which tests
3451
3382
    should run.  Tests matching any expression are run, and other tests are
3495
3426
    def get_transport_type(typestring):
3496
3427
        """Parse and return a transport specifier."""
3497
3428
        if typestring == "sftp":
3498
 
            from bzrlib.tests import stub_sftp
3499
 
            return stub_sftp.SFTPAbsoluteServer
 
3429
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3430
            return SFTPAbsoluteServer
3500
3431
        if typestring == "memory":
3501
 
            from bzrlib.tests import test_server
3502
 
            return memory.MemoryServer
 
3432
            from bzrlib.transport.memory import MemoryServer
 
3433
            return MemoryServer
3503
3434
        if typestring == "fakenfs":
3504
 
            from bzrlib.tests import test_server
3505
 
            return test_server.FakeNFSServer
 
3435
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3436
            return FakeNFSServer
3506
3437
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3507
3438
            (typestring)
3508
3439
        raise errors.BzrCommandError(msg)
3592
3523
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3524
                    "needs to be installed to use --subunit.")
3594
3525
            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
3526
        if parallel:
3601
3527
            self.additional_selftest_args.setdefault(
3602
3528
                'suite_decorators', []).append(parallel)
3633
3559
 
3634
3560
 
3635
3561
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
3562
    """Show version of bzr."""
3637
3563
 
3638
3564
    encoding_type = 'replace'
3639
3565
    takes_options = [
3650
3576
 
3651
3577
 
3652
3578
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
3579
    """Statement of optimism."""
3654
3580
 
3655
3581
    hidden = True
3656
3582
 
3657
3583
    @display_command
3658
3584
    def run(self):
3659
 
        self.outf.write("It sure does!\n")
 
3585
        print "It sure does!"
3660
3586
 
3661
3587
 
3662
3588
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3589
    """Find and print a base revision for merging two branches."""
3664
3590
    # TODO: Options to specify revisions on either side, as if
3665
3591
    #       merging only part of the history.
3666
3592
    takes_args = ['branch', 'other']
3672
3598
 
3673
3599
        branch1 = Branch.open_containing(branch)[0]
3674
3600
        branch2 = Branch.open_containing(other)[0]
3675
 
        self.add_cleanup(branch1.lock_read().unlock)
3676
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3601
        branch1.lock_read()
 
3602
        self.add_cleanup(branch1.unlock)
 
3603
        branch2.lock_read()
 
3604
        self.add_cleanup(branch2.unlock)
3677
3605
        last1 = ensure_null(branch1.last_revision())
3678
3606
        last2 = ensure_null(branch2.last_revision())
3679
3607
 
3680
3608
        graph = branch1.repository.get_graph(branch2.repository)
3681
3609
        base_rev_id = graph.find_unique_lca(last1, last2)
3682
3610
 
3683
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3611
        print 'merge base is revision %s' % base_rev_id
3684
3612
 
3685
3613
 
3686
3614
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
 
3615
    """Perform a three-way merge.
3688
3616
 
3689
3617
    The source of the merge can be specified either in the form of a branch,
3690
3618
    or in the form of a path to a file containing a merge directive generated
3719
3647
    committed to record the result of the merge.
3720
3648
 
3721
3649
    merge refuses to run if there are any uncommitted changes, unless
3722
 
    --force is given. The --force option can also be used to create a
3723
 
    merge revision which has more than two parents.
3724
 
 
3725
 
    If one would like to merge changes from the working tree of the other
3726
 
    branch without merging any committed revisions, the --uncommitted option
3727
 
    can be given.
 
3650
    --force is given.
3728
3651
 
3729
3652
    To select only some changes to merge, use "merge -i", which will prompt
3730
3653
    you to apply each diff hunk and file change, similar to "shelve".
3745
3668
        To apply a merge directive contained in /tmp/merge::
3746
3669
 
3747
3670
            bzr merge /tmp/merge
3748
 
 
3749
 
        To create a merge revision with three parents from two branches
3750
 
        feature1a and feature1b:
3751
 
 
3752
 
            bzr merge ../feature1a
3753
 
            bzr merge ../feature1b --force
3754
 
            bzr commit -m 'revision with three parents'
3755
3671
    """
3756
3672
 
3757
3673
    encoding_type = 'exact'
3773
3689
                ' completely merged into the source, pull from the'
3774
3690
                ' source rather than merging.  When this happens,'
3775
3691
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
3692
        Option('directory',
3777
3693
               help='Branch to merge into, '
3778
 
                    'rather than the one containing the working directory.'),
 
3694
                    'rather than the one containing the working directory.',
 
3695
               short_name='d',
 
3696
               type=unicode,
 
3697
               ),
3779
3698
        Option('preview', help='Instead of merging, show a diff of the'
3780
3699
               ' merge.'),
3781
3700
        Option('interactive', help='Select changes interactively.',
3814
3733
            unversioned_filter=tree.is_ignored, view_info=view_info)
3815
3734
        pb = ui.ui_factory.nested_progress_bar()
3816
3735
        self.add_cleanup(pb.finished)
3817
 
        self.add_cleanup(tree.lock_write().unlock)
 
3736
        tree.lock_write()
 
3737
        self.add_cleanup(tree.unlock)
3818
3738
        if location is not None:
3819
3739
            try:
3820
3740
                mergeable = bundle.read_mergeable_from_url(location,
4041
3961
 
4042
3962
 
4043
3963
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
3964
    """Redo a merge.
4045
3965
 
4046
3966
    Use this if you want to try a different merge technique while resolving
4047
3967
    conflicts.  Some merge techniques are better than others, and remerge
4072
3992
 
4073
3993
    def run(self, file_list=None, merge_type=None, show_base=False,
4074
3994
            reprocess=False):
4075
 
        from bzrlib.conflicts import restore
4076
3995
        if merge_type is None:
4077
3996
            merge_type = _mod_merge.Merge3Merger
4078
3997
        tree, file_list = tree_files(file_list)
4079
 
        self.add_cleanup(tree.lock_write().unlock)
 
3998
        tree.lock_write()
 
3999
        self.add_cleanup(tree.unlock)
4080
4000
        parents = tree.get_parent_ids()
4081
4001
        if len(parents) != 2:
4082
4002
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4135
4055
 
4136
4056
 
4137
4057
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
4058
    """Revert files to a previous revision.
4139
4059
 
4140
4060
    Giving a list of files will revert only those files.  Otherwise, all files
4141
4061
    will be reverted.  If the revision is not specified with '--revision', the
4160
4080
    created as above.  Directories containing unknown files will not be
4161
4081
    deleted.
4162
4082
 
4163
 
    The working tree contains a list of revisions that have been merged but
4164
 
    not yet committed. These revisions will be included as additional parents
4165
 
    of the next commit.  Normally, using revert clears that list as well as
4166
 
    reverting the files.  If any files are specified, revert leaves the list
4167
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4168
 
    .`` in the tree root to revert all files but keep the recorded merges,
4169
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4083
    The working tree contains a list of pending merged revisions, which will
 
4084
    be included as parents in the next commit.  Normally, revert clears that
 
4085
    list as well as reverting the files.  If any files are specified, revert
 
4086
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4087
    revert ." in the tree root to revert all files but keep the merge record,
 
4088
    and "bzr revert --forget-merges" to clear the pending merge list without
4170
4089
    reverting any files.
4171
4090
 
4172
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4173
 
    changes from a branch in a single revision.  To do this, perform the merge
4174
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4175
 
    the content of the tree as it was, but it will clear the list of pending
4176
 
    merges.  The next commit will then contain all of the changes that are
4177
 
    present in the other branch, but without any other parent revisions.
4178
 
    Because this technique forgets where these changes originated, it may
4179
 
    cause additional conflicts on later merges involving the same source and
 
4091
    Using "bzr revert --forget-merges", it is possible to apply the changes
 
4092
    from an arbitrary merge as a single revision.  To do this, perform the
 
4093
    merge as desired.  Then doing revert with the "--forget-merges" option will
 
4094
    keep the content of the tree as it was, but it will clear the list of
 
4095
    pending merges.  The next commit will then contain all of the changes that
 
4096
    would have been in the merge, but without any mention of the other parent
 
4097
    revisions.  Because this technique forgets where these changes originated,
 
4098
    it may cause additional conflicts on later merges involving the source and
4180
4099
    target branches.
4181
4100
    """
4182
4101
 
4192
4111
    def run(self, revision=None, no_backup=False, file_list=None,
4193
4112
            forget_merges=None):
4194
4113
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4114
        tree.lock_write()
 
4115
        self.add_cleanup(tree.unlock)
4196
4116
        if forget_merges:
4197
4117
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
4118
        else:
4206
4126
 
4207
4127
 
4208
4128
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
4129
    """Test reporting of assertion failures"""
4210
4130
    # intended just for use in testing
4211
4131
 
4212
4132
    hidden = True
4216
4136
 
4217
4137
 
4218
4138
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
4139
    """Show help on a command or other topic.
4220
4140
    """
4221
4141
 
4222
4142
    _see_also = ['topics']
4235
4155
 
4236
4156
 
4237
4157
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
4158
    """Show appropriate completions for context.
4239
4159
 
4240
4160
    For a list of all available commands, say 'bzr shell-complete'.
4241
4161
    """
4250
4170
 
4251
4171
 
4252
4172
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4173
    """Show unmerged/unpulled revisions between two branches.
4254
4174
 
4255
4175
    OTHER_BRANCH may be local or remote.
4256
4176
 
4334
4254
            restrict = 'remote'
4335
4255
 
4336
4256
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
4257
        parent = local_branch.get_parent()
4340
4258
        if other_branch is None:
4341
4259
            other_branch = parent
4350
4268
        remote_branch = Branch.open(other_branch)
4351
4269
        if remote_branch.base == local_branch.base:
4352
4270
            remote_branch = local_branch
4353
 
        else:
4354
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4355
4271
 
 
4272
        local_branch.lock_read()
 
4273
        self.add_cleanup(local_branch.unlock)
4356
4274
        local_revid_range = _revision_range_to_revid_range(
4357
4275
            _get_revision_range(my_revision, local_branch,
4358
4276
                self.name()))
4359
4277
 
 
4278
        remote_branch.lock_read()
 
4279
        self.add_cleanup(remote_branch.unlock)
4360
4280
        remote_revid_range = _revision_range_to_revid_range(
4361
4281
            _get_revision_range(revision,
4362
4282
                remote_branch, self.name()))
4412
4332
            message("Branches are up to date.\n")
4413
4333
        self.cleanup_now()
4414
4334
        if not status_code and parent is None and other_branch is not None:
4415
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4335
            local_branch.lock_write()
 
4336
            self.add_cleanup(local_branch.unlock)
4416
4337
            # handle race conditions - a parent might be set while we run.
4417
4338
            if local_branch.get_parent() is None:
4418
4339
                local_branch.set_parent(remote_branch.base)
4420
4341
 
4421
4342
 
4422
4343
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
 
    """
 
4344
    """Compress the data within a repository."""
4440
4345
 
4441
4346
    _see_also = ['repositories']
4442
4347
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
4348
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4349
    def run(self, branch_or_repo='.'):
4448
4350
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
4351
        try:
4450
4352
            branch = dir.open_branch()
4451
4353
            repository = branch.repository
4452
4354
        except errors.NotBranchError:
4453
4355
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4356
        repository.pack()
4455
4357
 
4456
4358
 
4457
4359
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
 
4360
    """List the installed plugins.
4459
4361
 
4460
4362
    This command displays the list of installed plugins including
4461
4363
    version of plugin and a short description of each.
4468
4370
    adding new commands, providing additional network transports and
4469
4371
    customizing log output.
4470
4372
 
4471
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4472
 
    for further information on plugins including where to find them and how to
4473
 
    install them. Instructions are also provided there on how to write new
4474
 
    plugins using the Python programming language.
 
4373
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4374
    information on plugins including where to find them and how to
 
4375
    install them. Instructions are also provided there on how to
 
4376
    write new plugins using the Python programming language.
4475
4377
    """
4476
4378
    takes_options = ['verbose']
4477
4379
 
4492
4394
                doc = '(no description)'
4493
4395
            result.append((name_ver, doc, plugin.path()))
4494
4396
        for name_ver, doc, path in sorted(result):
4495
 
            self.outf.write("%s\n" % name_ver)
4496
 
            self.outf.write("   %s\n" % doc)
 
4397
            print name_ver
 
4398
            print '   ', doc
4497
4399
            if verbose:
4498
 
                self.outf.write("   %s\n" % path)
4499
 
            self.outf.write("\n")
 
4400
                print '   ', path
 
4401
            print
4500
4402
 
4501
4403
 
4502
4404
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4405
    """Show testament (signing-form) of a revision."""
4504
4406
    takes_options = [
4505
4407
            'revision',
4506
4408
            Option('long', help='Produce long-format testament.'),
4518
4420
            b = Branch.open_containing(branch)[0]
4519
4421
        else:
4520
4422
            b = Branch.open(branch)
4521
 
        self.add_cleanup(b.lock_read().unlock)
 
4423
        b.lock_read()
 
4424
        self.add_cleanup(b.unlock)
4522
4425
        if revision is None:
4523
4426
            rev_id = b.last_revision()
4524
4427
        else:
4531
4434
 
4532
4435
 
4533
4436
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
4437
    """Show the origin of each line in a file.
4535
4438
 
4536
4439
    This prints out the given file with an annotation on the left side
4537
4440
    indicating which revision, author and date introduced the change.
4548
4451
                     Option('long', help='Show commit date in annotations.'),
4549
4452
                     'revision',
4550
4453
                     'show-ids',
4551
 
                     'directory',
4552
4454
                     ]
4553
4455
    encoding_type = 'exact'
4554
4456
 
4555
4457
    @display_command
4556
4458
    def run(self, filename, all=False, long=False, revision=None,
4557
 
            show_ids=False, directory=None):
 
4459
            show_ids=False):
4558
4460
        from bzrlib.annotate import annotate_file, annotate_file_tree
4559
4461
        wt, branch, relpath = \
4560
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4462
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4561
4463
        if wt is not None:
4562
 
            self.add_cleanup(wt.lock_read().unlock)
 
4464
            wt.lock_read()
 
4465
            self.add_cleanup(wt.unlock)
4563
4466
        else:
4564
 
            self.add_cleanup(branch.lock_read().unlock)
 
4467
            branch.lock_read()
 
4468
            self.add_cleanup(branch.unlock)
4565
4469
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
 
        self.add_cleanup(tree.lock_read().unlock)
 
4470
        tree.lock_read()
 
4471
        self.add_cleanup(tree.unlock)
4567
4472
        if wt is not None:
4568
4473
            file_id = wt.path2id(relpath)
4569
4474
        else:
4582
4487
 
4583
4488
 
4584
4489
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4490
    """Create a digital signature for an existing revision."""
4586
4491
    # TODO be able to replace existing ones.
4587
4492
 
4588
4493
    hidden = True # is this right ?
4589
4494
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
 
4495
    takes_options = ['revision']
4591
4496
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4497
    def run(self, revision_id_list=None, revision=None):
4593
4498
        if revision_id_list is not None and revision is not None:
4594
4499
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
4500
        if revision_id_list is None and revision is None:
4596
4501
            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)
 
4502
        b = WorkingTree.open_containing(u'.')[0].branch
 
4503
        b.lock_write()
 
4504
        self.add_cleanup(b.unlock)
4599
4505
        return self._run(b, revision_id_list, revision)
4600
4506
 
4601
4507
    def _run(self, b, revision_id_list, revision):
4647
4553
 
4648
4554
 
4649
4555
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.
 
4556
    """Convert the current branch into a checkout of the supplied branch.
4652
4557
 
4653
4558
    Once converted into a checkout, commits must succeed on the master branch
4654
4559
    before they will be applied to the local branch.
4660
4565
 
4661
4566
    _see_also = ['checkouts', 'unbind']
4662
4567
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
4568
    takes_options = []
4664
4569
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
4570
    def run(self, location=None):
 
4571
        b, relpath = Branch.open_containing(u'.')
4667
4572
        if location is None:
4668
4573
            try:
4669
4574
                location = b.get_old_bound_location()
4672
4577
                    'This format does not remember old locations.')
4673
4578
            else:
4674
4579
                if location is None:
4675
 
                    if b.get_bound_location() is not None:
4676
 
                        raise errors.BzrCommandError('Branch is already bound')
4677
 
                    else:
4678
 
                        raise errors.BzrCommandError('No location supplied '
4679
 
                            'and no previous location known')
 
4580
                    raise errors.BzrCommandError('No location supplied and no '
 
4581
                        'previous location known')
4680
4582
        b_other = Branch.open(location)
4681
4583
        try:
4682
4584
            b.bind(b_other)
4688
4590
 
4689
4591
 
4690
4592
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4593
    """Convert the current checkout into a regular branch.
4692
4594
 
4693
4595
    After unbinding, the local branch is considered independent and subsequent
4694
4596
    commits will be local only.
4696
4598
 
4697
4599
    _see_also = ['checkouts', 'bind']
4698
4600
    takes_args = []
4699
 
    takes_options = ['directory']
 
4601
    takes_options = []
4700
4602
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4603
    def run(self):
 
4604
        b, relpath = Branch.open_containing(u'.')
4703
4605
        if not b.unbind():
4704
4606
            raise errors.BzrCommandError('Local branch is not bound')
4705
4607
 
4706
4608
 
4707
4609
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
4610
    """Remove the last committed revision.
4709
4611
 
4710
4612
    --verbose will print out what is being removed.
4711
4613
    --dry-run will go through all the motions, but not actually
4751
4653
            b = control.open_branch()
4752
4654
 
4753
4655
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
4656
            tree.lock_write()
 
4657
            self.add_cleanup(tree.unlock)
4755
4658
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
 
4659
            b.lock_write()
 
4660
            self.add_cleanup(b.unlock)
4757
4661
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
4662
 
4759
4663
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4792
4696
                 end_revision=last_revno)
4793
4697
 
4794
4698
        if dry_run:
4795
 
            self.outf.write('Dry-run, pretending to remove'
4796
 
                            ' the above revisions.\n')
 
4699
            print 'Dry-run, pretending to remove the above revisions.'
 
4700
            if not force:
 
4701
                val = raw_input('Press <enter> to continue')
4797
4702
        else:
4798
 
            self.outf.write('The above revision(s) will be removed.\n')
4799
 
 
4800
 
        if not force:
4801
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4802
 
                self.outf.write('Canceled')
4803
 
                return 0
 
4703
            print 'The above revision(s) will be removed.'
 
4704
            if not force:
 
4705
                val = raw_input('Are you sure [y/N]? ')
 
4706
                if val.lower() not in ('y', 'yes'):
 
4707
                    print 'Canceled'
 
4708
                    return 0
4804
4709
 
4805
4710
        mutter('Uncommitting from {%s} to {%s}',
4806
4711
               last_rev_id, rev_id)
4807
4712
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4808
4713
                 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)
 
4714
        note('You can restore the old tip by running:\n'
 
4715
             '  bzr pull . -r revid:%s', last_rev_id)
4811
4716
 
4812
4717
 
4813
4718
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4719
    """Break a dead lock on a repository, branch or working directory.
4815
4720
 
4816
4721
    CAUTION: Locks should only be broken when you are sure that the process
4817
4722
    holding the lock has been stopped.
4818
4723
 
4819
 
    You can get information on what locks are open via the 'bzr info
4820
 
    [location]' command.
 
4724
    You can get information on what locks are open via the 'bzr info' command.
4821
4725
 
4822
4726
    :Examples:
4823
4727
        bzr break-lock
4824
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4825
4728
    """
4826
4729
    takes_args = ['location?']
4827
4730
 
4836
4739
 
4837
4740
 
4838
4741
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4742
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
4743
 
4841
4744
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
4745
    """
4850
4753
 
4851
4754
 
4852
4755
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
4756
    """Run the bzr server."""
4854
4757
 
4855
4758
    aliases = ['server']
4856
4759
 
4867
4770
                    'result in a dynamically allocated port.  The default port '
4868
4771
                    'depends on the protocol.',
4869
4772
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
4773
        Option('directory',
 
4774
               help='Serve contents of this directory.',
 
4775
               type=unicode),
4872
4776
        Option('allow-writes',
4873
4777
               help='By default the server is a readonly server.  Supplying '
4874
4778
                    '--allow-writes enables write access to the contents of '
4915
4819
 
4916
4820
 
4917
4821
class cmd_join(Command):
4918
 
    __doc__ = """Combine a tree into its containing tree.
 
4822
    """Combine a tree into its containing tree.
4919
4823
 
4920
4824
    This command requires the target tree to be in a rich-root format.
4921
4825
 
4961
4865
 
4962
4866
 
4963
4867
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4868
    """Split a subdirectory of a tree into a separate tree.
4965
4869
 
4966
4870
    This command will produce a target tree in a format that supports
4967
4871
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4987
4891
 
4988
4892
 
4989
4893
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4894
    """Generate a merge directive for auto-merge tools.
4991
4895
 
4992
4896
    A directive requests a merge to be performed, and also provides all the
4993
4897
    information necessary to do so.  This means it must either include a
5086
4990
 
5087
4991
 
5088
4992
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4993
    """Mail or create a merge-directive for submitting changes.
5090
4994
 
5091
4995
    A merge directive provides many things needed for requesting merges:
5092
4996
 
5174
5078
               short_name='f',
5175
5079
               type=unicode),
5176
5080
        Option('output', short_name='o',
5177
 
               help='Write merge directive to this file or directory; '
 
5081
               help='Write merge directive to this file; '
5178
5082
                    'use - for stdout.',
5179
5083
               type=unicode),
5180
5084
        Option('strict',
5203
5107
 
5204
5108
 
5205
5109
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5110
    """Create a merge-directive for submitting changes.
5207
5111
 
5208
5112
    A merge directive provides many things needed for requesting merges:
5209
5113
 
5276
5180
 
5277
5181
 
5278
5182
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5183
    """Create, remove or modify a tag naming a revision.
5280
5184
 
5281
5185
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
5186
    (--revision) option can be given -rtag:X, where X is any previously
5290
5194
 
5291
5195
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5292
5196
    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
5197
    """
5299
5198
 
5300
5199
    _see_also = ['commit', 'tags']
5301
 
    takes_args = ['tag_name?']
 
5200
    takes_args = ['tag_name']
5302
5201
    takes_options = [
5303
5202
        Option('delete',
5304
5203
            help='Delete this tag rather than placing it.',
5305
5204
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
5205
        Option('directory',
 
5206
            help='Branch in which to place the tag.',
 
5207
            short_name='d',
 
5208
            type=unicode,
 
5209
            ),
5308
5210
        Option('force',
5309
5211
            help='Replace existing tags.',
5310
5212
            ),
5311
5213
        'revision',
5312
5214
        ]
5313
5215
 
5314
 
    def run(self, tag_name=None,
 
5216
    def run(self, tag_name,
5315
5217
            delete=None,
5316
5218
            directory='.',
5317
5219
            force=None,
5318
5220
            revision=None,
5319
5221
            ):
5320
5222
        branch, relpath = Branch.open_containing(directory)
5321
 
        self.add_cleanup(branch.lock_write().unlock)
 
5223
        branch.lock_write()
 
5224
        self.add_cleanup(branch.unlock)
5322
5225
        if delete:
5323
 
            if tag_name is None:
5324
 
                raise errors.BzrCommandError("No tag specified to delete.")
5325
5226
            branch.tags.delete_tag(tag_name)
5326
5227
            self.outf.write('Deleted tag %s.\n' % tag_name)
5327
5228
        else:
5333
5234
                revision_id = revision[0].as_revision_id(branch)
5334
5235
            else:
5335
5236
                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
5237
            if (not force) and branch.tags.has_tag(tag_name):
5342
5238
                raise errors.TagAlreadyExists(tag_name)
5343
5239
            branch.tags.set_tag(tag_name, revision_id)
5345
5241
 
5346
5242
 
5347
5243
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
5244
    """List tags.
5349
5245
 
5350
5246
    This command shows a table of tag names and the revisions they reference.
5351
5247
    """
5352
5248
 
5353
5249
    _see_also = ['tag']
5354
5250
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
5251
        Option('directory',
 
5252
            help='Branch whose tags should be displayed.',
 
5253
            short_name='d',
 
5254
            type=unicode,
 
5255
            ),
5357
5256
        RegistryOption.from_kwargs('sort',
5358
5257
            'Sort tags by different criteria.', title='Sorting',
5359
5258
            alpha='Sort tags lexicographically (default).',
5376
5275
        if not tags:
5377
5276
            return
5378
5277
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5278
        branch.lock_read()
 
5279
        self.add_cleanup(branch.unlock)
5380
5280
        if revision:
5381
5281
            graph = branch.repository.get_graph()
5382
5282
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5315
 
5416
5316
 
5417
5317
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5318
    """Reconfigure the type of a bzr directory.
5419
5319
 
5420
5320
    A target configuration must be specified.
5421
5321
 
5506
5406
 
5507
5407
 
5508
5408
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5409
    """Set the branch of a checkout and update.
5510
5410
 
5511
5411
    For lightweight checkouts, this changes the branch being referenced.
5512
5412
    For heavyweight checkouts, this checks that there are no local commits
5528
5428
    that of the master.
5529
5429
    """
5530
5430
 
5531
 
    takes_args = ['to_location?']
 
5431
    takes_args = ['to_location']
5532
5432
    takes_options = [Option('force',
5533
5433
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
5434
                     Option('create-branch', short_name='b',
5536
5435
                        help='Create the target branch from this one before'
5537
5436
                             ' switching to it.'),
5538
 
                    ]
 
5437
                     ]
5539
5438
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5439
    def run(self, to_location, force=False, create_branch=False):
5542
5440
        from bzrlib import switch
5543
5441
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5442
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
 
        if to_location is None:
5547
 
            if revision is None:
5548
 
                raise errors.BzrCommandError('You must supply either a'
5549
 
                                             ' revision or a location')
5550
 
            to_location = '.'
5551
5443
        try:
5552
5444
            branch = control_dir.open_branch()
5553
5445
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5567
5459
            to_branch = branch.bzrdir.sprout(to_location,
5568
5460
                                 possible_transports=[branch.bzrdir.root_transport],
5569
5461
                                 source_branch=branch).open_branch()
 
5462
            # try:
 
5463
            #     from_branch = control_dir.open_branch()
 
5464
            # except errors.NotBranchError:
 
5465
            #     raise BzrCommandError('Cannot create a branch from this'
 
5466
            #         ' location when we cannot open this branch')
 
5467
            # from_branch.bzrdir.sprout(
 
5468
            pass
5570
5469
        else:
5571
5470
            try:
5572
5471
                to_branch = Branch.open(to_location)
5574
5473
                this_url = self._get_branch_location(control_dir)
5575
5474
                to_branch = Branch.open(
5576
5475
                    urlutils.join(this_url, '..', to_location))
5577
 
        if revision is not None:
5578
 
            revision = revision.as_revision_id(to_branch)
5579
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5476
        switch.switch(control_dir, to_branch, force)
5580
5477
        if had_explicit_nick:
5581
5478
            branch = control_dir.open_branch() #get the new branch!
5582
5479
            branch.nick = to_branch.nick
5602
5499
 
5603
5500
 
5604
5501
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5502
    """Manage filtered views.
5606
5503
 
5607
5504
    Views provide a mask over the tree so that users can focus on
5608
5505
    a subset of a tree when doing their work. After creating a view,
5756
5653
 
5757
5654
 
5758
5655
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5656
    """Show hooks."""
5760
5657
 
5761
5658
    hidden = True
5762
5659
 
5775
5672
                    self.outf.write("    <no hooks installed>\n")
5776
5673
 
5777
5674
 
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
5675
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5676
    """Temporarily set aside some changes from the current tree.
5805
5677
 
5806
5678
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5679
    ie. out of the way, until a later time when you can bring them back from
5860
5732
 
5861
5733
    def run_for_list(self):
5862
5734
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5735
        tree.lock_read()
 
5736
        self.add_cleanup(tree.unlock)
5864
5737
        manager = tree.get_shelf_manager()
5865
5738
        shelves = manager.active_shelves()
5866
5739
        if len(shelves) == 0:
5875
5748
 
5876
5749
 
5877
5750
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5751
    """Restore shelved changes.
5879
5752
 
5880
5753
    By default, the most recently shelved changes are restored. However if you
5881
5754
    specify a shelf by id those changes will be restored instead.  This works
5907
5780
 
5908
5781
 
5909
5782
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5783
    """Remove unwanted files from working tree.
5911
5784
 
5912
5785
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5786
    files are never deleted.
5921
5794
 
5922
5795
    To check what clean-tree will do, use --dry-run.
5923
5796
    """
5924
 
    takes_options = ['directory',
5925
 
                     Option('ignored', help='Delete all ignored files.'),
 
5797
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5926
5798
                     Option('detritus', help='Delete conflict files, merge'
5927
5799
                            ' backups, and failed selftest dirs.'),
5928
5800
                     Option('unknown',
5931
5803
                            ' deleting them.'),
5932
5804
                     Option('force', help='Do not prompt before deleting.')]
5933
5805
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5934
 
            force=False, directory=u'.'):
 
5806
            force=False):
5935
5807
        from bzrlib.clean_tree import clean_tree
5936
5808
        if not (unknown or ignored or detritus):
5937
5809
            unknown = True
5938
5810
        if dry_run:
5939
5811
            force = True
5940
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5941
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5812
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5813
                   dry_run=dry_run, no_prompt=force)
5942
5814
 
5943
5815
 
5944
5816
class cmd_reference(Command):
5945
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5817
    """list, view and set branch locations for nested trees.
5946
5818
 
5947
5819
    If no arguments are provided, lists the branch locations for nested trees.
5948
5820
    If one argument is provided, display the branch location for that tree.
5988
5860
            self.outf.write('%s %s\n' % (path, location))
5989
5861
 
5990
5862
 
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)
 
5863
# these get imported and then picked up by the scan for cmd_*
 
5864
# TODO: Some more consistent way to split command definitions across files;
 
5865
# we do need to load at least some information about them to know of
 
5866
# aliases.  ideally we would avoid loading the implementation until the
 
5867
# details were needed.
 
5868
from bzrlib.cmd_version_info import cmd_version_info
 
5869
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5870
from bzrlib.bundle.commands import (
 
5871
    cmd_bundle_info,
 
5872
    )
 
5873
from bzrlib.foreign import cmd_dpush
 
5874
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5875
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5876
        cmd_weave_plan_merge, cmd_weave_merge_text