/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2009-12-16 13:52:52 UTC
  • mto: This revision was merged to the branch mainline in revision 4948.
  • Revision ID: andrew.bennetts@canonical.com-20091216135252-ly3roz5tcwaw2cq8
Replace lots of try/finally blocks in builtins.py with add_cleanup.  Reduces line count by 80, and removes lots of indentation levels too.

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
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
54
53
    )
55
54
from bzrlib.branch import Branch
56
55
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
56
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
57
from bzrlib.smtp_connection import SMTPConnection
60
58
from bzrlib.workingtree import WorkingTree
61
59
""")
62
60
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
61
from bzrlib.commands import Command, display_command
68
62
from bzrlib.option import (
69
63
    ListOption,
70
64
    Option,
239
233
# opens the branch?)
240
234
 
241
235
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
236
    """Display status summary.
243
237
 
244
238
    This reports on versioned and unknown files, reporting them
245
239
    grouped by state.  Possible states are:
332
326
 
333
327
 
334
328
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
329
    """Write out metadata for a revision.
336
330
 
337
331
    The revision to print can either be specified by a specific
338
332
    revision identifier, or you can use --revision.
344
338
    # cat-revision is more for frontends so should be exact
345
339
    encoding = 'strict'
346
340
 
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
341
    @display_command
356
342
    def run(self, revision_id=None, revision=None):
357
343
        if revision_id is not None and revision is not None:
362
348
                                         ' --revision or a revision_id')
363
349
        b = WorkingTree.open_containing(u'.')[0].branch
364
350
 
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')
 
351
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
352
        if revision_id is not None:
 
353
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
354
            try:
 
355
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
356
            except errors.NoSuchRevision:
 
357
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
358
                    revision_id)
 
359
                raise errors.BzrCommandError(msg)
 
360
        elif revision is not None:
 
361
            for rev in revision:
 
362
                if rev is None:
 
363
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
364
                                                 ' revision.')
 
365
                rev_id = rev.as_revision_id(b)
 
366
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
367
 
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
368
 
392
369
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
370
    """Dump the contents of a btree index file to stdout.
394
371
 
395
372
    PATH is a btree index file, it can be any URL. This includes things like
396
373
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
437
        for node in bt.iter_all_entries():
461
438
            # Node is made up of:
462
439
            # (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)
 
440
            refs_as_tuples = static_tuple.as_tuples(node[3])
469
441
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
442
            self.outf.write('%s\n' % (as_tuple,))
471
443
 
472
444
 
473
445
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
446
    """Remove the working tree from a given branch/checkout.
475
447
 
476
448
    Since a lightweight checkout is little more than a working tree
477
449
    this will refuse to run against one.
479
451
    To re-create the working tree, use "bzr checkout".
480
452
    """
481
453
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
454
    takes_args = ['location?']
483
455
    takes_options = [
484
456
        Option('force',
485
457
               help='Remove the working tree even if it has '
486
458
                    'uncommitted changes.'),
487
459
        ]
488
460
 
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()
 
461
    def run(self, location='.', force=False):
 
462
        d = bzrdir.BzrDir.open(location)
 
463
 
 
464
        try:
 
465
            working = d.open_workingtree()
 
466
        except errors.NoWorkingTree:
 
467
            raise errors.BzrCommandError("No working tree to remove")
 
468
        except errors.NotLocalUrl:
 
469
            raise errors.BzrCommandError("You cannot remove the working tree"
 
470
                                         " of a remote path")
 
471
        if not force:
 
472
            if (working.has_changes()):
 
473
                raise errors.UncommittedChanges(working)
 
474
 
 
475
        working_path = working.bzrdir.root_transport.base
 
476
        branch_path = working.branch.bzrdir.root_transport.base
 
477
        if working_path != branch_path:
 
478
            raise errors.BzrCommandError("You cannot remove the working tree"
 
479
                                         " from a lightweight checkout")
 
480
 
 
481
        d.destroy_workingtree()
512
482
 
513
483
 
514
484
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
485
    """Show current revision number.
516
486
 
517
487
    This is equal to the number of revisions on this branch.
518
488
    """
548
518
 
549
519
 
550
520
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
521
    """Show revision number and revision id for a given revision identifier.
552
522
    """
553
523
    hidden = True
554
524
    takes_args = ['revision_info*']
610
580
 
611
581
 
612
582
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
583
    """Add specified files or directories.
614
584
 
615
585
    In non-recursive mode, all the named items are added, regardless
616
586
    of whether they were previously ignored.  A warning is given if
696
666
 
697
667
 
698
668
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
669
    """Create a new versioned directory.
700
670
 
701
671
    This is equivalent to creating the directory and then adding it.
702
672
    """
706
676
 
707
677
    def run(self, dir_list):
708
678
        for d in dir_list:
 
679
            os.mkdir(d)
709
680
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
681
            wt.add([dd])
 
682
            self.outf.write('added %s\n' % d)
718
683
 
719
684
 
720
685
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
686
    """Show path of a file relative to root"""
722
687
 
723
688
    takes_args = ['filename']
724
689
    hidden = True
733
698
 
734
699
 
735
700
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
701
    """Show inventory of the current working copy or a revision.
737
702
 
738
703
    It is possible to limit the output to a particular entry
739
704
    type using the --kind option.  For example: --kind file.
794
759
 
795
760
 
796
761
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
762
    """Move or rename a file.
798
763
 
799
764
    :Usage:
800
765
        bzr mv OLDNAME NEWNAME
931
896
 
932
897
 
933
898
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
899
    """Turn this branch into a mirror of another branch.
935
900
 
936
901
    By default, this command only works on branches that have not diverged.
937
902
    Branches are considered diverged if the destination branch's most recent 
986
951
        try:
987
952
            tree_to = WorkingTree.open_containing(directory)[0]
988
953
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
954
        except errors.NoWorkingTree:
992
955
            tree_to = None
993
956
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
957
        
997
958
        if local and not branch_to.get_bound_location():
998
959
            raise errors.LocalRequiresBoundBranch()
999
960
 
1029
990
        else:
1030
991
            branch_from = Branch.open(location,
1031
992
                possible_transports=possible_transports)
 
993
 
 
994
            if branch_to.get_parent() is None or remember:
 
995
                branch_to.set_parent(branch_from.base)
 
996
 
 
997
        if branch_from is not branch_to:
1032
998
            branch_from.lock_read()
1033
999
            self.add_cleanup(branch_from.unlock)
1034
 
 
1035
 
            if branch_to.get_parent() is None or remember:
1036
 
                branch_to.set_parent(branch_from.base)
1037
 
 
1038
1000
        if revision is not None:
1039
1001
            revision_id = revision.as_revision_id(branch_from)
1040
1002
 
 
1003
        branch_to.lock_write()
 
1004
        self.add_cleanup(branch_to.unlock)
1041
1005
        if tree_to is not None:
1042
1006
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
1007
            change_reporter = delta._ChangeReporter(
1058
1022
 
1059
1023
 
1060
1024
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1025
    """Update a mirror of this branch.
1062
1026
 
1063
1027
    The target branch will not have its working tree populated because this
1064
1028
    is both expensive, and is not supported on remote file systems.
1125
1089
        # Get the source branch
1126
1090
        (tree, br_from,
1127
1091
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1092
        if strict is None:
 
1093
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1094
        if strict is None: strict = True # default value
1128
1095
        # Get the tip's revision_id
1129
1096
        revision = _get_one_revision('push', revision)
1130
1097
        if revision is not None:
1131
1098
            revision_id = revision.in_history(br_from).rev_id
1132
1099
        else:
1133
1100
            revision_id = None
1134
 
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
1101
        if strict and tree is not None and revision_id is None:
 
1102
            if (tree.has_changes()):
 
1103
                raise errors.UncommittedChanges(
 
1104
                    tree, more='Use --no-strict to force the push.')
 
1105
            if tree.last_revision() != tree.branch.last_revision():
 
1106
                # The tree has lost sync with its branch, there is little
 
1107
                # chance that the user is aware of it but he can still force
 
1108
                # the push with --no-strict
 
1109
                raise errors.OutOfDateTree(
 
1110
                    tree, more='Use --no-strict to force the push.')
 
1111
 
1139
1112
        # Get the stacked_on branch, if any
1140
1113
        if stacked_on is not None:
1141
1114
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1146
 
1174
1147
 
1175
1148
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1149
    """Create a new branch that is a copy of an existing branch.
1177
1150
 
1178
1151
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1152
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1179
                    ' directory exists, but does not already'
1207
1180
                    ' have a control directory.  This flag will'
1208
1181
                    ' allow branch to proceed.'),
1209
 
        Option('bind',
1210
 
            help="Bind new branch to from location."),
1211
1182
        ]
1212
1183
    aliases = ['get', 'clone']
1213
1184
 
1214
1185
    def run(self, from_location, to_location=None, revision=None,
1215
1186
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
 
1187
            use_existing_dir=False, switch=False):
1217
1188
        from bzrlib import switch as _mod_switch
1218
1189
        from bzrlib.tag import _merge_tags_if_possible
1219
1190
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1272
1243
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
1244
            errors.UnstackableRepositoryFormat), e:
1274
1245
            note('Branched %d revision(s).' % branch.revno())
1275
 
        if bind:
1276
 
            # Bind to the parent
1277
 
            parent_branch = Branch.open(from_location)
1278
 
            branch.bind(parent_branch)
1279
 
            note('New branch bound to %s' % from_location)
1280
1246
        if switch:
1281
1247
            # Switch to the new branch
1282
1248
            wt, _ = WorkingTree.open_containing('.')
1286
1252
 
1287
1253
 
1288
1254
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1255
    """Create a new checkout of an existing branch.
1290
1256
 
1291
1257
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1258
    the branch found in '.'. This is useful if you have removed the working tree
1355
1321
 
1356
1322
 
1357
1323
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1324
    """Show list of renamed files.
1359
1325
    """
1360
1326
    # TODO: Option to show renames between two historical versions.
1361
1327
 
1387
1353
 
1388
1354
 
1389
1355
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1356
    """Update a tree to have the latest code committed to its branch.
1391
1357
 
1392
1358
    This will perform a merge into the working tree, and may generate
1393
1359
    conflicts. If you have any local changes, you will still
1395
1361
 
1396
1362
    If you want to discard your local changes, you can just do a
1397
1363
    'bzr revert' instead of 'bzr commit' after the update.
1398
 
 
1399
 
    If the tree's branch is bound to a master branch, it will also update
1400
 
    the branch from the master.
1401
1364
    """
1402
1365
 
1403
1366
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1367
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1368
    aliases = ['up']
1407
1369
 
1408
 
    def run(self, dir='.', revision=None):
1409
 
        if revision is not None and len(revision) != 1:
1410
 
            raise errors.BzrCommandError(
1411
 
                        "bzr update --revision takes exactly one revision")
 
1370
    def run(self, dir='.'):
1412
1371
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1372
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1373
        master = tree.branch.get_master_branch(
1416
1374
            possible_transports=possible_transports)
1417
1375
        if master is not None:
1418
1376
            tree.lock_write()
1422
1380
            branch_location = tree.branch.base
1423
1381
        self.add_cleanup(tree.unlock)
1424
1382
        # get rid of the final '/' and be ready for display
1425
 
        branch_location = urlutils.unescape_for_display(
1426
 
            branch_location.rstrip('/'),
1427
 
            self.outf.encoding)
 
1383
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1384
                                                        self.outf.encoding)
1428
1385
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
 
        if master is None:
1430
 
            old_tip = None
1431
 
        else:
1432
 
            # may need to fetch data into a heavyweight checkout
1433
 
            # XXX: this may take some time, maybe we should display a
1434
 
            # message
1435
 
            old_tip = branch.update(possible_transports)
1436
 
        if revision is not None:
1437
 
            revision_id = revision[0].as_revision_id(branch)
1438
 
        else:
1439
 
            revision_id = branch.last_revision()
1440
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1442
 
            note("Tree is up to date at revision %s of branch %s" %
1443
 
                ('.'.join(map(str, revno)), branch_location))
1444
 
            return 0
 
1386
        last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1387
        if last_rev == _mod_revision.ensure_null(
 
1388
            tree.branch.last_revision()):
 
1389
            # may be up to date, check master too.
 
1390
            if master is None or last_rev == _mod_revision.ensure_null(
 
1391
                master.last_revision()):
 
1392
                revno = tree.branch.revision_id_to_revno(last_rev)
 
1393
                note('Tree is up to date at revision %d of branch %s'
 
1394
                     % (revno, branch_location))
 
1395
                return 0
1445
1396
        view_info = _get_view_info_for_change_reporter(tree)
1446
 
        change_reporter = delta._ChangeReporter(
1447
 
            unversioned_filter=tree.is_ignored,
1448
 
            view_info=view_info)
1449
 
        try:
1450
 
            conflicts = tree.update(
1451
 
                change_reporter,
1452
 
                possible_transports=possible_transports,
1453
 
                revision=revision_id,
1454
 
                old_tip=old_tip)
1455
 
        except errors.NoSuchRevision, e:
1456
 
            raise errors.BzrCommandError(
1457
 
                                  "branch has no revision %s\n"
1458
 
                                  "bzr update --revision only works"
1459
 
                                  " for a revision in the branch history"
1460
 
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1397
        conflicts = tree.update(
 
1398
            delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1399
            view_info=view_info), possible_transports=possible_transports)
 
1400
        revno = tree.branch.revision_id_to_revno(
1462
1401
            _mod_revision.ensure_null(tree.last_revision()))
1463
 
        note('Updated to revision %s of branch %s' %
1464
 
             ('.'.join(map(str, revno)), branch_location))
1465
 
        parent_ids = tree.get_parent_ids()
1466
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1402
        note('Updated to revision %d of branch %s' %
 
1403
             (revno, branch_location))
 
1404
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1467
1405
            note('Your local commits will now show as pending merges with '
1468
1406
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
1407
        if conflicts != 0:
1473
1411
 
1474
1412
 
1475
1413
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1414
    """Show information about a working tree, branch or repository.
1477
1415
 
1478
1416
    This command will show all known locations and formats associated to the
1479
1417
    tree, branch or repository.
1517
1455
 
1518
1456
 
1519
1457
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1458
    """Remove files or directories.
1521
1459
 
1522
1460
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1461
    them if they can easily be recovered using revert. If no options or
1571
1509
 
1572
1510
 
1573
1511
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1512
    """Print file_id of a particular file or directory.
1575
1513
 
1576
1514
    The file_id is assigned when the file is first added and remains the
1577
1515
    same through all revisions where the file exists, even when it is
1593
1531
 
1594
1532
 
1595
1533
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1534
    """Print path of file_ids to a file or directory.
1597
1535
 
1598
1536
    This prints one line for each directory down to the target,
1599
1537
    starting at the branch root.
1615
1553
 
1616
1554
 
1617
1555
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1556
    """Reconcile bzr metadata in a branch.
