~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2010-01-29 14:09:05 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129140905-2uiarb6p8di1ywsr
Correction to url

from review: https://code.edge.launchpad.net/~mbp/bzr/doc/+merge/18250

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
54
54
    )
55
55
from bzrlib.branch import Branch
56
56
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
58
from bzrlib.smtp_connection import SMTPConnection
60
59
from bzrlib.workingtree import WorkingTree
61
60
""")
62
61
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
62
from bzrlib.commands import Command, display_command
68
63
from bzrlib.option import (
69
64
    ListOption,
70
65
    Option,
232
227
    return view_info
233
228
 
234
229
 
235
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
 
    """Open the tree or branch containing the specified file, unless
237
 
    the --directory option is used to specify a different branch."""
238
 
    if directory is not None:
239
 
        return (None, Branch.open(directory), filename)
240
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
241
 
 
242
 
 
243
230
# TODO: Make sure no commands unconditionally use the working directory as a
244
231
# branch.  If a filename argument is used, the first of them should be used to
245
232
# specify the branch.  (Perhaps this can be factored out into some kind of
247
234
# opens the branch?)
248
235
 
249
236
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
237
    """Display status summary.
251
238
 
252
239
    This reports on versioned and unknown files, reporting them
253
240
    grouped by state.  Possible states are:
340
327
 
341
328
 
342
329
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
 
330
    """Write out metadata for a revision.
344
331
 
345
332
    The revision to print can either be specified by a specific
346
333
    revision identifier, or you can use --revision.
348
335
 
349
336
    hidden = True
350
337
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
338
    takes_options = ['revision']
352
339
    # cat-revision is more for frontends so should be exact
353
340
    encoding = 'strict'
354
341
 
355
 
    def print_revision(self, revisions, revid):
356
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
357
 
        record = stream.next()
358
 
        if record.storage_kind == 'absent':
359
 
            raise errors.NoSuchRevision(revisions, revid)
360
 
        revtext = record.get_bytes_as('fulltext')
361
 
        self.outf.write(revtext.decode('utf-8'))
362
 
 
363
342
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
343
    def run(self, revision_id=None, revision=None):
365
344
        if revision_id is not None and revision is not None:
366
345
            raise errors.BzrCommandError('You can only supply one of'
367
346
                                         ' revision_id or --revision')
368
347
        if revision_id is None and revision is None:
369
348
            raise errors.BzrCommandError('You must supply either'
370
349
                                         ' --revision or a revision_id')
371
 
        b = WorkingTree.open_containing(directory)[0].branch
372
 
 
373
 
        revisions = b.repository.revisions
374
 
        if revisions is None:
375
 
            raise errors.BzrCommandError('Repository %r does not support '
376
 
                'access to raw revision texts')
377
 
 
378
 
        b.repository.lock_read()
379
 
        try:
380
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
381
 
            if revision_id is not None:
382
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
383
 
                try:
384
 
                    self.print_revision(revisions, revision_id)
385
 
                except errors.NoSuchRevision:
386
 
                    msg = "The repository %s contains no revision %s." % (
387
 
                        b.repository.base, revision_id)
388
 
                    raise errors.BzrCommandError(msg)
389
 
            elif revision is not None:
390
 
                for rev in revision:
391
 
                    if rev is None:
392
 
                        raise errors.BzrCommandError(
393
 
                            'You cannot specify a NULL revision.')
394
 
                    rev_id = rev.as_revision_id(b)
395
 
                    self.print_revision(revisions, rev_id)
396
 
        finally:
397
 
            b.repository.unlock()
398
 
        
 
350
        b = WorkingTree.open_containing(u'.')[0].branch
 
351
 
 
352
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
353
        if revision_id is not None:
 
354
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
355
            try:
 
356
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
357
            except errors.NoSuchRevision:
 
358
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
359
                    revision_id)
 
360
                raise errors.BzrCommandError(msg)
 
361
        elif revision is not None:
 
362
            for rev in revision:
 
363
                if rev is None:
 
364
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
365
                                                 ' revision.')
 
366
                rev_id = rev.as_revision_id(b)
 
367
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
368
 
399
369
 
400
370
class cmd_dump_btree(Command):
401
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
371
    """Dump the contents of a btree index file to stdout.
402
372
 
403
373
    PATH is a btree index file, it can be any URL. This includes things like
404
374
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
468
438
        for node in bt.iter_all_entries():
469
439
            # Node is made up of:
470
440
            # (index, key, value, [references])
471
 
            try:
472
 
                refs = node[3]
473
 
            except IndexError:
474
 
                refs_as_tuples = None
475
 
            else:
476
 
                refs_as_tuples = static_tuple.as_tuples(refs)
 
441
            refs_as_tuples = static_tuple.as_tuples(node[3])
477
442
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
443
            self.outf.write('%s\n' % (as_tuple,))
479
444
 
480
445
 
481
446
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
447
    """Remove the working tree from a given branch/checkout.
483
448
 
484
449
    Since a lightweight checkout is little more than a working tree
485
450
    this will refuse to run against one.
487
452
    To re-create the working tree, use "bzr checkout".
488
453
    """
489
454
    _see_also = ['checkout', 'working-trees']
490
 
    takes_args = ['location*']
 
455
    takes_args = ['location?']
491
456
    takes_options = [
492
457
        Option('force',
493
458
               help='Remove the working tree even if it has '
494
459
                    'uncommitted changes.'),
495
460
        ]
496
461
 
497
 
    def run(self, location_list, force=False):
498
 
        if not location_list:
499
 
            location_list=['.']
500
 
 
501
 
        for location in location_list:
502
 
            d = bzrdir.BzrDir.open(location)
503
 
            
504
 
            try:
505
 
                working = d.open_workingtree()
506
 
            except errors.NoWorkingTree:
507
 
                raise errors.BzrCommandError("No working tree to remove")
508
 
            except errors.NotLocalUrl:
509
 
                raise errors.BzrCommandError("You cannot remove the working tree"
510
 
                                             " of a remote path")
511
 
            if not force:
512
 
                if (working.has_changes()):
513
 
                    raise errors.UncommittedChanges(working)
514
 
 
515
 
            if working.user_url != working.branch.user_url:
516
 
                raise errors.BzrCommandError("You cannot remove the working tree"
517
 
                                             " from a lightweight checkout")
518
 
 
519
 
            d.destroy_workingtree()
 
462
    def run(self, location='.', force=False):
 
463
        d = bzrdir.BzrDir.open(location)
 
464
 
 
465
        try:
 
466
            working = d.open_workingtree()
 
467
        except errors.NoWorkingTree:
 
468
            raise errors.BzrCommandError("No working tree to remove")
 
469
        except errors.NotLocalUrl:
 
470
            raise errors.BzrCommandError("You cannot remove the working tree"
 
471
                                         " of a remote path")
 
472
        if not force:
 
473
            if (working.has_changes()):
 
474
                raise errors.UncommittedChanges(working)
 
475
 
 
476
        working_path = working.bzrdir.root_transport.base
 
477
        branch_path = working.branch.bzrdir.root_transport.base
 
478
        if working_path != branch_path:
 
479
            raise errors.BzrCommandError("You cannot remove the working tree"
 
480
                                         " from a lightweight checkout")
 
481
 
 
482
        d.destroy_workingtree()
520
483
 
521
484
 
522
485
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
486
    """Show current revision number.
524
487
 
525
488
    This is equal to the number of revisions on this branch.
526
489
    """
556
519
 
557
520
 
558
521
class cmd_revision_info(Command):
559
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
522
    """Show revision number and revision id for a given revision identifier.
560
523
    """
561
524
    hidden = True
562
525
    takes_args = ['revision_info*']
563
526
    takes_options = [
564
527
        'revision',
565
 
        custom_help('directory',
 
528
        Option('directory',
566
529
            help='Branch to examine, '
567
 
                 'rather than the one containing the working directory.'),
 
530
                 'rather than the one containing the working directory.',
 
531
            short_name='d',
 
532
            type=unicode,
 
533
            ),
568
534
        Option('tree', help='Show revno of working tree'),
569
535
        ]
570
536
 
615
581
 
616
582
 
617
583
class cmd_add(Command):
618
 
    __doc__ = """Add specified files or directories.
 
584
    """Add specified files or directories.
619
585
 
620
586
    In non-recursive mode, all the named items are added, regardless
621
587
    of whether they were previously ignored.  A warning is given if
701
667
 
702
668
 
703
669
class cmd_mkdir(Command):
704
 
    __doc__ = """Create a new versioned directory.
 
670
    """Create a new versioned directory.
705
671
 
706
672
    This is equivalent to creating the directory and then adding it.
707
673
    """
711
677
 
712
678
    def run(self, dir_list):
713
679
        for d in dir_list:
 
680
            os.mkdir(d)
714
681
            wt, dd = WorkingTree.open_containing(d)
715
 
            base = os.path.dirname(dd)
716
 
            id = wt.path2id(base)
717
 
            if id != None:
718
 
                os.mkdir(d)
719
 
                wt.add([dd])
720
 
                self.outf.write('added %s\n' % d)
721
 
            else:
722
 
                raise errors.NotVersionedError(path=base)
 
682
            wt.add([dd])
 
683
            self.outf.write('added %s\n' % d)
723
684
 
724
685
 
725
686
class cmd_relpath(Command):
726
 
    __doc__ = """Show path of a file relative to root"""
 
687
    """Show path of a file relative to root"""
727
688
 
728
689
    takes_args = ['filename']
729
690
    hidden = True
738
699
 
739
700
 
740
701
class cmd_inventory(Command):
741
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
702
    """Show inventory of the current working copy or a revision.
