~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-02-28 10:08:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5062.
  • Revision ID: robertc@robertcollins.net-20100228100829-nroa3qp8zi8jwxke
* bzr now has a ``.testr.conf`` file in its source tree configured
  appropriately for running tests with Testrepository
  (``https://launchpad.net/testrepository``). (Robert Collins)

* Documentation about testing with ``subunit`` has been tweaked.
  (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
60
60
from bzrlib.workingtree import WorkingTree
61
61
""")
62
62
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
63
from bzrlib.commands import Command, display_command
68
64
from bzrlib.option import (
69
65
    ListOption,
70
66
    Option,
239
235
# opens the branch?)
240
236
 
241
237
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
238
    """Display status summary.
243
239
 
244
240
    This reports on versioned and unknown files, reporting them
245
241
    grouped by state.  Possible states are:
332
328
 
333
329
 
334
330
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
331
    """Write out metadata for a revision.
336
332
 
337
333
    The revision to print can either be specified by a specific
338
334
    revision identifier, or you can use --revision.
390
386
        
391
387
 
392
388
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
389
    """Dump the contents of a btree index file to stdout.
394
390
 
395
391
    PATH is a btree index file, it can be any URL. This includes things like
396
392
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
456
        for node in bt.iter_all_entries():
461
457
            # Node is made up of:
462
458
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
 
459
            refs_as_tuples = static_tuple.as_tuples(node[3])
469
460
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
461
            self.outf.write('%s\n' % (as_tuple,))
471
462
 
472
463
 
473
464
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
465
    """Remove the working tree from a given branch/checkout.
475
466
 
476
467
    Since a lightweight checkout is little more than a working tree
477
468
    this will refuse to run against one.
504
495
                if (working.has_changes()):
505
496
                    raise errors.UncommittedChanges(working)
506
497
 
507
 
            if working.user_url != working.branch.user_url:
 
498
            working_path = working.bzrdir.root_transport.base
 
499
            branch_path = working.branch.bzrdir.root_transport.base
 
500
            if working_path != branch_path:
508
501
                raise errors.BzrCommandError("You cannot remove the working tree"
509
502
                                             " from a lightweight checkout")
510
503
 
512
505
 
513
506
 
514
507
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
508
    """Show current revision number.
516
509
 
517
510
    This is equal to the number of revisions on this branch.
518
511
    """
548
541
 
549
542
 
550
543
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
544
    """Show revision number and revision id for a given revision identifier.
552
545
    """
553
546
    hidden = True
554
547
    takes_args = ['revision_info*']
610
603
 
611
604
 
612
605
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
606
    """Add specified files or directories.
614
607
 
615
608
    In non-recursive mode, all the named items are added, regardless
616
609
    of whether they were previously ignored.  A warning is given if
696
689
 
697
690
 
698
691
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
692
    """Create a new versioned directory.
700
693
 
701
694
    This is equivalent to creating the directory and then adding it.
702
695
    """
706
699
 
707
700
    def run(self, dir_list):
708
701
        for d in dir_list:
 
702
            os.mkdir(d)
709
703
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
704
            wt.add([dd])
 
705
            self.outf.write('added %s\n' % d)
718
706
 
719
707
 
720
708
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
709
    """Show path of a file relative to root"""
722
710
 
723
711
    takes_args = ['filename']
724
712
    hidden = True
733
721
 
734
722
 
735
723
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
724
    """Show inventory of the current working copy or a revision.
737
725
 
738
726
    It is possible to limit the output to a particular entry
739
727
    type using the --kind option.  For example: --kind file.
794
782
 
795
783
 
796
784
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
785
    """Move or rename a file.
798
786
 
799
787
    :Usage:
800
788
        bzr mv OLDNAME NEWNAME
931
919
 
932
920
 
933
921
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
922
    """Turn this branch into a mirror of another branch.
935
923
 
936
924
    By default, this command only works on branches that have not diverged.
937
925
    Branches are considered diverged if the destination branch's most recent 
986
974
        try:
987
975
            tree_to = WorkingTree.open_containing(directory)[0]
988
976
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
977
        except errors.NoWorkingTree:
992
978
            tree_to = None
993
979
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
980
        
997
981
        if local and not branch_to.get_bound_location():
998
982
            raise errors.LocalRequiresBoundBranch()
999
983
 
1029
1013
        else:
1030
1014
            branch_from = Branch.open(location,
1031
1015
                possible_transports=possible_transports)
 
1016
 
 
1017
            if branch_to.get_parent() is None or remember:
 
1018
                branch_to.set_parent(branch_from.base)
 
1019
 
 
1020
        if branch_from is not branch_to:
1032
1021
            branch_from.lock_read()
1033
1022
            self.add_cleanup(branch_from.unlock)
1034
 
 
1035
 
            if branch_to.get_parent() is None or remember:
1036
 
                branch_to.set_parent(branch_from.base)
1037
 
 
1038
1023
        if revision is not None:
1039
1024
            revision_id = revision.as_revision_id(branch_from)
1040
1025
 
 
1026
        branch_to.lock_write()
 
1027
        self.add_cleanup(branch_to.unlock)
1041
1028
        if tree_to is not None:
1042
1029
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
1030
            change_reporter = delta._ChangeReporter(
1058
1045
 
1059
1046
 
1060
1047
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1048
    """Update a mirror of this branch.
1062
1049
 
1063
1050
    The target branch will not have its working tree populated because this
1064
1051
    is both expensive, and is not supported on remote file systems.
1125
1112
        # Get the source branch
1126
1113
        (tree, br_from,
1127
1114
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1115
        if strict is None:
 
1116
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1117
        if strict is None: strict = True # default value
1128
1118
        # Get the tip's revision_id
1129
1119
        revision = _get_one_revision('push', revision)
1130
1120
        if revision is not None:
1131
1121
            revision_id = revision.in_history(br_from).rev_id
1132
1122
        else:
1133
1123
            revision_id = None
1134
 
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
1124
        if strict and tree is not None and revision_id is None:
 
1125
            if (tree.has_changes()):
 
1126
                raise errors.UncommittedChanges(
 
1127
                    tree, more='Use --no-strict to force the push.')
 
1128
            if tree.last_revision() != tree.branch.last_revision():
 
1129
                # The tree has lost sync with its branch, there is little
 
1130
                # chance that the user is aware of it but he can still force
 
1131
                # the push with --no-strict
 
1132
                raise errors.OutOfDateTree(
 
1133
                    tree, more='Use --no-strict to force the push.')
 
1134
 
1139
1135
        # Get the stacked_on branch, if any
1140
1136
        if stacked_on is not None:
1141
1137
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1169
 
1174
1170
 
1175
1171
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1172
    """Create a new branch that is a copy of an existing branch.
1177
1173
 
1178
1174
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1175
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1286
1282
 
1287
1283
 
1288
1284
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1285
    """Create a new checkout of an existing branch.
1290
1286
 
1291
1287
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1288
    the branch found in '.'. This is useful if you have removed the working tree
1355
1351
 
1356
1352
 
1357
1353
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1354
    """Show list of renamed files.
1359
1355
    """
1360
1356
    # TODO: Option to show renames between two historical versions.
1361
1357
 
1387
1383
 
1388
1384
 
1389
1385
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1386
    """Update a tree to have the latest code committed to its branch.
1391
1387
 
1392
1388
    This will perform a merge into the working tree, and may generate
1393
1389
    conflicts. If you have any local changes, you will still
1422
1418
            branch_location = tree.branch.base
1423
1419
        self.add_cleanup(tree.unlock)
1424
1420
        # get rid of the final '/' and be ready for display
1425
 
        branch_location = urlutils.unescape_for_display(
1426
 
            branch_location.rstrip('/'),
1427
 
            self.outf.encoding)
 
1421
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1422
                                                        self.outf.encoding)
1428
1423
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
1424
        if master is None:
1430
1425
            old_tip = None
1438
1433
        else:
1439
1434
            revision_id = branch.last_revision()
1440
1435
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1442
 
            note("Tree is up to date at revision %s of branch %s" %
1443
 
                ('.'.join(map(str, revno)), branch_location))
 
1436
            revno = branch.revision_id_to_revno(revision_id)
 
1437
            note("Tree is up to date at revision %d of branch %s" %
 
1438
                (revno, branch_location))
1444
1439
            return 0
1445
1440
        view_info = _get_view_info_for_change_reporter(tree)
1446
1441
        change_reporter = delta._ChangeReporter(
1458
1453
                                  "bzr update --revision only works"
1459
1454
                                  " for a revision in the branch history"
1460
1455
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1456
        revno = tree.branch.revision_id_to_revno(
1462
1457
            _mod_revision.ensure_null(tree.last_revision()))
1463
 
        note('Updated to revision %s of branch %s' %
1464
 
             ('.'.join(map(str, revno)), branch_location))
1465
 
        parent_ids = tree.get_parent_ids()
1466
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1458
        note('Updated to revision %d of branch %s' %
 
1459
             (revno, branch_location))
 
1460
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1467
1461
            note('Your local commits will now show as pending merges with '
1468
1462
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
1463
        if conflicts != 0:
1473
1467
 
1474
1468
 
1475
1469
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1470
    """Show information about a working tree, branch or repository.
1477
1471
 
1478
1472
    This command will show all known locations and formats associated to the
1479
1473
    tree, branch or repository.
1517
1511
 
1518
1512
 
1519
1513
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1514
    """Remove files or directories.
1521
1515
 
1522
1516
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1517
    them if they can easily be recovered using revert. If no options or
1571
1565
 
1572
1566
 
1573
1567
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1568
    """Print file_id of a particular file or directory.
1575
1569
 
1576
1570
    The file_id is assigned when the file is first added and remains the
1577
1571
    same through all revisions where the file exists, even when it is
1593
1587
 
1594
1588
 
1595
1589
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1590
    """Print path of file_ids to a file or directory.
1597
1591
 
1598
1592
    This prints one line for each directory down to the target,
1599
1593
    starting at the branch root.
1615
1609
 
1616
1610
 
1617
1611
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1612
    """Reconcile bzr metadata in a branch.
1619
1613
 
1620
1614
    This can correct data mismatches that may have been caused by
1621
1615
    previous ghost operations or bzr upgrades. You should only
1643
1637
 
1644
1638
 
1645
1639
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1640
    """Display the list of revision ids on a branch."""
1647
1641
 
1648
1642
    _see_also = ['log']
1649
1643
    takes_args = ['location?']
1659
1653
 
1660
1654
 
1661
1655
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1656
    """List all revisions merged into this branch."""
1663
1657
 
1664
1658
    _see_also = ['log', 'revision-history']
1665
1659
    takes_args = ['location?']
1684
1678
 
1685
1679
 
1686
1680
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1681
    """Make a directory into a versioned branch.
1688
1682
 
1689
1683
    Use this to create an empty branch, or before importing an
1690
1684
    existing project.
1793
1787
 
1794
1788
 
1795
1789
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1790
    """Create a shared repository for branches to share storage space.
1797
1791
 
1798
1792
    New branches created under the repository directory will store their
1799
1793
    revisions in the repository, not in the branch directory.  For branches
1853
1847
 
1854
1848
 
1855
1849
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1850
    """Show differences in the working tree, between revisions or branches.
1857
1851
 
1858
1852
    If no arguments are given, all changes for the current tree are listed.
1859
1853
    If files are given, only the changes in those files are listed.
1945
1939
            help='Use this command to compare files.',
1946
1940
            type=unicode,
1947
1941
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1942
        ]
1953
1943
    aliases = ['di', 'dif']
1954
1944
    encoding_type = 'exact'
1955
1945
 
1956
1946
    @display_command
1957
1947
    def run(self, revision=None, file_list=None, diff_options=None,
1958
 
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
 
            show_diff_trees)
 
1948
            prefix=None, old=None, new=None, using=None):
 
1949
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1961
1950
 
1962
1951
        if (prefix is None) or (prefix == '0'):
1963
1952
            # diff -p0 format
1977
1966
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1967
                                         ' one or two revision specifiers')
1979
1968
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
1969
        (old_tree, new_tree,
1985
1970
         old_branch, new_branch,
1986
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1971
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1972
            file_list, revision, old, new, apply_view=True)
1988
1973
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1974
                               specific_files=specific_files,
1990
1975
                               external_diff_options=diff_options,
1991
1976
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1977
                               extra_trees=extra_trees, using=using)
1994
1978
 
1995
1979
 
1996
1980
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1981
    """List files deleted in the working tree.
1998
1982
    """
1999
1983
    # TODO: Show files deleted since a previous revision, or
2000
1984
    # between two revisions.
2023
2007
 
2024
2008
 
2025
2009
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
2010
    """List files modified in working tree.
2027
2011
    """
2028
2012
 
2029
2013
    hidden = True
2046
2030
 
2047
2031
 
2048
2032
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
2033
    """List files added in working tree.
2050
2034
    """
2051
2035
 
2052
2036
    hidden = True
2082
2066
 
2083
2067
 
2084
2068
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2069
    """Show the tree root directory.
2086
2070
 
2087
2071
    The root is the nearest enclosing directory with a .bzr control
2088
2072
    directory."""
2112
2096
 
2113
2097
 
2114
2098
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2099
    """Show historical log for a branch or subset of a branch.
2116
2100
 
2117
2101
    log is bzr's default tool for exploring the history of a branch.
2118
2102
    The branch to use is taken from the first parameter. If no parameters
2299
2283
                   help='Show changes made in each revision as a patch.'),
2300
2284
            Option('include-merges',
2301
2285
                   help='Show merged revisions like --levels 0 does.'),
2302
 
            Option('exclude-common-ancestry',
2303
 
                   help='Display only the revisions that are not part'
2304
 
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
2306
2286
            ]
2307
2287
    encoding_type = 'replace'
2308
2288
 
2318
2298
            message=None,
2319
2299
            limit=None,
2320
2300
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2301
            include_merges=False):
2324
2302
        from bzrlib.log import (
2325
2303
            Logger,
2326
2304
            make_log_request_dict,
2327
2305
            _get_info_for_log_files,
2328
2306
            )
2329
2307
        direction = (forward and 'forward') or 'reverse'
2330
 
        if (exclude_common_ancestry
2331
 
            and (revision is None or len(revision) != 2)):
2332
 
            raise errors.BzrCommandError(
2333
 
                '--exclude-common-ancestry requires -r with two revisions')
2334
2308
        if include_merges:
2335
2309
            if levels is None:
2336
2310
                levels = 0
2429
2403
            direction=direction, specific_fileids=file_ids,
2430
2404
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2405
            message_search=message, delta_type=delta_type,
2432
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
2434
 
            )
 
