/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: John Whitley
  • Date: 2010-01-05 19:29:07 UTC
  • mto: This revision was merged to the branch mainline in revision 4981.
  • Revision ID: whitley@bangpath.org-20100105192907-hy326yzkt7ywdao3
A trial implementation of '!!' syntax for double-negative ignore exclusions.
These act like regular ignores, but take precedence over the single '!' 
exclusions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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,
239
234
# opens the branch?)
240
235
 
241
236
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
237
    """Display status summary.
243
238
 
244
239
    This reports on versioned and unknown files, reporting them
245
240
    grouped by state.  Possible states are:
332
327
 
333
328
 
334
329
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
330
    """Write out metadata for a revision.
336
331
 
337
332
    The revision to print can either be specified by a specific
338
333
    revision identifier, or you can use --revision.
344
339
    # cat-revision is more for frontends so should be exact
345
340
    encoding = 'strict'
346
341
 
347
 
    def print_revision(self, revisions, revid):
348
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
 
        record = stream.next()
350
 
        if record.storage_kind == 'absent':
351
 
            raise errors.NoSuchRevision(revisions, revid)
352
 
        revtext = record.get_bytes_as('fulltext')
353
 
        self.outf.write(revtext.decode('utf-8'))
354
 
 
355
342
    @display_command
356
343
    def run(self, revision_id=None, revision=None):
357
344
        if revision_id is not None and revision is not None:
362
349
                                         ' --revision or a revision_id')
363
350
        b = WorkingTree.open_containing(u'.')[0].branch
364
351
 
365
 
        revisions = b.repository.revisions
366
 
        if revisions is None:
367
 
            raise errors.BzrCommandError('Repository %r does not support '
368
 
                'access to raw revision texts')
 
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'))
369
368
 
370
 
        b.repository.lock_read()
371
 
        try:
372
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
373
 
            if revision_id is not None:
374
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
 
                try:
376
 
                    self.print_revision(revisions, revision_id)
377
 
                except errors.NoSuchRevision:
378
 
                    msg = "The repository %s contains no revision %s." % (
379
 
                        b.repository.base, revision_id)
380
 
                    raise errors.BzrCommandError(msg)
381
 
            elif revision is not None:
382
 
                for rev in revision:
383
 
                    if rev is None:
384
 
                        raise errors.BzrCommandError(
385
 
                            'You cannot specify a NULL revision.')
386
 
                    rev_id = rev.as_revision_id(b)
387
 
                    self.print_revision(revisions, rev_id)
388
 
        finally:
389
 
            b.repository.unlock()
390
 
        
391
369
 
392
370
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
371
    """Dump the contents of a btree index file to stdout.
394
372
 
395
373
    PATH is a btree index file, it can be any URL. This includes things like
396
374
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
438
        for node in bt.iter_all_entries():
461
439
            # Node is made up of:
462
440
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
 
441
            refs_as_tuples = static_tuple.as_tuples(node[3])
469
442
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
443
            self.outf.write('%s\n' % (as_tuple,))
471
444
 
472
445
 
473
446
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
447
    """Remove the working tree from a given branch/checkout.
475
448
 
476
449
    Since a lightweight checkout is little more than a working tree
477
450
    this will refuse to run against one.
479
452
    To re-create the working tree, use "bzr checkout".
480
453
    """
481
454
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
455
    takes_args = ['location?']
483
456
    takes_options = [
484
457
        Option('force',
485
458
               help='Remove the working tree even if it has '
486
459
                    'uncommitted changes.'),
487
460
        ]
488
461
 
489
 
    def run(self, location_list, force=False):
490
 
        if not location_list:
491
 
            location_list=['.']
492
 
 
493
 
        for location in location_list:
494
 
            d = bzrdir.BzrDir.open(location)
495
 
            
496
 
            try:
497
 
                working = d.open_workingtree()
498
 
            except errors.NoWorkingTree:
499
 
                raise errors.BzrCommandError("No working tree to remove")
500
 
            except errors.NotLocalUrl:
501
 
                raise errors.BzrCommandError("You cannot remove the working tree"
502
 
                                             " of a remote path")
503
 
            if not force:
504
 
                if (working.has_changes()):
505
 
                    raise errors.UncommittedChanges(working)
506
 
 
507
 
            if working.user_url != working.branch.user_url:
508
 
                raise errors.BzrCommandError("You cannot remove the working tree"
509
 
                                             " from a lightweight checkout")
510
 
 
511
 
            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()
512
483
 
513
484
 
514
485
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
486
    """Show current revision number.
516
487
 
517
488
    This is equal to the number of revisions on this branch.
518
489
    """
528
499
        if tree:
529
500
            try:
530
501
                wt = WorkingTree.open_containing(location)[0]
531
 
                self.add_cleanup(wt.lock_read().unlock)
 
502
                wt.lock_read()
532
503
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
504
                raise errors.NoWorkingTree(location)
 
505
            self.add_cleanup(wt.unlock)
534
506
            revid = wt.last_revision()
535
507
            try:
536
508
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
539
511
            revno = ".".join(str(n) for n in revno_t)
540
512
        else:
541
513
            b = Branch.open_containing(location)[0]
542
 
            self.add_cleanup(b.lock_read().unlock)
 
514
            b.lock_read()
 
515
            self.add_cleanup(b.unlock)
543
516
            revno = b.revno()
544
517
        self.cleanup_now()
545
518
        self.outf.write(str(revno) + '\n')
546
519
 
547
520
 
548
521
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
522
    """Show revision number and revision id for a given revision identifier.
550
523
    """
551
524
    hidden = True
552
525
    takes_args = ['revision_info*']
568
541
        try:
569
542
            wt = WorkingTree.open_containing(directory)[0]
570
543
            b = wt.branch
571
 
            self.add_cleanup(wt.lock_read().unlock)
 
544
            wt.lock_read()
 
545
            self.add_cleanup(wt.unlock)
572
546
        except (errors.NoWorkingTree, errors.NotLocalUrl):
573
547
            wt = None
574
548
            b = Branch.open_containing(directory)[0]
575
 
            self.add_cleanup(b.lock_read().unlock)
 
549
            b.lock_read()
 
550
            self.add_cleanup(b.unlock)
576
551
        revision_ids = []
577
552
        if revision is not None:
578
553
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
606
581
 
607
582
 
608
583
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
584
    """Add specified files or directories.
610
585
 
611
586
    In non-recursive mode, all the named items are added, regardless
612
587
    of whether they were previously ignored.  A warning is given if
677
652
                should_print=(not is_quiet()))
678
653
 
679
654
        if base_tree:
680
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
655
            base_tree.lock_read()
 
656
            self.add_cleanup(base_tree.unlock)
681
657
        tree, file_list = tree_files_for_add(file_list)
682
658
        added, ignored = tree.smart_add(file_list, not
683
659
            no_recurse, action=action, save=not dry_run)
691
667
 
692
668
 
693
669
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
670
    """Create a new versioned directory.
695
671
 
696
672
    This is equivalent to creating the directory and then adding it.
697
673
    """
701
677
 
702
678
    def run(self, dir_list):
703
679
        for d in dir_list:
 
680
            os.mkdir(d)
704
681
            wt, dd = WorkingTree.open_containing(d)
705
 
            base = os.path.dirname(dd)
706
 
            id = wt.path2id(base)
707
 
            if id != None:
708
 
                os.mkdir(d)
709
 
                wt.add([dd])
710
 
                self.outf.write('added %s\n' % d)
711
 
            else:
712
 
                raise errors.NotVersionedError(path=base)
 
682
            wt.add([dd])
 
683
            self.outf.write('added %s\n' % d)
713
684
 
714
685
 
715
686
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
687
    """Show path of a file relative to root"""
717
688
 
718
689
    takes_args = ['filename']
719
690
    hidden = True
728
699
 
729
700
 
730
701
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
702
    """Show inventory of the current working copy or a revision.
732
703
 
733
704
    It is possible to limit the output to a particular entry
734
705
    type using the --kind option.  For example: --kind file.
755
726
 
756
727
        revision = _get_one_revision('inventory', revision)
757
728
        work_tree, file_list = tree_files(file_list)
758
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
729
        work_tree.lock_read()
 
730
        self.add_cleanup(work_tree.unlock)
759
731
        if revision is not None:
760
732
            tree = revision.as_tree(work_tree.branch)
761
733
 
762
734
            extra_trees = [work_tree]
763
 
            self.add_cleanup(tree.lock_read().unlock)
 
735
            tree.lock_read()
 
736
            self.add_cleanup(tree.unlock)
764
737
        else:
765
738
            tree = work_tree
766
739
            extra_trees = []
787
760
 
788
761
 
789
762
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
791
764
 
792
765
    :Usage:
793
766
        bzr mv OLDNAME NEWNAME
826
799
        if len(names_list) < 2:
827
800
            raise errors.BzrCommandError("missing file argument")
828
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
829
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
802
        tree.lock_tree_write()
 
803
        self.add_cleanup(tree.unlock)
830
804
        self._run(tree, names_list, rel_names, after)
831
805
 
832
806
    def run_auto(self, names_list, after, dry_run):
837
811
            raise errors.BzrCommandError('--after cannot be specified with'
838
812
                                         ' --auto.')
839
813
        work_tree, file_list = tree_files(names_list, default_branch='.')
840
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
814
        work_tree.lock_tree_write()
 
815
        self.add_cleanup(work_tree.unlock)
841
816
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
842
817
 
843
818
    def _run(self, tree, names_list, rel_names, after):
922
897
 
923
898
 
924
899
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
900
    """Turn this branch into a mirror of another branch.
