/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
54
54
    )
55
55
from bzrlib.branch import Branch
56
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
57
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
59
from bzrlib.smtp_connection import SMTPConnection
59
60
from bzrlib.workingtree import WorkingTree
60
61
""")
61
62
 
62
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
63
68
from bzrlib.option import (
64
69
    ListOption,
65
70
    Option,
234
239
# opens the branch?)
235
240
 
236
241
class cmd_status(Command):
237
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
238
243
 
239
244
    This reports on versioned and unknown files, reporting them
240
245
    grouped by state.  Possible states are:
327
332
 
328
333
 
329
334
class cmd_cat_revision(Command):
330
 
    """Write out metadata for a revision.
 
335
    __doc__ = """Write out metadata for a revision.
331
336
 
332
337
    The revision to print can either be specified by a specific
333
338
    revision identifier, or you can use --revision.
339
344
    # cat-revision is more for frontends so should be exact
340
345
    encoding = 'strict'
341
346
 
 
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
 
342
355
    @display_command
343
356
    def run(self, revision_id=None, revision=None):
344
357
        if revision_id is not None and revision is not None:
349
362
                                         ' --revision or a revision_id')
350
363
        b = WorkingTree.open_containing(u'.')[0].branch
351
364
 
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'))
 
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')
368
369
 
 
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
        
369
391
 
370
392
class cmd_dump_btree(Command):
371
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
372
394
 
373
395
    PATH is a btree index file, it can be any URL. This includes things like
374
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
438
460
        for node in bt.iter_all_entries():
439
461
            # Node is made up of:
440
462
            # (index, key, value, [references])
441
 
            refs_as_tuples = static_tuple.as_tuples(node[3])
 
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)
442
469
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
443
470
            self.outf.write('%s\n' % (as_tuple,))
444
471
 
445
472
 
446
473
class cmd_remove_tree(Command):
447
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
448
475
 
449
476
    Since a lightweight checkout is little more than a working tree
450
477
    this will refuse to run against one.
452
479
    To re-create the working tree, use "bzr checkout".
453
480
    """
454
481
    _see_also = ['checkout', 'working-trees']
455
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
456
483
    takes_options = [
457
484
        Option('force',
458
485
               help='Remove the working tree even if it has '
459
486
                    'uncommitted changes.'),
460
487
        ]
461
488
 
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()
 
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()
483
512
 
484
513
 
485
514
class cmd_revno(Command):
486
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
487
516
 
488
517
    This is equal to the number of revisions on this branch.
489
518
    """
519
548
 
520
549
 
521
550
class cmd_revision_info(Command):
522
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
523
552
    """
524
553
    hidden = True
525
554
    takes_args = ['revision_info*']
581
610
 
582
611
 
583
612
class cmd_add(Command):
584
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
585
614
 
586
615
    In non-recursive mode, all the named items are added, regardless
587
616
    of whether they were previously ignored.  A warning is given if
667
696
 
668
697
 
669
698
class cmd_mkdir(Command):
670
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
671
700
 
672
701
    This is equivalent to creating the directory and then adding it.
673
702
    """
677
706
 
678
707
    def run(self, dir_list):
679
708
        for d in dir_list:
680
 
            os.mkdir(d)
681
709
            wt, dd = WorkingTree.open_containing(d)
682
 
            wt.add([dd])
683
 
            self.outf.write('added %s\n' % 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)
684
718
 
685
719
 
686
720
class cmd_relpath(Command):
687
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
688
722
 
689
723
    takes_args = ['filename']
690
724
    hidden = True
699
733
 
700
734
 
701
735
class cmd_inventory(Command):
702
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
703
737
 
704
738
    It is possible to limit the output to a particular entry
705
739
    type using the --kind option.  For example: --kind file.
760
794
 
761
795
 
762
796
class cmd_mv(Command):
763
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
764
798
 
765
799
    :Usage:
766
800
        bzr mv OLDNAME NEWNAME
897
931
 
898
932
 
899
933
class cmd_pull(Command):
900
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
901
935
 
902
936
    By default, this command only works on branches that have not diverged.
903
937
    Branches are considered diverged if the destination branch's most recent 
952
986
        try:
953
987
            tree_to = WorkingTree.open_containing(directory)[0]
954
988
            branch_to = tree_to.branch
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
955
991
        except errors.NoWorkingTree:
956
992
            tree_to = None
957
993
            branch_to = Branch.open_containing(directory)[0]
958
 
        
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
 
996
 
959
997
        if local and not branch_to.get_bound_location():
960
998
            raise errors.LocalRequiresBoundBranch()
961
999
 
991
1029
        else:
992
1030
            branch_from = Branch.open(location,
993
1031
                possible_transports=possible_transports)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
994
1034
 
995
1035
            if branch_to.get_parent() is None or remember:
996
1036
                branch_to.set_parent(branch_from.base)
997
1037
 
998
 
        if branch_from is not branch_to:
999
 
            branch_from.lock_read()
1000
 
            self.add_cleanup(branch_from.unlock)
1001
1038
        if revision is not None:
1002
1039
            revision_id = revision.as_revision_id(branch_from)
1003
1040
 
1004
 
        branch_to.lock_write()
1005
 
        self.add_cleanup(branch_to.unlock)
1006
1041
        if tree_to is not None:
1007
1042
            view_info = _get_view_info_for_change_reporter(tree_to)
1008
1043
            change_reporter = delta._ChangeReporter(
1023
1058
 
1024
1059
 
1025
1060
class cmd_push(Command):
1026
 
    """Update a mirror of this branch.
 