1619
1557
 
1620
1558
    This can correct data mismatches that may have been caused by
1621
1559
    previous ghost operations or bzr upgrades. You should only
1643
1581
 
1644
1582
 
1645
1583
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1584
    """Display the list of revision ids on a branch."""
1647
1585
 
1648
1586
    _see_also = ['log']
1649
1587
    takes_args = ['location?']
1659
1597
 
1660
1598
 
1661
1599
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1600
    """List all revisions merged into this branch."""
1663
1601
 
1664
1602
    _see_also = ['log', 'revision-history']
1665
1603
    takes_args = ['location?']
1684
1622
 
1685
1623
 
1686
1624
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1625
    """Make a directory into a versioned branch.
1688
1626
 
1689
1627
    Use this to create an empty branch, or before importing an
1690
1628
    existing project.
1793
1731
 
1794
1732
 
1795
1733
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1734
    """Create a shared repository for branches to share storage space.
1797
1735
 
1798
1736
    New branches created under the repository directory will store their
1799
1737
    revisions in the repository, not in the branch directory.  For branches
1853
1791
 
1854
1792
 
1855
1793
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1794
    """Show differences in the working tree, between revisions or branches.
1857
1795
 
1858
1796
    If no arguments are given, all changes for the current tree are listed.
1859
1797
    If files are given, only the changes in those files are listed.
1945
1883
            help='Use this command to compare files.',
1946
1884
            type=unicode,
1947
1885
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1886
        ]
1953
1887
    aliases = ['di', 'dif']
1954
1888
    encoding_type = 'exact'
1955
1889
 
1956
1890
    @display_command
1957
1891
    def run(self, revision=None, file_list=None, diff_options=None,
1958
 
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
 
            show_diff_trees)
 
1892
            prefix=None, old=None, new=None, using=None):
 
1893
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1961
1894
 
1962
1895
        if (prefix is None) or (prefix == '0'):
1963
1896
            # diff -p0 format
1977
1910
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1911
                                         ' one or two revision specifiers')
1979
1912
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
1913
        (old_tree, new_tree,
1985
1914
         old_branch, new_branch,
1986
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1915
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1916
            file_list, revision, old, new, apply_view=True)
1988
1917
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1918
                               specific_files=specific_files,
1990
1919
                               external_diff_options=diff_options,
1991
1920
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1921
                               extra_trees=extra_trees, using=using)
1994
1922
 
1995
1923
 
1996
1924
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1925
    """List files deleted in the working tree.
1998
1926
    """
1999
1927
    # TODO: Show files deleted since a previous revision, or
2000
1928
    # between two revisions.
2023
1951
 
2024
1952
 
2025
1953
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1954
    """List files modified in working tree.
2027
1955
    """
2028
1956
 
2029
1957
    hidden = True
2046
1974
 
2047
1975
 
2048
1976
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1977
    """List files added in working tree.
2050
1978
    """
2051
1979
 
2052
1980
    hidden = True
2082
2010
 
2083
2011
 
2084
2012
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2013
    """Show the tree root directory.
2086
2014
 
2087
2015
    The root is the nearest enclosing directory with a .bzr control
2088
2016
    directory."""
2112
2040
 
2113
2041
 
2114
2042
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2043
    """Show historical log for a branch or subset of a branch.
2116
2044
 
2117
2045
    log is bzr's default tool for exploring the history of a branch.
2118
2046
    The branch to use is taken from the first parameter. If no parameters
2229
2157
    :Tips & tricks:
2230
2158
 
2231
2159
      GUI tools and IDEs are often better at exploring history than command
2232
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2234
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2160
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2161
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2162
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2163
 
 
2164
      Web interfaces are often better at exploring history than command line
 
2165
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2166
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2236
2167
 
2237
2168
      You may find it useful to add the aliases below to ``bazaar.conf``::
2238
2169
 
2299
2230
                   help='Show changes made in each revision as a patch.'),
2300
2231
            Option('include-merges',
2301
2232
                   help='Show merged revisions like --levels 0 does.'),
2302
 
            Option('exclude-common-ancestry',
2303
 
                   help='Display only the revisions that are not part'
2304
 
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
2306
2233
            ]
2307
2234
    encoding_type = 'replace'
2308
2235
 
2318
2245
            message=None,
2319
2246
            limit=None,
2320
2247
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2248
            include_merges=False):
2324
2249
        from bzrlib.log import (
2325
2250
            Logger,
2326
2251
            make_log_request_dict,
2327
2252
            _get_info_for_log_files,
2328
2253
            )
2329
2254
        direction = (forward and 'forward') or 'reverse'
2330
 
        if (exclude_common_ancestry
2331
 
            and (revision is None or len(revision) != 2)):
2332
 
            raise errors.BzrCommandError(
2333
 
                '--exclude-common-ancestry requires -r with two revisions')
2334
2255
        if include_merges:
2335
2256
            if levels is None:
2336
2257
                levels = 0
2429
2350
            direction=direction, specific_fileids=file_ids,
2430
2351
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2352
            message_search=message, delta_type=delta_type,
2432
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
2434
 
            )
 
2353
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2354
        Logger(b, rqst).show(lf)
2436
2355
 
2437
2356
 
2456
2375
            raise errors.BzrCommandError(
2457
2376
                "bzr %s doesn't accept two revisions in different"
2458
2377
                " branches." % command_name)
2459
 
        if start_spec.spec is None:
2460
 
            # Avoid loading all the history.
2461
 
            rev1 = RevisionInfo(branch, None, None)
2462
 
        else:
2463
 
            rev1 = start_spec.in_history(branch)
 
2378
        rev1 = start_spec.in_history(branch)
2464
2379
        # Avoid loading all of history when we know a missing
2465
2380
        # end of range means the last revision ...
2466
2381
        if end_spec.spec is None:
2495
2410
 
2496
2411
 
2497
2412
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2413
    """Return revision-ids which affected a particular file.
2499
2414
 
2500
2415
    A more user-friendly interface is "bzr log FILE".
2501
2416
    """
2516
2431
 
2517
2432
 
2518
2433
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2434
    """List files in a tree.
2520
2435
    """
2521
2436
 
2522
2437
    _see_also = ['status', 'cat']
2633
2548
 
2634
2549
 
2635
2550
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2551
    """List unknown files.
2637
2552
    """
2638
2553
 
2639
2554
    hidden = True
2646
2561
 
2647
2562
 
2648
2563
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2564
    """Ignore specified files or patterns.
2650
2565
 
2651
2566
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2567
 
2660
2575
    After adding, editing or deleting that file either indirectly by
2661
2576
    using this command or directly by using an editor, be sure to commit
2662
2577
    it.
2663
 
    
2664
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
 
    the global ignore file can be found in the application data directory as
2666
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
 
    Global ignores are not touched by this command. The global ignore file
2668
 
    can be edited directly using an editor.
2669
 
 
2670
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
 
    precedence over regular ignores.  Such exceptions are used to specify
2672
 
    files that should be versioned which would otherwise be ignored.
2673
 
    
2674
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
 
    precedence over the '!' exception patterns.
2676
2578
 
2677
2579
    Note: ignore patterns containing shell wildcards must be quoted from
2678
2580
    the shell on Unix.
2682
2584
 
2683
2585
            bzr ignore ./Makefile
2684
2586
 
2685
 
        Ignore .class files in all directories...::
 
2587
        Ignore class files in all directories::
2686
2588
 
2687
2589
            bzr ignore "*.class"
2688
2590
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
2591
        Ignore .o files under the lib directory::
2694
2592
 
2695
2593
            bzr ignore "lib/**/*.o"
2701
2599
        Ignore everything but the "debian" toplevel directory::
2702
2600
 
2703
2601
            bzr ignore "RE:(?!debian/).*"
2704
 
        
2705
 
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
2707
 
        
2708
 
            bzr ignore "*"
2709
 
            bzr ignore "!./local"
2710
 
            bzr ignore "!!*~"
2711
2602
    """