926
901
 
927
902
    By default, this command only works on branches that have not diverged.
928
903
    Branches are considered diverged if the destination branch's most recent 
977
952
        try:
978
953
            tree_to = WorkingTree.open_containing(directory)[0]
979
954
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
955
        except errors.NoWorkingTree:
982
956
            tree_to = None
983
957
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
 
958
        
986
959
        if local and not branch_to.get_bound_location():
987
960
            raise errors.LocalRequiresBoundBranch()
988
961
 
1018
991
        else:
1019
992
            branch_from = Branch.open(location,
1020
993
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
994
 
1023
995
            if branch_to.get_parent() is None or remember:
1024
996
                branch_to.set_parent(branch_from.base)
1025
997
 
 
998
        if branch_from is not branch_to:
 
999
            branch_from.lock_read()
 
1000
            self.add_cleanup(branch_from.unlock)
1026
1001
        if revision is not None:
1027
1002
            revision_id = revision.as_revision_id(branch_from)
1028
1003
 
 
1004
        branch_to.lock_write()
 
1005
        self.add_cleanup(branch_to.unlock)
1029
1006
        if tree_to is not None:
1030
1007
            view_info = _get_view_info_for_change_reporter(tree_to)
1031
1008
            change_reporter = delta._ChangeReporter(
1046
1023
 
1047
1024
 
1048
1025
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
 
1026
    """Update a mirror of this branch.
1050
1027
 
1051
1028
    The target branch will not have its working tree populated because this
1052
1029
    is both expensive, and is not supported on remote file systems.
1113
1090
        # Get the source branch
1114
1091
        (tree, br_from,
1115
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
1116
1096
        # Get the tip's revision_id
1117
1097
        revision = _get_one_revision('push', revision)
1118
1098
        if revision is not None:
1119
1099
            revision_id = revision.in_history(br_from).rev_id
1120
1100
        else:
1121
1101
            revision_id = None
1122
 
        if tree is not None and revision_id is None:
1123
 
            tree.check_changed_or_out_of_date(
1124
 
                strict, 'push_strict',
1125
 
                more_error='Use --no-strict to force the push.',
1126
 
                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
 
1127
1113
        # Get the stacked_on branch, if any
1128
1114
        if stacked_on is not None:
1129
1115
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1147
 
1162
1148
 
1163
1149
class cmd_branch(Command):
1164
 
    __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.
1165
1151
 
1166
1152
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1153
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1194
1180
                    ' directory exists, but does not already'
1195
1181
                    ' have a control directory.  This flag will'
1196
1182
                    ' allow branch to proceed.'),
1197
 
        Option('bind',
1198
 
            help="Bind new branch to from location."),
1199
1183
        ]
1200
1184
    aliases = ['get', 'clone']
1201
1185
 
1202
1186
    def run(self, from_location, to_location=None, revision=None,
1203
1187
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
 
            use_existing_dir=False, switch=False, bind=False):
 
1188
            use_existing_dir=False, switch=False):
1205
1189
        from bzrlib import switch as _mod_switch
1206
1190
        from bzrlib.tag import _merge_tags_if_possible
1207
1191
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1192
            from_location)
1209
1193
        revision = _get_one_revision('branch', revision)
1210
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1194
        br_from.lock_read()
 
1195
        self.add_cleanup(br_from.unlock)
1211
1196
        if revision is not None:
1212
1197
            revision_id = revision.as_revision_id(br_from)
1213
1198
        else:
1259
1244
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
1245
            errors.UnstackableRepositoryFormat), e:
1261
1246
            note('Branched %d revision(s).' % branch.revno())
1262
 
        if bind:
1263
 
            # Bind to the parent
1264
 
            parent_branch = Branch.open(from_location)
1265
 
            branch.bind(parent_branch)
1266
 
            note('New branch bound to %s' % from_location)
1267
1247
        if switch:
1268
1248
            # Switch to the new branch
1269
1249
            wt, _ = WorkingTree.open_containing('.')
1273
1253
 
1274
1254
 
1275
1255
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1256
    """Create a new checkout of an existing branch.
1277
1257
 
1278
1258
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1259
    the branch found in '.'. This is useful if you have removed the working tree
1342
1322
 
1343
1323
 
1344
1324
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1325
    """Show list of renamed files.
1346
1326
    """
1347
1327
    # TODO: Option to show renames between two historical versions.
1348
1328
 
1353
1333
    @display_command
1354
1334
    def run(self, dir=u'.'):
1355
1335
        tree = WorkingTree.open_containing(dir)[0]
1356
 
        self.add_cleanup(tree.lock_read().unlock)
 
1336
        tree.lock_read()
 
1337
        self.add_cleanup(tree.unlock)
1357
1338
        new_inv = tree.inventory
1358
1339
        old_tree = tree.basis_tree()
1359
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1340
        old_tree.lock_read()
 
1341
        self.add_cleanup(old_tree.unlock)
1360
1342
        old_inv = old_tree.inventory
1361
1343
        renames = []
1362
1344
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1372
1354
 
1373
1355
 
1374
1356
class cmd_update(Command):
1375
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1357
    """Update a tree to have the latest code committed to its branch.
1376
1358
 
1377
1359
    This will perform a merge into the working tree, and may generate
1378
1360
    conflicts. If you have any local changes, you will still
1400
1382
        master = branch.get_master_branch(
1401
1383
            possible_transports=possible_transports)
1402
1384
        if master is not None:
 
1385
            tree.lock_write()
1403
1386
            branch_location = master.base
1404
 
            tree.lock_write()
1405
1387
        else:
 
1388
            tree.lock_tree_write()
1406
1389
            branch_location = tree.branch.base
1407
 
            tree.lock_tree_write()
1408
1390
        self.add_cleanup(tree.unlock)
1409
1391
        # get rid of the final '/' and be ready for display
1410
 
        branch_location = urlutils.unescape_for_display(
1411
 
            branch_location.rstrip('/'),
1412
 
            self.outf.encoding)
 
1392
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1393
                                                        self.outf.encoding)
1413
1394
        existing_pending_merges = tree.get_parent_ids()[1:]
1414
1395
        if master is None:
1415
1396
            old_tip = None
1423
1404
        else:
1424
1405
            revision_id = branch.last_revision()
1425
1406
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1427
 
            note("Tree is up to date at revision %s of branch %s" %
1428
 
                ('.'.join(map(str, revno)), branch_location))
 
1407
            revno = branch.revision_id_to_revno(revision_id)
 
1408
            note("Tree is up to date at revision %d of branch %s" %
 
1409
                (revno, branch_location))
1429
1410
            return 0
1430
1411
        view_info = _get_view_info_for_change_reporter(tree)
1431
1412
        change_reporter = delta._ChangeReporter(
1443
1424
                                  "bzr update --revision only works"
1444
1425
                                  " for a revision in the branch history"
1445
1426
                                  % (e.revision))
1446
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1427
        revno = tree.branch.revision_id_to_revno(
1447
1428
            _mod_revision.ensure_null(tree.last_revision()))
1448
 
        note('Updated to revision %s of branch %s' %
1449
 
             ('.'.join(map(str, revno)), branch_location))
1450
 
        parent_ids = tree.get_parent_ids()
1451
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1429
        note('Updated to revision %d of branch %s' %
 
1430
             (revno, branch_location))
 
1431
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1452
1432
            note('Your local commits will now show as pending merges with '
1453
1433
                 "'bzr status', and can be committed with 'bzr commit'.")
1454
1434
        if conflicts != 0:
1458
1438
 
1459
1439
 
1460
1440
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1441
    """Show information about a working tree, branch or repository.
1462
1442
 
1463
1443
    This command will show all known locations and formats associated to the
1464
1444
    tree, branch or repository.
1502
1482
 
1503
1483
 
1504
1484
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1485
    """Remove files or directories.
1506
1486
 
1507
1487
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1488
    them if they can easily be recovered using revert. If no options or
1530
1510
        if file_list is not None:
1531
1511
            file_list = [f for f in file_list]
1532
1512
 
1533
 
        self.add_cleanup(tree.lock_write().unlock)
 
1513
        tree.lock_write()
 
1514
        self.add_cleanup(tree.unlock)
1534
1515
        # Heuristics should probably all move into tree.remove_smart or
1535
1516
        # some such?
1536
1517
        if new:
1555
1536
 
1556
1537
 
1557
1538
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1539
    """Print file_id of a particular file or directory.
1559
1540
 
1560
1541
    The file_id is assigned when the file is first added and remains the
1561
1542
    same through all revisions where the file exists, even when it is
1577
1558
 
1578
1559
 
1579
1560
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1561
    """Print path of file_ids to a file or directory.
1581
1562
 
1582
1563
    This prints one line for each directory down to the target,
1583
1564
    starting at the branch root.
1599
1580
 
1600
1581
 
1601
1582
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1583
    """Reconcile bzr metadata in a branch.
1603
1584
 
1604
1585
    This can correct data mismatches that may have been caused by
1605
1586
    previous ghost operations or bzr upgrades. You should only
1627
1608
 
1628
1609
 
1629
1610
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1611
    """Display the list of revision ids on a branch."""
1631
1612
 
1632
1613
    _see_also = ['log']
1633
1614
    takes_args = ['location?']
1643
1624
 
1644
1625
 
1645
1626
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1627
    """List all revisions merged into this branch."""
1647
1628
 
1648
1629
    _see_also = ['log', 'revision-history']
1649
1630
    takes_args = ['location?']
1668
1649
 
1669
1650
 
1670
1651
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1652
    """Make a directory into a versioned branch.
1672
1653
 
1673
1654
    Use this to create an empty branch, or before importing an
1674
1655
    existing project.
1777
1758
 
1778
1759
 
1779
1760
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1761
    """Create a shared repository for branches to share storage space.
1781
1762
 
1782
1763
    New branches created under the repository directory will store their
1783
1764
    revisions in the repository, not in the branch directory.  For branches
1837
1818
 
1838
1819
 
1839
1820
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1821
    """Show differences in the working tree, between revisions or branches.
1841
1822
 
1842
1823
    If no arguments are given, all changes for the current tree are listed.
1843
1824
    If files are given, only the changes in those files are listed.
1929
1910
            help='Use this command to compare files.',
1930
1911
            type=unicode,
1931
1912
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1913
        ]
1937
1914
    aliases = ['di', 'dif']
1938
1915
    encoding_type = 'exact'
1939
1916
 
1940
1917
    @display_command
1941
1918
    def run(self, revision=None, file_list=None, diff_options=None,
1942
 
            prefix=None, old=None, new=None, using=None, format=None):
1943
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
 
            show_diff_trees)
 
1919
            prefix=None, old=None, new=None, using=None):
 
1920
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1945
1921
 
1946
1922
        if (prefix is None) or (prefix == '0'):
1947
1923
            # diff -p0 format
1961
1937
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1938
                                         ' one or two revision specifiers')
1963
1939
 
1964
 
        if using is not None and format is not None:
1965
 
            raise errors.BzrCommandError('--using and --format are mutually '
1966
 
                'exclusive.')
1967
 
 
1968
1940
        (old_tree, new_tree,
1969
1941
         old_branch, new_branch,
1970
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1942
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1943
            file_list, revision, old, new, apply_view=True)
1972
1944
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1945
                               specific_files=specific_files,
1974
1946
                               external_diff_options=diff_options,
1975
1947
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1948
                               extra_trees=extra_trees, using=using)
1978
1949
 
1979
1950
 
1980
1951
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1952
    """List files deleted in the working tree.
1982
1953
    """
1983
1954
    # TODO: Show files deleted since a previous revision, or
1984
1955
    # between two revisions.
1992
1963
    @display_command
1993
1964
    def run(self, show_ids=False):
1994
1965
        tree = WorkingTree.open_containing(u'.')[0]
1995
 
        self.add_cleanup(tree.lock_read().unlock)
 
1966
        tree.lock_read()
 
1967
        self.add_cleanup(tree.unlock)
1996
1968
        old = tree.basis_tree()
1997
 
        self.add_cleanup(old.lock_read().unlock)
 
1969
        old.lock_read()
 
1970
        self.add_cleanup(old.unlock)
1998
1971
        for path, ie in old.inventory.iter_entries():
1999
1972
            if not tree.has_id(ie.file_id):
2000
1973
                self.outf.write(path)
2005
1978
 
2006
1979
 
2007
1980
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
1981
    """List files modified in working tree.
2009
1982
    """
2010
1983
 
2011
1984
    hidden = True
2028
2001
 
2029
2002
 
2030
2003
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
2004
    """List files added in working tree.
2032
2005
    """
2033
2006
 
2034
2007
    hidden = True
2042
2015
    @display_command
2043
2016
    def run(self, null=False):
2044
2017
        wt = WorkingTree.open_containing(u'.')[0]
2045
 
        self.add_cleanup(wt.lock_read().unlock)
 
2018
        wt.lock_read()
 
2019
        self.add_cleanup(wt.unlock)
2046
2020
        basis = wt.basis_tree()
2047
 
        self.add_cleanup(basis.lock_read().unlock)
 
2021
        basis.lock_read()
 
2022
        self.add_cleanup(basis.unlock)
2048
2023
        basis_inv = basis.inventory
2049
2024
        inv = wt.inventory
2050
2025
        for file_id in inv:
2062
2037
 
2063
2038
 
2064
2039
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
2040
    """Show the tree root directory.
2066
2041
 
2067
2042
    The root is the nearest enclosing directory with a .bzr control
2068
2043
    directory."""
2092
2067
 
2093
2068
 
2094
2069
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2070
    """Show historical log for a branch or subset of a branch.
2096
2071
 
2097
2072
    log is bzr's default tool for exploring the history of a branch.
2098
2073
    The branch to use is taken from the first parameter. If no parameters
2209
2184
    :Tips & tricks:
2210
2185
 
2211
2186
      GUI tools and IDEs are often better at exploring history than command
2212
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2213
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2214
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2215
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2187
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2188
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2189
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2190
 
 
2191
      Web interfaces are often better at exploring history than command line
 
2192
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2193
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2216
2194
 
2217
2195
      You may find it useful to add the aliases below to ``bazaar.conf``::
2218
2196
 
2279
2257
                   help='Show changes made in each revision as a patch.'),
2280
2258
            Option('include-merges',
2281
2259
                   help='Show merged revisions like --levels 0 does.'),
2282
 
            Option('exclude-common-ancestry',
2283
 
                   help='Display only the revisions that are not part'
2284
 
                   ' of both ancestries (require -rX..Y)'
2285
 
                   )
2286
2260
            ]