1061
    __doc__ = """Update a mirror of this branch.
1027
1062
 
1028
1063
    The target branch will not have its working tree populated because this
1029
1064
    is both expensive, and is not supported on remote file systems.
1090
1125
        # Get the source branch
1091
1126
        (tree, br_from,
1092
1127
         _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
1096
1128
        # Get the tip's revision_id
1097
1129
        revision = _get_one_revision('push', revision)
1098
1130
        if revision is not None:
1099
1131
            revision_id = revision.in_history(br_from).rev_id
1100
1132
        else:
1101
1133
            revision_id = None
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
 
 
 
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.')
1113
1139
        # Get the stacked_on branch, if any
1114
1140
        if stacked_on is not None:
1115
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1147
1173
 
1148
1174
 
1149
1175
class cmd_branch(Command):
1150
 
    """Create a new branch that is a copy of an existing branch.
 
1176
    __doc__ = """Create a new branch that is a copy of an existing branch.
1151
1177
 
1152
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1153
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1260
1286
 
1261
1287
 
1262
1288
class cmd_checkout(Command):
1263
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1264
1290
 
1265
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1266
1292
    the branch found in '.'. This is useful if you have removed the working tree
1329
1355
 
1330
1356
 
1331
1357
class cmd_renames(Command):
1332
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1333
1359
    """
1334
1360
    # TODO: Option to show renames between two historical versions.
1335
1361
 
1361
1387
 
1362
1388
 
1363
1389
class cmd_update(Command):
1364
 
    """Update a tree to have the latest code committed to its branch.
 
1390
    __doc__ = """Update a tree to have the latest code committed to its branch.
1365
1391
 
1366
1392
    This will perform a merge into the working tree, and may generate
1367
1393
    conflicts. If you have any local changes, you will still
1396
1422
            branch_location = tree.branch.base
1397
1423
        self.add_cleanup(tree.unlock)
1398
1424
        # get rid of the final '/' and be ready for display
1399
 
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
1400
 
                                                        self.outf.encoding)
 
1425
        branch_location = urlutils.unescape_for_display(
 
1426
            branch_location.rstrip('/'),
 
1427
            self.outf.encoding)
1401
1428
        existing_pending_merges = tree.get_parent_ids()[1:]
1402
1429
        if master is None:
1403
1430
            old_tip = None
1411
1438
        else:
1412
1439
            revision_id = branch.last_revision()
1413
1440
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
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))
 
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))
1417
1444
            return 0
1418
1445
        view_info = _get_view_info_for_change_reporter(tree)
1419
1446
        change_reporter = delta._ChangeReporter(
1431
1458
                                  "bzr update --revision only works"
1432
1459
                                  " for a revision in the branch history"
1433
1460
                                  % (e.revision))