742
703
 
743
704
    It is possible to limit the output to a particular entry
744
705
    type using the --kind option.  For example: --kind file.
799
760
 
800
761
 
801
762
class cmd_mv(Command):
802
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
803
764
 
804
765
    :Usage:
805
766
        bzr mv OLDNAME NEWNAME
936
897
 
937
898
 
938
899
class cmd_pull(Command):
939
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
900
    """Turn this branch into a mirror of another branch.
940
901
 
941
902
    By default, this command only works on branches that have not diverged.
942
903
    Branches are considered diverged if the destination branch's most recent 
965
926
    takes_options = ['remember', 'overwrite', 'revision',
966
927
        custom_help('verbose',
967
928
            help='Show logs of pulled revisions.'),
968
 
        custom_help('directory',
 
929
        Option('directory',
969
930
            help='Branch to pull into, '
970
 
                 'rather than the one containing the working directory.'),
 
931
                 'rather than the one containing the working directory.',
 
932
            short_name='d',
 
933
            type=unicode,
 
934
            ),
971
935
        Option('local',
972
936
            help="Perform a local pull in a bound "
973
937
                 "branch.  Local pulls are not applied to "
988
952
        try:
989
953
            tree_to = WorkingTree.open_containing(directory)[0]
990
954
            branch_to = tree_to.branch
991
 
            tree_to.lock_write()
992
 
            self.add_cleanup(tree_to.unlock)
993
955
        except errors.NoWorkingTree:
994
956
            tree_to = None
995
957
            branch_to = Branch.open_containing(directory)[0]
996
 
            branch_to.lock_write()
997
 
            self.add_cleanup(branch_to.unlock)
998
 
 
 
958
        
999
959
        if local and not branch_to.get_bound_location():
1000
960
            raise errors.LocalRequiresBoundBranch()
1001
961
 
1031
991
        else:
1032
992
            branch_from = Branch.open(location,
1033
993
                possible_transports=possible_transports)
 
994
 
 
995
            if branch_to.get_parent() is None or remember:
 
996
                branch_to.set_parent(branch_from.base)
 
997
 
 
998
        if branch_from is not branch_to:
1034
999
            branch_from.lock_read()
1035
1000
            self.add_cleanup(branch_from.unlock)
1036
 
 
1037
 
            if branch_to.get_parent() is None or remember:
1038
 
                branch_to.set_parent(branch_from.base)
1039
 
 
1040
1001
        if revision is not None:
1041
1002
            revision_id = revision.as_revision_id(branch_from)
1042
1003
 
 
1004
        branch_to.lock_write()
 
1005
        self.add_cleanup(branch_to.unlock)
1043
1006
        if tree_to is not None:
1044
1007
            view_info = _get_view_info_for_change_reporter(tree_to)
1045
1008
            change_reporter = delta._ChangeReporter(
1060
1023
 
1061
1024
 
1062
1025
class cmd_push(Command):
1063
 
    __doc__ = """Update a mirror of this branch.
 
1026
    """Update a mirror of this branch.
1064
1027
 
1065
1028
    The target branch will not have its working tree populated because this
1066
1029
    is both expensive, and is not supported on remote file systems.
1090
1053
        Option('create-prefix',
1091
1054
               help='Create the path leading up to the branch '
1092
1055
                    'if it does not already exist.'),
1093
 
        custom_help('directory',
 
1056
        Option('directory',
1094
1057
            help='Branch to push from, '
1095
 
                 'rather than the one containing the working directory.'),
 
1058
                 'rather than the one containing the working directory.',
 
1059
            short_name='d',
 
1060
            type=unicode,
 
1061
            ),
1096
1062
        Option('use-existing-dir',
1097
1063
               help='By default push will fail if the target'
1098
1064
                    ' directory exists, but does not already'
1124
1090
        # Get the source branch
1125
1091
        (tree, br_from,
1126
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
1127
1096
        # Get the tip's revision_id
1128
1097
        revision = _get_one_revision('push', revision)
1129
1098
        if revision is not None:
1130
1099
            revision_id = revision.in_history(br_from).rev_id
1131
1100
        else:
1132
1101
            revision_id = None
1133
 
        if tree is not None and revision_id is None:
1134
 
            tree.check_changed_or_out_of_date(
1135
 
                strict, 'push_strict',
1136
 
                more_error='Use --no-strict to force the push.',
1137
 
                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
 
1138
1113
        # Get the stacked_on branch, if any
1139
1114
        if stacked_on is not None:
1140
1115
            stacked_on = urlutils.normalize_url(stacked_on)
1172
1147
 
1173
1148
 
1174
1149
class cmd_branch(Command):
1175
 
    __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.
1176
1151
 
1177
1152
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1178
1153
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1285
1260
 
1286
1261
 
1287
1262
class cmd_checkout(Command):
1288
 
    __doc__ = """Create a new checkout of an existing branch.
 
1263
    """Create a new checkout of an existing branch.
1289
1264
 
1290
1265
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1291
1266
    the branch found in '.'. This is useful if you have removed the working tree
1354
1329
 
1355
1330
 
1356
1331
class cmd_renames(Command):
1357
 
    __doc__ = """Show list of renamed files.
 
1332
    """Show list of renamed files.
1358
1333
    """
1359
1334
    # TODO: Option to show renames between two historical versions.
1360
1335
 
1386
1361
 
1387
1362
 
1388
1363
class cmd_update(Command):
1389
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1364
    """Update a tree to have the latest code committed to its branch.
1390
1365
 
1391
1366
    This will perform a merge into the working tree, and may generate
1392
1367
    conflicts. If you have any local changes, you will still
1421
1396
            branch_location = tree.branch.base
1422
1397
        self.add_cleanup(tree.unlock)
1423
1398
        # get rid of the final '/' and be ready for display
1424
 
        branch_location = urlutils.unescape_for_display(
1425
 
            branch_location.rstrip('/'),
1426
 
            self.outf.encoding)
 
1399
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1400
                                                        self.outf.encoding)
1427
1401
        existing_pending_merges = tree.get_parent_ids()[1:]
1428
1402
        if master is None:
1429
1403
            old_tip = None
1437
1411
        else:
1438
1412
            revision_id = branch.last_revision()
1439
1413
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1440
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1441
 
            note("Tree is up to date at revision %s of branch %s" %
1442
 
                ('.'.join(map(str, revno)), branch_location))
 
1414
            revno = branch.revision_id_to_revno(revision_id)
 
1415
            note("Tree is up to date at revision %d of branch %s" %
 
1416
                (revno, branch_location))
1443
1417
            return 0
1444
1418
        view_info = _get_view_info_for_change_reporter(tree)
1445
1419
        change_reporter = delta._ChangeReporter(
1457
1431
                                  "bzr update --revision only works"
1458
1432
                                  " for a revision in the branch history"
1459
1433
                                  % (e.revision))
1460
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1434
        revno = tree.branch.revision_id_to_revno(
1461
1435
            _mod_revision.ensure_null(tree.last_revision()))
1462
 
        note('Updated to revision %s of branch %s' %
1463
 
             ('.'.join(map(str, revno)), branch_location))
1464
 
        parent_ids = tree.get_parent_ids()
1465
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1436
        note('Updated to revision %d of branch %s' %
 
1437
             (revno, branch_location))
 
1438
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1466
1439
            note('Your local commits will now show as pending merges with '
1467
1440
                 "'bzr status', and can be committed with 'bzr commit'.")
1468
1441
        if conflicts != 0:
1472
1445
 
1473
1446
 
1474
1447
class cmd_info(Command):
1475
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1448
    """Show information about a working tree, branch or repository.
1476
1449
 
1477
1450
    This command will show all known locations and formats associated to the
1478
1451
    tree, branch or repository.
1516
1489
 
1517
1490
 
1518
1491
class cmd_remove(Command):
1519
 
    __doc__ = """Remove files or directories.
 
1492
    """Remove files or directories.
1520
1493
 
1521
1494
    This makes bzr stop tracking changes to the specified files. bzr will delete
1522
1495
    them if they can easily be recovered using revert. If no options or
1570
1543
 
1571
1544
 
1572
1545
class cmd_file_id(Command):
1573
 
    __doc__ = """Print file_id of a particular file or directory.
 
1546
    """Print file_id of a particular file or directory.
1574
1547
 
1575
1548
    The file_id is assigned when the file is first added and remains the
1576
1549
    same through all revisions where the file exists, even when it is
1592
1565
 
1593
1566
 
1594
1567
class cmd_file_path(Command):
1595
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1568
    """Print path of file_ids to a file or directory.
1596
1569
 
1597
1570
    This prints one line for each directory down to the target,
1598
1571
    starting at the branch root.
1614
1587
 
1615
1588
 
1616
1589
class cmd_reconcile(Command):
1617
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1590
    """Reconcile bzr metadata in a branch.
1618
1591
 
1619
1592
    This can correct data mismatches that may have been caused by
1620
1593
    previous ghost operations or bzr upgrades. You should only