2287
2261
    encoding_type = 'replace'
2288
2262
 
2298
2272
            message=None,
2299
2273
            limit=None,
2300
2274
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
 
2275
            include_merges=False):
2304
2276
        from bzrlib.log import (
2305
2277
            Logger,
2306
2278
            make_log_request_dict,
2307
2279
            _get_info_for_log_files,
2308
2280
            )
2309
2281
        direction = (forward and 'forward') or 'reverse'
2310
 
        if (exclude_common_ancestry
2311
 
            and (revision is None or len(revision) != 2)):
2312
 
            raise errors.BzrCommandError(
2313
 
                '--exclude-common-ancestry requires -r with two revisions')
2314
2282
        if include_merges:
2315
2283
            if levels is None:
2316
2284
                levels = 0
2332
2300
        if file_list:
2333
2301
            # find the file ids to log and check for directory filtering
2334
2302
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
 
                revision, file_list, self.add_cleanup)
 
2303
                revision, file_list)
 
2304
            self.add_cleanup(b.unlock)
2336
2305
            for relpath, file_id, kind in file_info_list:
2337
2306
                if file_id is None:
2338
2307
                    raise errors.BzrCommandError(
2356
2325
                location = '.'
2357
2326
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2327
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
 
2328
            b.lock_read()
 
2329
            self.add_cleanup(b.unlock)
2360
2330
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
2331
 
2362
2332
        # Decide on the type of delta & diff filtering to use
2407
2377
            direction=direction, specific_fileids=file_ids,
2408
2378
            start_revision=rev1, end_revision=rev2, limit=limit,
2409
2379
            message_search=message, delta_type=delta_type,
2410
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
 
            exclude_common_ancestry=exclude_common_ancestry,
2412
 
            )
 
2380
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2413
2381
        Logger(b, rqst).show(lf)
2414
2382
 
2415
2383
 
2434
2402
            raise errors.BzrCommandError(
2435
2403
                "bzr %s doesn't accept two revisions in different"
2436
2404
                " branches." % command_name)
2437
 
        if start_spec.spec is None:
2438
 
            # Avoid loading all the history.
2439
 
            rev1 = RevisionInfo(branch, None, None)
2440
 
        else:
2441
 
            rev1 = start_spec.in_history(branch)
 
2405
        rev1 = start_spec.in_history(branch)
2442
2406
        # Avoid loading all of history when we know a missing
2443
2407
        # end of range means the last revision ...
2444
2408
        if end_spec.spec is None:
2473
2437
 
2474
2438
 
2475
2439
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2440
    """Return revision-ids which affected a particular file.
2477
2441
 
2478
2442
    A more user-friendly interface is "bzr log FILE".
2479
2443
    """
2486
2450
        tree, relpath = WorkingTree.open_containing(filename)
2487
2451
        file_id = tree.path2id(relpath)
2488
2452
        b = tree.branch
2489
 
        self.add_cleanup(b.lock_read().unlock)
 
2453
        b.lock_read()
 
2454
        self.add_cleanup(b.unlock)
2490
2455
        touching_revs = log.find_touching_revisions(b, file_id)
2491
2456
        for revno, revision_id, what in touching_revs:
2492
2457
            self.outf.write("%6d %s\n" % (revno, what))
2493
2458
 
2494
2459
 
2495
2460
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2461
    """List files in a tree.
2497
2462
    """
2498
2463
 
2499
2464
    _see_also = ['status', 'cat']
2561
2526
                view_str = views.view_display_str(view_files)
2562
2527
                note("Ignoring files outside view. View is %s" % view_str)
2563
2528
 
2564
 
        self.add_cleanup(tree.lock_read().unlock)
 
2529
        tree.lock_read()
 
2530
        self.add_cleanup(tree.unlock)
2565
2531
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
2532
            from_dir=relpath, recursive=recursive):
2567
2533
            # Apply additional masking
2609
2575
 
2610
2576
 
2611
2577
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2578
    """List unknown files.
2613
2579
    """
2614
2580
 
2615
2581
    hidden = True
2622
2588
 
2623
2589
 
2624
2590
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2591
    """Ignore specified files or patterns.
2626
2592
 
2627
2593
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2594
 
2636
2602
    After adding, editing or deleting that file either indirectly by
2637
2603
    using this command or directly by using an editor, be sure to commit
2638
2604
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
2605
 
2653
2606
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2607
    the shell on Unix.
2658
2611
 
2659
2612
            bzr ignore ./Makefile
2660
2613
 
2661
 
        Ignore .class files in all directories...::
 
2614
        Ignore class files in all directories...::
2662
2615
 
2663
2616
            bzr ignore "*.class"
2664
2617
 
2677
2630
        Ignore everything but the "debian" toplevel directory::
2678
2631
 
2679
2632
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2633
    """
2688
2634
 
2689
2635
    _see_also = ['status', 'ignored', 'patterns']
2690
2636
    takes_args = ['name_pattern*']
2691
2637
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2638
        Option('old-default-rules',
 
2639
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2640
        ]
2695
2641
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2642
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2643
        from bzrlib import ignores
2698
 
        if default_rules is not None:
2699
 
            # dump the default rules and exit
2700
 
            for pattern in ignores.USER_DEFAULTS:
2701
 
                self.outf.write("%s\n" % pattern)
 
2644
        if old_default_rules is not None:
 
2645
            # dump the rules and exit
 
2646
            for pattern in ignores.OLD_DEFAULTS:
 
2647
                print pattern
2702
2648
            return
2703
2649
        if not name_pattern_list:
2704
2650
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
 
2651
                                  "NAME_PATTERN or --old-default-rules")
2706
2652
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2653
                             for p in name_pattern_list]
2708
2654
        for name_pattern in name_pattern_list:
2720
2666
            if id is not None:
2721
2667
                filename = entry[0]
2722
2668
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2669
                    matches.append(filename.encode('utf-8'))
2724
2670
        tree.unlock()
2725
2671
        if len(matches) > 0:
2726
 
            self.outf.write("Warning: the following files are version controlled and"
2727
 
                  " match your ignore pattern:\n%s"
2728
 
                  "\nThese files will continue to be version controlled"
2729
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2672
            print "Warning: the following files are version controlled and" \
 
2673
                  " match your ignore pattern:\n%s" \
 
2674
                  "\nThese files will continue to be version controlled" \
 
2675
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2730
2676
 
2731
2677
 
2732
2678
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2679
    """List ignored files and the patterns that matched them.
2734
2680
 
2735
2681
    List all the ignored files and the ignore pattern that caused the file to
2736
2682
    be ignored.
2746
2692
    @display_command
2747
2693
    def run(self):
2748
2694
        tree = WorkingTree.open_containing(u'.')[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
 
2695
        tree.lock_read()
 
2696
        self.add_cleanup(tree.unlock)
2750
2697
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
2698
            if file_class != 'I':
2752
2699
                continue
2756
2703
 
2757
2704
 
2758
2705
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2706
    """Lookup the revision-id from a revision-number
2760
2707
 
2761
2708
    :Examples:
2762
2709
        bzr lookup-revision 33
2769
2716
        try:
2770
2717
            revno = int(revno)
2771
2718
        except ValueError:
2772
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
 
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2775
 
        self.outf.write("%s\n" % revid)
 
2719
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2720
 
 
2721
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
2722
 
2777
2723
 
2778
2724
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2725
    """Export current or past revision to a destination directory or archive.
2780
2726
 
2781
2727
    If no revision is specified this exports the last committed revision.
2782
2728
 
2814
2760
        Option('root',
2815
2761
               type=str,
2816
2762
               help="Name of the root directory inside the exported file."),
2817
 
        Option('per-file-timestamps',
2818
 
               help='Set modification time of files to that of the last '
2819
 
                    'revision in which it was changed.'),
2820
2763
        ]
2821
2764
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2765
        root=None, filters=False):
2823
2766
        from bzrlib.export import export
2824
2767
 
2825
2768
        if branch_or_subdir is None:
2832
2775
 
2833
2776
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2834
2777
        try:
2835
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
 
                   per_file_timestamps=per_file_timestamps)
 
2778
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2837
2779
        except errors.NoSuchExportFormat, e:
2838
2780
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
2781
 
2840
2782
 
2841
2783
class cmd_cat(Command):
2842
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2784
    """Write the contents of a file as of a given revision to standard output.
2843
2785
 
2844
2786
    If no revision is nominated, the last revision is used.
2845
2787
 
2865
2807
                                         " one revision specifier")
2866
2808
        tree, branch, relpath = \
2867
2809
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
 
        self.add_cleanup(branch.lock_read().unlock)
 
2810
        branch.lock_read()
 
2811
        self.add_cleanup(branch.unlock)
2869
2812
        return self._run(tree, branch, relpath, filename, revision,
2870
2813
                         name_from_revision, filters)
2871
2814
 
2874
2817
        if tree is None:
2875
2818
            tree = b.basis_tree()
2876
2819
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2878
2820
 
2879
2821
        old_file_id = rev_tree.path2id(relpath)
2880
2822
 
2915
2857
            chunks = content.splitlines(True)
2916
2858
            content = filtered_output_bytes(chunks, filters,
2917
2859
                ContentFilterContext(relpath, rev_tree))
2918
 
            self.cleanup_now()
2919
2860
            self.outf.writelines(content)
2920
2861
        else:
2921
 
            self.cleanup_now()
2922
2862
            self.outf.write(content)
2923
2863
 
2924
2864
 
2925
2865
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2866
    """Show the offset in seconds from GMT to local time."""
2927
2867
    hidden = True
2928
2868
    @display_command
2929
2869
    def run(self):
2930
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2870
        print osutils.local_time_offset()
2931
2871
 
2932
2872
 
2933
2873
 
2934
2874
class cmd_commit(Command):
2935
 
    __doc__ = """Commit changes into a new revision.
 
2875
    """Commit changes into a new revision.
2936
2876
 
2937
2877
    An explanatory message needs to be given for each commit. This is
2938
2878
    often done by using the --message option (getting the message from the
3046
2986
                         "the master branch until a normal commit "
3047
2987
                         "is performed."
3048
2988
                    ),
3049
 
             Option('show-diff', short_name='p',
 
2989
             Option('show-diff',
3050
2990
                    help='When no message is supplied, show the diff along'
3051
2991
                    ' with the status summary in the message editor.'),
3052
2992
             ]
3132
3072
                    '(use --file "%(f)s" to take commit message from that file)'
3133
3073
                    % { 'f': message })
3134
3074
                ui.ui_factory.show_warning(warning_msg)
3135
 
            if '\r' in message:
3136
 
                message = message.replace('\r\n', '\n')
3137
 
                message = message.replace('\r', '\n')
3138
 
            if file:
3139
 
                raise errors.BzrCommandError(
3140
 
                    "please specify either --message or --file")
3141
3075
 
3142
3076
        def get_message(commit_obj):
3143
3077
            """Callback to get commit message"""
3144
 
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
3147
 
            elif message is not None:
3148
 
                my_message = message
3149
 
            else:
3150
 
                # No message supplied: make one up.
3151
 
                # text is the status of the tree