1434
 
        revno = tree.branch.revision_id_to_revno(
 
1461
        revno = tree.branch.revision_id_to_dotted_revno(
1435
1462
            _mod_revision.ensure_null(tree.last_revision()))
1436
 
        note('Updated to revision %d of branch %s' %
1437
 
             (revno, branch_location))
1438
 
        if tree.get_parent_ids()[1:] != existing_pending_merges:
 
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:
1439
1467
            note('Your local commits will now show as pending merges with '
1440
1468
                 "'bzr status', and can be committed with 'bzr commit'.")
1441
1469
        if conflicts != 0:
1445
1473
 
1446
1474
 
1447
1475
class cmd_info(Command):
1448
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1449
1477
 
1450
1478
    This command will show all known locations and formats associated to the
1451
1479
    tree, branch or repository.
1489
1517
 
1490
1518
 
1491
1519
class cmd_remove(Command):
1492
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1493
1521
 
1494
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1495
1523
    them if they can easily be recovered using revert. If no options or
1543
1571
 
1544
1572
 
1545
1573
class cmd_file_id(Command):
1546
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1547
1575
 
1548
1576
    The file_id is assigned when the file is first added and remains the
1549
1577
    same through all revisions where the file exists, even when it is
1565
1593
 
1566
1594
 
1567
1595
class cmd_file_path(Command):
1568
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1569
1597
 
1570
1598
    This prints one line for each directory down to the target,
1571
1599
    starting at the branch root.
1587
1615
 
1588
1616
 
1589
1617
class cmd_reconcile(Command):
1590
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1591
1619
 
1592
1620
    This can correct data mismatches that may have been caused by
1593
1621
    previous ghost operations or bzr upgrades. You should only
1615
1643
 
1616
1644
 
1617
1645
class cmd_revision_history(Command):
1618
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1619
1647
 
1620
1648
    _see_also = ['log']
1621
1649
    takes_args = ['location?']
1631
1659
 
1632
1660
 
1633
1661
class cmd_ancestry(Command):
1634
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1635
1663
 
1636
1664
    _see_also = ['log', 'revision-history']
1637
1665
    takes_args = ['location?']
1656
1684
 
1657
1685
 
1658
1686
class cmd_init(Command):
1659
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1660
1688
 
1661
1689
    Use this to create an empty branch, or before importing an
1662
1690
    existing project.
1765
1793
 
1766
1794
 
1767
1795
class cmd_init_repository(Command):
1768
 
    """Create a shared repository for branches to share storage space.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1769
1797
 
1770
1798
    New branches created under the repository directory will store their
1771
1799
    revisions in the repository, not in the branch directory.  For branches
1825
1853
 
1826
1854
 
1827
1855
class cmd_diff(Command):
1828
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1829
1857
 
1830
1858
    If no arguments are given, all changes for the current tree are listed.
1831
1859
    If files are given, only the changes in those files are listed.
1917
1945
            help='Use this command to compare files.',
1918
1946
            type=unicode,
1919
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1920
1952
        ]
1921
1953
    aliases = ['di', 'dif']
1922
1954
    encoding_type = 'exact'
1923
1955
 
1924
1956
    @display_command
1925
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1926
 
            prefix=None, old=None, new=None, using=None):
1927
 
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
 
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)
1928
1961
 
1929
1962
        if (prefix is None) or (prefix == '0'):
1930
1963
            # diff -p0 format
1944
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1945
1978
                                         ' one or two revision specifiers')
1946
1979
 
 
1980
        if using is not None and format is not None:
 
1981
            raise errors.BzrCommandError('--using and --format are mutually '
 
1982
                'exclusive.')
 
1983
 
1947
1984
        (old_tree, new_tree,
1948
1985
         old_branch, new_branch,
1949
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
1950
 
            file_list, revision, old, new, apply_view=True)
 
1986
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1987
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1951
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1952
1989
                               specific_files=specific_files,
1953
1990
                               external_diff_options=diff_options,
1954
1991
                               old_label=old_label, new_label=new_label,
1955
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1956
1994
 
1957
1995
 
1958
1996
class cmd_deleted(Command):
1959
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1960
1998
    """
1961
1999
    # TODO: Show files deleted since a previous revision, or
1962
2000
    # between two revisions.
1985
2023
 
1986
2024
 
1987
2025
class cmd_modified(Command):
1988
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1989
2027
    """
1990
2028
 
1991
2029
    hidden = True
2008
2046
 
2009
2047
 
2010
2048
class cmd_added(Command):
2011
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
2012
2050
    """
2013
2051
 
2014
2052
    hidden = True
2044
2082
 
2045
2083
 
2046
2084
class cmd_root(Command):
2047
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2048
2086
 
2049
2087
    The root is the nearest enclosing directory with a .bzr control
2050
2088
    directory."""
2074
2112
 
2075
2113
 
2076
2114
class cmd_log(Command):
2077
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2078
2116
 
2079
2117
    log is bzr's default tool for exploring the history of a branch.
2080
2118
    The branch to use is taken from the first parameter. If no parameters
2261
2299
                   help='Show changes made in each revision as a patch.'),
2262
2300
            Option('include-merges',
2263
2301
                   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
                   )
2264
2306
            ]
2265
2307
    encoding_type = 'replace'
2266
2308
 
2276
2318
            message=None,
2277
2319
            limit=None,
2278
2320
            show_diff=False,
2279
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2280
2324
        from bzrlib.log import (
2281
2325
            Logger,
2282
2326
            make_log_request_dict,
2283
2327
            _get_info_for_log_files,
2284
2328
            )
2285
2329
        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')
2286
2334
        if include_merges:
2287
2335
            if levels is None:
2288
2336
                levels = 0
2381
2429
            direction=direction, specific_fileids=file_ids,
2382
2430
            start_revision=rev1, end_revision=rev2, limit=limit,
2383
2431
            message_search=message, delta_type=delta_type,
2384
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2432
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2433
            exclude_common_ancestry=exclude_common_ancestry,
 
2434
            )
2385
2435
        Logger(b, rqst).show(lf)
2386
2436
 
2387
2437
 
2406
2456
            raise errors.BzrCommandError(
2407
2457
                "bzr %s doesn't accept two revisions in different"
2408
2458
                " branches." % command_name)
2409
 
        rev1 = start_spec.in_history(branch)
 
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)
2410
2464
        # Avoid loading all of history when we know a missing
2411
2465
        # end of range means the last revision ...
2412
2466
        if end_spec.spec is None:
2441
2495
 
2442
2496
 
2443
2497
class cmd_touching_revisions(Command):
2444
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2445
2499
 
2446
2500
    A more user-friendly interface is "bzr log FILE".
2447
2501
    """
2462
2516
 
2463
2517
 
2464
2518
class cmd_ls(Command):
2465
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2466
2520
    """
2467
2521
 
2468
2522
    _see_also = ['status', 'cat']
2579
2633
 
2580
2634
 
2581
2635
class cmd_unknowns(Command):
2582
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2583
2637
    """
2584
2638
 
2585
2639
    hidden = True
2592
2646
 
2593
2647
 
2594
2648
class cmd_ignore(Command):
2595
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2596
2650
 
2597
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2598
2652
 
2607
2661
    using this command or directly by using an editor, be sure to commit
2608
2662
    it.
2609
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
 
2610
2670
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2611
2671
    precedence over regular ignores.  Such exceptions are used to specify
2612
2672
    files that should be versioned which would otherwise be ignored.
2653
2713
    _see_also = ['status', 'ignored', 'patterns']
2654
2714
    takes_args = ['name_pattern*']
2655
2715
    takes_options = [
2656
 
        Option('old-default-rules',
2657
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2716
        Option('default-rules',
 
2717
               help='Display the default ignore rules that bzr uses.')
2658
2718
        ]
2659
2719
 
2660
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2661
2721
        from bzrlib import ignores
2662
 
        if old_default_rules is not None:
2663
 
            # dump the rules and exit
2664
 
            for pattern in ignores.OLD_DEFAULTS:
2665
 
                print pattern
 
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)
2666
2726
            return
2667
2727
        if not name_pattern_list:
2668
2728
            raise errors.BzrCommandError("ignore requires at least one "
2669
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2670
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2671
2731
                             for p in name_pattern_list]
2672
2732
        for name_pattern in name_pattern_list:
2684
2744
            if id is not None:
2685
2745
                filename = entry[0]
2686
2746
                if ignored.match(filename):
2687
 
                    matches.append(filename.encode('utf-8'))
 
2747
                    matches.append(filename)
2688
2748
        tree.unlock()
2689
2749
        if len(matches) > 0:
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),)
 
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),))
2694
2754
 