2712
2603
 
2713
2604
    _see_also = ['status', 'ignored', 'patterns']
2714
2605
    takes_args = ['name_pattern*']
2715
2606
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2607
        Option('old-default-rules',
 
2608
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2609
        ]
2719
2610
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2611
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2612
        from bzrlib import ignores
2722
 
        if default_rules is not None:
2723
 
            # dump the default rules and exit
2724
 
            for pattern in ignores.USER_DEFAULTS:
2725
 
                self.outf.write("%s\n" % pattern)
 
2613
        if old_default_rules is not None:
 
2614
            # dump the rules and exit
 
2615
            for pattern in ignores.OLD_DEFAULTS:
 
2616
                print pattern
2726
2617
            return
2727
2618
        if not name_pattern_list:
2728
2619
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2620
                                  "NAME_PATTERN or --old-default-rules")
2730
2621
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2622
                             for p in name_pattern_list]
2732
2623
        for name_pattern in name_pattern_list:
2744
2635
            if id is not None:
2745
2636
                filename = entry[0]
2746
2637
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2638
                    matches.append(filename.encode('utf-8'))
2748
2639
        tree.unlock()
2749
2640
        if len(matches) > 0:
2750
 
            self.outf.write("Warning: the following files are version controlled and"
2751
 
                  " match your ignore pattern:\n%s"
2752
 
                  "\nThese files will continue to be version controlled"
2753
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2641
            print "Warning: the following files are version controlled and" \
 
2642
                  " match your ignore pattern:\n%s" \
 
2643
                  "\nThese files will continue to be version controlled" \
 
2644
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2754
2645
 
2755
2646
 
2756
2647
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2648
    """List ignored files and the patterns that matched them.
2758
2649
 
2759
2650
    List all the ignored files and the ignore pattern that caused the file to
2760
2651
    be ignored.
2781
2672
 
2782
2673
 
2783
2674
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2675
    """Lookup the revision-id from a revision-number
2785
2676
 
2786
2677
    :Examples:
2787
2678
        bzr lookup-revision 33
2794
2685
        try:
2795
2686
            revno = int(revno)
2796
2687
        except ValueError:
2797
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
 
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
 
        self.outf.write("%s\n" % revid)
 
2688
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2689
 
 
2690
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2691
 
2802
2692
 
2803
2693
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2694
    """Export current or past revision to a destination directory or archive.
2805
2695
 
2806
2696
    If no revision is specified this exports the last committed revision.
2807
2697
 
2839
2729
        Option('root',
2840
2730
               type=str,
2841
2731
               help="Name of the root directory inside the exported file."),
2842
 
        Option('per-file-timestamps',
2843
 
               help='Set modification time of files to that of the last '
2844
 
                    'revision in which it was changed.'),
2845
2732
        ]
2846
2733
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2734
        root=None, filters=False):
2848
2735
        from bzrlib.export import export
2849
2736
 
2850
2737
        if branch_or_subdir is None:
2857
2744
 
2858
2745
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2746
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2747
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2862
2748
        except errors.NoSuchExportFormat, e:
2863
2749
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2750
 
2865
2751
 
2866
2752
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2753
    """Write the contents of a file as of a given revision to standard output.
2868
2754
 
2869
2755
    If no revision is nominated, the last revision is used.
2870
2756
 
2900
2786
        if tree is None:
2901
2787
            tree = b.basis_tree()
2902
2788
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2789
 
2906
2790
        old_file_id = rev_tree.path2id(relpath)
2907
2791
 
2942
2826
            chunks = content.splitlines(True)
2943
2827
            content = filtered_output_bytes(chunks, filters,
2944
2828
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
2829
            self.outf.writelines(content)
2947
2830
        else:
2948
 
            self.cleanup_now()
2949
2831
            self.outf.write(content)
2950
2832
 
2951
2833
 
2952
2834
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2835
    """Show the offset in seconds from GMT to local time."""
2954
2836
    hidden = True
2955
2837
    @display_command
2956
2838
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2839
        print osutils.local_time_offset()
2958
2840
 
2959
2841
 
2960
2842
 
2961
2843
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2844
    """Commit changes into a new revision.
2963
2845
 
2964
2846
    An explanatory message needs to be given for each commit. This is
2965
2847
    often done by using the --message option (getting the message from the
3073
2955
                         "the master branch until a normal commit "
3074
2956
                         "is performed."
3075
2957
                    ),
3076
 
             Option('show-diff', short_name='p',
 
2958
             Option('show-diff',
3077
2959
                    help='When no message is supplied, show the diff along'
3078
2960
                    ' with the status summary in the message editor.'),
3079
2961
             ]
3159
3041
                    '(use --file "%(f)s" to take commit message from that file)'
3160
3042
                    % { 'f': message })
3161
3043
                ui.ui_factory.show_warning(warning_msg)
3162
 
            if '\r' in message:
3163
 
                message = message.replace('\r\n', '\n')
3164
 
                message = message.replace('\r', '\n')
3165
 
            if file:
3166
 
                raise errors.BzrCommandError(
3167
 
                    "please specify either --message or --file")
3168
3044
 
3169
3045
        def get_message(commit_obj):
3170
3046
            """Callback to get commit message"""
3171
 
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
3174
 
            elif message is not None:
3175
 
                my_message = message
3176
 
            else:
3177
 
                # No message supplied: make one up.
3178
 
                # text is the status of the tree
3179
 
                text = make_commit_message_template_encoded(tree,
 
3047
            my_message = message
 
3048
            if my_message is not None and '\r' in my_message:
 
3049
                my_message = my_message.replace('\r\n', '\n')
 
3050
                my_message = my_message.replace('\r', '\n')
 
3051
            if my_message is None and not file:
 
3052
                t = make_commit_message_template_encoded(tree,
3180
3053
                        selected_list, diff=show_diff,
3181
3054
                        output_encoding=osutils.get_user_encoding())
3182
 
                # start_message is the template generated from hooks
3183
 
                # XXX: Warning - looks like hooks return unicode,
3184
 
                # make_commit_message_template_encoded returns user encoding.
3185
 
                # We probably want to be using edit_commit_message instead to
3186
 
                # avoid this.
3187
3055
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
3056
                my_message = edit_commit_message_encoded(t,
3189
3057
                    start_message=start_message)
3190
3058
                if my_message is None:
3191
3059
                    raise errors.BzrCommandError("please specify a commit"
3192
3060
                        " message with either --message or --file")
 
3061
            elif my_message and file:
 
3062
                raise errors.BzrCommandError(
 
3063
                    "please specify either --message or --file")
 
3064
            if file:
 
3065
                my_message = codecs.open(file, 'rt',
 
3066
                                         osutils.get_user_encoding()).read()
3193
3067
            if my_message == "":
3194
3068
                raise errors.BzrCommandError("empty commit message specified")
3195
3069
            return my_message
3207
3081
                        timezone=offset,
3208
3082
                        exclude=safe_relpath_files(tree, exclude))
3209
3083
        except PointlessCommit:
 
3084
            # FIXME: This should really happen before the file is read in;
 
3085
            # perhaps prepare the commit; get the message; then actually commit
3210
3086
            raise errors.BzrCommandError("No changes to commit."
3211
3087
                              " Use --unchanged to commit anyhow.")
3212
3088
        except ConflictsInTree:
3217
3093
            raise errors.BzrCommandError("Commit refused because there are"
3218
3094
                              " unknown files in the working tree.")
3219
3095
        except errors.BoundBranchOutOfDate, e:
3220
 
            e.extra_help = ("\n"
3221
 
                'To commit to master branch, run update and then commit.\n'
3222
 
                'You can also pass --local to commit to continue working '
3223
 
                'disconnected.')
3224
 
            raise
 
3096
            raise errors.BzrCommandError(str(e) + "\n"
 
3097
            'To commit to master branch, run update and then commit.\n'
 
3098
            'You can also pass --local to commit to continue working '
 
3099
            'disconnected.')
3225
3100
 
3226
3101
 
3227
3102
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3103
    """Validate working tree structure, branch consistency and repository history.
3229
3104
 
3230
3105
    This command checks various invariants about branch and repository storage
3231
3106
    to detect data corruption or bzr bugs.
3295
3170
 
3296
3171
 
3297
3172
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3173
    """Upgrade branch storage to current format.
3299
3174
 
3300
3175
    The check command or bzr developers may sometimes advise you to run
3301
3176
    this command. When the default format has changed you may also be warned
3319
3194
 
3320
3195
 
3321
3196
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3197
    """Show or set bzr user id.
3323
3198
 
3324
3199
    :Examples:
3325
3200
        Show the email of the current user::
3369
3244
 
3370
3245
 
3371
3246
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3247
    """Print or set the branch nickname.
3373
3248
 
3374
3249
    If unset, the tree root directory name is used as the nickname.
3375
3250
    To print the current nickname, execute with no argument.
3389
3264
 
3390
3265
    @display_command
3391
3266
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3267
        print branch.nick
3393
3268
 
3394
3269
 
3395
3270
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3271
    """Set/unset and display aliases.
3397
3272
 
3398
3273
    :Examples:
3399
3274
        Show the current aliases::
3463
3338
 
3464
3339
 
3465
3340
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3341
    """Run internal test suite.
3467
3342
 
3468
3343
    If arguments are given, they are regular expressions that say which tests
3469
3344
    should run.  Tests matching any expression are run, and other tests are
3513
3388
    def get_transport_type(typestring):
3514
3389
        """Parse and return a transport specifier."""
3515
3390
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3391
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3392
            return SFTPAbsoluteServer
3518
3393
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3394
            from bzrlib.transport.memory import MemoryServer
 
3395
            return MemoryServer
3521
3396
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3397
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3398
            return FakeNFSServer
3524
3399
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3400
            (typestring)
3526
3401
        raise errors.BzrCommandError(msg)
3610
3485
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3486
                    "needs to be installed to use --subunit.")
3612
3487
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
 
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3616
 
                import msvcrt
3617
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3488
        if parallel:
3619
3489
            self.additional_selftest_args.setdefault(
3620
3490
                'suite_decorators', []).append(parallel)
3651
3521
 
3652
3522
 
3653
3523
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3524
    """Show version of bzr."""
3655
3525
 
3656
3526
    encoding_type = 'replace'
3657
3527
    takes_options = [
3668
3538
 
3669
3539
 
3670
3540
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3541
    """Statement of optimism."""
3672
3542
 
3673
3543
    hidden = True
3674
3544
 
3675
3545
    @display_command
3676
3546
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3547
        print "It sure does!"
3678
3548
 
3679
3549
 
3680
3550
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3551
    """Find and print a base revision for merging two branches."""
3682
3552
    # TODO: Options to specify revisions on either side, as if
3683
3553
    #       merging only part of the history.
3684
3554
    takes_args = ['branch', 'other']
3700
3570
        graph = branch1.repository.get_graph(branch2.repository)
3701
3571
        base_rev_id = graph.find_unique_lca(last1, last2)
3702
3572
 
3703
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3573
        print 'merge base is revision %s' % base_rev_id
3704
3574
 
3705
3575
 
3706
3576
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3577
    """Perform a three-way merge.
3708
3578
 
3709
3579
    The source of the merge can be specified either in the form of a branch,
3710
3580
    or in the form of a path to a file containing a merge directive generated
3739
3609
    committed to record the result of the merge.
3740
3610
 
3741
3611
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
3743
 
    merge revision which has more than two parents.
3744
 
 
3745
 
    If one would like to merge changes from the working tree of the other
3746
 
    branch without merging any committed revisions, the --uncommitted option
3747
 
    can be given.
 
3612
    --force is given.
3748
3613
 
3749
3614
    To select only some changes to merge, use "merge -i", which will prompt
3750
3615
    you to apply each diff hunk and file change, similar to "shelve".
3765
3630
        To apply a merge directive contained in /tmp/merge::
3766
3631
 
3767
3632
            bzr merge /tmp/merge
3768
 
 
3769
 
        To create a merge revision with three parents from two branches
3770
 
        feature1a and feature1b:
3771
 
 
3772
 
            bzr merge ../feature1a
3773
 
            bzr merge ../feature1b --force
3774
 
            bzr commit -m 'revision with three parents'
3775
3633
    """
3776
3634
 
3777
3635
    encoding_type = 'exact'
3854
3712
                    raise errors.BzrCommandError(
3855
3713
                        'Cannot use -r with merge directives or bundles')
3856
3714
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
 
                   mergeable, None)
 
3715
                   mergeable, pb)
3858
3716
 
3859
3717
        if merger is None and uncommitted:
3860
3718
            if revision is not None and len(revision) > 0:
3861
3719
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3862
3720
                    ' --revision at the same time.')
3863
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3721
            merger = self.get_merger_from_uncommitted(tree, location, pb)
3864
3722
            allow_pending = False
3865
3723
 
3866
3724
        if merger is None:
3867
3725
            merger, allow_pending = self._get_merger_from_branch(tree,
3868
 
                location, revision, remember, possible_transports, None)
 
3726
                location, revision, remember, possible_transports, pb)
3869
3727
 
3870
3728
        merger.merge_type = merge_type
3871
3729
        merger.reprocess = reprocess
4065
3923
 
4066
3924
 
4067
3925
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3926
    """Redo a merge.
4069
3927
 
4070
3928
    Use this if you want to try a different merge technique while resolving
4071
3929
    conflicts.  Some merge techniques are better than others, and remerge
4096
3954
 
4097
3955
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3956
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3957
        if merge_type is None:
4101
3958
            merge_type = _mod_merge.Merge3Merger
4102
3959
        tree, file_list = tree_files(file_list)
4143
4000
        # list, we imply that the working tree text has seen and rejected
4144
4001
        # all the changes from the other tree, when in fact those changes
4145
4002
        # have not yet been seen.
 
4003
        pb = ui.ui_factory.nested_progress_bar()
4146
4004
        tree.set_parent_ids(parents[:1])
4147
4005
        try:
4148
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4006
            merger = _mod_merge.Merger.from_revision_ids(pb,
 
4007
                                                         tree, parents[1])
4149
4008
            merger.interesting_ids = interesting_ids
4150
4009
            merger.merge_type = merge_type
4151
4010
            merger.show_base = show_base
4153
4012
            conflicts = merger.do_merge()
4154
4013
        finally:
4155
4014
            tree.set_parent_ids(parents)
 
4015
            pb.finished()
4156
4016
        if conflicts > 0:
4157
4017
            return 1
4158
4018
        else:
4160
4020
 
4161
4021
 
4162
4022
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4023
    """Revert files to a previous revision.
4164
4024
 
4165
4025
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4026
    will be reverted.  If the revision is not specified with '--revision', the
4185
4045
    created as above.  Directories containing unknown files will not be
4186
4046
    deleted.
4187
4047
 
4188
 
    The working tree contains a list of revisions that have been merged but
4189
 
    not yet committed. These revisions will be included as additional parents
4190
 
    of the next commit.  Normally, using revert clears that list as well as
4191
 
    reverting the files.  If any files are specified, revert leaves the list
4192
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4193
 
    .`` in the tree root to revert all files but keep the recorded merges,
4194
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4048
    The working tree contains a list of pending merged revisions, which will
 
4049
    be included as parents in the next commit.  Normally, revert clears that
 
4050
    list as well as reverting the files.  If any files are specified, revert
 
4051
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4052
    revert ." in the tree root to revert all files but keep the merge record,
 
4053
    and "bzr revert --forget-merges" to clear the pending merge list without
4195
4054
    reverting any files.
4196
4055
 
4197
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4198
 
    changes from a branch in a single revision.  To do this, perform the merge
4199
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4200
 
    the content of the tree as it was, but it will clear the list of pending
4201
 
    merges.  The next commit will then contain all of the changes that are
4202
 
    present in the other branch, but without any other parent revisions.
4203
 
    Because this technique forgets where these changes originated, it may
4204
 
    cause additional conflicts on later merges involving the same source and
 
4056
    Using "bzr revert --forget-merges", it is possible to apply the changes
 
4057
    from an arbitrary merge as a single revision.  To do this, perform the
 
4058
    merge as desired.  Then doing revert with the "--forget-merges" option will
 
4059
    keep the content of the tree as it was, but it will clear the list of
 
4060
    pending merges.  The next commit will then contain all of the changes that
 
4061
    would have been in the merge, but without any mention of the other parent
 
4062
    revisions.  Because this technique forgets where these changes originated,
 
4063
    it may cause additional conflicts on later merges involving the source and
4205
4064
    target branches.
4206
4065
    """
4207
4066
 
4217
4076
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4077
            forget_merges=None):
4219
4078
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
 
4079
        tree.lock_write()
4221
4080
        self.add_cleanup(tree.unlock)
4222
4081
        if forget_merges:
4223
4082
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4227
4086
    @staticmethod
4228
4087
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
4088
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
4089
        pb = ui.ui_factory.nested_progress_bar()
 
4090
        try:
 
4091
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4092
                report_changes=True)
 