2406
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2407
        Logger(b, rqst).show(lf)
2436
2408
 
2437
2409
 
2456
2428
            raise errors.BzrCommandError(
2457
2429
                "bzr %s doesn't accept two revisions in different"
2458
2430
                " branches." % command_name)
2459
 
        if start_spec.spec is None:
2460
 
            # Avoid loading all the history.
2461
 
            rev1 = RevisionInfo(branch, None, None)
2462
 
        else:
2463
 
            rev1 = start_spec.in_history(branch)
 
2431
        rev1 = start_spec.in_history(branch)
2464
2432
        # Avoid loading all of history when we know a missing
2465
2433
        # end of range means the last revision ...
2466
2434
        if end_spec.spec is None:
2495
2463
 
2496
2464
 
2497
2465
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2466
    """Return revision-ids which affected a particular file.
2499
2467
 
2500
2468
    A more user-friendly interface is "bzr log FILE".
2501
2469
    """
2516
2484
 
2517
2485
 
2518
2486
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2487
    """List files in a tree.
2520
2488
    """
2521
2489
 
2522
2490
    _see_also = ['status', 'cat']
2633
2601
 
2634
2602
 
2635
2603
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2604
    """List unknown files.
2637
2605
    """
2638
2606
 
2639
2607
    hidden = True