2695
2755
 
2696
2756
class cmd_ignored(Command):
2697
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2698
2758
 
2699
2759
    List all the ignored files and the ignore pattern that caused the file to
2700
2760
    be ignored.
2721
2781
 
2722
2782
 
2723
2783
class cmd_lookup_revision(Command):
2724
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2725
2785
 
2726
2786
    :Examples:
2727
2787
        bzr lookup-revision 33
2734
2794
        try:
2735
2795
            revno = int(revno)
2736
2796
        except ValueError:
2737
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2738
 
 
2739
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
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)
2740
2801
 
2741
2802
 
2742
2803
class cmd_export(Command):
2743
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2744
2805
 
2745
2806
    If no revision is specified this exports the last committed revision.
2746
2807
 
2778
2839
        Option('root',
2779
2840
               type=str,
2780
2841
               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.'),
2781
2845
        ]
2782
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2783
 
        root=None, filters=False):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2784
2848
        from bzrlib.export import export
2785
2849
 
2786
2850
        if branch_or_subdir is None:
2793
2857
 
2794
2858
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2795
2859
        try:
2796
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2860
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2861
                   per_file_timestamps=per_file_timestamps)
2797
2862
        except errors.NoSuchExportFormat, e:
2798
2863
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2799
2864
 
2800
2865
 