4093
        finally:
 
4094
            pb.finished()
4232
4095
 
4233
4096
 
4234
4097
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4098
    """Test reporting of assertion failures"""
4236
4099
    # intended just for use in testing
4237
4100
 
4238
4101
    hidden = True
4242
4105
 
4243
4106
 
4244
4107
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4108
    """Show help on a command or other topic.
4246
4109
    """
4247
4110
 
4248
4111
    _see_also = ['topics']
4261
4124
 
4262
4125
 
4263
4126
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4127
    """Show appropriate completions for context.
4265
4128
 
4266
4129
    For a list of all available commands, say 'bzr shell-complete'.
4267
4130
    """
4276
4139
 
4277
4140
 
4278
4141
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4142
    """Show unmerged/unpulled revisions between two branches.
4280
4143
 
4281
4144
    OTHER_BRANCH may be local or remote.
4282
4145
 
4360
4223
            restrict = 'remote'
4361
4224
 
4362
4225
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4226
        parent = local_branch.get_parent()
4367
4227
        if other_branch is None:
4368
4228
            other_branch = parent
4377
4237
        remote_branch = Branch.open(other_branch)
4378
4238
        if remote_branch.base == local_branch.base:
4379
4239
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4240
 
 
4241
        local_branch.lock_read()
 
4242
        self.add_cleanup(local_branch.unlock)
4384
4243
        local_revid_range = _revision_range_to_revid_range(
4385
4244
            _get_revision_range(my_revision, local_branch,
4386
4245
                self.name()))
4387
4246
 
 
4247
        remote_branch.lock_read()
 
4248
        self.add_cleanup(remote_branch.unlock)
4388
4249
        remote_revid_range = _revision_range_to_revid_range(
4389
4250
            _get_revision_range(revision,
4390
4251
                remote_branch, self.name()))
4449
4310
 
4450
4311
 
4451
4312
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
4313
    """Compress the data within a repository."""
4469
4314
 
4470
4315
    _see_also = ['repositories']
4471
4316
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4317
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4318
    def run(self, branch_or_repo='.'):
4477
4319
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4320
        try:
4479
4321
            branch = dir.open_branch()
4480
4322
            repository = branch.repository
4481
4323
        except errors.NotBranchError:
4482
4324
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4325
        repository.pack()
4484
4326
 
4485
4327
 
4486
4328
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4329
    """List the installed plugins.