3152
 
                text = make_commit_message_template_encoded(tree,
 
3078
            my_message = message
 
3079
            if my_message is not None and '\r' in my_message:
 
3080
                my_message = my_message.replace('\r\n', '\n')
 
3081
                my_message = my_message.replace('\r', '\n')
 
3082
            if my_message is None and not file:
 
3083
                t = make_commit_message_template_encoded(tree,
3153
3084
                        selected_list, diff=show_diff,
3154
3085
                        output_encoding=osutils.get_user_encoding())
3155
 
                # start_message is the template generated from hooks
3156
 
                # XXX: Warning - looks like hooks return unicode,
3157
 
                # make_commit_message_template_encoded returns user encoding.
3158
 
                # We probably want to be using edit_commit_message instead to
3159
 
                # avoid this.
3160
3086
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
3087
                my_message = edit_commit_message_encoded(t,
3162
3088
                    start_message=start_message)
3163
3089
                if my_message is None:
3164
3090
                    raise errors.BzrCommandError("please specify a commit"
3165
3091
                        " message with either --message or --file")
 
3092
            elif my_message and file:
 
3093
                raise errors.BzrCommandError(
 
3094
                    "please specify either --message or --file")
 
3095
            if file:
 
3096
                my_message = codecs.open(file, 'rt',
 
3097
                                         osutils.get_user_encoding()).read()
3166
3098
            if my_message == "":
3167
3099
                raise errors.BzrCommandError("empty commit message specified")
3168
3100
            return my_message
3180
3112
                        timezone=offset,
3181
3113
                        exclude=safe_relpath_files(tree, exclude))
3182
3114
        except PointlessCommit:
 
3115
            # FIXME: This should really happen before the file is read in;
 
3116
            # perhaps prepare the commit; get the message; then actually commit
3183
3117
            raise errors.BzrCommandError("No changes to commit."
3184
3118
                              " Use --unchanged to commit anyhow.")
3185
3119
        except ConflictsInTree:
3190
3124
            raise errors.BzrCommandError("Commit refused because there are"
3191
3125
                              " unknown files in the working tree.")
3192
3126
        except errors.BoundBranchOutOfDate, e:
3193
 
            e.extra_help = ("\n"
3194
 
                'To commit to master branch, run update and then commit.\n'
3195
 
                'You can also pass --local to commit to continue working '
3196
 
                'disconnected.')
3197
 
            raise
 
3127
            raise errors.BzrCommandError(str(e) + "\n"
 
3128
            'To commit to master branch, run update and then commit.\n'
 
3129
            'You can also pass --local to commit to continue working '
 
3130
            'disconnected.')
3198
3131
 
3199
3132
 
3200
3133
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3134
    """Validate working tree structure, branch consistency and repository history.
3202
3135
 
3203
3136
    This command checks various invariants about branch and repository storage
3204
3137
    to detect data corruption or bzr bugs.
3268
3201
 
3269
3202
 
3270
3203
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
3204
    """Upgrade branch storage to current format.
3272
3205
 
3273
3206
    The check command or bzr developers may sometimes advise you to run
3274
3207
    this command. When the default format has changed you may also be warned
3292
3225
 
3293
3226
 
3294
3227
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
 
3228
    """Show or set bzr user id.
3296
3229
 
3297
3230
    :Examples:
3298
3231
        Show the email of the current user::
3342
3275
 
3343
3276
 
3344
3277
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
3278
    """Print or set the branch nickname.
3346
3279
 
3347
3280
    If unset, the tree root directory name is used as the nickname.
3348
3281
    To print the current nickname, execute with no argument.
3362
3295
 
3363
3296
    @display_command
3364
3297
    def printme(self, branch):
3365
 
        self.outf.write('%s\n' % branch.nick)
 
3298
        print branch.nick
3366
3299
 
3367
3300
 
3368
3301
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
3302
    """Set/unset and display aliases.
3370
3303
 
3371
3304
    :Examples:
3372
3305
        Show the current aliases::
3436
3369
 
3437
3370
 
3438
3371
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
 
3372
    """Run internal test suite.
3440
3373
 
3441
3374
    If arguments are given, they are regular expressions that say which tests
3442
3375
    should run.  Tests matching any expression are run, and other tests are
3486
3419
    def get_transport_type(typestring):
3487
3420
        """Parse and return a transport specifier."""
3488
3421
        if typestring == "sftp":
3489
 
            from bzrlib.tests import stub_sftp
3490
 
            return stub_sftp.SFTPAbsoluteServer
 
3422
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3423
            return SFTPAbsoluteServer
3491
3424
        if typestring == "memory":
3492
 
            from bzrlib.tests import test_server
3493
 
            return memory.MemoryServer
 
3425
            from bzrlib.transport.memory import MemoryServer
 
3426
            return MemoryServer
3494
3427
        if typestring == "fakenfs":
3495
 
            from bzrlib.tests import test_server
3496
 
            return test_server.FakeNFSServer
 
3428
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3429
            return FakeNFSServer
3497
3430
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
3431
            (typestring)
3499
3432
        raise errors.BzrCommandError(msg)
3583
3516
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3517
                    "needs to be installed to use --subunit.")
3585
3518
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
 
                import msvcrt
3590
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
3519
        if parallel:
3592
3520
            self.additional_selftest_args.setdefault(
3593
3521
                'suite_decorators', []).append(parallel)
3624
3552
 
3625
3553
 
3626
3554
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3555
    """Show version of bzr."""
3628
3556
 
3629
3557
    encoding_type = 'replace'
3630
3558
    takes_options = [
3641
3569
 
3642
3570
 
3643
3571
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3572
    """Statement of optimism."""
3645
3573
 
3646
3574
    hidden = True
3647
3575
 
3648
3576
    @display_command
3649
3577
    def run(self):
3650
 
        self.outf.write("It sure does!\n")
 
3578
        print "It sure does!"
3651
3579
 
3652
3580
 
3653
3581
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3582
    """Find and print a base revision for merging two branches."""
3655
3583
    # TODO: Options to specify revisions on either side, as if
3656
3584
    #       merging only part of the history.
3657
3585
    takes_args = ['branch', 'other']
3663
3591
 
3664
3592
        branch1 = Branch.open_containing(branch)[0]
3665
3593
        branch2 = Branch.open_containing(other)[0]
3666
 
        self.add_cleanup(branch1.lock_read().unlock)
3667
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3594
        branch1.lock_read()
 
3595
        self.add_cleanup(branch1.unlock)
 
3596
        branch2.lock_read()
 
3597
        self.add_cleanup(branch2.unlock)
3668
3598
        last1 = ensure_null(branch1.last_revision())
3669
3599
        last2 = ensure_null(branch2.last_revision())
3670
3600
 
3671
3601
        graph = branch1.repository.get_graph(branch2.repository)
3672
3602
        base_rev_id = graph.find_unique_lca(last1, last2)
3673
3603
 
3674
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3604
        print 'merge base is revision %s' % base_rev_id
3675
3605
 
3676
3606
 
3677
3607
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
 
3608
    """Perform a three-way merge.
3679
3609
 
3680
3610
    The source of the merge can be specified either in the form of a branch,
3681
3611
    or in the form of a path to a file containing a merge directive generated
3710
3640
    committed to record the result of the merge.
3711
3641
 
3712
3642
    merge refuses to run if there are any uncommitted changes, unless
3713
 
    --force is given. The --force option can also be used to create a
3714
 
    merge revision which has more than two parents.
3715
 
 
3716
 
    If one would like to merge changes from the working tree of the other
3717
 
    branch without merging any committed revisions, the --uncommitted option
3718
 
    can be given.
 
3643
    --force is given.
3719
3644
 
3720
3645
    To select only some changes to merge, use "merge -i", which will prompt
3721
3646
    you to apply each diff hunk and file change, similar to "shelve".
3736
3661
        To apply a merge directive contained in /tmp/merge::
3737
3662
 
3738
3663
            bzr merge /tmp/merge
3739
 
 
3740
 
        To create a merge revision with three parents from two branches
3741
 
        feature1a and feature1b:
3742
 
 
3743
 
            bzr merge ../feature1a
3744
 
            bzr merge ../feature1b --force
3745
 
            bzr commit -m 'revision with three parents'
3746
3664
    """
3747
3665
 
3748
3666
    encoding_type = 'exact'
3808
3726
            unversioned_filter=tree.is_ignored, view_info=view_info)
3809
3727
        pb = ui.ui_factory.nested_progress_bar()
3810
3728
        self.add_cleanup(pb.finished)
3811
 
        self.add_cleanup(tree.lock_write().unlock)
 
3729
        tree.lock_write()
 
3730
        self.add_cleanup(tree.unlock)
3812
3731
        if location is not None:
3813
3732
            try:
3814
3733
                mergeable = bundle.read_mergeable_from_url(location,
3824
3743
                    raise errors.BzrCommandError(
3825
3744
                        'Cannot use -r with merge directives or bundles')
3826
3745
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3827
 
                   mergeable, None)
 
3746
                   mergeable, pb)
3828
3747
 
3829
3748
        if merger is None and uncommitted:
3830
3749
            if revision is not None and len(revision) > 0:
3831
3750
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3832
3751
                    ' --revision at the same time.')
3833
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3752
            merger = self.get_merger_from_uncommitted(tree, location, pb)
3834
3753
            allow_pending = False
3835
3754
 
3836
3755
        if merger is None:
3837
3756
            merger, allow_pending = self._get_merger_from_branch(tree,
3838
 
                location, revision, remember, possible_transports, None)
 
3757
                location, revision, remember, possible_transports, pb)
3839
3758
 
3840
3759
        merger.merge_type = merge_type
3841
3760
        merger.reprocess = reprocess
4035
3954
 
4036
3955
 
4037
3956
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3957
    """Redo a merge.
4039
3958
 
4040
3959
    Use this if you want to try a different merge technique while resolving
4041
3960
    conflicts.  Some merge techniques are better than others, and remerge
4066
3985
 
4067
3986
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3987
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3988
        if merge_type is None:
4071
3989
            merge_type = _mod_merge.Merge3Merger
4072
3990
        tree, file_list = tree_files(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
 
3991
        tree.lock_write()
 
3992
        self.add_cleanup(tree.unlock)
4074
3993
        parents = tree.get_parent_ids()
4075
3994
        if len(parents) != 2:
4076
3995
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4112
4031
        # list, we imply that the working tree text has seen and rejected
4113
4032
        # all the changes from the other tree, when in fact those changes
4114
4033
        # have not yet been seen.
 
4034
        pb = ui.ui_factory.nested_progress_bar()
4115
4035
        tree.set_parent_ids(parents[:1])
4116
4036
        try:
4117
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4037
            merger = _mod_merge.Merger.from_revision_ids(pb,
 
4038
                                                         tree, parents[1])
4118
4039
            merger.interesting_ids = interesting_ids
4119
4040
            merger.merge_type = merge_type
4120
4041
            merger.show_base = show_base
4122
4043
            conflicts = merger.do_merge()
4123
4044
        finally:
4124
4045
            tree.set_parent_ids(parents)
 
4046
            pb.finished()
4125
4047
        if conflicts > 0:
4126
4048
            return 1
4127
4049
        else:
4129
4051
 
4130
4052
 
4131
4053
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
4054
    """Revert files to a previous revision.
4133
4055
 
4134
4056
    Giving a list of files will revert only those files.  Otherwise, all files
4135
4057
    will be reverted.  If the revision is not specified with '--revision', the
4154
4076
    created as above.  Directories containing unknown files will not be
4155
4077
    deleted.
4156
4078
 
4157
 
    The working tree contains a list of revisions that have been merged but
4158
 
    not yet committed. These revisions will be included as additional parents
4159
 
    of the next commit.  Normally, using revert clears that list as well as
4160
 
    reverting the files.  If any files are specified, revert leaves the list
4161
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4162
 
    .`` in the tree root to revert all files but keep the recorded merges,
4163
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4079
    The working tree contains a list of pending merged revisions, which will
 
4080
    be included as parents in the next commit.  Normally, revert clears that
 
4081
    list as well as reverting the files.  If any files are specified, revert
 
4082
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4083
    revert ." in the tree root to revert all files but keep the merge record,
 
4084
    and "bzr revert --forget-merges" to clear the pending merge list without
4164
4085
    reverting any files.
4165
4086
 
4166
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4167
 
    changes from a branch in a single revision.  To do this, perform the merge
4168
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4169
 
    the content of the tree as it was, but it will clear the list of pending
4170
 
    merges.  The next commit will then contain all of the changes that are
4171
 
    present in the other branch, but without any other parent revisions.
4172
 
    Because this technique forgets where these changes originated, it may
4173
 
    cause additional conflicts on later merges involving the same source and
 
4087
    Using "bzr revert --forget-merges", it is possible to apply the changes
 
4088
    from an arbitrary merge as a single revision.  To do this, perform the
 
4089
    merge as desired.  Then doing revert with the "--forget-merges" option will
 
4090
    keep the content of the tree as it was, but it will clear the list of
 
4091
    pending merges.  The next commit will then contain all of the changes that
 
4092
    would have been in the merge, but without any mention of the other parent
 
4093
    revisions.  Because this technique forgets where these changes originated,
 
4094
    it may cause additional conflicts on later merges involving the source and
4174
4095
    target branches.
4175
4096
    """
4176
4097
 
4186
4107
    def run(self, revision=None, no_backup=False, file_list=None,
4187
4108
            forget_merges=None):
4188
4109
        tree, file_list = tree_files(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4110
        tree.lock_write()
 
4111
        self.add_cleanup(tree.unlock)
4190
4112
        if forget_merges:
4191
4113
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
4114
        else:
4195
4117
    @staticmethod
4196
4118
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
4119
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4199
 
            report_changes=True)
 
4120
        pb = ui.ui_factory.nested_progress_bar()
 
4121
        try:
 
4122
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4123
                report_changes=True)
 
4124
        finally:
 
4125
            pb.finished()
4200
4126
 
4201
4127
 
4202
4128
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
4129
    """Test reporting of assertion failures"""
4204
4130
    # intended just for use in testing
4205
4131
 
4206
4132
    hidden = True
4210
4136
 
4211
4137
 
4212
4138
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
4139
    """Show help on a command or other topic.
4214
4140
    """
4215
4141
 
4216
4142
    _see_also = ['topics']
4229
4155
 
4230
4156
 
4231
4157
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
4158
    """Show appropriate completions for context.
4233
4159
 
4234
4160
    For a list of all available commands, say 'bzr shell-complete'.
4235
4161
    """
4244
4170
 
4245
4171
 
4246
4172
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4173
    """Show unmerged/unpulled revisions between two branches.
4248
4174
 
4249
4175
    OTHER_BRANCH may be local or remote.
4250
4176
 
4328
4254
            restrict = 'remote'
4329
4255
 
4330
4256
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
4257
        parent = local_branch.get_parent()
4334
4258
        if other_branch is None:
4335
4259
            other_branch = parent
4344
4268
        remote_branch = Branch.open(other_branch)
4345
4269
        if remote_branch.base == local_branch.base:
4346
4270
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
4271
 
 
4272
        local_branch.lock_read()
 
4273
        self.add_cleanup(local_branch.unlock)
4350
4274
        local_revid_range = _revision_range_to_revid_range(
4351
4275
            _get_revision_range(my_revision, local_branch,
4352
4276
                self.name()))
4353
4277
 
 
4278
        remote_branch.lock_read()
 
4279
        self.add_cleanup(remote_branch.unlock)
4354
4280
        remote_revid_range = _revision_range_to_revid_range(
4355
4281
            _get_revision_range(revision,
4356
4282
                remote_branch, self.name()))
4406
4332
            message("Branches are up to date.\n")
4407
4333
        self.cleanup_now()
4408
4334
        if not status_code and parent is None and other_branch is not None:
4409
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4335
            local_branch.lock_write()
 
4336
            self.add_cleanup(local_branch.unlock)
4410
4337
            # handle race conditions - a parent might be set while we run.
4411
4338
            if local_branch.get_parent() is None:
4412
4339
                local_branch.set_parent(remote_branch.base)
4414
4341
 
4415
4342
 
4416
4343
class cmd_pack(Command):
4417
 
    __doc__ = """Compress the data within a repository.
4418
 
 
4419
 
    This operation compresses the data within a bazaar repository. As
4420
 
    bazaar supports automatic packing of repository, this operation is
4421
 
    normally not required to be done manually.
4422
 
 
4423
 
    During the pack operation, bazaar takes a backup of existing repository
4424
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4425
 
    automatically when it is safe to do so. To save disk space by removing
4426
 
    the backed up pack files, the --clean-obsolete-packs option may be
4427
 
    used.
4428
 
 
4429
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4430
 
    during or immediately after repacking, you may be left with a state
4431
 
    where the deletion has been written to disk but the new packs have not
4432
 
    been. In this case the repository may be unusable.
4433
 
    """
 
4344
    """Compress the data within a repository."""
4434
4345
 
4435
4346
    _see_also = ['repositories']
4436
4347
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
4348
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4349
    def run(self, branch_or_repo='.'):
4442
4350
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
4351
        try:
4444
4352
            branch = dir.open_branch()
4445
4353
            repository = branch.repository
4446
4354
        except errors.NotBranchError:
4447
4355
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4356
        repository.pack()
4449
4357
 
4450
4358
 
4451
4359
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
 
4360
    """List the installed plugins.
4453
4361
 
4454
4362
    This command displays the list of installed plugins including
4455
4363
    version of plugin and a short description of each.
4462
4370
    adding new commands, providing additional network transports and
4463
4371
    customizing log output.
4464
4372
 
4465
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4466
 
    for further information on plugins including where to find them and how to
4467
 
    install them. Instructions are also provided there on how to write new
4468
 
    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.
4469
4377
    """