2801
2866
class cmd_cat(Command):
2802
 
    """Write the contents of a file as of a given revision to standard output.
 
2867
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2803
2868
 
2804
2869
    If no revision is nominated, the last revision is used.
2805
2870
 
2885
2950
 
2886
2951
 
2887
2952
class cmd_local_time_offset(Command):
2888
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2889
2954
    hidden = True
2890
2955
    @display_command
2891
2956
    def run(self):
2892
 
        print osutils.local_time_offset()
 
2957
        self.outf.write("%s\n" % osutils.local_time_offset())
2893
2958
 
2894
2959
 
2895
2960
 
2896
2961
class cmd_commit(Command):
2897
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2898
2963
 
2899
2964
    An explanatory message needs to be given for each commit. This is
2900
2965
    often done by using the --message option (getting the message from the
3008
3073
                         "the master branch until a normal commit "
3009
3074
                         "is performed."
3010
3075
                    ),
3011
 
             Option('show-diff',
 
3076
             Option('show-diff', short_name='p',
3012
3077
                    help='When no message is supplied, show the diff along'
3013
3078
                    ' with the status summary in the message editor.'),
3014
3079
             ]
3094
3159
                    '(use --file "%(f)s" to take commit message from that file)'
3095
3160
                    % { 'f': message })
3096
3161
                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")
3097
3168
 
3098
3169
        def get_message(commit_obj):
3099
3170
            """Callback to get commit message"""
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,
 
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,
3106
3180
                        selected_list, diff=show_diff,
3107
3181
                        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.
3108
3187
                start_message = generate_commit_message_template(commit_obj)
3109
 
                my_message = edit_commit_message_encoded(t,
 
3188
                my_message = edit_commit_message_encoded(text,
3110
3189
                    start_message=start_message)
3111
3190
                if my_message is None:
3112
3191
                    raise errors.BzrCommandError("please specify a commit"
3113
3192
                        " 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()
3120
3193
            if my_message == "":
3121
3194
                raise errors.BzrCommandError("empty commit message specified")
3122
3195
            return my_message
3134
3207
                        timezone=offset,
3135
3208
                        exclude=safe_relpath_files(tree, exclude))
3136
3209
        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
3139
3210
            raise errors.BzrCommandError("No changes to commit."
3140
3211
                              " Use --unchanged to commit anyhow.")
3141
3212
        except ConflictsInTree:
3146
3217
            raise errors.BzrCommandError("Commit refused because there are"
3147
3218
                              " unknown files in the working tree.")
3148
3219
        except errors.BoundBranchOutOfDate, e:
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.')
 
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
3153
3225
 
3154
3226
 
3155
3227
class cmd_check(Command):
3156
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3157
3229
 
3158
3230
    This command checks various invariants about branch and repository storage
3159
3231
    to detect data corruption or bzr bugs.
3223
3295
 
3224
3296
 
3225
3297
class cmd_upgrade(Command):
3226
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3227
3299
 
3228
3300
    The check command or bzr developers may sometimes advise you to run
3229
3301
    this command. When the default format has changed you may also be warned
3247
3319
 
3248
3320
 
3249
3321
class cmd_whoami(Command):
3250
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3251
3323
 
3252
3324
    :Examples:
3253
3325
        Show the email of the current user::
3297
3369
 
3298
3370
 
3299
3371
class cmd_nick(Command):
3300
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3301
3373
 
3302
3374
    If unset, the tree root directory name is used as the nickname.
3303
3375
    To print the current nickname, execute with no argument.
3317
3389
 
3318
3390
    @display_command
3319
3391
    def printme(self, branch):
3320
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
3321
3393
 
3322
3394
 
3323
3395
class cmd_alias(Command):
3324
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3325
3397
 
3326
3398
    :Examples:
3327
3399
        Show the current aliases::
3391
3463
 
3392
3464
 
3393
3465
class cmd_selftest(Command):
3394
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3395
3467
 
3396
3468
    If arguments are given, they are regular expressions that say which tests
3397
3469
    should run.  Tests matching any expression are run, and other tests are
3444
3516
            from bzrlib.tests import stub_sftp
3445
3517
            return stub_sftp.SFTPAbsoluteServer
3446
3518
        if typestring == "memory":
3447
 
            from bzrlib.transport.memory import MemoryServer
3448
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
3449
3521
        if typestring == "fakenfs":
3450
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3451
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
3452
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3453
3525
            (typestring)
3454
3526
        raise errors.BzrCommandError(msg)
3538
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3539
3611
                    "needs to be installed to use --subunit.")
3540
3612
            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)
3541
3618
        if parallel:
3542
3619
            self.additional_selftest_args.setdefault(
3543
3620
                'suite_decorators', []).append(parallel)
3574
3651
 
3575
3652
 
3576
3653
class cmd_version(Command):
3577
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3578
3655
 
3579
3656
    encoding_type = 'replace'
3580
3657
    takes_options = [
3591
3668
 
3592
3669
 
3593
3670
class cmd_rocks(Command):
3594
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3595
3672
 
3596
3673
    hidden = True
3597
3674
 
3598
3675
    @display_command
3599
3676
    def run(self):
3600
 
        print "It sure does!"
 
3677
        self.outf.write("It sure does!\n")
3601
3678
 
3602
3679
 
3603
3680
class cmd_find_merge_base(Command):
3604
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3605
3682
    # TODO: Options to specify revisions on either side, as if
3606
3683
    #       merging only part of the history.
3607
3684
    takes_args = ['branch', 'other']
3623
3700
        graph = branch1.repository.get_graph(branch2.repository)
3624
3701
        base_rev_id = graph.find_unique_lca(last1, last2)
3625
3702
 
3626
 
        print 'merge base is revision %s' % base_rev_id
 
3703
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3627
3704
 
3628
3705
 
3629
3706
class cmd_merge(Command):
3630
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3631
3708
 
3632
3709
    The source of the merge can be specified either in the form of a branch,
3633
3710
    or in the form of a path to a file containing a merge directive generated
3988
4065
 
3989
4066
 
3990
4067
class cmd_remerge(Command):
3991
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
3992
4069
 
3993
4070
    Use this if you want to try a different merge technique while resolving
3994
4071
    conflicts.  Some merge techniques are better than others, and remerge
4019
4096
 
4020
4097
    def run(self, file_list=None, merge_type=None, show_base=False,
4021
4098
            reprocess=False):
 
4099
        from bzrlib.conflicts import restore
4022
4100
        if merge_type is None:
4023
4101
            merge_type = _mod_merge.Merge3Merger
4024
4102
        tree, file_list = tree_files(file_list)
4082
4160
 
4083
4161
 
4084
4162
class cmd_revert(Command):
4085
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
4086
4164
 
4087
4165
    Giving a list of files will revert only those files.  Otherwise, all files
4088
4166
    will be reverted.  If the revision is not specified with '--revision', the
4139
4217
    def run(self, revision=None, no_backup=False, file_list=None,
4140
4218
            forget_merges=None):
4141
4219
        tree, file_list = tree_files(file_list)
4142
 
        tree.lock_write()
 
4220
        tree.lock_tree_write()
4143
4221
        self.add_cleanup(tree.unlock)
4144
4222
        if forget_merges:
4145
4223
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4154
4232
 
4155
4233
 
4156
4234
class cmd_assert_fail(Command):
4157
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4158
4236
    # intended just for use in testing
4159
4237
 
4160
4238
    hidden = True
4164
4242
 
4165
4243
 
4166
4244
class cmd_help(Command):
4167
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4168
4246
    """