1642
1615
 
1643
1616
 
1644
1617
class cmd_revision_history(Command):
1645
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1618
    """Display the list of revision ids on a branch."""
1646
1619
 
1647
1620
    _see_also = ['log']
1648
1621
    takes_args = ['location?']
1658
1631
 
1659
1632
 
1660
1633
class cmd_ancestry(Command):
1661
 
    __doc__ = """List all revisions merged into this branch."""
 
1634
    """List all revisions merged into this branch."""
1662
1635
 
1663
1636
    _see_also = ['log', 'revision-history']
1664
1637
    takes_args = ['location?']
1683
1656
 
1684
1657
 
1685
1658
class cmd_init(Command):
1686
 
    __doc__ = """Make a directory into a versioned branch.
 
1659
    """Make a directory into a versioned branch.
1687
1660
 
1688
1661
    Use this to create an empty branch, or before importing an
1689
1662
    existing project.
1792
1765
 
1793
1766
 
1794
1767
class cmd_init_repository(Command):
1795
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1768
    """Create a shared repository for branches to share storage space.
1796
1769
 
1797
1770
    New branches created under the repository directory will store their
1798
1771
    revisions in the repository, not in the branch directory.  For branches
1852
1825
 
1853
1826
 
1854
1827
class cmd_diff(Command):
1855
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1828
    """Show differences in the working tree, between revisions or branches.
1856
1829
 
1857
1830
    If no arguments are given, all changes for the current tree are listed.
1858
1831
    If files are given, only the changes in those files are listed.
1944
1917
            help='Use this command to compare files.',
1945
1918
            type=unicode,
1946
1919
            ),
1947
 
        RegistryOption('format',
1948
 
            help='Diff format to use.',
1949
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1950
 
            value_switches=False, title='Diff format'),
1951
1920
        ]
1952
1921
    aliases = ['di', 'dif']
1953
1922
    encoding_type = 'exact'
1954
1923
 
1955
1924
    @display_command
1956
1925
    def run(self, revision=None, file_list=None, diff_options=None,
1957
 
            prefix=None, old=None, new=None, using=None, format=None):
1958
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1959
 
            show_diff_trees)
 
1926
            prefix=None, old=None, new=None, using=None):
 
1927
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1960
1928
 
1961
1929
        if (prefix is None) or (prefix == '0'):
1962
1930
            # diff -p0 format
1976
1944
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1977
1945
                                         ' one or two revision specifiers')
1978
1946
 
1979
 
        if using is not None and format is not None:
1980
 
            raise errors.BzrCommandError('--using and --format are mutually '
1981
 
                'exclusive.')
1982
 
 
1983
1947
        (old_tree, new_tree,
1984
1948
         old_branch, new_branch,
1985
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1986
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1949
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1950
            file_list, revision, old, new, apply_view=True)
1987
1951
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1988
1952
                               specific_files=specific_files,
1989
1953
                               external_diff_options=diff_options,
1990
1954
                               old_label=old_label, new_label=new_label,
1991
 
                               extra_trees=extra_trees, using=using,
1992
 
                               format_cls=format)
 
1955
                               extra_trees=extra_trees, using=using)
1993
1956
 
1994
1957
 
1995
1958
class cmd_deleted(Command):
1996
 
    __doc__ = """List files deleted in the working tree.
 
1959
    """List files deleted in the working tree.
1997
1960
    """
1998
1961
    # TODO: Show files deleted since a previous revision, or
1999
1962
    # between two revisions.
2002
1965
    # level of effort but possibly much less IO.  (Or possibly not,
2003
1966
    # if the directories are very large...)
2004
1967
    _see_also = ['status', 'ls']
2005
 
    takes_options = ['directory', 'show-ids']
 
1968
    takes_options = ['show-ids']
2006
1969
 
2007
1970
    @display_command
2008
 
    def run(self, show_ids=False, directory=u'.'):
2009
 
        tree = WorkingTree.open_containing(directory)[0]
 
1971
    def run(self, show_ids=False):
 
1972
        tree = WorkingTree.open_containing(u'.')[0]
2010
1973
        tree.lock_read()
2011
1974
        self.add_cleanup(tree.unlock)
2012
1975
        old = tree.basis_tree()
2022
1985
 
2023
1986
 
2024
1987
class cmd_modified(Command):
2025
 
    __doc__ = """List files modified in working tree.
 
1988
    """List files modified in working tree.
2026
1989
    """
2027
1990
 
2028
1991
    hidden = True
2029
1992
    _see_also = ['status', 'ls']
2030
 
    takes_options = ['directory',
 
1993
    takes_options = [
2031
1994
            Option('null',
2032
1995
                   help='Write an ascii NUL (\\0) separator '
2033
1996
                   'between files rather than a newline.')
2034
1997
            ]
2035
1998
 
2036
1999
    @display_command
2037
 
    def run(self, null=False, directory=u'.'):
2038
 
        tree = WorkingTree.open_containing(directory)[0]
 
2000
    def run(self, null=False):
 
2001
        tree = WorkingTree.open_containing(u'.')[0]
2039
2002
        td = tree.changes_from(tree.basis_tree())
2040
2003
        for path, id, kind, text_modified, meta_modified in td.modified:
2041
2004
            if null:
2045
2008
 
2046
2009
 
2047
2010
class cmd_added(Command):
2048
 
    __doc__ = """List files added in working tree.
 
2011
    """List files added in working tree.
2049
2012
    """
2050
2013
 
2051
2014
    hidden = True
2052
2015
    _see_also = ['status', 'ls']
2053
 
    takes_options = ['directory',
 
2016
    takes_options = [
2054
2017
            Option('null',
2055
2018
                   help='Write an ascii NUL (\\0) separator '
2056
2019
                   'between files rather than a newline.')
2057
2020
            ]
2058
2021
 
2059
2022
    @display_command
2060
 
    def run(self, null=False, directory=u'.'):
2061
 
        wt = WorkingTree.open_containing(directory)[0]
 
2023
    def run(self, null=False):
 
2024
        wt = WorkingTree.open_containing(u'.')[0]
2062
2025
        wt.lock_read()
2063
2026
        self.add_cleanup(wt.unlock)
2064
2027
        basis = wt.basis_tree()
2072
2035
            if inv.is_root(file_id) and len(basis_inv) == 0:
2073
2036
                continue
2074
2037
            path = inv.id2path(file_id)
2075
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2038
            if not os.access(osutils.abspath(path), os.F_OK):
2076
2039
                continue
2077
2040
            if null:
2078
2041
                self.outf.write(path + '\0')
2081
2044
 
2082
2045
 
2083
2046
class cmd_root(Command):
2084
 
    __doc__ = """Show the tree root directory.
 
2047
    """Show the tree root directory.
2085
2048
 
2086
2049
    The root is the nearest enclosing directory with a .bzr control
2087
2050
    directory."""
2111
2074
 
2112
2075
 
2113
2076
class cmd_log(Command):
2114
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2077
    """Show historical log for a branch or subset of a branch.
2115
2078
 
2116
2079
    log is bzr's default tool for exploring the history of a branch.
2117
2080
    The branch to use is taken from the first parameter. If no parameters
2298
2261
                   help='Show changes made in each revision as a patch.'),
2299
2262
            Option('include-merges',
2300
2263
                   help='Show merged revisions like --levels 0 does.'),
2301
 
            Option('exclude-common-ancestry',
2302
 
                   help='Display only the revisions that are not part'
2303
 
                   ' of both ancestries (require -rX..Y)'
2304
 
                   )
2305
2264
            ]
2306
2265
    encoding_type = 'replace'
2307
2266
 
2317
2276
            message=None,
2318
2277
            limit=None,
2319
2278
            show_diff=False,
2320
 
            include_merges=False,
2321
 
            exclude_common_ancestry=False,
2322
 
            ):
 
2279
            include_merges=False):
2323
2280
        from bzrlib.log import (
2324
2281
            Logger,
2325
2282
            make_log_request_dict,
2326
2283
            _get_info_for_log_files,
2327
2284
            )
2328
2285
        direction = (forward and 'forward') or 'reverse'
2329
 
        if (exclude_common_ancestry
2330
 
            and (revision is None or len(revision) != 2)):
2331
 
            raise errors.BzrCommandError(
2332
 
                '--exclude-common-ancestry requires -r with two revisions')
2333
2286
        if include_merges:
2334
2287
            if levels is None:
2335
2288
                levels = 0
2428
2381
            direction=direction, specific_fileids=file_ids,
2429
2382
            start_revision=rev1, end_revision=rev2, limit=limit,
2430
2383
            message_search=message, delta_type=delta_type,
2431
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2432
 
            exclude_common_ancestry=exclude_common_ancestry,
2433
 
            )
 
2384
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2434
2385
        Logger(b, rqst).show(lf)
2435
2386
 
2436
2387
 
2455
2406
            raise errors.BzrCommandError(
2456
2407
                "bzr %s doesn't accept two revisions in different"
2457
2408
                " branches." % command_name)
2458
 
        if start_spec.spec is None:
2459
 
            # Avoid loading all the history.
2460
 
            rev1 = RevisionInfo(branch, None, None)
2461
 
        else:
2462
 
            rev1 = start_spec.in_history(branch)
 
2409
        rev1 = start_spec.in_history(branch)
2463
2410
        # Avoid loading all of history when we know a missing
2464
2411
        # end of range means the last revision ...
2465
2412
        if end_spec.spec is None:
2494
2441
 
2495
2442
 
2496
2443
class cmd_touching_revisions(Command):
2497
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2444
    """Return revision-ids which affected a particular file.
2498
2445
 
2499
2446
    A more user-friendly interface is "bzr log FILE".
2500
2447
    """
2515
2462
 
2516
2463
 
2517
2464
class cmd_ls(Command):
2518
 
    __doc__ = """List files in a tree.
 
2465
    """List files in a tree.
2519
2466
    """
2520
2467
 
2521
2468
    _see_also = ['status', 'cat']
2538
2485
                   help='List entries of a particular kind: file, directory, symlink.',
2539
2486
                   type=unicode),