4488
4330
 
4489
4331
    This command displays the list of installed plugins including
4490
4332
    version of plugin and a short description of each.
4497
4339
    adding new commands, providing additional network transports and
4498
4340
    customizing log output.
4499
4341
 
4500
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4501
 
    for further information on plugins including where to find them and how to
4502
 
    install them. Instructions are also provided there on how to write new
4503
 
    plugins using the Python programming language.
 
4342
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4343
    information on plugins including where to find them and how to
 
4344
    install them. Instructions are also provided there on how to
 
4345
    write new plugins using the Python programming language.
4504
4346
    """
4505
4347
    takes_options = ['verbose']
4506
4348
 
4521
4363
                doc = '(no description)'
4522
4364
            result.append((name_ver, doc, plugin.path()))
4523
4365
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
4366
            print name_ver
 
4367
            print '   ', doc
4526
4368
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4369
                print '   ', path
 
4370
            print
4529
4371
 
4530
4372
 
4531
4373
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4374
    """Show testament (signing-form) of a revision."""
4533
4375
    takes_options = [
4534
4376
            'revision',
4535
4377
            Option('long', help='Produce long-format testament.'),
4561
4403
 
4562
4404
 
4563
4405
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4406
    """Show the origin of each line in a file.
4565
4407
 
4566
4408
    This prints out the given file with an annotation on the left side
4567
4409
    indicating which revision, author and date introduced the change.
4614
4456
 
4615
4457
 
4616
4458
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4459
    """Create a digital signature for an existing revision."""
4618
4460
    # TODO be able to replace existing ones.
4619
4461
 
4620
4462
    hidden = True # is this right ?
4680
4522
 
4681
4523
 
4682
4524
class cmd_bind(Command):
4683
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
 
    If no branch is supplied, rebind to the last bound location.
 
4525
    """Convert the current branch into a checkout of the supplied branch.
4685
4526
 
4686
4527
    Once converted into a checkout, commits must succeed on the master branch
4687
4528
    before they will be applied to the local branch.
4705
4546
                    'This format does not remember old locations.')
4706
4547
            else:
4707
4548
                if location is None:
4708
 
                    if b.get_bound_location() is not None:
4709
 
                        raise errors.BzrCommandError('Branch is already bound')
4710
 
                    else:
4711
 
                        raise errors.BzrCommandError('No location supplied '
4712
 
                            'and no previous location known')
 
4549
                    raise errors.BzrCommandError('No location supplied and no '
 
4550
                        'previous location known')
4713
4551
        b_other = Branch.open(location)
4714
4552
        try:
4715
4553
            b.bind(b_other)
4721
4559
 
4722
4560
 
4723
4561
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4562
    """Convert the current checkout into a regular branch.