2646
2614
 
2647
2615
 
2648
2616
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2617
    """Ignore specified files or patterns.
2650
2618
 
2651
2619
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2620
 
2661
2629
    using this command or directly by using an editor, be sure to commit
2662
2630
    it.
2663
2631
    
2664
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
 
    the global ignore file can be found in the application data directory as
2666
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
 
    Global ignores are not touched by this command. The global ignore file
2668
 
    can be edited directly using an editor.
2669
 
 
2670
2632
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2633
    precedence over regular ignores.  Such exceptions are used to specify
2672
2634
    files that should be versioned which would otherwise be ignored.
2713
2675
    _see_also = ['status', 'ignored', 'patterns']
2714
2676
    takes_args = ['name_pattern*']
2715
2677
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2678
        Option('old-default-rules',
 
2679
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2680
        ]
2719
2681
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2682
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2683
        from bzrlib import ignores
2722
 
        if default_rules is not None:
2723
 
            # dump the default rules and exit
2724
 
            for pattern in ignores.USER_DEFAULTS:
2725
 
                self.outf.write("%s\n" % pattern)
 
2684
        if old_default_rules is not None:
 
2685
            # dump the rules and exit
 
2686
            for pattern in ignores.OLD_DEFAULTS:
 
2687
                print pattern
2726
2688
            return
2727
2689
        if not name_pattern_list:
2728
2690
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2691
                                  "NAME_PATTERN or --old-default-rules")
2730
2692
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2693
                             for p in name_pattern_list]
2732
2694
        for name_pattern in name_pattern_list:
2744
2706
            if id is not None:
2745
2707
                filename = entry[0]
2746
2708
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2709
                    matches.append(filename.encode('utf-8'))
2748
2710
        tree.unlock()
2749
2711
        if len(matches) > 0:
2750
 
            self.outf.write("Warning: the following files are version controlled and"
2751
 
                  " match your ignore pattern:\n%s"
2752
 
                  "\nThese files will continue to be version controlled"
2753
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2712
            print "Warning: the following files are version controlled and" \
 
2713
                  " match your ignore pattern:\n%s" \
 
2714
                  "\nThese files will continue to be version controlled" \
 
2715
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2754
2716
 
2755
2717
 
2756
2718
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2719
    """List ignored files and the patterns that matched them.