2540
2487
            'show-ids',
2541
 
            'directory',
2542
2488
            ]
2543
2489
    @display_command
2544
2490
    def run(self, revision=None, verbose=False,
2545
2491
            recursive=False, from_root=False,
2546
2492
            unknown=False, versioned=False, ignored=False,
2547
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2493
            null=False, kind=None, show_ids=False, path=None):
2548
2494
 
2549
2495
        if kind and kind not in ('file', 'directory', 'symlink'):
2550
2496
            raise errors.BzrCommandError('invalid kind specified')
2562
2508
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2509
                                             ' and PATH')
2564
2510
            fs_path = path
2565
 
        tree, branch, relpath = \
2566
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2511
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2512
            fs_path)
2567
2513
 
2568
2514
        # Calculate the prefix to use
2569
2515
        prefix = None
2633
2579
 
2634
2580
 
2635
2581
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2582
    """List unknown files.
2637
2583
    """
2638
2584
 
2639
2585
    hidden = True
2640
2586
    _see_also = ['ls']
2641
 
    takes_options = ['directory']
2642
2587
 
2643
2588
    @display_command
2644
 
    def run(self, directory=u'.'):
2645
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2589
    def run(self):
 
2590
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2646
2591
            self.outf.write(osutils.quotefn(f) + '\n')
2647
2592
 
2648
2593
 
2649
2594
class cmd_ignore(Command):
2650
 
    __doc__ = """Ignore specified files or patterns.
 
2595
    """Ignore specified files or patterns.
2651
2596
 
2652
2597
    See ``bzr help patterns`` for details on the syntax of patterns.
2653
2598
 
2662
2607
    using this command or directly by using an editor, be sure to commit
2663
2608
    it.
2664
2609
    
2665
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2666
 
    the global ignore file can be found in the application data directory as
2667
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2668
 
    Global ignores are not touched by this command. The global ignore file
2669
 
    can be edited directly using an editor.
2670
 
 
2671
2610
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2672
2611
    precedence over regular ignores.  Such exceptions are used to specify
2673
2612
    files that should be versioned which would otherwise be ignored.
2713
2652
 
2714
2653
    _see_also = ['status', 'ignored', 'patterns']
2715
2654
    takes_args = ['name_pattern*']
2716
 
    takes_options = ['directory',
2717
 
        Option('default-rules',
2718
 
               help='Display the default ignore rules that bzr uses.')
 
2655
    takes_options = [
 
2656
        Option('old-default-rules',
 
2657
               help='Write out the ignore rules bzr < 0.9 always used.')
2719
2658
        ]
2720
2659
 
2721
 
    def run(self, name_pattern_list=None, default_rules=None,
2722
 
            directory=u'.'):
 
2660
    def run(self, name_pattern_list=None, old_default_rules=None):
2723
2661
        from bzrlib import ignores
2724
 
        if default_rules is not None:
2725
 
            # dump the default rules and exit
2726
 
            for pattern in ignores.USER_DEFAULTS:
2727
 
                self.outf.write("%s\n" % pattern)
 
2662
        if old_default_rules is not None:
 
2663
            # dump the rules and exit
 
2664
            for pattern in ignores.OLD_DEFAULTS:
 
2665
                print pattern
2728
2666
            return
2729
2667
        if not name_pattern_list:
2730
2668
            raise errors.BzrCommandError("ignore requires at least one "
2731
 
                "NAME_PATTERN or --default-rules.")
 
2669
                                  "NAME_PATTERN or --old-default-rules")
2732
2670
        name_pattern_list = [globbing.normalize_pattern(p)
2733
2671
                             for p in name_pattern_list]
2734
2672
        for name_pattern in name_pattern_list:
2736
2674
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2737
2675
                raise errors.BzrCommandError(
2738
2676
                    "NAME_PATTERN should not be an absolute path")
2739
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2677
        tree, relpath = WorkingTree.open_containing(u'.')
2740
2678
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2741
2679
        ignored = globbing.Globster(name_pattern_list)
2742
2680
        matches = []
2746
2684
            if id is not None:
2747
2685
                filename = entry[0]
2748
2686
                if ignored.match(filename):
2749
 
                    matches.append(filename)
 
2687
                    matches.append(filename.encode('utf-8'))
2750
2688
        tree.unlock()
2751
2689
        if len(matches) > 0:
2752
 
            self.outf.write("Warning: the following files are version controlled and"
2753
 
                  " match your ignore pattern:\n%s"
2754
 
                  "\nThese files will continue to be version controlled"
2755
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2690
            print "Warning: the following files are version controlled and" \
 
2691
                  " match your ignore pattern:\n%s" \
 
2692
                  "\nThese files will continue to be version controlled" \
 
2693
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2756
2694
 
2757
2695
 
2758
2696
class cmd_ignored(Command):
2759
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2697
    """List ignored files and the patterns that matched them.
2760
2698
 
2761
2699
    List all the ignored files and the ignore pattern that caused the file to
2762
2700
    be ignored.
2768
2706
 
2769
2707
    encoding_type = 'replace'
2770
2708
    _see_also = ['ignore', 'ls']
2771
 
    takes_options = ['directory']
2772
2709
 
2773
2710
    @display_command
2774
 
    def run(self, directory=u'.'):
2775
 
        tree = WorkingTree.open_containing(directory)[0]
 
2711
    def run(self):
 
2712
        tree = WorkingTree.open_containing(u'.')[0]
2776
2713
        tree.lock_read()
2777
2714
        self.add_cleanup(tree.unlock)
2778
2715
        for path, file_class, kind, file_id, entry in tree.list_files():
2784
2721
 
2785
2722
 
2786
2723
class cmd_lookup_revision(Command):
2787
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2724
    """Lookup the revision-id from a revision-number
2788
2725
 
2789
2726
    :Examples:
2790
2727
        bzr lookup-revision 33
2791
2728
    """
2792
2729
    hidden = True
2793
2730
    takes_args = ['revno']
2794
 
    takes_options = ['directory']
2795
2731
 
2796
2732
    @display_command
2797
 
    def run(self, revno, directory=u'.'):
 
2733
    def run(self, revno):
2798
2734
        try:
2799
2735
            revno = int(revno)
2800
2736
        except ValueError:
2801
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2802
 
                                         % revno)
2803
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2804
 
        self.outf.write("%s\n" % revid)
 
2737
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2738
 
 
2739
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2805
2740
 
2806
2741
 
2807
2742
class cmd_export(Command):
2808
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2743
    """Export current or past revision to a destination directory or archive.
2809
2744
 
2810
2745
    If no revision is specified this exports the last committed revision.
2811
2746
 
2833
2768
      =================       =========================
2834
2769
    """
2835
2770
    takes_args = ['dest', 'branch_or_subdir?']
2836
 
    takes_options = ['directory',
 
2771
    takes_options = [
2837
2772
        Option('format',
2838
2773
               help="Type of file to export to.",
2839
2774
               type=unicode),
2843
2778
        Option('root',
2844
2779
               type=str,
2845
2780
               help="Name of the root directory inside the exported file."),
2846
 
        Option('per-file-timestamps',
2847
 
               help='Set modification time of files to that of the last '
2848
 
                    'revision in which it was changed.'),
2849
2781
        ]
2850
2782
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2851
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2783
        root=None, filters=False):
2852
2784
        from bzrlib.export import export
2853
2785
 
2854
2786
        if branch_or_subdir is None:
2855
 
            tree = WorkingTree.open_containing(directory)[0]
 
2787
            tree = WorkingTree.open_containing(u'.')[0]
2856
2788
            b = tree.branch
2857
2789
            subdir = None
2858
2790
        else:
2861
2793
 
2862
2794
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2863
2795
        try:
2864
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2865
 
                   per_file_timestamps=per_file_timestamps)
 
2796
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2866
2797
        except errors.NoSuchExportFormat, e:
2867
2798
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2868
2799
 
2869
2800
 
2870
2801
class cmd_cat(Command):
2871
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2802
    """Write the contents of a file as of a given revision to standard output.
2872
2803
 
2873
2804
    If no revision is nominated, the last revision is used.
2874
2805
 
2877
2808
    """
2878
2809
 
2879
2810
    _see_also = ['ls']
2880
 
    takes_options = ['directory',
 
2811
    takes_options = [
2881
2812
        Option('name-from-revision', help='The path name in the old tree.'),
2882
2813
        Option('filters', help='Apply content filters to display the '
2883
2814
                'convenience form.'),
2888
2819
 
2889
2820
    @display_command
2890
2821
    def run(self, filename, revision=None, name_from_revision=False,
2891
 
            filters=False, directory=None):
 
2822
            filters=False):
2892
2823
        if revision is not None and len(revision) != 1:
2893
2824
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2894
2825
                                         " one revision specifier")
2895
2826
        tree, branch, relpath = \
2896
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2827
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2897
2828
        branch.lock_read()
2898
2829
        self.add_cleanup(branch.unlock)
2899
2830
        return self._run(tree, branch, relpath, filename, revision,
2954
2885
 
2955
2886
 
2956
2887
class cmd_local_time_offset(Command):
2957
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2888
    """Show the offset in seconds from GMT to local time."""
2958
2889
    hidden = True
2959
2890
    @display_command
2960
2891
    def run(self):
2961
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2892
        print osutils.local_time_offset()
2962
2893
 
2963
2894
 
2964
2895
 
2965
2896
class cmd_commit(Command):
2966
 
    __doc__ = """Commit changes into a new revision.
 
2897
    """Commit changes into a new revision.
2967
2898
 
2968
2899
    An explanatory message needs to be given for each commit. This is
2969
2900
    often done by using the --message option (getting the message from the
3077
3008
                         "the master branch until a normal commit "
3078
3009
                         "is performed."
3079
3010
                    ),
3080
 
             Option('show-diff', short_name='p',
 
3011
             Option('show-diff',
3081
3012
                    help='When no message is supplied, show the diff along'
3082
3013
                    ' with the status summary in the message editor.'),
3083
3014
             ]
3163
3094
                    '(use --file "%(f)s" to take commit message from that file)'
3164
3095
                    % { 'f': message })
3165
3096
                ui.ui_factory.show_warning(warning_msg)
3166
 
            if '\r' in message:
3167
 
                message = message.replace('\r\n', '\n')
3168
 
                message = message.replace('\r', '\n')
3169
 
            if file:
3170
 
                raise errors.BzrCommandError(
3171
 
                    "please specify either --message or --file")
3172
3097
 
3173
3098
        def get_message(commit_obj):
3174
3099
            """Callback to get commit message"""
3175
 
            if file:
3176
 
                my_message = codecs.open(
3177
 
                    file, 'rt', osutils.get_user_encoding()).read()
3178
 
            elif message is not None:
3179
 
                my_message = message
3180
 
            else:
3181
 
                # No message supplied: make one up.
3182
 
                # text is the status of the tree
3183
 
                text = make_commit_message_template_encoded(tree,
 
3100
            my_message = message
 
3101
            if my_message is not None and '\r' in my_message:
 
3102
                my_message = my_message.replace('\r\n', '\n')
 
3103
                my_message = my_message.replace('\r', '\n')
 
3104
            if my_message is None and not file:
 
3105
                t = make_commit_message_template_encoded(tree,
3184
3106
                        selected_list, diff=show_diff,
3185
3107
                        output_encoding=osutils.get_user_encoding())
3186
 
                # start_message is the template generated from hooks
3187
 
                # XXX: Warning - looks like hooks return unicode,
3188
 
                # make_commit_message_template_encoded returns user encoding.
3189
 
                # We probably want to be using edit_commit_message instead to
3190
 
                # avoid this.
3191
3108
                start_message = generate_commit_message_template(commit_obj)
3192
 
                my_message = edit_commit_message_encoded(text,
 
3109
                my_message = edit_commit_message_encoded(t,
3193
3110
                    start_message=start_message)
3194
3111
                if my_message is None:
3195
3112
                    raise errors.BzrCommandError("please specify a commit"
3196
3113
                        " message with either --message or --file")
 
3114
            elif my_message and file:
 
3115
                raise errors.BzrCommandError(
 
3116
                    "please specify either --message or --file")
 
3117
            if file:
 
3118
                my_message = codecs.open(file, 'rt',
 
3119
                                         osutils.get_user_encoding()).read()
3197
3120
            if my_message == "":
3198
3121
                raise errors.BzrCommandError("empty commit message specified")
3199
3122
            return my_message
3211
3134
                        timezone=offset,
3212
3135
                        exclude=safe_relpath_files(tree, exclude))
3213
3136
        except PointlessCommit:
 
3137
            # FIXME: This should really happen before the file is read in;
 
3138
            # perhaps prepare the commit; get the message; then actually commit
3214
3139
            raise errors.BzrCommandError("No changes to commit."
3215
3140
                              " Use --unchanged to commit anyhow.")
3216
3141
        except ConflictsInTree:
3221
3146
            raise errors.BzrCommandError("Commit refused because there are"
3222
3147
                              " unknown files in the working tree.")
3223
3148
        except errors.BoundBranchOutOfDate, e:
3224
 
            e.extra_help = ("\n"
3225
 
                'To commit to master branch, run update and then commit.\n'
3226
 
                'You can also pass --local to commit to continue working '
3227
 
                'disconnected.')
3228
 
            raise
 
3149
            raise errors.BzrCommandError(str(e) + "\n"
 
3150
            'To commit to master branch, run update and then commit.\n'
 
3151
            'You can also pass --local to commit to continue working '
 
3152
            'disconnected.')
3229
3153
 
3230
3154
 
3231
3155
class cmd_check(Command):
3232
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3156
    """Validate working tree structure, branch consistency and repository history.
3233
3157
 
3234
3158
    This command checks various invariants about branch and repository storage
3235
3159
    to detect data corruption or bzr bugs.
3299
3223
 
3300
3224
 
3301
3225
class cmd_upgrade(Command):
3302
 
    __doc__ = """Upgrade branch storage to current format.
 
3226
    """Upgrade branch storage to current format.
3303
3227
 
3304
3228
    The check command or bzr developers may sometimes advise you to run
3305
3229
    this command. When the default format has changed you may also be warned
3323
3247
 
3324
3248
 
3325
3249
class cmd_whoami(Command):
3326
 
    __doc__ = """Show or set bzr user id.
 
3250
    """Show or set bzr user id.
3327
3251
 
3328
3252
    :Examples:
3329
3253
        Show the email of the current user::
3373
3297
 
3374
3298
 
3375
3299
class cmd_nick(Command):
3376
 
    __doc__ = """Print or set the branch nickname.
 
3300
    """Print or set the branch nickname.
3377
3301
 
3378
3302
    If unset, the tree root directory name is used as the nickname.
3379
3303
    To print the current nickname, execute with no argument.
3384
3308
 
3385
3309
    _see_also = ['info']
3386
3310
    takes_args = ['nickname?']
3387
 
    takes_options = ['directory']
3388
 
    def run(self, nickname=None, directory=u'.'):
3389
 
        branch = Branch.open_containing(directory)[0]
 
3311
    def run(self, nickname=None):
 
3312
        branch = Branch.open_containing(u'.')[0]
3390
3313
        if nickname is None:
3391
3314
            self.printme(branch)
3392
3315
        else:
3394
3317
 
3395
3318
    @display_command
3396
3319
    def printme(self, branch):
3397
 
        self.outf.write('%s\n' % branch.nick)
 
3320
        print branch.nick
3398
3321
 
3399
3322
 
3400
3323
class cmd_alias(Command):
3401
 
    __doc__ = """Set/unset and display aliases.
 
3324
    """Set/unset and display aliases.
3402
3325
 
3403
3326
    :Examples:
3404
3327
        Show the current aliases::
3468
3391
 
3469
3392
 
3470
3393
class cmd_selftest(Command):
3471
 
    __doc__ = """Run internal test suite.
 
3394
    """Run internal test suite.
3472
3395
 
3473
3396
    If arguments are given, they are regular expressions that say which tests
3474
3397
    should run.  Tests matching any expression are run, and other tests are
3518
3441
    def get_transport_type(typestring):
3519
3442
        """Parse and return a transport specifier."""
3520
3443
        if typestring == "sftp":
3521
 
            from bzrlib.tests import stub_sftp
3522
 
            return stub_sftp.SFTPAbsoluteServer
 
3444
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3445
            return SFTPAbsoluteServer
3523
3446
        if typestring == "memory":
3524
 
            from bzrlib.tests import test_server
3525
 
            return memory.MemoryServer
 
3447
            from bzrlib.transport.memory import MemoryServer
 
3448
            return MemoryServer
3526
3449
        if typestring == "fakenfs":
3527
 
            from bzrlib.tests import test_server
3528
 
            return test_server.FakeNFSServer
 
3450
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3451
            return FakeNFSServer
3529
3452
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3530
3453
            (typestring)
3531
3454
        raise errors.BzrCommandError(msg)
3615
3538
                raise errors.BzrCommandError("subunit not available. subunit "
3616
3539
                    "needs to be installed to use --subunit.")
3617
3540
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3618
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3619
 
            # stdout, which would corrupt the subunit stream. 
3620
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3621
 
                import msvcrt
3622
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3623
3541
        if parallel:
3624
3542
            self.additional_selftest_args.setdefault(
3625
3543
                'suite_decorators', []).append(parallel)
3656
3574
 
3657
3575
 
3658
3576
class cmd_version(Command):
3659
 
    __doc__ = """Show version of bzr."""
 
3577
    """Show version of bzr."""
3660
3578
 
3661
3579
    encoding_type = 'replace'
3662
3580
    takes_options = [
3673
3591
 
3674
3592
 
3675
3593
class cmd_rocks(Command):
3676
 
    __doc__ = """Statement of optimism."""
 
3594
    """Statement of optimism."""
3677
3595
 
3678
3596
    hidden = True
3679
3597
 
3680
3598
    @display_command
3681
3599
    def run(self):
3682
 
        self.outf.write("It sure does!\n")
 
3600
        print "It sure does!"
3683
3601
 
3684
3602
 
3685
3603
class cmd_find_merge_base(Command):
3686
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3604
    """Find and print a base revision for merging two branches."""
3687
3605
    # TODO: Options to specify revisions on either side, as if
3688
3606
    #       merging only part of the history.
3689
3607
    takes_args = ['branch', 'other']
3705
3623
        graph = branch1.repository.get_graph(branch2.repository)
3706
3624
        base_rev_id = graph.find_unique_lca(last1, last2)
3707
3625
 
3708
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3626
        print 'merge base is revision %s' % base_rev_id
3709
3627
 
3710
3628
 
3711
3629
class cmd_merge(Command):
3712
 
    __doc__ = """Perform a three-way merge.
 
3630
    """Perform a three-way merge.
3713
3631
 
3714
3632
    The source of the merge can be specified either in the form of a branch,
3715
3633
    or in the form of a path to a file containing a merge directive generated
3798
3716
                ' completely merged into the source, pull from the'
3799
3717
                ' source rather than merging.  When this happens,'
3800
3718
                ' you do not need to commit the result.'),
3801
 
        custom_help('directory',
 
3719
        Option('directory',
3802
3720
               help='Branch to merge into, '
3803
 
                    'rather than the one containing the working directory.'),
 
3721
                    'rather than the one containing the working directory.',
 
3722
               short_name='d',
 
3723
               type=unicode,
 
3724
               ),
3804
3725
        Option('preview', help='Instead of merging, show a diff of the'
3805
3726
               ' merge.'),
3806
3727
        Option('interactive', help='Select changes interactively.',
3856
3777
                    raise errors.BzrCommandError(
3857
3778
                        'Cannot use -r with merge directives or bundles')
3858
3779
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3859
 
                   mergeable, None)
 
3780
                   mergeable, pb)