4169
4247
 
4170
4248
    _see_also = ['topics']
4183
4261
 
4184
4262
 
4185
4263
class cmd_shell_complete(Command):
4186
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4187
4265
 
4188
4266
    For a list of all available commands, say 'bzr shell-complete'.
4189
4267
    """
4198
4276
 
4199
4277
 
4200
4278
class cmd_missing(Command):
4201
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4202
4280
 
4203
4281
    OTHER_BRANCH may be local or remote.
4204
4282
 
4282
4360
            restrict = 'remote'
4283
4361
 
4284
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
 
4365
 
4285
4366
        parent = local_branch.get_parent()
4286
4367
        if other_branch is None:
4287
4368
            other_branch = parent
4296
4377
        remote_branch = Branch.open(other_branch)
4297
4378
        if remote_branch.base == local_branch.base:
4298
4379
            remote_branch = local_branch
 
4380
        else:
 
4381
            remote_branch.lock_read()
 
4382
            self.add_cleanup(remote_branch.unlock)
4299
4383
 
4300
 
        local_branch.lock_read()
4301
 
        self.add_cleanup(local_branch.unlock)
4302
4384
        local_revid_range = _revision_range_to_revid_range(
4303
4385
            _get_revision_range(my_revision, local_branch,
4304
4386
                self.name()))
4305
4387
 
4306
 
        remote_branch.lock_read()
4307
 
        self.add_cleanup(remote_branch.unlock)
4308
4388
        remote_revid_range = _revision_range_to_revid_range(
4309
4389
            _get_revision_range(revision,
4310
4390
                remote_branch, self.name()))
4369
4449
 
4370
4450
 
4371
4451
class cmd_pack(Command):
4372
 
    """Compress the data within a repository."""
 
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
    """
4373
4469
 
4374
4470
    _see_also = ['repositories']
4375
4471
    takes_args = ['branch_or_repo?']
 
4472
    takes_options = [
 
4473
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4474
        ]
4376
4475
 
4377
 
    def run(self, branch_or_repo='.'):
 
4476
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4378
4477
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4379
4478
        try:
4380
4479
            branch = dir.open_branch()
4381
4480
            repository = branch.repository
4382
4481
        except errors.NotBranchError:
4383
4482
            repository = dir.open_repository()
4384
 
        repository.pack()
 
4483
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4385
4484
 
4386
4485
 
4387
4486
class cmd_plugins(Command):
4388
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4389
4488
 
4390
4489
    This command displays the list of installed plugins including
4391
4490
    version of plugin and a short description of each.
4422
4521
                doc = '(no description)'
4423
4522
            result.append((name_ver, doc, plugin.path()))
4424
4523
        for name_ver, doc, path in sorted(result):
4425
 
            print name_ver
4426
 
            print '   ', doc
 
4524
            self.outf.write("%s\n" % name_ver)
 
4525
            self.outf.write("   %s\n" % doc)
4427
4526
            if verbose:
4428
 
                print '   ', path
4429
 
            print
 
4527
                self.outf.write("   %s\n" % path)
 
4528
            self.outf.write("\n")
4430
4529
 
4431
4530
 