2758
2720
 
2759
2721
    List all the ignored files and the ignore pattern that caused the file to
2760
2722
    be ignored.
2781
2743
 
2782
2744
 
2783
2745
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2746
    """Lookup the revision-id from a revision-number
2785
2747
 
2786
2748
    :Examples:
2787
2749
        bzr lookup-revision 33
2794
2756
        try:
2795
2757
            revno = int(revno)
2796
2758
        except ValueError:
2797
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
 
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
 
        self.outf.write("%s\n" % revid)
 
2759
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2760
 
 
2761
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2762
 
2802
2763
 
2803
2764
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2765
    """Export current or past revision to a destination directory or archive.
2805
2766
 
2806
2767
    If no revision is specified this exports the last committed revision.
2807
2768
 
2839
2800
        Option('root',
2840
2801
               type=str,
2841
2802
               help="Name of the root directory inside the exported file."),
2842
 
        Option('per-file-timestamps',
2843
 
               help='Set modification time of files to that of the last '
2844
 
                    'revision in which it was changed.'),
2845
2803
        ]
2846
2804
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2805
        root=None, filters=False):
2848
2806
        from bzrlib.export import export
2849
2807
 
2850
2808
        if branch_or_subdir is None:
2857
2815
 
2858
2816
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2817
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2818
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2862
2819
        except errors.NoSuchExportFormat, e:
2863
2820
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2821
 
2865
2822
 
2866
2823
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2824
    """Write the contents of a file as of a given revision to standard output.
2868
2825
 
2869
2826
    If no revision is nominated, the last revision is used.
2870
2827
 
2950
2907
 
2951
2908
 
2952
2909
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2910
    """Show the offset in seconds from GMT to local time."""
2954
2911
    hidden = True
2955
2912
    @display_command
2956
2913
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2914
        print osutils.local_time_offset()
2958
2915
 
2959
2916
 
2960
2917
 
2961
2918
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2919
    """Commit changes into a new revision.
2963
2920
 
2964
2921
    An explanatory message needs to be given for each commit. This is
2965
2922
    often done by using the --message option (getting the message from the
3073
3030
                         "the master branch until a normal commit "
3074
3031
                         "is performed."
3075
3032
                    ),