3860
3781
 
3861
3782
        if merger is None and uncommitted:
3862
3783
            if revision is not None and len(revision) > 0:
3863
3784
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3864
3785
                    ' --revision at the same time.')
3865
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3786
            merger = self.get_merger_from_uncommitted(tree, location, pb)
3866
3787
            allow_pending = False
3867
3788
 
3868
3789
        if merger is None:
3869
3790
            merger, allow_pending = self._get_merger_from_branch(tree,
3870
 
                location, revision, remember, possible_transports, None)
 
3791
                location, revision, remember, possible_transports, pb)
3871
3792
 
3872
3793
        merger.merge_type = merge_type
3873
3794
        merger.reprocess = reprocess
4067
3988
 
4068
3989
 
4069
3990
class cmd_remerge(Command):
4070
 
    __doc__ = """Redo a merge.
 
3991
    """Redo a merge.
4071
3992
 
4072
3993
    Use this if you want to try a different merge technique while resolving
4073
3994
    conflicts.  Some merge techniques are better than others, and remerge
4098
4019
 
4099
4020
    def run(self, file_list=None, merge_type=None, show_base=False,
4100
4021
            reprocess=False):
4101
 
        from bzrlib.conflicts import restore
4102
4022
        if merge_type is None:
4103
4023
            merge_type = _mod_merge.Merge3Merger
4104
4024
        tree, file_list = tree_files(file_list)
4145
4065
        # list, we imply that the working tree text has seen and rejected
4146
4066
        # all the changes from the other tree, when in fact those changes
4147
4067
        # have not yet been seen.
 
4068
        pb = ui.ui_factory.nested_progress_bar()
4148
4069
        tree.set_parent_ids(parents[:1])
4149
4070
        try:
4150
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4071
            merger = _mod_merge.Merger.from_revision_ids(pb,
 
4072
                                                         tree, parents[1])
4151
4073
            merger.interesting_ids = interesting_ids
4152
4074
            merger.merge_type = merge_type
4153
4075
            merger.show_base = show_base
4155
4077
            conflicts = merger.do_merge()
4156
4078
        finally:
4157
4079
            tree.set_parent_ids(parents)
 
4080
            pb.finished()
4158
4081
        if conflicts > 0:
4159
4082
            return 1
4160
4083
        else:
4162
4085
 
4163
4086
 
4164
4087
class cmd_revert(Command):
4165
 
    __doc__ = """Revert files to a previous revision.
 
4088
    """Revert files to a previous revision.
4166
4089
 
4167
4090
    Giving a list of files will revert only those files.  Otherwise, all files
4168
4091
    will be reverted.  If the revision is not specified with '--revision', the
4219
4142
    def run(self, revision=None, no_backup=False, file_list=None,
4220
4143
            forget_merges=None):
4221
4144
        tree, file_list = tree_files(file_list)
4222
 
        tree.lock_tree_write()
 
4145
        tree.lock_write()
4223
4146
        self.add_cleanup(tree.unlock)
4224
4147
        if forget_merges:
4225
4148
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4229
4152
    @staticmethod
4230
4153
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4231
4154
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4232
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4233
 
            report_changes=True)
 
4155
        pb = ui.ui_factory.nested_progress_bar()
 
4156
        try:
 
4157
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4158
                report_changes=True)
 
4159
        finally:
 
4160
            pb.finished()
4234
4161
 
4235
4162
 
4236
4163
class cmd_assert_fail(Command):
4237
 
    __doc__ = """Test reporting of assertion failures"""
 
4164
    """Test reporting of assertion failures"""
4238
4165
    # intended just for use in testing
4239
4166
 
4240
4167
    hidden = True
4244
4171
 
4245
4172
 
4246
4173
class cmd_help(Command):
4247
 
    __doc__ = """Show help on a command or other topic.
 
4174
    """Show help on a command or other topic.
4248
4175
    """
4249
4176
 
4250
4177
    _see_also = ['topics']
4263
4190
 
4264
4191
 
4265
4192
class cmd_shell_complete(Command):
4266
 
    __doc__ = """Show appropriate completions for context.
 
4193
    """Show appropriate completions for context.
4267
4194
 
4268
4195
    For a list of all available commands, say 'bzr shell-complete'.
4269
4196
    """
4278
4205
 
4279
4206
 
4280
4207
class cmd_missing(Command):
4281
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4208
    """Show unmerged/unpulled revisions between two branches.
4282
4209
 
4283
4210
    OTHER_BRANCH may be local or remote.
4284
4211
 
4362
4289
            restrict = 'remote'
4363
4290
 
4364
4291
        local_branch = Branch.open_containing(u".")[0]
4365
 
        local_branch.lock_read()
4366
 
        self.add_cleanup(local_branch.unlock)
4367
 
 
4368
4292
        parent = local_branch.get_parent()
4369
4293
        if other_branch is None:
4370
4294
            other_branch = parent
4379
4303
        remote_branch = Branch.open(other_branch)
4380
4304
        if remote_branch.base == local_branch.base:
4381
4305
            remote_branch = local_branch
4382
 
        else:
4383
 
            remote_branch.lock_read()
4384
 
            self.add_cleanup(remote_branch.unlock)
4385
4306
 
 
4307
        local_branch.lock_read()
 
4308
        self.add_cleanup(local_branch.unlock)
4386
4309
        local_revid_range = _revision_range_to_revid_range(
4387
4310
            _get_revision_range(my_revision, local_branch,
4388
4311
                self.name()))
4389
4312
 
 
4313
        remote_branch.lock_read()
 
4314
        self.add_cleanup(remote_branch.unlock)
4390
4315
        remote_revid_range = _revision_range_to_revid_range(
4391
4316
            _get_revision_range(revision,
4392
4317
                remote_branch, self.name()))
4451
4376
 
4452
4377
 
4453
4378
class cmd_pack(Command):
4454
 
    __doc__ = """Compress the data within a repository.
4455
 
 
4456
 
    This operation compresses the data within a bazaar repository. As
4457
 
    bazaar supports automatic packing of repository, this operation is
4458
 
    normally not required to be done manually.
4459
 
 
4460
 
    During the pack operation, bazaar takes a backup of existing repository
4461
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4462
 
    automatically when it is safe to do so. To save disk space by removing
4463
 
    the backed up pack files, the --clean-obsolete-packs option may be
4464
 
    used.
4465
 
 
4466
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4467
 
    during or immediately after repacking, you may be left with a state
4468
 
    where the deletion has been written to disk but the new packs have not
4469
 
    been. In this case the repository may be unusable.
4470
 
    """
 
4379
    """Compress the data within a repository."""
4471
4380
 
4472
4381
    _see_also = ['repositories']
4473
4382
    takes_args = ['branch_or_repo?']
4474
 
    takes_options = [
4475
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4476
 
        ]
4477
4383
 
4478
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4384
    def run(self, branch_or_repo='.'):
4479
4385
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4480
4386
        try:
4481
4387
            branch = dir.open_branch()
4482
4388
            repository = branch.repository
4483
4389
        except errors.NotBranchError:
4484
4390
            repository = dir.open_repository()
4485
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4391
        repository.pack()
4486
4392
 
4487
4393
 
4488
4394
class cmd_plugins(Command):
4489
 
    __doc__ = """List the installed plugins.
 