4470
4378
    takes_options = ['verbose']
4471
4379
 
4486
4394
                doc = '(no description)'
4487
4395
            result.append((name_ver, doc, plugin.path()))
4488
4396
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
 
4397
            print name_ver
 
4398
            print '   ', doc
4491
4399
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
4400
                print '   ', path
 
4401
            print
4494
4402
 
4495
4403
 
4496
4404
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4405
    """Show testament (signing-form) of a revision."""
4498
4406
    takes_options = [
4499
4407
            'revision',
4500
4408
            Option('long', help='Produce long-format testament.'),
4512
4420
            b = Branch.open_containing(branch)[0]
4513
4421
        else:
4514
4422
            b = Branch.open(branch)
4515
 
        self.add_cleanup(b.lock_read().unlock)
 
4423
        b.lock_read()
 
4424
        self.add_cleanup(b.unlock)
4516
4425
        if revision is None:
4517
4426
            rev_id = b.last_revision()
4518
4427
        else:
4525
4434
 
4526
4435
 
4527
4436
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4437
    """Show the origin of each line in a file.
4529
4438
 
4530
4439
    This prints out the given file with an annotation on the left side
4531
4440
    indicating which revision, author and date introduced the change.
4552
4461
        wt, branch, relpath = \
4553
4462
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4463
        if wt is not None:
4555
 
            self.add_cleanup(wt.lock_read().unlock)
 
4464
            wt.lock_read()
 
4465
            self.add_cleanup(wt.unlock)
4556
4466
        else:
4557
 
            self.add_cleanup(branch.lock_read().unlock)
 
4467
            branch.lock_read()
 
4468
            self.add_cleanup(branch.unlock)
4558
4469
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
 
        self.add_cleanup(tree.lock_read().unlock)
 
4470
        tree.lock_read()
 
4471
        self.add_cleanup(tree.unlock)
4560
4472
        if wt is not None:
4561
4473
            file_id = wt.path2id(relpath)
4562
4474
        else:
4575
4487
 
4576
4488
 
4577
4489
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4490
    """Create a digital signature for an existing revision."""
4579
4491
    # TODO be able to replace existing ones.
4580
4492
 
4581
4493
    hidden = True # is this right ?
4588
4500
        if revision_id_list is None and revision is None:
4589
4501
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4502
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
 
4503
        b.lock_write()
 
4504
        self.add_cleanup(b.unlock)
4592
4505
        return self._run(b, revision_id_list, revision)
4593
4506
 
4594
4507
    def _run(self, b, revision_id_list, revision):
4640
4553
 
4641
4554
 
4642
4555
class cmd_bind(Command):
4643
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
 
    If no branch is supplied, rebind to the last bound location.
 
4556
    """Convert the current branch into a checkout of the supplied branch.
4645
4557
 
4646
4558
    Once converted into a checkout, commits must succeed on the master branch
4647
4559
    before they will be applied to the local branch.
4665
4577
                    'This format does not remember old locations.')
4666
4578
            else:
4667
4579
                if location is None:
4668
 
                    if b.get_bound_location() is not None:
4669
 
                        raise errors.BzrCommandError('Branch is already bound')
4670
 
                    else:
4671
 
                        raise errors.BzrCommandError('No location supplied '
4672
 
                            'and no previous location known')
 
4580
                    raise errors.BzrCommandError('No location supplied and no '
 
4581
                        'previous location known')
4673
4582
        b_other = Branch.open(location)
4674
4583
        try:
4675
4584
            b.bind(b_other)
4681
4590
 
4682
4591
 
4683
4592
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4593
    """Convert the current checkout into a regular branch.
4685
4594
 
4686
4595
    After unbinding, the local branch is considered independent and subsequent
4687
4596
    commits will be local only.
4698
4607
 
4699
4608
 
4700
4609
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4610
    """Remove the last committed revision.
4702
4611
 
4703
4612
    --verbose will print out what is being removed.
4704
4613
    --dry-run will go through all the motions, but not actually
4744
4653
            b = control.open_branch()
4745
4654
 
4746
4655
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4656
            tree.lock_write()
 
4657
            self.add_cleanup(tree.unlock)
4748
4658
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
 
4659
            b.lock_write()
 
4660
            self.add_cleanup(b.unlock)
4750
4661
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4751
4662
 
4752
4663
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4785
4696
                 end_revision=last_revno)
4786
4697
 
4787
4698
        if dry_run:
4788
 
            self.outf.write('Dry-run, pretending to remove'
4789
 
                            ' 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')
4790
4702
        else:
4791
 
            self.outf.write('The above revision(s) will be removed.\n')
4792
 
 
4793
 
        if not force:
4794
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4795
 
                self.outf.write('Canceled')
4796
 
                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
4797
4709
 
4798
4710
        mutter('Uncommitting from {%s} to {%s}',
4799
4711
               last_rev_id, rev_id)
4800
4712
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
4713
                 revno=revno, local=local)
4802
 
        self.outf.write('You can restore the old tip by running:\n'
4803
 
             '  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)
4804
4716
 
4805
4717
 
4806
4718
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4719
    """Break a dead lock on a repository, branch or working directory.
4808
4720
 
4809
4721
    CAUTION: Locks should only be broken when you are sure that the process
4810
4722
    holding the lock has been stopped.
4811
4723
 
4812
 
    You can get information on what locks are open via the 'bzr info
4813
 
    [location]' command.
 
4724
    You can get information on what locks are open via the 'bzr info' command.
4814
4725
 
4815
4726
    :Examples:
4816
4727
        bzr break-lock
4817
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4818
4728
    """
4819
4729
    takes_args = ['location?']
4820
4730
 
4829
4739
 
4830
4740
 
4831
4741
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4742
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4743
 
4834
4744
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4745
    """
4843
4753
 
4844
4754
 
4845
4755
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4756
    """Run the bzr server."""
4847
4757
 
4848
4758
    aliases = ['server']
4849
4759
 
4909
4819
 
4910
4820
 
4911
4821
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
 
4822
    """Combine a tree into its containing tree.
4913
4823
 
4914
4824
    This command requires the target tree to be in a rich-root format.
4915
4825
 
4955
4865
 
4956
4866
 
4957
4867
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4868
    """Split a subdirectory of a tree into a separate tree.
4959
4869
 
4960
4870
    This command will produce a target tree in a format that supports
4961
4871
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4981
4891
 
4982
4892
 
4983
4893
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4894
    """Generate a merge directive for auto-merge tools.
4985
4895
 
4986
4896
    A directive requests a merge to be performed, and also provides all the
4987
4897
    information necessary to do so.  This means it must either include a
5080
4990
 
5081
4991
 
5082
4992
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4993
    """Mail or create a merge-directive for submitting changes.
5084
4994
 
5085
4995
    A merge directive provides many things needed for requesting merges:
5086
4996
 
5092
5002
      directly from the merge directive, without retrieving data from a
5093
5003
      branch.
5094
5004
 
5095
 
    `bzr send` creates a compact data set that, when applied using bzr
5096
 
    merge, has the same effect as merging from the source branch.  
5097
 
    
5098
 
    By default the merge directive is self-contained and can be applied to any
5099
 
    branch containing submit_branch in its ancestory without needing access to
5100
 
    the source branch.
5101
 
    
5102
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5103
 
    revisions, but only a structured request to merge from the
5104
 
    public_location.  In that case the public_branch is needed and it must be
5105
 
    up-to-date and accessible to the recipient.  The public_branch is always
5106
 
    included if known, so that people can check it later.
5107
 
 
5108
 
    The submit branch defaults to the parent of the source branch, but can be
5109
 
    overridden.  Both submit branch and public branch will be remembered in
5110
 
    branch.conf the first time they are used for a particular branch.  The
5111
 
    source branch defaults to that containing the working directory, but can
5112
 
    be changed using --from.
5113
 
 
5114
 
    In order to calculate those changes, bzr must analyse the submit branch.
5115
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5116
 
    If a public location is known for the submit_branch, that location is used
5117
 
    in the merge directive.
5118
 
 
5119
 
    The default behaviour is to send the merge directive by mail, unless -o is
5120
 
    given, in which case it is sent to a file.
 
5005
    If --no-bundle is specified, then public_branch is needed (and must be
 
5006
    up-to-date), so that the receiver can perform the merge using the
 
5007
    public_branch.  The public_branch is always included if known, so that
 
5008
    people can check it later.
 
5009
 
 
5010
    The submit branch defaults to the parent, but can be overridden.  Both
 
5011
    submit branch and public branch will be remembered if supplied.
 
5012
 
 
5013
    If a public_branch is known for the submit_branch, that public submit
 
5014
    branch is used in the merge instructions.  This means that a local mirror
 
5015
    can be used as your actual submit branch, once you have set public_branch
 
5016
    for that mirror.
5121
5017
 
5122
5018
    Mail is sent using your preferred mail program.  This should be transparent
5123
5019
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5143
5039
 
5144
5040
    The merge directives created by bzr send may be applied using bzr merge or
5145
5041
    bzr pull by specifying a file containing a merge directive as the location.
5146
 
 
5147
 
    bzr send makes extensive use of public locations to map local locations into
5148
 
    URLs that can be used by other people.  See `bzr help configuration` to
5149
 
    set them, and use `bzr info` to display them.
5150
5042
    """
5151
5043
 
5152
5044
    encoding_type = 'exact'
5168
5060
               short_name='f',
5169
5061
               type=unicode),