4725
4563
 
4726
4564
    After unbinding, the local branch is considered independent and subsequent
4727
4565
    commits will be local only.
4738
4576
 
4739
4577
 
4740
4578
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4579
    """Remove the last committed revision.
4742
4580
 
4743
4581
    --verbose will print out what is being removed.
4744
4582
    --dry-run will go through all the motions, but not actually
4827
4665
                 end_revision=last_revno)
4828
4666
 
4829
4667
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4668
            print 'Dry-run, pretending to remove the above revisions.'
 
4669
            if not force:
 
4670
                val = raw_input('Press <enter> to continue')
4832
4671
        else:
4833
 
            self.outf.write('The above revision(s) will be removed.\n')
4834
 
 
4835
 
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
4838
 
                return 0
 
4672
            print 'The above revision(s) will be removed.'
 
4673
            if not force:
 
4674
                val = raw_input('Are you sure [y/N]? ')
 
4675
                if val.lower() not in ('y', 'yes'):
 
4676
                    print 'Canceled'
 
4677
                    return 0
4839
4678
 
4840
4679
        mutter('Uncommitting from {%s} to {%s}',
4841
4680
               last_rev_id, rev_id)
4842
4681
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4682
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4683
        note('You can restore the old tip by running:\n'
 
4684
             '  bzr pull . -r revid:%s', last_rev_id)
4846
4685
 
4847
4686
 
4848
4687
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4688
    """Break a dead lock on a repository, branch or working directory.
4850
4689
 
4851
4690
    CAUTION: Locks should only be broken when you are sure that the process
4852
4691
    holding the lock has been stopped.
4853
4692
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
 
4693
    You can get information on what locks are open via the 'bzr info' command.
4856
4694
 
4857
4695
    :Examples:
4858
4696
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
4697
    """
4861
4698
    takes_args = ['location?']
4862
4699
 
4871
4708
 
4872
4709
 
4873
4710
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4711
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4712
 
4876
4713
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4714
    """
4885
4722
 
4886
4723
 
4887
4724
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4725
    """Run the bzr server."""
4889
4726
 
4890
4727
    aliases = ['server']
4891
4728
 
4951
4788
 
4952
4789
 
4953
4790
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4791
    """Combine a tree into its containing tree.
4955
4792
 
4956
4793
    This command requires the target tree to be in a rich-root format.
4957
4794
 
4997
4834
 
4998
4835
 
4999
4836
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4837
    """Split a subdirectory of a tree into a separate tree.
5001
4838
 
5002
4839
    This command will produce a target tree in a format that supports
5003
4840
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4860
 
5024
4861
 
5025
4862
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4863
    """Generate a merge directive for auto-merge tools.
5027
4864
 
5028
4865
    A directive requests a merge to be performed, and also provides all the
5029
4866
    information necessary to do so.  This means it must either include a
5122
4959
 
5123
4960
 
5124
4961
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4962
    """Mail or create a merge-directive for submitting changes.
5126
4963
 
5127
4964
    A merge directive provides many things needed for requesting merges:
5128
4965
 
5134
4971
      directly from the merge directive, without retrieving data from a
5135
4972
      branch.
5136
4973
 
5137
 
    `bzr send` creates a compact data set that, when applied using bzr
5138
 
    merge, has the same effect as merging from the source branch.  
5139
 
    
5140
 
    By default the merge directive is self-contained and can be applied to any
5141
 
    branch containing submit_branch in its ancestory without needing access to
5142
 
    the source branch.
5143
 
    
5144
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5145
 
    revisions, but only a structured request to merge from the
5146
 
    public_location.  In that case the public_branch is needed and it must be
5147
 
    up-to-date and accessible to the recipient.  The public_branch is always
5148
 
    included if known, so that people can check it later.
5149
 
 
5150
 
    The submit branch defaults to the parent of the source branch, but can be
5151
 
    overridden.  Both submit branch and public branch will be remembered in
5152
 
    branch.conf the first time they are used for a particular branch.  The
5153
 
    source branch defaults to that containing the working directory, but can
5154
 
    be changed using --from.
5155
 
 
5156
 
    In order to calculate those changes, bzr must analyse the submit branch.
5157
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
 
    If a public location is known for the submit_branch, that location is used
5159
 
    in the merge directive.
5160
 
 
5161
 
    The default behaviour is to send the merge directive by mail, unless -o is
5162
 
    given, in which case it is sent to a file.
 
4974
    If --no-bundle is specified, then public_branch is needed (and must be
 
4975
    up-to-date), so that the receiver can perform the merge using the
 
4976
    public_branch.  The public_branch is always included if known, so that
 
4977
    people can check it later.
 
4978
 
 
4979
    The submit branch defaults to the parent, but can be overridden.  Both
 
4980
    submit branch and public branch will be remembered if supplied.
 
4981
 
 
4982
    If a public_branch is known for the submit_branch, that public submit
 
4983
    branch is used in the merge instructions.  This means that a local mirror
 
4984
    can be used as your actual submit branch, once you have set public_branch
 
4985
    for that mirror.
5163
4986
 
5164
4987
    Mail is sent using your preferred mail program.  This should be transparent
5165
4988
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5185
5008
 
5186
5009
    The merge directives created by bzr send may be applied using bzr merge or
5187
5010
    bzr pull by specifying a file containing a merge directive as the location.
5188
 
 
5189
 
    bzr send makes extensive use of public locations to map local locations into
5190
 
    URLs that can be used by other people.  See `bzr help configuration` to
5191
 
    set them, and use `bzr info` to display them.
5192
5011
    """
5193
5012
 
5194
5013
    encoding_type = 'exact'
5210
5029
               short_name='f',
5211
5030
               type=unicode),
5212
5031
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
5032
               help='Write merge directive to this file; '
5214
5033
                    'use - for stdout.',
5215
5034
               type=unicode),
5216
5035
        Option('strict',
5239
5058
 
5240
5059
 
5241
5060
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5061
    """Create a merge-directive for submitting changes.
5243
5062
 
5244
5063
    A merge directive provides many things needed for requesting merges:
5245
5064
 
5312
5131
 
5313
5132
 
5314
5133
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5134
    """Create, remove or modify a tag naming a revision.
5316
5135
 
5317
5136
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5137
    (--revision) option can be given -rtag:X, where X is any previously
5326
5145
 
5327
5146
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
5147
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5329
 
 
5330
 
    If no tag name is specified it will be determined through the 
5331
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
 
    details.
5334
5148
    """
5335
5149
 
5336
5150
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
5151
    takes_args = ['tag_name']