4395
    """List the installed plugins.
4490
4396
 
4491
4397
    This command displays the list of installed plugins including
4492
4398
    version of plugin and a short description of each.
4523
4429
                doc = '(no description)'
4524
4430
            result.append((name_ver, doc, plugin.path()))
4525
4431
        for name_ver, doc, path in sorted(result):
4526
 
            self.outf.write("%s\n" % name_ver)
4527
 
            self.outf.write("   %s\n" % doc)
 
4432
            print name_ver
 
4433
            print '   ', doc
4528
4434
            if verbose:
4529
 
                self.outf.write("   %s\n" % path)
4530
 
            self.outf.write("\n")
 
4435
                print '   ', path
 
4436
            print
4531
4437
 
4532
4438
 
4533
4439
class cmd_testament(Command):
4534
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4440
    """Show testament (signing-form) of a revision."""
4535
4441
    takes_options = [
4536
4442
            'revision',
4537
4443
            Option('long', help='Produce long-format testament.'),
4563
4469
 
4564
4470
 
4565
4471
class cmd_annotate(Command):
4566
 
    __doc__ = """Show the origin of each line in a file.
 
4472
    """Show the origin of each line in a file.
4567
4473
 
4568
4474
    This prints out the given file with an annotation on the left side
4569
4475
    indicating which revision, author and date introduced the change.
4580
4486
                     Option('long', help='Show commit date in annotations.'),
4581
4487
                     'revision',
4582
4488
                     'show-ids',
4583
 
                     'directory',
4584
4489
                     ]
4585
4490
    encoding_type = 'exact'
4586
4491
 
4587
4492
    @display_command
4588
4493
    def run(self, filename, all=False, long=False, revision=None,
4589
 
            show_ids=False, directory=None):
 
4494
            show_ids=False):
4590
4495
        from bzrlib.annotate import annotate_file, annotate_file_tree
4591
4496
        wt, branch, relpath = \
4592
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4497
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4593
4498
        if wt is not None:
4594
4499
            wt.lock_read()
4595
4500
            self.add_cleanup(wt.unlock)
4617
4522
 
4618
4523
 
4619
4524
class cmd_re_sign(Command):
4620
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4525
    """Create a digital signature for an existing revision."""
4621
4526
    # TODO be able to replace existing ones.
4622
4527
 
4623
4528
    hidden = True # is this right ?
4624
4529
    takes_args = ['revision_id*']
4625
 
    takes_options = ['directory', 'revision']
 
4530
    takes_options = ['revision']
4626
4531
 
4627
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4532
    def run(self, revision_id_list=None, revision=None):
4628
4533
        if revision_id_list is not None and revision is not None:
4629
4534
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4630
4535
        if revision_id_list is None and revision is None:
4631
4536
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4632
 
        b = WorkingTree.open_containing(directory)[0].branch
 
4537
        b = WorkingTree.open_containing(u'.')[0].branch
4633
4538
        b.lock_write()
4634
4539
        self.add_cleanup(b.unlock)
4635
4540
        return self._run(b, revision_id_list, revision)
4683
4588
 
4684
4589
 
4685
4590
class cmd_bind(Command):
4686
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4687
 
    If no branch is supplied, rebind to the last bound location.
 
4591
    """Convert the current branch into a checkout of the supplied branch.
4688
4592
 
4689
4593
    Once converted into a checkout, commits must succeed on the master branch
4690
4594
    before they will be applied to the local branch.
4696
4600
 
4697
4601
    _see_also = ['checkouts', 'unbind']
4698
4602
    takes_args = ['location?']
4699
 
    takes_options = ['directory']
 
4603
    takes_options = []
4700
4604
 
4701
 
    def run(self, location=None, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
4605
    def run(self, location=None):
 
4606
        b, relpath = Branch.open_containing(u'.')
4703
4607
        if location is None:
4704
4608
            try:
4705
4609
                location = b.get_old_bound_location()
4708
4612
                    'This format does not remember old locations.')
4709
4613
            else:
4710
4614
                if location is None:
4711
 
                    if b.get_bound_location() is not None:
4712
 
                        raise errors.BzrCommandError('Branch is already bound')
4713
 
                    else:
4714
 
                        raise errors.BzrCommandError('No location supplied '
4715
 
                            'and no previous location known')
 
4615
                    raise errors.BzrCommandError('No location supplied and no '
 
4616
                        'previous location known')
4716
4617
        b_other = Branch.open(location)
4717
4618
        try:
4718
4619
            b.bind(b_other)
4724
4625
 
4725
4626
 
4726
4627
class cmd_unbind(Command):
4727
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4628
    """Convert the current checkout into a regular branch.
4728
4629
 
4729
4630
    After unbinding, the local branch is considered independent and subsequent
4730
4631
    commits will be local only.
4732
4633
 
4733
4634
    _see_also = ['checkouts', 'bind']
4734
4635
    takes_args = []
4735
 
    takes_options = ['directory']
 
4636
    takes_options = []
4736
4637
 
4737
 
    def run(self, directory=u'.'):
4738
 
        b, relpath = Branch.open_containing(directory)
 
4638
    def run(self):
 
4639
        b, relpath = Branch.open_containing(u'.')
4739
4640
        if not b.unbind():
4740
4641
            raise errors.BzrCommandError('Local branch is not bound')
4741
4642
 
4742
4643
 
4743
4644
class cmd_uncommit(Command):
4744
 
    __doc__ = """Remove the last committed revision.
 
4645
    """Remove the last committed revision.
4745
4646
 
4746
4647
    --verbose will print out what is being removed.
4747
4648
    --dry-run will go through all the motions, but not actually
4830
4731
                 end_revision=last_revno)
4831
4732
 
4832
4733
        if dry_run:
4833
 
            self.outf.write('Dry-run, pretending to remove'
4834
 
                            ' the above revisions.\n')
 
4734
            print 'Dry-run, pretending to remove the above revisions.'
 
4735
            if not force:
 
4736
                val = raw_input('Press <enter> to continue')
4835
4737
        else:
4836
 
            self.outf.write('The above revision(s) will be removed.\n')
4837
 
 
4838
 
        if not force:
4839
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4840
 
                self.outf.write('Canceled')
4841
 
                return 0
 
4738
            print 'The above revision(s) will be removed.'
 
4739
            if not force:
 
4740
                val = raw_input('Are you sure [y/N]? ')
 
4741
                if val.lower() not in ('y', 'yes'):
 
4742
                    print 'Canceled'
 
4743
                    return 0
4842
4744
 
4843
4745
        mutter('Uncommitting from {%s} to {%s}',
4844
4746
               last_rev_id, rev_id)
4845
4747
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4846
4748
                 revno=revno, local=local)
4847
 
        self.outf.write('You can restore the old tip by running:\n'
4848
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4749
        note('You can restore the old tip by running:\n'
 
4750
             '  bzr pull . -r revid:%s', last_rev_id)
4849
4751
 
4850
4752
 
4851
4753
class cmd_break_lock(Command):
4852
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4754
    """Break a dead lock on a repository, branch or working directory.
4853
4755
 
4854
4756
    CAUTION: Locks should only be broken when you are sure that the process
4855
4757
    holding the lock has been stopped.
4874
4776
 
4875
4777
 
4876
4778
class cmd_wait_until_signalled(Command):
4877
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4779
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4878
4780
 
4879
4781
    This just prints a line to signal when it is ready, then blocks on stdin.
4880
4782
    """
4888
4790
 
4889
4791
 
4890
4792
class cmd_serve(Command):
4891
 
    __doc__ = """Run the bzr server."""
 
4793
    """Run the bzr server."""
4892
4794
 
4893
4795
    aliases = ['server']
4894
4796
 
4905
4807
                    'result in a dynamically allocated port.  The default port '
4906
4808
                    'depends on the protocol.',
4907
4809
               type=str),
4908
 
        custom_help('directory',
4909
 
               help='Serve contents of this directory.'),
 
4810
        Option('directory',
 
4811
               help='Serve contents of this directory.',
 
4812
               type=unicode),
4910
4813
        Option('allow-writes',
4911
4814
               help='By default the server is a readonly server.  Supplying '
4912
4815
                    '--allow-writes enables write access to the contents of '
4953
4856
 
4954
4857
 
4955
4858
class cmd_join(Command):
4956
 
    __doc__ = """Combine a tree into its containing tree.
 
4859
    """Combine a tree into its containing tree.
4957
4860
 
4958
4861
    This command requires the target tree to be in a rich-root format.
4959
4862
 
4999
4902
 
5000
4903
 
5001
4904
class cmd_split(Command):
5002
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4905
    """Split a subdirectory of a tree into a separate tree.
5003
4906
 
5004
4907
    This command will produce a target tree in a format that supports
5005
4908
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5025
4928
 
5026
4929
 
5027
4930
class cmd_merge_directive(Command):
5028
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4931
    """Generate a merge directive for auto-merge tools.
5029
4932
 
5030
4933
    A directive requests a merge to be performed, and also provides all the
5031
4934
    information necessary to do so.  This means it must either include a
5124
5027
 
5125
5028
 
5126
5029
class cmd_send(Command):
5127
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5030
    """Mail or create a merge-directive for submitting changes.
5128
5031
 
5129
5032
    A merge directive provides many things needed for requesting merges:
5130
5033
 
5212
5115
               short_name='f',
5213
5116
               type=unicode),
5214
5117
        Option('output', short_name='o',
5215
 
               help='Write merge directive to this file or directory; '
 
5118
               help='Write merge directive to this file; '
5216
5119
                    'use - for stdout.',
5217
5120
               type=unicode),
5218
5121
        Option('strict',
5241
5144
 
5242
5145
 
5243
5146
class cmd_bundle_revisions(cmd_send):
5244
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5147
    """Create a merge-directive for submitting changes.
5245
5148
 
5246
5149
    A merge directive provides many things needed for requesting merges:
5247
5150
 
5314
5217
 
5315
5218
 
5316
5219
class cmd_tag(Command):
5317
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5220
    """Create, remove or modify a tag naming a revision.
5318
5221
 
5319
5222
    Tags give human-meaningful names to revisions.  Commands that take a -r
5320
5223
    (--revision) option can be given -rtag:X, where X is any previously
5328
5231
 
5329
5232
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5330
5233
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5331
 
 
5332
 
    If no tag name is specified it will be determined through the 
5333
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5334
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5335
 
    details.
5336
5234
    """
5337
5235
 
5338
5236
    _see_also = ['commit', 'tags']
5339
 
    takes_args = ['tag_name?']
 
5237
    takes_args = ['tag_name']
5340
5238
    takes_options = [
5341
5239
        Option('delete',
5342
5240
            help='Delete this tag rather than placing it.',
5343
5241
            ),
5344
 
        custom_help('directory',
5345
 
            help='Branch in which to place the tag.'),
 
5242
        Option('directory',
 
5243
            help='Branch in which to place the tag.',
 
5244
            short_name='d',
 
5245
            type=unicode,
 
5246
            ),
5346
5247
        Option('force',
5347
5248
            help='Replace existing tags.',
5348
5249
            ),
5349
5250
        'revision',
5350
5251
        ]
5351
5252
 
5352
 
    def run(self, tag_name=None,
 
5253
    def run(self, tag_name,
5353
5254
            delete=None,
5354
5255
            directory='.',
5355
5256
            force=None,
5359
5260
        branch.lock_write()
5360
5261
        self.add_cleanup(branch.unlock)
5361
5262
        if delete:
5362
 
            if tag_name is None:
5363
 
                raise errors.BzrCommandError("No tag specified to delete.")
5364
5263
            branch.tags.delete_tag(tag_name)
5365
5264
            self.outf.write('Deleted tag %s.\n' % tag_name)
5366
5265
        else:
5372
5271
                revision_id = revision[0].as_revision_id(branch)
5373
5272
            else:
5374
5273
                revision_id = branch.last_revision()
5375
 
            if tag_name is None:
5376
 
                tag_name = branch.automatic_tag_name(revision_id)
5377
 
                if tag_name is None:
5378
 
                    raise errors.BzrCommandError(
5379
 
                        "Please specify a tag name.")
5380
5274
            if (not force) and branch.tags.has_tag(tag_name):
5381
5275
                raise errors.TagAlreadyExists(tag_name)
5382
5276
            branch.tags.set_tag(tag_name, revision_id)
5384
5278
 
5385
5279
 
5386
5280
class cmd_tags(Command):
5387
 
    __doc__ = """List tags.
 
5281
    """List tags.
5388
5282
 
5389
5283
    This command shows a table of tag names and the revisions they reference.
5390
5284
    """
5391
5285
 
5392
5286
    _see_also = ['tag']
5393
5287
    takes_options = [
5394
 
        custom_help('directory',
5395
 
            help='Branch whose tags should be displayed.'),
 
5288
        Option('directory',
 
5289
            help='Branch whose tags should be displayed.',
 
5290
            short_name='d',
 
5291
            type=unicode,
 
5292
            ),
5396
5293
        RegistryOption.from_kwargs('sort',
5397
5294
            'Sort tags by different criteria.', title='Sorting',
5398
5295
            alpha='Sort tags lexicographically (default).',
5455
5352
 
5456
5353
 
5457
5354
class cmd_reconfigure(Command):
5458
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5355
    """Reconfigure the type of a bzr directory.
5459
5356
 
5460
5357
    A target configuration must be specified.
5461
5358
 
5546
5443
 
5547
5444
 
5548
5445
class cmd_switch(Command):
5549
 
    __doc__ = """Set the branch of a checkout and update.
 
5446
    """Set the branch of a checkout and update.
5550
5447
 
5551
5448
    For lightweight checkouts, this changes the branch being referenced.
5552
5449
    For heavyweight checkouts, this checks that there are no local commits
5642
5539
 
5643
5540
 
5644
5541
class cmd_view(Command):
5645
 
    __doc__ = """Manage filtered views.
 
5542
    """Manage filtered views.
5646
5543
 
5647
5544
    Views provide a mask over the tree so that users can focus on
5648
5545
    a subset of a tree when doing their work. After creating a view,
5796
5693
 
5797
5694
 
5798
5695
class cmd_hooks(Command):
5799
 
    __doc__ = """Show hooks."""
 
5696
    """Show hooks."""
5800
5697
 
5801
5698
    hidden = True
5802
5699
 
5815
5712
                    self.outf.write("    <no hooks installed>\n")
5816
5713
 
5817
5714
 
5818
 
class cmd_remove_branch(Command):
5819
 
    __doc__ = """Remove a branch.
5820
 
 
5821
 
    This will remove the branch from the specified location but 
5822
 
    will keep any working tree or repository in place.
5823
 
 
5824
 
    :Examples:
5825
 
 
5826
 
      Remove the branch at repo/trunk::
5827
 
 
5828
 
        bzr remove-branch repo/trunk
5829
 
 
5830
 
    """
5831
 
 
5832
 
    takes_args = ["location?"]
5833
 
 
5834
 
    aliases = ["rmbranch"]
5835
 
 
5836
 
    def run(self, location=None):
5837
 
        if location is None:
5838
 
            location = "."
5839
 
        branch = Branch.open_containing(location)[0]
5840
 
        branch.bzrdir.destroy_branch()
5841
 
        
5842
 
 
5843
5715
class cmd_shelve(Command):
5844
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5716
    """Temporarily set aside some changes from the current tree.
5845
5717
 
5846
5718
    Shelve allows you to temporarily put changes you've made "on the shelf",
5847
5719
    ie. out of the way, until a later time when you can bring them back from
5916
5788
 
5917
5789
 
5918
5790
class cmd_unshelve(Command):
5919
 
    __doc__ = """Restore shelved changes.
 
5791
    """Restore shelved changes.
5920
5792
 
5921
5793
    By default, the most recently shelved changes are restored. However if you
5922
5794
    specify a shelf by id those changes will be restored instead.  This works
5948
5820
 
5949
5821
 
5950
5822
class cmd_clean_tree(Command):
5951
 
    __doc__ = """Remove unwanted files from working tree.
 
5823
    """Remove unwanted files from working tree.
5952
5824
 
5953
5825
    By default, only unknown files, not ignored files, are deleted.  Versioned
5954
5826
    files are never deleted.
5962
5834
 
5963
5835
    To check what clean-tree will do, use --dry-run.
5964
5836
    """
5965
 
    takes_options = ['directory',
5966
 
                     Option('ignored', help='Delete all ignored files.'),
 
5837
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5967
5838
                     Option('detritus', help='Delete conflict files, merge'
5968
5839
                            ' backups, and failed selftest dirs.'),
5969
5840
                     Option('unknown',
5972
5843
                            ' deleting them.'),
5973
5844
                     Option('force', help='Do not prompt before deleting.')]
5974
5845
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5975
 
            force=False, directory=u'.'):
 
5846
            force=False):
5976
5847
        from bzrlib.clean_tree import clean_tree
5977
5848
        if not (unknown or ignored or detritus):
5978
5849
            unknown = True
5979
5850
        if dry_run:
5980
5851
            force = True
5981
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5982
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5852
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5853
                   dry_run=dry_run, no_prompt=force)
5983
5854
 
5984
5855
 
5985
5856
class cmd_reference(Command):
5986
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5857
    """list, view and set branch locations for nested trees.
5987
5858
 
5988
5859
    If no arguments are provided, lists the branch locations for nested trees.
5989
5860
    If one argument is provided, display the branch location for that tree.
6029
5900
            self.outf.write('%s %s\n' % (path, location))
6030
5901
 
6031
5902
 
6032
 
def _register_lazy_builtins():
6033
 
    # register lazy builtins from other modules; called at startup and should
6034
 
    # be only called once.
6035
 
    for (name, aliases, module_name) in [
6036
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6037
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6038
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6039
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6040
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6041
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6042
 
        ]:
6043
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5903
# these get imported and then picked up by the scan for cmd_*
 
5904
# TODO: Some more consistent way to split command definitions across files;
 
5905
# we do need to load at least some information about them to know of
 
5906
# aliases.  ideally we would avoid loading the implementation until the
 
5907
# details were needed.
 
5908
from bzrlib.cmd_version_info import cmd_version_info
 
5909
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5910
from bzrlib.bundle.commands import (
 
5911
    cmd_bundle_info,
 
5912
    )
 
5913
from bzrlib.foreign import cmd_dpush
 
5914
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5915
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5916
        cmd_weave_plan_merge, cmd_weave_merge_text