5170
5062
        Option('output', short_name='o',
5171
 
               help='Write merge directive to this file or directory; '
 
5063
               help='Write merge directive to this file; '
5172
5064
                    'use - for stdout.',
5173
5065
               type=unicode),
5174
5066
        Option('strict',
5197
5089
 
5198
5090
 
5199
5091
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5092
    """Create a merge-directive for submitting changes.
5201
5093
 
5202
5094
    A merge directive provides many things needed for requesting merges:
5203
5095
 
5270
5162
 
5271
5163
 
5272
5164
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5165
    """Create, remove or modify a tag naming a revision.
5274
5166
 
5275
5167
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
5168
    (--revision) option can be given -rtag:X, where X is any previously
5284
5176
 
5285
5177
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
5178
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
 
 
5288
 
    If no tag name is specified it will be determined through the 
5289
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5290
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5291
 
    details.
5292
5179
    """
5293
5180
 
5294
5181
    _see_also = ['commit', 'tags']
5295
 
    takes_args = ['tag_name?']
 
5182
    takes_args = ['tag_name']
5296
5183
    takes_options = [
5297
5184
        Option('delete',
5298
5185
            help='Delete this tag rather than placing it.',
5308
5195
        'revision',
5309
5196
        ]
5310
5197
 
5311
 
    def run(self, tag_name=None,
 
5198
    def run(self, tag_name,
5312
5199
            delete=None,
5313
5200
            directory='.',
5314
5201
            force=None,
5315
5202
            revision=None,
5316
5203
            ):
5317
5204
        branch, relpath = Branch.open_containing(directory)
5318
 
        self.add_cleanup(branch.lock_write().unlock)
 
5205
        branch.lock_write()
 
5206
        self.add_cleanup(branch.unlock)
5319
5207
        if delete:
5320
 
            if tag_name is None:
5321
 
                raise errors.BzrCommandError("No tag specified to delete.")
5322
5208
            branch.tags.delete_tag(tag_name)
5323
5209
            self.outf.write('Deleted tag %s.\n' % tag_name)
5324
5210
        else:
5330
5216
                revision_id = revision[0].as_revision_id(branch)
5331
5217
            else:
5332
5218
                revision_id = branch.last_revision()
5333
 
            if tag_name is None:
5334
 
                tag_name = branch.automatic_tag_name(revision_id)
5335
 
                if tag_name is None:
5336
 
                    raise errors.BzrCommandError(
5337
 
                        "Please specify a tag name.")
5338
5219
            if (not force) and branch.tags.has_tag(tag_name):
5339
5220
                raise errors.TagAlreadyExists(tag_name)
5340
5221
            branch.tags.set_tag(tag_name, revision_id)
5342
5223
 
5343
5224
 
5344
5225
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
5226
    """List tags.
5346
5227
 
5347
5228
    This command shows a table of tag names and the revisions they reference.
5348
5229
    """
5376
5257
        if not tags:
5377
5258
            return
5378
5259
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
 
5260
        branch.lock_read()
 
5261
        self.add_cleanup(branch.unlock)
5380
5262
        if revision:
5381
5263
            graph = branch.repository.get_graph()
5382
5264
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5415
5297
 
5416
5298
 
5417
5299
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5300
    """Reconfigure the type of a bzr directory.
5419
5301
 
5420
5302
    A target configuration must be specified.
5421
5303
 
5506
5388
 
5507
5389
 
5508
5390
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5391
    """Set the branch of a checkout and update.
5510
5392
 
5511
5393
    For lightweight checkouts, this changes the branch being referenced.
5512
5394
    For heavyweight checkouts, this checks that there are no local commits
5528
5410
    that of the master.
5529
5411
    """
5530
5412
 
5531
 
    takes_args = ['to_location?']
 
5413
    takes_args = ['to_location']
5532
5414
    takes_options = [Option('force',
5533
5415
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
5416
                     Option('create-branch', short_name='b',
5536
5417
                        help='Create the target branch from this one before'
5537
5418
                             ' switching to it.'),
5538
 
                    ]
 
5419
                     ]
5539
5420
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5421
    def run(self, to_location, force=False, create_branch=False):
5542
5422
        from bzrlib import switch
5543
5423
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5424
        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
5425
        try:
5552
5426
            branch = control_dir.open_branch()
5553
5427
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5567
5441
            to_branch = branch.bzrdir.sprout(to_location,
5568
5442
                                 possible_transports=[branch.bzrdir.root_transport],
5569
5443
                                 source_branch=branch).open_branch()
 
5444
            # try:
 
5445
            #     from_branch = control_dir.open_branch()
 
5446
            # except errors.NotBranchError:
 
5447
            #     raise BzrCommandError('Cannot create a branch from this'
 
5448
            #         ' location when we cannot open this branch')
 
5449
            # from_branch.bzrdir.sprout(
 
5450
            pass
5570
5451
        else:
5571
5452
            try:
5572
5453
                to_branch = Branch.open(to_location)
5574
5455
                this_url = self._get_branch_location(control_dir)
5575
5456
                to_branch = Branch.open(
5576
5457
                    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)
 
5458
        switch.switch(control_dir, to_branch, force)
5580
5459
        if had_explicit_nick:
5581
5460
            branch = control_dir.open_branch() #get the new branch!
5582
5461
            branch.nick = to_branch.nick
5602
5481
 
5603
5482
 
5604
5483
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5484
    """Manage filtered views.
5606
5485
 
5607
5486
    Views provide a mask over the tree so that users can focus on
5608
5487
    a subset of a tree when doing their work. After creating a view,
5756
5635
 
5757
5636
 
5758
5637
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5638
    """Show hooks."""
5760
5639
 
5761
5640
    hidden = True
5762
5641
 
5775
5654
                    self.outf.write("    <no hooks installed>\n")
5776
5655
 
5777
5656
 
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
5657
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5658
    """Temporarily set aside some changes from the current tree.
5805
5659
 
5806
5660
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5661
    ie. out of the way, until a later time when you can bring them back from
5860
5714
 
5861
5715
    def run_for_list(self):
5862
5716
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
 
5717
        tree.lock_read()
 
5718
        self.add_cleanup(tree.unlock)
5864
5719
        manager = tree.get_shelf_manager()
5865
5720
        shelves = manager.active_shelves()
5866
5721
        if len(shelves) == 0:
5875
5730
 
5876
5731
 
5877
5732
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5733
    """Restore shelved changes.
5879
5734
 
5880
5735
    By default, the most recently shelved changes are restored. However if you
5881
5736
    specify a shelf by id those changes will be restored instead.  This works
5889
5744
            enum_switch=False, value_switches=True,
5890
5745
            apply="Apply changes and remove from the shelf.",
5891
5746
            dry_run="Show changes, but do not apply or remove them.",
5892
 
            preview="Instead of unshelving the changes, show the diff that "
5893
 
                    "would result from unshelving.",
5894
5747
            delete_only="Delete changes without applying them.",
5895
5748
            keep="Apply changes but don't delete them.",
5896
5749
        )
5907
5760
 
5908
5761
 
5909
5762
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5763
    """Remove unwanted files from working tree.
5911
5764
 
5912
5765
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5766
    files are never deleted.
5941
5794
 
5942
5795
 
5943
5796
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5797
    """list, view and set branch locations for nested trees.
5945
5798
 
5946
5799
    If no arguments are provided, lists the branch locations for nested trees.
5947
5800
    If one argument is provided, display the branch location for that tree.
5987
5840
            self.outf.write('%s %s\n' % (path, location))
5988
5841
 
5989
5842
 
5990
 
def _register_lazy_builtins():
5991
 
    # register lazy builtins from other modules; called at startup and should
5992
 
    # be only called once.
5993
 
    for (name, aliases, module_name) in [
5994
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
 
        ]:
6001
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5843
# these get imported and then picked up by the scan for cmd_*
 
5844
# TODO: Some more consistent way to split command definitions across files;
 
5845
# we do need to load at least some information about them to know of
 
5846
# aliases.  ideally we would avoid loading the implementation until the
 
5847
# details were needed.
 
5848
from bzrlib.cmd_version_info import cmd_version_info
 
5849
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5850
from bzrlib.bundle.commands import (
 
5851
    cmd_bundle_info,
 
5852
    )
 
5853
from bzrlib.foreign import cmd_dpush
 
5854
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5855
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5856
        cmd_weave_plan_merge, cmd_weave_merge_text