3076
 
             Option('show-diff', short_name='p',
 
3033
             Option('show-diff',
3077
3034
                    help='When no message is supplied, show the diff along'
3078
3035
                    ' with the status summary in the message editor.'),
3079
3036
             ]
3159
3116
                    '(use --file "%(f)s" to take commit message from that file)'
3160
3117
                    % { 'f': message })
3161
3118
                ui.ui_factory.show_warning(warning_msg)
3162
 
            if '\r' in message:
3163
 
                message = message.replace('\r\n', '\n')
3164
 
                message = message.replace('\r', '\n')
3165
 
            if file:
3166
 
                raise errors.BzrCommandError(
3167
 
                    "please specify either --message or --file")
3168
3119
 
3169
3120
        def get_message(commit_obj):
3170
3121
            """Callback to get commit message"""
3171
 
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
3174
 
            elif message is not None:
3175
 
                my_message = message
3176
 
            else:
3177
 
                # No message supplied: make one up.
3178
 
                # text is the status of the tree
3179
 
                text = make_commit_message_template_encoded(tree,
 
3122
            my_message = message
 
3123
            if my_message is not None and '\r' in my_message:
 
3124
                my_message = my_message.replace('\r\n', '\n')
 
3125
                my_message = my_message.replace('\r', '\n')
 
3126
            if my_message is None and not file:
 
3127
                t = make_commit_message_template_encoded(tree,
3180
3128
                        selected_list, diff=show_diff,
3181
3129
                        output_encoding=osutils.get_user_encoding())
3182
 
                # start_message is the template generated from hooks
3183
 
                # XXX: Warning - looks like hooks return unicode,
3184
 
                # make_commit_message_template_encoded returns user encoding.
3185
 
                # We probably want to be using edit_commit_message instead to
3186
 
                # avoid this.
3187
3130
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
3131
                my_message = edit_commit_message_encoded(t,
3189
3132
                    start_message=start_message)
3190
3133
                if my_message is None:
3191
3134
                    raise errors.BzrCommandError("please specify a commit"
3192
3135
                        " message with either --message or --file")
 
3136
            elif my_message and file:
 
3137
                raise errors.BzrCommandError(
 
3138
                    "please specify either --message or --file")
 
3139
            if file:
 
3140
                my_message = codecs.open(file, 'rt',
 
3141
                                         osutils.get_user_encoding()).read()
3193
3142
            if my_message == "":
3194
3143
                raise errors.BzrCommandError("empty commit message specified")
3195
3144
            return my_message
3207
3156
                        timezone=offset,
3208
3157
                        exclude=safe_relpath_files(tree, exclude))
3209
3158
        except PointlessCommit:
 
3159
            # FIXME: This should really happen before the file is read in;
 
3160
            # perhaps prepare the commit; get the message; then actually commit
3210
3161
            raise errors.BzrCommandError("No changes to commit."
3211
3162
                              " Use --unchanged to commit anyhow.")
3212
3163
        except ConflictsInTree:
3217
3168
            raise errors.BzrCommandError("Commit refused because there are"
3218
3169
                              " unknown files in the working tree.")
3219
3170
        except errors.BoundBranchOutOfDate, e:
3220
 
            e.extra_help = ("\n"
3221
 
                'To commit to master branch, run update and then commit.\n'
3222
 
                'You can also pass --local to commit to continue working '
3223
 
                'disconnected.')
3224
 
            raise
 
3171
            raise errors.BzrCommandError(str(e) + "\n"
 
3172
            'To commit to master branch, run update and then commit.\n'
 
3173
            'You can also pass --local to commit to continue working '
 
3174
            'disconnected.')
3225
3175
 
3226
3176
 
3227
3177
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3178
    """Validate working tree structure, branch consistency and repository history.
3229
3179
 
3230
3180
    This command checks various invariants about branch and repository storage
3231
3181
    to detect data corruption or bzr bugs.
3295
3245
 
3296
3246
 
3297
3247
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3248
    """Upgrade branch storage to current format.
3299
3249
 
3300
3250
    The check command or bzr developers may sometimes advise you to run
3301
3251
    this command. When the default format has changed you may also be warned
3319
3269
 
3320
3270
 
3321
3271
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3272
    """Show or set bzr user id.
3323
3273
 
3324
3274
    :Examples:
3325
3275
        Show the email of the current user::
3369
3319
 
3370
3320
 
3371
3321
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3322
    """Print or set the branch nickname.
3373
3323
 
3374
3324
    If unset, the tree root directory name is used as the nickname.
3375
3325
    To print the current nickname, execute with no argument.
3389
3339
 
3390
3340
    @display_command
3391
3341
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3342
        print branch.nick
3393
3343
 
3394
3344
 
3395
3345
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3346
    """Set/unset and display aliases.
3397
3347
 
3398
3348
    :Examples:
3399
3349
        Show the current aliases::
3463
3413
 
3464
3414
 
3465
3415
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3416
    """Run internal test suite.
3467
3417
 
3468
3418
    If arguments are given, they are regular expressions that say which tests