5338
5152
    takes_options = [
5339
5153
        Option('delete',
5340
5154
            help='Delete this tag rather than placing it.',
5350
5164
        'revision',
5351
5165
        ]
5352
5166
 
5353
 
    def run(self, tag_name=None,
 
5167
    def run(self, tag_name,
5354
5168
            delete=None,
5355
5169
            directory='.',
5356
5170
            force=None,
5360
5174
        branch.lock_write()
5361
5175
        self.add_cleanup(branch.unlock)
5362
5176
        if delete:
5363
 
            if tag_name is None:
5364
 
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5177
            branch.tags.delete_tag(tag_name)
5366
5178
            self.outf.write('Deleted tag %s.\n' % tag_name)
5367
5179
        else:
5373
5185
                revision_id = revision[0].as_revision_id(branch)
5374
5186
            else:
5375
5187
                revision_id = branch.last_revision()
5376
 
            if tag_name is None:
5377
 
                tag_name = branch.automatic_tag_name(revision_id)
5378
 
                if tag_name is None:
5379
 
                    raise errors.BzrCommandError(
5380
 
                        "Please specify a tag name.")
5381
5188
            if (not force) and branch.tags.has_tag(tag_name):
5382
5189
                raise errors.TagAlreadyExists(tag_name)
5383
5190
            branch.tags.set_tag(tag_name, revision_id)
5385
5192
 
5386
5193
 
5387
5194
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5195
    """List tags.
5389
5196
 
5390
5197
    This command shows a table of tag names and the revisions they reference.
5391
5198
    """
5459
5266
 
5460
5267
 
5461
5268
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5269
    """Reconfigure the type of a bzr directory.
5463
5270
 
5464
5271
    A target configuration must be specified.
5465
5272
 
5550
5357
 
5551
5358
 
5552
5359
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5360
    """Set the branch of a checkout and update.
5554
5361
 
5555
5362
    For lightweight checkouts, this changes the branch being referenced.
5556
5363
    For heavyweight checkouts, this checks that there are no local commits
5572
5379
    that of the master.
5573
5380
    """
5574
5381
 
5575
 
    takes_args = ['to_location?']
 
5382
    takes_args = ['to_location']
5576
5383
    takes_options = [Option('force',
5577
5384
                        help='Switch even if local commits will be lost.'),
5578
 
                     'revision',
5579
5385
                     Option('create-branch', short_name='b',
5580
5386
                        help='Create the target branch from this one before'
5581
5387
                             ' switching to it.'),
5582
 
                    ]
 
5388
                     ]
5583
5389
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5390
    def run(self, to_location, force=False, create_branch=False):
5586
5391
        from bzrlib import switch
5587
5392
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
5393
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
 
        if to_location is None:
5591
 
            if revision is None:
5592
 
                raise errors.BzrCommandError('You must supply either a'
5593
 
                                             ' revision or a location')
5594
 
            to_location = '.'
5595
5394
        try:
5596
5395
            branch = control_dir.open_branch()
5597
5396
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5602
5401
            if branch is None:
5603
5402
                raise errors.BzrCommandError('cannot create branch without'
5604
5403
                                             ' source branch')
5605
 
            to_location = directory_service.directories.dereference(
5606
 
                              to_location)
5607
5404
            if '/' not in to_location and '\\' not in to_location:
5608
5405
                # This path is meant to be relative to the existing branch
5609
5406
                this_url = self._get_branch_location(control_dir)
5611
5408
            to_branch = branch.bzrdir.sprout(to_location,
5612
5409
                                 possible_transports=[branch.bzrdir.root_transport],
5613
5410
                                 source_branch=branch).open_branch()
 
5411
            # try:
 
5412
            #     from_branch = control_dir.open_branch()
 
5413
            # except errors.NotBranchError:
 
5414
            #     raise BzrCommandError('Cannot create a branch from this'
 
5415
            #         ' location when we cannot open this branch')
 
5416
            # from_branch.bzrdir.sprout(
 
5417
            pass
5614
5418
        else:
5615
5419
            try:
5616
5420
                to_branch = Branch.open(to_location)
5618
5422
                this_url = self._get_branch_location(control_dir)
5619
5423
                to_branch = Branch.open(
5620
5424
                    urlutils.join(this_url, '..', to_location))
5621
 
        if revision is not None:
5622
 
            revision = revision.as_revision_id(to_branch)
5623
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5425
        switch.switch(control_dir, to_branch, force)
5624
5426
        if had_explicit_nick:
5625
5427
            branch = control_dir.open_branch() #get the new branch!
5626
5428
            branch.nick = to_branch.nick
5646
5448
 
5647
5449
 
5648
5450
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5451
    """Manage filtered views.
5650
5452
 
5651
5453
    Views provide a mask over the tree so that users can focus on
5652
5454
    a subset of a tree when doing their work. After creating a view,
5800
5602
 
5801
5603
 
5802
5604
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5605
    """Show hooks."""
5804
5606
 
5805
5607
    hidden = True
5806
5608
 
5819
5621
                    self.outf.write("    <no hooks installed>\n")
5820
5622
 
5821
5623
 
5822
 
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
5824
 
 
5825
 
    This will remove the branch from the specified location but 
5826
 
    will keep any working tree or repository in place.
5827
 
 
5828
 
    :Examples:
5829
 
 
5830
 
      Remove the branch at repo/trunk::
5831
 
 
5832
 
        bzr remove-branch repo/trunk
5833
 
 
5834
 
    """
5835
 
 
5836
 
    takes_args = ["location?"]
5837
 
 
5838
 
    aliases = ["rmbranch"]
5839
 
 
5840
 
    def run(self, location=None):
5841
 
        if location is None:
5842
 
            location = "."
5843
 
        branch = Branch.open_containing(location)[0]
5844
 
        branch.bzrdir.destroy_branch()
5845
 
        
5846
 
 
5847
5624
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5625
    """Temporarily set aside some changes from the current tree.
5849
5626
 
5850
5627
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5628
    ie. out of the way, until a later time when you can bring them back from
5920
5697
 
5921
5698
 
5922
5699
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5700
    """Restore shelved changes.
5924
5701
 
5925
5702
    By default, the most recently shelved changes are restored. However if you
5926
5703
    specify a shelf by id those changes will be restored instead.  This works
5934
5711
            enum_switch=False, value_switches=True,
5935
5712
            apply="Apply changes and remove from the shelf.",
5936
5713
            dry_run="Show changes, but do not apply or remove them.",
5937
 
            preview="Instead of unshelving the changes, show the diff that "
5938
 
                    "would result from unshelving.",
5939
5714
            delete_only="Delete changes without applying them.",
5940
5715
            keep="Apply changes but don't delete them.",
5941
5716
        )
5952
5727
 
5953
5728
 
5954
5729
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5730
    """Remove unwanted files from working tree.
5956
5731
 
5957
5732
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5733
    files are never deleted.
5986
5761
 
5987
5762
 
5988
5763
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5764
    """list, view and set branch locations for nested trees.
5990
5765
 
5991
5766
    If no arguments are provided, lists the branch locations for nested trees.
5992
5767
    If one argument is provided, display the branch location for that tree.
6032
5807
            self.outf.write('%s %s\n' % (path, location))
6033
5808
 
6034
5809
 
6035
 
def _register_lazy_builtins():
6036
 
    # register lazy builtins from other modules; called at startup and should
6037
 
    # be only called once.
6038
 
    for (name, aliases, module_name) in [
6039
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6040
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6045
 
        ]:
6046
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5810
# these get imported and then picked up by the scan for cmd_*
 
5811
# TODO: Some more consistent way to split command definitions across files;
 
5812
# we do need to load at least some information about them to know of
 
5813
# aliases.  ideally we would avoid loading the implementation until the
 
5814
# details were needed.
 
5815
from bzrlib.cmd_version_info import cmd_version_info
 
5816
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5817
from bzrlib.bundle.commands import (
 
5818
    cmd_bundle_info,
 
5819
    )
 
5820
from bzrlib.foreign import cmd_dpush
 
5821
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5822
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5823
        cmd_weave_plan_merge, cmd_weave_merge_text