4432
4531
class cmd_testament(Command):
4433
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4434
4533
    takes_options = [
4435
4534
            'revision',
4436
4535
            Option('long', help='Produce long-format testament.'),
4462
4561
 
4463
4562
 
4464
4563
class cmd_annotate(Command):
4465
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4466
4565
 
4467
4566
    This prints out the given file with an annotation on the left side
4468
4567
    indicating which revision, author and date introduced the change.
4515
4614
 
4516
4615
 
4517
4616
class cmd_re_sign(Command):
4518
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4519
4618
    # TODO be able to replace existing ones.
4520
4619
 
4521
4620
    hidden = True # is this right ?
4581
4680
 
4582
4681
 
4583
4682
class cmd_bind(Command):
4584
 
    """Convert the current branch into a checkout of the supplied branch.
 
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.
4585
4685
 
4586
4686
    Once converted into a checkout, commits must succeed on the master branch
4587
4687
    before they will be applied to the local branch.
4621
4721
 
4622
4722
 
4623
4723
class cmd_unbind(Command):
4624
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
4625
4725
 
4626
4726
    After unbinding, the local branch is considered independent and subsequent
4627
4727
    commits will be local only.
4638
4738
 
4639
4739
 
4640
4740
class cmd_uncommit(Command):
4641
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
4642
4742
 
4643
4743
    --verbose will print out what is being removed.
4644
4744
    --dry-run will go through all the motions, but not actually
4712
4812
                rev_id = b.get_rev_id(revno)
4713
4813
 
4714
4814
        if rev_id is None or _mod_revision.is_null(rev_id):
4715
 
            ui.ui_factory.note('No revisions to uncommit.')
 
4815
            self.outf.write('No revisions to uncommit.\n')
4716
4816
            return 1
4717
4817
 
4718
 
        log_collector = ui.ui_factory.make_output_stream()
4719
4818
        lf = log_formatter('short',
4720
 
                           to_file=log_collector,
 
4819
                           to_file=self.outf,
4721
4820
                           show_timezone='original')
4722
4821
 
4723
4822
        show_log(b,
4728
4827
                 end_revision=last_revno)
4729
4828
 
4730
4829
        if dry_run:
4731
 
            ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
 
4830
            self.outf.write('Dry-run, pretending to remove'
 
4831
                            ' the above revisions.\n')
4732
4832
        else:
4733
 
            ui.ui_factory.note('The above revision(s) will be removed.')
 
4833
            self.outf.write('The above revision(s) will be removed.\n')
4734
4834
 
4735
4835
        if not force:
4736
 
            if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
4737
 
                ui.ui_factory.note('Canceled')
 
4836
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4837
                self.outf.write('Canceled')
4738
4838
                return 0
4739
4839
 
4740
4840
        mutter('Uncommitting from {%s} to {%s}',
4741
4841
               last_rev_id, rev_id)
4742
4842
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4743
4843
                 revno=revno, local=local)
4744
 
        ui.ui_factory.note('You can restore the old tip by running:\n'
4745
 
             '  bzr pull . -r revid:%s' % last_rev_id)
 
4844
        self.outf.write('You can restore the old tip by running:\n'
 
4845
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4746
4846
 
4747
4847
 
4748
4848
class cmd_break_lock(Command):
4749
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4750
4850
 
4751
4851
    CAUTION: Locks should only be broken when you are sure that the process
4752
4852
    holding the lock has been stopped.
4771
4871
 
4772
4872
 
4773
4873
class cmd_wait_until_signalled(Command):
4774
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4775
4875
 
4776
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
4777
4877
    """
4785
4885
 
4786
4886
 
4787
4887
class cmd_serve(Command):
4788
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
4789
4889
 
4790
4890
    aliases = ['server']
4791
4891
 
4851
4951
 
4852
4952
 
4853
4953
class cmd_join(Command):
4854
 
    """Combine a tree into its containing tree.
 
4954
    __doc__ = """Combine a tree into its containing tree.
4855
4955
 
4856
4956
    This command requires the target tree to be in a rich-root format.
4857
4957
 
4897
4997
 
4898
4998
 
4899
4999
class cmd_split(Command):
4900
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4901
5001
 
4902
5002
    This command will produce a target tree in a format that supports
4903
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4923
5023
 
4924
5024
 
4925
5025
class cmd_merge_directive(Command):
4926
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
4927
5027
 
4928
5028
    A directive requests a merge to be performed, and also provides all the
4929
5029
    information necessary to do so.  This means it must either include a
5022
5122
 
5023
5123
 
5024
5124
class cmd_send(Command):
5025
 
    """Mail or create a merge-directive for submitting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
5026
5126
 
5027
5127
    A merge directive provides many things needed for requesting merges:
5028
5128
 
5110
5210
               short_name='f',
5111
5211
               type=unicode),
5112
5212
        Option('output', short_name='o',
5113
 
               help='Write merge directive to this file; '
 
5213
               help='Write merge directive to this file or directory; '
5114
5214
                    'use - for stdout.',
5115
5215
               type=unicode),
5116
5216
        Option('strict',
5139
5239
 
5140
5240
 
5141
5241
class cmd_bundle_revisions(cmd_send):
5142
 
    """Create a merge-directive for submitting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
5143
5243
 
5144
5244
    A merge directive provides many things needed for requesting merges:
5145
5245
 
5212
5312
 
5213
5313
 
5214
5314
class cmd_tag(Command):
5215
 
    """Create, remove or modify a tag naming a revision.
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
5216
5316
 
5217
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
5218
5318
    (--revision) option can be given -rtag:X, where X is any previously
5226
5326
 
5227
5327
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5228
5328
    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.
5229
5334
    """
5230
5335
 
5231
5336
    _see_also = ['commit', 'tags']
5232
 
    takes_args = ['tag_name']
 
5337
    takes_args = ['tag_name?']
5233
5338
    takes_options = [
5234
5339
        Option('delete',
5235
5340
            help='Delete this tag rather than placing it.',
5245
5350
        'revision',
5246
5351
        ]
5247
5352
 
5248
 
    def run(self, tag_name,
 
5353
    def run(self, tag_name=None,
5249
5354
            delete=None,
5250
5355
            directory='.',
5251
5356
            force=None,
5255
5360
        branch.lock_write()
5256
5361
        self.add_cleanup(branch.unlock)
5257
5362
        if delete:
 
5363
            if tag_name is None:
 
5364
                raise errors.BzrCommandError("No tag specified to delete.")
5258
5365
            branch.tags.delete_tag(tag_name)
5259
5366
            self.outf.write('Deleted tag %s.\n' % tag_name)
5260
5367
        else:
5266
5373
                revision_id = revision[0].as_revision_id(branch)
5267
5374
            else:
5268
5375
                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.")
5269
5381
            if (not force) and branch.tags.has_tag(tag_name):
5270
5382
                raise errors.TagAlreadyExists(tag_name)
5271
5383
            branch.tags.set_tag(tag_name, revision_id)
5273
5385
 
5274
5386
 
5275
5387
class cmd_tags(Command):
5276
 
    """List tags.
 
5388
    __doc__ = """List tags.
5277
5389
 
5278
5390
    This command shows a table of tag names and the revisions they reference.
5279
5391
    """
5347
5459
 
5348
5460
 
5349
5461
class cmd_reconfigure(Command):
5350
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
5351
5463
 
5352
5464
    A target configuration must be specified.
5353
5465
 
5438
5550
 
5439
5551
 
5440
5552
class cmd_switch(Command):
5441
 
    """Set the branch of a checkout and update.
 
5553
    __doc__ = """Set the branch of a checkout and update.
5442
5554
 
5443
5555
    For lightweight checkouts, this changes the branch being referenced.
5444
5556
    For heavyweight checkouts, this checks that there are no local commits
5534
5646
 
5535
5647
 
5536
5648
class cmd_view(Command):
5537
 
    """Manage filtered views.
 
5649
    __doc__ = """Manage filtered views.
5538
5650
 
5539
5651
    Views provide a mask over the tree so that users can focus on
5540
5652
    a subset of a tree when doing their work. After creating a view,
5688
5800
 
5689
5801
 
5690
5802
class cmd_hooks(Command):
5691
 
    """Show hooks."""
 
5803
    __doc__ = """Show hooks."""
5692
5804
 
5693
5805
    hidden = True
5694
5806
 
5707
5819
                    self.outf.write("    <no hooks installed>\n")
5708
5820
 
5709
5821
 
 
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
 
5710
5847
class cmd_shelve(Command):
5711
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5712
5849
 
5713
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
5714
5851
    ie. out of the way, until a later time when you can bring them back from
5783
5920
 
5784
5921
 
5785
5922
class cmd_unshelve(Command):
5786
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
5787
5924
 
5788
5925
    By default, the most recently shelved changes are restored. However if you
5789
5926
    specify a shelf by id those changes will be restored instead.  This works
5815
5952
 
5816
5953
 
5817
5954
class cmd_clean_tree(Command):
5818
 
    """Remove unwanted files from working tree.
 
5955
    __doc__ = """Remove unwanted files from working tree.
5819
5956
 
5820
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
5821
5958
    files are never deleted.
5849
5986
 
5850
5987
 
5851
5988
class cmd_reference(Command):
5852
 
    """list, view and set branch locations for nested trees.
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
5853
5990
 
5854
5991
    If no arguments are provided, lists the branch locations for nested trees.
5855
5992
    If one argument is provided, display the branch location for that tree.
5895
6032
            self.outf.write('%s %s\n' % (path, location))
5896
6033
 
5897
6034
 
5898
 
# these get imported and then picked up by the scan for cmd_*
5899
 
# TODO: Some more consistent way to split command definitions across files;
5900
 
# we do need to load at least some information about them to know of
5901
 
# aliases.  ideally we would avoid loading the implementation until the
5902
 
# details were needed.
5903
 
from bzrlib.cmd_version_info import cmd_version_info
5904
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5905
 
from bzrlib.bundle.commands import (
5906
 
    cmd_bundle_info,
5907
 
    )
5908
 
from bzrlib.foreign import cmd_dpush
5909
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5910
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5911
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
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)