3469
3419
    should run.  Tests matching any expression are run, and other tests are
3610
3560
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3561
                    "needs to be installed to use --subunit.")
3612
3562
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
 
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3616
 
                import msvcrt
3617
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3563
        if parallel:
3619
3564
            self.additional_selftest_args.setdefault(
3620
3565
                'suite_decorators', []).append(parallel)
3651
3596
 
3652
3597
 
3653
3598
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3599
    """Show version of bzr."""
3655
3600
 
3656
3601
    encoding_type = 'replace'
3657
3602
    takes_options = [
3668
3613
 
3669
3614
 
3670
3615
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3616
    """Statement of optimism."""
3672
3617
 
3673
3618
    hidden = True
3674
3619
 
3675
3620
    @display_command
3676
3621
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3622
        print "It sure does!"
3678
3623
 
3679
3624
 
3680
3625
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3626
    """Find and print a base revision for merging two branches."""
3682
3627
    # TODO: Options to specify revisions on either side, as if
3683
3628
    #       merging only part of the history.
3684
3629
    takes_args = ['branch', 'other']
3700
3645
        graph = branch1.repository.get_graph(branch2.repository)
3701
3646
        base_rev_id = graph.find_unique_lca(last1, last2)
3702
3647
 
3703
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3648
        print 'merge base is revision %s' % base_rev_id
3704
3649
 
3705
3650
 
3706
3651
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3652
    """Perform a three-way merge.
3708
3653
 
3709
3654
    The source of the merge can be specified either in the form of a branch,
3710
3655
    or in the form of a path to a file containing a merge directive generated
4065
4010
 
4066
4011
 
4067
4012
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
4013
    """Redo a merge.
4069
4014
 
4070
4015
    Use this if you want to try a different merge technique while resolving
4071
4016
    conflicts.  Some merge techniques are better than others, and remerge
4096
4041
 
4097
4042
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
4043
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
4044
        if merge_type is None:
4101
4045
            merge_type = _mod_merge.Merge3Merger
4102
4046
        tree, file_list = tree_files(file_list)
4160
4104
 
4161
4105
 
4162
4106
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4107
    """Revert files to a previous revision.
4164
4108
 
4165
4109
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4110
    will be reverted.  If the revision is not specified with '--revision', the
4217
4161
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4162
            forget_merges=None):
4219
4163
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
 
4164
        tree.lock_write()
4221
4165
        self.add_cleanup(tree.unlock)
4222
4166
        if forget_merges:
4223
4167
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4232
4176
 
4233
4177
 
4234
4178
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4179
    """Test reporting of assertion failures"""
4236
4180
    # intended just for use in testing
4237
4181
 
4238
4182
    hidden = True
4242
4186
 
4243
4187
 
4244
4188
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4189
    """Show help on a command or other topic.
4246
4190
    """
4247
4191
 
4248
4192
    _see_also = ['topics']
4261
4205
 
4262
4206
 
4263
4207
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4208
    """Show appropriate completions for context.
4265
4209
 
4266
4210
    For a list of all available commands, say 'bzr shell-complete'.
4267
4211
    """
4276
4220
 
4277
4221
 
4278
4222
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4223
    """Show unmerged/unpulled revisions between two branches.
4280
4224
 
4281
4225
    OTHER_BRANCH may be local or remote.
4282
4226
 
4360
4304
            restrict = 'remote'
4361
4305
 
4362
4306
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4307
        parent = local_branch.get_parent()
4367
4308
        if other_branch is None:
4368
4309
            other_branch = parent
4377
4318
        remote_branch = Branch.open(other_branch)
4378
4319
        if remote_branch.base == local_branch.base:
4379
4320
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4321
 
 
4322
        local_branch.lock_read()
 
4323
        self.add_cleanup(local_branch.unlock)
4384
4324
        local_revid_range = _revision_range_to_revid_range(
4385
4325
            _get_revision_range(my_revision, local_branch,
4386
4326
                self.name()))
4387
4327
 
 
4328
        remote_branch.lock_read()
 
4329
        self.add_cleanup(remote_branch.unlock)
4388
4330
        remote_revid_range = _revision_range_to_revid_range(
4389
4331
            _get_revision_range(revision,
4390
4332
                remote_branch, self.name()))
4449
4391
 
4450
4392
 
4451
4393
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
4394
    """Compress the data within a repository."""
4469
4395
 
4470
4396
    _see_also = ['repositories']
4471
4397
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4398
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4399
    def run(self, branch_or_repo='.'):
4477
4400
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4401
        try:
4479
4402
            branch = dir.open_branch()
4480
4403
            repository = branch.repository
4481
4404
        except errors.NotBranchError:
4482
4405
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4406
        repository.pack()
4484
4407
 
4485
4408
 
4486
4409
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4410
    """List the installed plugins.
4488
4411
 
4489
4412
    This command displays the list of installed plugins including
4490
4413
    version of plugin and a short description of each.
4521
4444
                doc = '(no description)'
4522
4445
            result.append((name_ver, doc, plugin.path()))
4523
4446
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
4447
            print name_ver
 
4448
            print '   ', doc
4526
4449
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4450
                print '   ', path
 
4451
            print
4529
4452
 
4530
4453
 
4531
4454
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4455
    """Show testament (signing-form) of a revision."""
4533
4456
    takes_options = [
4534
4457
            'revision',
4535
4458
            Option('long', help='Produce long-format testament.'),
4561
4484
 
4562
4485
 
4563
4486
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4487
    """Show the origin of each line in a file.
4565
4488
 
4566
4489
    This prints out the given file with an annotation on the left side
4567
4490
    indicating which revision, author and date introduced the change.
4614
4537
 
4615
4538
 
4616
4539
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4540
    """Create a digital signature for an existing revision."""
4618
4541
    # TODO be able to replace existing ones.
4619
4542
 
4620
4543
    hidden = True # is this right ?
4680
4603
 
4681
4604
 
4682
4605
class cmd_bind(Command):
4683
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
 
    If no branch is supplied, rebind to the last bound location.
 
4606
    """Convert the current branch into a checkout of the supplied branch.
4685
4607
 
4686
4608
    Once converted into a checkout, commits must succeed on the master branch
4687
4609
    before they will be applied to the local branch.
4721
4643
 
4722
4644
 
4723
4645
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4646
    """Convert the current checkout into a regular branch.
4725
4647
 
4726
4648
    After unbinding, the local branch is considered independent and subsequent
4727
4649
    commits will be local only.
4738
4660
 
4739
4661
 
4740
4662
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4663
    """Remove the last committed revision.
4742
4664
 
4743
4665
    --verbose will print out what is being removed.
4744
4666
    --dry-run will go through all the motions, but not actually
4812
4734
                rev_id = b.get_rev_id(revno)
4813
4735
 
4814
4736
        if rev_id is None or _mod_revision.is_null(rev_id):
4815
 
            self.outf.write('No revisions to uncommit.\n')
 
4737
            ui.ui_factory.note('No revisions to uncommit.')
4816
4738
            return 1
4817
4739
 
 
4740
        log_collector = ui.ui_factory.make_output_stream()
4818
4741
        lf = log_formatter('short',
4819
 
                           to_file=self.outf,
 
4742
                           to_file=log_collector,
4820
4743
                           show_timezone='original')
4821
4744
 
4822
4745
        show_log(b,
4827
4750
                 end_revision=last_revno)
4828
4751
 
4829
4752
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4753
            ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
4832
4754
        else:
4833
 
            self.outf.write('The above revision(s) will be removed.\n')
 
4755
            ui.ui_factory.note('The above revision(s) will be removed.')
4834
4756
 
4835
4757
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
 
4758
            if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
 
4759
                ui.ui_factory.note('Canceled')
4838
4760
                return 0
4839
4761
 
4840
4762
        mutter('Uncommitting from {%s} to {%s}',
4841
4763
               last_rev_id, rev_id)
4842
4764
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4765
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4766
        ui.ui_factory.note('You can restore the old tip by running:\n'
 
4767
             '  bzr pull . -r revid:%s' % last_rev_id)
4846
4768
 
4847
4769
 
4848
4770
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4771
    """Break a dead lock on a repository, branch or working directory.
4850
4772
 
4851
4773
    CAUTION: Locks should only be broken when you are sure that the process
4852
4774
    holding the lock has been stopped.
4871
4793
 
4872
4794
 
4873
4795
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4796
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4797
 
4876
4798
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4799
    """
4885
4807
 
4886
4808
 
4887
4809
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4810
    """Run the bzr server."""
4889
4811
 
4890
4812
    aliases = ['server']
4891
4813
 
4951
4873
 
4952
4874
 
4953
4875
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4876
    """Combine a tree into its containing tree.
4955
4877
 
4956
4878
    This command requires the target tree to be in a rich-root format.
4957
4879
 
4997
4919
 
4998
4920
 
4999
4921
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4922
    """Split a subdirectory of a tree into a separate tree.
5001
4923
 
5002
4924
    This command will produce a target tree in a format that supports
5003
4925
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4945
 
5024
4946
 
5025
4947
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4948
    """Generate a merge directive for auto-merge tools.
5027
4949
 
5028
4950
    A directive requests a merge to be performed, and also provides all the
5029
4951
    information necessary to do so.  This means it must either include a
5122
5044
 
5123
5045
 
5124
5046
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5047
    """Mail or create a merge-directive for submitting changes.
5126
5048
 
5127
5049
    A merge directive provides many things needed for requesting merges:
5128
5050
 
5210
5132
               short_name='f',
5211
5133
               type=unicode),
5212
5134
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
5135
               help='Write merge directive to this file; '
5214
5136
                    'use - for stdout.',
5215
5137
               type=unicode),
5216
5138
        Option('strict',
5239
5161
 
5240
5162
 
5241
5163
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5164
    """Create a merge-directive for submitting changes.
5243
5165
 
5244
5166
    A merge directive provides many things needed for requesting merges:
5245
5167
 
5312
5234
 
5313
5235
 
5314
5236
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5237
    """Create, remove or modify a tag naming a revision.
5316
5238
 
5317
5239
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5240
    (--revision) option can be given -rtag:X, where X is any previously
5326
5248
 
5327
5249
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
5250
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5329
 
 
5330
 
    If no tag name is specified it will be determined through the 
5331
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
 
    details.
5334
5251
    """
5335
5252
 
5336
5253
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
5254
    takes_args = ['tag_name']
5338
5255
    takes_options = [
5339
5256
        Option('delete',
5340
5257
            help='Delete this tag rather than placing it.',
5350
5267
        'revision',
5351
5268
        ]
5352
5269
 
5353
 
    def run(self, tag_name=None,
 
5270
    def run(self, tag_name,
5354
5271
            delete=None,
5355
5272
            directory='.',
5356
5273
            force=None,
5360
5277
        branch.lock_write()
5361
5278
        self.add_cleanup(branch.unlock)
5362
5279
        if delete:
5363
 
            if tag_name is None:
5364
 
                raise errors.BzrCommandError("No tag specified to delete.")
5365
5280
            branch.tags.delete_tag(tag_name)
5366
5281
            self.outf.write('Deleted tag %s.\n' % tag_name)
5367
5282
        else:
5373
5288
                revision_id = revision[0].as_revision_id(branch)
5374
5289
            else:
5375
5290
                revision_id = branch.last_revision()
5376
 
            if tag_name is None:
5377
 
                tag_name = branch.automatic_tag_name(revision_id)
5378
 
                if tag_name is None:
5379
 
                    raise errors.BzrCommandError(
5380
 
                        "Please specify a tag name.")
5381
5291
            if (not force) and branch.tags.has_tag(tag_name):
5382
5292
                raise errors.TagAlreadyExists(tag_name)
5383
5293
            branch.tags.set_tag(tag_name, revision_id)
5385
5295
 
5386
5296
 
5387
5297
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5298
    """List tags.
5389
5299
 
5390
5300
    This command shows a table of tag names and the revisions they reference.
5391
5301
    """
5459
5369
 
5460
5370
 
5461
5371
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5372
    """Reconfigure the type of a bzr directory.
5463
5373
 
5464
5374
    A target configuration must be specified.
5465
5375
 
5550
5460
 
5551
5461
 
5552
5462
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5463
    """Set the branch of a checkout and update.
5554
5464
 
5555
5465
    For lightweight checkouts, this changes the branch being referenced.
5556
5466
    For heavyweight checkouts, this checks that there are no local commits
5646
5556
 
5647
5557
 
5648
5558
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5559
    """Manage filtered views.
5650
5560
 
5651
5561
    Views provide a mask over the tree so that users can focus on
5652
5562
    a subset of a tree when doing their work. After creating a view,
5800
5710
 
5801
5711
 
5802
5712
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5713
    """Show hooks."""
5804
5714
 
5805
5715
    hidden = True
5806
5716
 
5819
5729
                    self.outf.write("    <no hooks installed>\n")
5820
5730
 
5821
5731
 
5822
 
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
5824
 
 
5825
 
    This will remove the branch from the specified location but 
5826
 
    will keep any working tree or repository in place.
5827
 
 
5828
 
    :Examples:
5829
 
 
5830
 
      Remove the branch at repo/trunk::
5831
 
 
5832
 
        bzr remove-branch repo/trunk
5833
 
 
5834
 
    """
5835
 
 
5836
 
    takes_args = ["location?"]
5837
 
 
5838
 
    aliases = ["rmbranch"]
5839
 
 
5840
 
    def run(self, location=None):
5841
 
        if location is None:
5842
 
            location = "."
5843
 
        branch = Branch.open_containing(location)[0]
5844
 
        branch.bzrdir.destroy_branch()
5845
 
        
5846
 
 
5847
5732
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5733
    """Temporarily set aside some changes from the current tree.
5849
5734
 
5850
5735
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5736
    ie. out of the way, until a later time when you can bring them back from
5920
5805
 
5921
5806
 
5922
5807
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5808
    """Restore shelved changes.
5924
5809
 
5925
5810
    By default, the most recently shelved changes are restored. However if you
5926
5811
    specify a shelf by id those changes will be restored instead.  This works
5952
5837
 
5953
5838
 
5954
5839
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5840
    """Remove unwanted files from working tree.
5956
5841
 
5957
5842
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5843
    files are never deleted.
5986
5871
 
5987
5872
 
5988
5873
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5874
    """list, view and set branch locations for nested trees.
5990
5875
 
5991
5876
    If no arguments are provided, lists the branch locations for nested trees.
5992
5877
    If one argument is provided, display the branch location for that tree.
6032
5917
            self.outf.write('%s %s\n' % (path, location))
6033
5918
 
6034
5919
 
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)
 
5920
# these get imported and then picked up by the scan for cmd_*
 
5921
# TODO: Some more consistent way to split command definitions across files;
 
5922
# we do need to load at least some information about them to know of
 
5923
# aliases.  ideally we would avoid loading the implementation until the
 
5924
# details were needed.
 
5925
from bzrlib.cmd_version_info import cmd_version_info
 
5926
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5927
from bzrlib.bundle.commands import (
 
5928
    cmd_bundle_info,
 
5929
    )
 
5930
from bzrlib.foreign import cmd_dpush
 
5931
from bzrlib.sign_my_commits import cmd_sign_my_commits