~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Merge bzr.dev into cleanup

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
471
467
 
472
468
 
473
469
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
470
    """Remove the working tree from a given branch/checkout.
475
471
 
476
472
    Since a lightweight checkout is little more than a working tree
477
473
    this will refuse to run against one.
504
500
                if (working.has_changes()):
505
501
                    raise errors.UncommittedChanges(working)
506
502
 
507
 
            if working.user_url != working.branch.user_url:
 
503
            working_path = working.bzrdir.root_transport.base
 
504
            branch_path = working.branch.bzrdir.root_transport.base
 
505
            if working_path != branch_path:
508
506
                raise errors.BzrCommandError("You cannot remove the working tree"
509
507
                                             " from a lightweight checkout")
510
508
 
512
510
 
513
511
 
514
512
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
513
    """Show current revision number.
516
514
 
517
515
    This is equal to the number of revisions on this branch.
518
516
    """
548
546
 
549
547
 
550
548
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
549
    """Show revision number and revision id for a given revision identifier.
552
550
    """
553
551
    hidden = True
554
552
    takes_args = ['revision_info*']
610
608
 
611
609
 
612
610
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
611
    """Add specified files or directories.
614
612
 
615
613
    In non-recursive mode, all the named items are added, regardless
616
614
    of whether they were previously ignored.  A warning is given if
696
694
 
697
695
 
698
696
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
697
    """Create a new versioned directory.
700
698
 
701
699
    This is equivalent to creating the directory and then adding it.
702
700
    """
718
716
 
719
717
 
720
718
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
719
    """Show path of a file relative to root"""
722
720
 
723
721
    takes_args = ['filename']
724
722
    hidden = True
733
731
 
734
732
 
735
733
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
734
    """Show inventory of the current working copy or a revision.
737
735
 
738
736
    It is possible to limit the output to a particular entry
739
737
    type using the --kind option.  For example: --kind file.
794
792
 
795
793
 
796
794
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
795
    """Move or rename a file.
798
796
 
799
797
    :Usage:
800
798
        bzr mv OLDNAME NEWNAME
931
929
 
932
930
 
933
931
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
932
    """Turn this branch into a mirror of another branch.
935
933
 
936
934
    By default, this command only works on branches that have not diverged.
937
935
    Branches are considered diverged if the destination branch's most recent 
986
984
        try:
987
985
            tree_to = WorkingTree.open_containing(directory)[0]
988
986
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
987
        except errors.NoWorkingTree:
992
988
            tree_to = None
993
989
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
990
        
997
991
        if local and not branch_to.get_bound_location():
998
992
            raise errors.LocalRequiresBoundBranch()
999
993
 
1029
1023
        else:
1030
1024
            branch_from = Branch.open(location,
1031
1025
                possible_transports=possible_transports)
 
1026
 
 
1027
            if branch_to.get_parent() is None or remember:
 
1028
                branch_to.set_parent(branch_from.base)
 
1029
 
 
1030
        if branch_from is not branch_to:
1032
1031
            branch_from.lock_read()
1033
1032
            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
1033
        if revision is not None:
1039
1034
            revision_id = revision.as_revision_id(branch_from)
1040
1035
 
 
1036
        branch_to.lock_write()
 
1037
        self.add_cleanup(branch_to.unlock)
1041
1038
        if tree_to is not None:
1042
1039
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
1040
            change_reporter = delta._ChangeReporter(
1058
1055
 
1059
1056
 
1060
1057
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1058
    """Update a mirror of this branch.
1062
1059
 
1063
1060
    The target branch will not have its working tree populated because this
1064
1061
    is both expensive, and is not supported on remote file systems.
1125
1122
        # Get the source branch
1126
1123
        (tree, br_from,
1127
1124
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1125
        if strict is None:
 
1126
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1127
        if strict is None: strict = True # default value
1128
1128
        # Get the tip's revision_id
1129
1129
        revision = _get_one_revision('push', revision)
1130
1130
        if revision is not None:
1131
1131
            revision_id = revision.in_history(br_from).rev_id
1132
1132
        else:
1133
1133
            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.')
 
1134
        if strict and tree is not None and revision_id is None:
 
1135
            if (tree.has_changes()):
 
1136
                raise errors.UncommittedChanges(
 
1137
                    tree, more='Use --no-strict to force the push.')
 
1138
            if tree.last_revision() != tree.branch.last_revision():
 
1139
                # The tree has lost sync with its branch, there is little
 
1140
                # chance that the user is aware of it but he can still force
 
1141
                # the push with --no-strict
 
1142
                raise errors.OutOfDateTree(
 
1143
                    tree, more='Use --no-strict to force the push.')
 
1144
 
1139
1145
        # Get the stacked_on branch, if any
1140
1146
        if stacked_on is not None:
1141
1147
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1179
 
1174
1180
 
1175
1181
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1182
    """Create a new branch that is a copy of an existing branch.
1177
1183
 
1178
1184
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1185
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1286
1292
 
1287
1293
 
1288
1294
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1295
    """Create a new checkout of an existing branch.
1290
1296
 
1291
1297
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1298
    the branch found in '.'. This is useful if you have removed the working tree
1355
1361
 
1356
1362
 
1357
1363
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1364
    """Show list of renamed files.
1359
1365
    """
1360
1366
    # TODO: Option to show renames between two historical versions.
1361
1367
 
1387
1393
 
1388
1394
 
1389
1395
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1396
    """Update a tree to have the latest code committed to its branch.
1391
1397
 
1392
1398
    This will perform a merge into the working tree, and may generate
1393
1399
    conflicts. If you have any local changes, you will still
1422
1428
            branch_location = tree.branch.base
1423
1429
        self.add_cleanup(tree.unlock)
1424
1430
        # 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)
 
1431
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1432
                                                        self.outf.encoding)
1428
1433
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
1434
        if master is None:
1430
1435
            old_tip = None
1438
1443
        else:
1439
1444
            revision_id = branch.last_revision()
1440
1445
        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))
 
1446
            revno = branch.revision_id_to_revno(revision_id)
 
1447
            note("Tree is up to date at revision %d of branch %s" %
 
1448
                (revno, branch_location))
1444
1449
            return 0
1445
1450
        view_info = _get_view_info_for_change_reporter(tree)
1446
1451
        change_reporter = delta._ChangeReporter(
1458
1463
                                  "bzr update --revision only works"
1459
1464
                                  " for a revision in the branch history"
1460
1465
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1466
        revno = tree.branch.revision_id_to_revno(
1462
1467
            _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:
 
1468
        note('Updated to revision %d of branch %s' %
 
1469
             (revno, branch_location))
 
1470
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1467
1471
            note('Your local commits will now show as pending merges with '
1468
1472
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
1473
        if conflicts != 0:
1473
1477
 
1474
1478
 
1475
1479
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1480
    """Show information about a working tree, branch or repository.
1477
1481
 
1478
1482
    This command will show all known locations and formats associated to the
1479
1483
    tree, branch or repository.
1517
1521
 
1518
1522
 
1519
1523
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1524
    """Remove files or directories.
1521
1525
 
1522
1526
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1527
    them if they can easily be recovered using revert. If no options or
1571
1575
 
1572
1576
 
1573
1577
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1578
    """Print file_id of a particular file or directory.
1575
1579
 
1576
1580
    The file_id is assigned when the file is first added and remains the
1577
1581
    same through all revisions where the file exists, even when it is
1593
1597
 
1594
1598
 
1595
1599
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1600
    """Print path of file_ids to a file or directory.
1597
1601
 
1598
1602
    This prints one line for each directory down to the target,
1599
1603
    starting at the branch root.
1615
1619
 
1616
1620
 
1617
1621
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1622
    """Reconcile bzr metadata in a branch.
1619
1623
 
1620
1624
    This can correct data mismatches that may have been caused by
1621
1625
    previous ghost operations or bzr upgrades. You should only
1643
1647
 
1644
1648
 
1645
1649
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1650
    """Display the list of revision ids on a branch."""
1647
1651
 
1648
1652
    _see_also = ['log']
1649
1653
    takes_args = ['location?']
1659
1663
 
1660
1664
 
1661
1665
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1666
    """List all revisions merged into this branch."""
1663
1667
 
1664
1668
    _see_also = ['log', 'revision-history']
1665
1669
    takes_args = ['location?']
1684
1688
 
1685
1689
 
1686
1690
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1691
    """Make a directory into a versioned branch.
1688
1692
 
1689
1693
    Use this to create an empty branch, or before importing an
1690
1694
    existing project.
1793
1797
 
1794
1798
 
1795
1799
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1800
    """Create a shared repository for branches to share storage space.
1797
1801
 
1798
1802
    New branches created under the repository directory will store their
1799
1803
    revisions in the repository, not in the branch directory.  For branches
1853
1857
 
1854
1858
 
1855
1859
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1860
    """Show differences in the working tree, between revisions or branches.
1857
1861
 
1858
1862
    If no arguments are given, all changes for the current tree are listed.
1859
1863
    If files are given, only the changes in those files are listed.
1945
1949
            help='Use this command to compare files.',
1946
1950
            type=unicode,
1947
1951
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1952
        ]
1953
1953
    aliases = ['di', 'dif']
1954
1954
    encoding_type = 'exact'
1955
1955
 
1956
1956
    @display_command
1957
1957
    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)
 
1958
            prefix=None, old=None, new=None, using=None):
 
1959
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1961
1960
 
1962
1961
        if (prefix is None) or (prefix == '0'):
1963
1962
            # diff -p0 format
1977
1976
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1977
                                         ' one or two revision specifiers')
1979
1978
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
1979
        (old_tree, new_tree,
1985
1980
         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)
 
1981
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1982
            file_list, revision, old, new, apply_view=True)
1988
1983
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1984
                               specific_files=specific_files,
1990
1985
                               external_diff_options=diff_options,
1991
1986
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1987
                               extra_trees=extra_trees, using=using)
1994
1988
 
1995
1989
 
1996
1990
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1991
    """List files deleted in the working tree.
1998
1992
    """
1999
1993
    # TODO: Show files deleted since a previous revision, or
2000
1994
    # between two revisions.
2023
2017
 
2024
2018
 
2025
2019
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
2020
    """List files modified in working tree.
2027
2021
    """
2028
2022
 
2029
2023
    hidden = True
2046
2040
 
2047
2041
 
2048
2042
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
2043
    """List files added in working tree.
2050
2044
    """
2051
2045
 
2052
2046
    hidden = True
2082
2076
 
2083
2077
 
2084
2078
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2079
    """Show the tree root directory.
2086
2080
 
2087
2081
    The root is the nearest enclosing directory with a .bzr control
2088
2082
    directory."""
2112
2106
 
2113
2107
 
2114
2108
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2109
    """Show historical log for a branch or subset of a branch.
2116
2110
 
2117
2111
    log is bzr's default tool for exploring the history of a branch.
2118
2112
    The branch to use is taken from the first parameter. If no parameters
2299
2293
                   help='Show changes made in each revision as a patch.'),
2300
2294
            Option('include-merges',
2301
2295
                   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
2296
            ]
2307
2297
    encoding_type = 'replace'
2308
2298
 
2318
2308
            message=None,
2319
2309
            limit=None,
2320
2310
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2311
            include_merges=False):
2324
2312
        from bzrlib.log import (
2325
2313
            Logger,
2326
2314
            make_log_request_dict,
2327
2315
            _get_info_for_log_files,
2328
2316
            )
2329
2317
        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
2318
        if include_merges:
2335
2319
            if levels is None:
2336
2320
                levels = 0
2429
2413
            direction=direction, specific_fileids=file_ids,
2430
2414
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2415
            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
 
            )
 
2416
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2417
        Logger(b, rqst).show(lf)
2436
2418
 
2437
2419
 
2495
2477
 
2496
2478
 
2497
2479
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2480
    """Return revision-ids which affected a particular file.
2499
2481
 
2500
2482
    A more user-friendly interface is "bzr log FILE".
2501
2483
    """
2516
2498
 
2517
2499
 
2518
2500
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2501
    """List files in a tree.
2520
2502
    """
2521
2503
 
2522
2504
    _see_also = ['status', 'cat']
2633
2615
 
2634
2616
 
2635
2617
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2618
    """List unknown files.
2637
2619
    """
2638
2620
 
2639
2621
    hidden = True
2646
2628
 
2647
2629
 
2648
2630
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2631
    """Ignore specified files or patterns.
2650
2632
 
2651
2633
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2634
 
2661
2643
    using this command or directly by using an editor, be sure to commit
2662
2644
    it.
2663
2645
    
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
2646
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2647
    precedence over regular ignores.  Such exceptions are used to specify
2672
2648
    files that should be versioned which would otherwise be ignored.
2713
2689
    _see_also = ['status', 'ignored', 'patterns']
2714
2690
    takes_args = ['name_pattern*']
2715
2691
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2692
        Option('old-default-rules',
 
2693
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2694
        ]
2719
2695
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2696
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2697
        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:
 
2698
        if old_default_rules is not None:
 
2699
            # dump the rules and exit
 
2700
            for pattern in ignores.OLD_DEFAULTS:
2725
2701
                self.outf.write("%s\n" % pattern)
2726
2702
            return
2727
2703
        if not name_pattern_list:
2728
2704
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2705
                                  "NAME_PATTERN or --old-default-rules")
2730
2706
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2707
                             for p in name_pattern_list]
2732
2708
        for name_pattern in name_pattern_list:
2754
2730
 
2755
2731
 
2756
2732
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2733
    """List ignored files and the patterns that matched them.
2758
2734
 
2759
2735
    List all the ignored files and the ignore pattern that caused the file to
2760
2736
    be ignored.
2781
2757
 
2782
2758
 
2783
2759
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2760
    """Lookup the revision-id from a revision-number
2785
2761
 
2786
2762
    :Examples:
2787
2763
        bzr lookup-revision 33
2801
2777
 
2802
2778
 
2803
2779
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2780
    """Export current or past revision to a destination directory or archive.
2805
2781
 
2806
2782
    If no revision is specified this exports the last committed revision.
2807
2783
 
2864
2840
 
2865
2841
 
2866
2842
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2843
    """Write the contents of a file as of a given revision to standard output.
2868
2844
 
2869
2845
    If no revision is nominated, the last revision is used.
2870
2846
 
2950
2926
 
2951
2927
 
2952
2928
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2929
    """Show the offset in seconds from GMT to local time."""
2954
2930
    hidden = True
2955
2931
    @display_command
2956
2932
    def run(self):
2959
2935
 
2960
2936
 
2961
2937
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2938
    """Commit changes into a new revision.
2963
2939
 
2964
2940
    An explanatory message needs to be given for each commit. This is
2965
2941
    often done by using the --message option (getting the message from the
3073
3049
                         "the master branch until a normal commit "
3074
3050
                         "is performed."
3075
3051
                    ),
3076
 
             Option('show-diff', short_name='p',
 
3052
             Option('show-diff',
3077
3053
                    help='When no message is supplied, show the diff along'
3078
3054
                    ' with the status summary in the message editor.'),
3079
3055
             ]
3159
3135
                    '(use --file "%(f)s" to take commit message from that file)'
3160
3136
                    % { 'f': message })
3161
3137
                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
3138
 
3169
3139
        def get_message(commit_obj):
3170
3140
            """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,
 
3141
            my_message = message
 
3142
            if my_message is not None and '\r' in my_message:
 
3143
                my_message = my_message.replace('\r\n', '\n')
 
3144
                my_message = my_message.replace('\r', '\n')
 
3145
            if my_message is None and not file:
 
3146
                t = make_commit_message_template_encoded(tree,
3180
3147
                        selected_list, diff=show_diff,
3181
3148
                        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
3149
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
3150
                my_message = edit_commit_message_encoded(t,
3189
3151
                    start_message=start_message)
3190
3152
                if my_message is None:
3191
3153
                    raise errors.BzrCommandError("please specify a commit"
3192
3154
                        " message with either --message or --file")
 
3155
            elif my_message and file:
 
3156
                raise errors.BzrCommandError(
 
3157
                    "please specify either --message or --file")
 
3158
            if file:
 
3159
                my_message = codecs.open(file, 'rt',
 
3160
                                         osutils.get_user_encoding()).read()
3193
3161
            if my_message == "":
3194
3162
                raise errors.BzrCommandError("empty commit message specified")
3195
3163
            return my_message
3207
3175
                        timezone=offset,
3208
3176
                        exclude=safe_relpath_files(tree, exclude))
3209
3177
        except PointlessCommit:
 
3178
            # FIXME: This should really happen before the file is read in;
 
3179
            # perhaps prepare the commit; get the message; then actually commit
3210
3180
            raise errors.BzrCommandError("No changes to commit."
3211
3181
                              " Use --unchanged to commit anyhow.")
3212
3182
        except ConflictsInTree:
3225
3195
 
3226
3196
 
3227
3197
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3198
    """Validate working tree structure, branch consistency and repository history.
3229
3199
 
3230
3200
    This command checks various invariants about branch and repository storage
3231
3201
    to detect data corruption or bzr bugs.
3295
3265
 
3296
3266
 
3297
3267
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3268
    """Upgrade branch storage to current format.
3299
3269
 
3300
3270
    The check command or bzr developers may sometimes advise you to run
3301
3271
    this command. When the default format has changed you may also be warned
3319
3289
 
3320
3290
 
3321
3291
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3292
    """Show or set bzr user id.
3323
3293
 
3324
3294
    :Examples:
3325
3295
        Show the email of the current user::
3369
3339
 
3370
3340
 
3371
3341
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3342
    """Print or set the branch nickname.
3373
3343
 
3374
3344
    If unset, the tree root directory name is used as the nickname.
3375
3345
    To print the current nickname, execute with no argument.
3393
3363
 
3394
3364
 
3395
3365
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3366
    """Set/unset and display aliases.
3397
3367
 
3398
3368
    :Examples:
3399
3369
        Show the current aliases::
3463
3433
 
3464
3434
 
3465
3435
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3436
    """Run internal test suite.
3467
3437
 
3468
3438
    If arguments are given, they are regular expressions that say which tests
3469
3439
    should run.  Tests matching any expression are run, and other tests are
3610
3580
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3581
                    "needs to be installed to use --subunit.")
3612
3582
            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
3583
        if parallel:
3619
3584
            self.additional_selftest_args.setdefault(
3620
3585
                'suite_decorators', []).append(parallel)
3651
3616
 
3652
3617
 
3653
3618
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3619
    """Show version of bzr."""
3655
3620
 
3656
3621
    encoding_type = 'replace'
3657
3622
    takes_options = [
3668
3633
 
3669
3634
 
3670
3635
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3636
    """Statement of optimism."""
3672
3637
 
3673
3638
    hidden = True
3674
3639
 
3678
3643
 
3679
3644
 
3680
3645
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3646
    """Find and print a base revision for merging two branches."""
3682
3647
    # TODO: Options to specify revisions on either side, as if
3683
3648
    #       merging only part of the history.
3684
3649
    takes_args = ['branch', 'other']
3704
3669
 
3705
3670
 
3706
3671
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3672
    """Perform a three-way merge.
3708
3673
 
3709
3674
    The source of the merge can be specified either in the form of a branch,
3710
3675
    or in the form of a path to a file containing a merge directive generated
4065
4030
 
4066
4031
 
4067
4032
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
4033
    """Redo a merge.
4069
4034
 
4070
4035
    Use this if you want to try a different merge technique while resolving
4071
4036
    conflicts.  Some merge techniques are better than others, and remerge
4096
4061
 
4097
4062
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
4063
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
4064
        if merge_type is None:
4101
4065
            merge_type = _mod_merge.Merge3Merger
4102
4066
        tree, file_list = tree_files(file_list)
4160
4124
 
4161
4125
 
4162
4126
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4127
    """Revert files to a previous revision.
4164
4128
 
4165
4129
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4130
    will be reverted.  If the revision is not specified with '--revision', the
4217
4181
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4182
            forget_merges=None):
4219
4183
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
 
4184
        tree.lock_write()
4221
4185
        self.add_cleanup(tree.unlock)
4222
4186
        if forget_merges:
4223
4187
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4232
4196
 
4233
4197
 
4234
4198
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4199
    """Test reporting of assertion failures"""
4236
4200
    # intended just for use in testing
4237
4201
 
4238
4202
    hidden = True
4242
4206
 
4243
4207
 
4244
4208
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4209
    """Show help on a command or other topic.
4246
4210
    """
4247
4211
 
4248
4212
    _see_also = ['topics']
4261
4225
 
4262
4226
 
4263
4227
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4228
    """Show appropriate completions for context.
4265
4229
 
4266
4230
    For a list of all available commands, say 'bzr shell-complete'.
4267
4231
    """
4276
4240
 
4277
4241
 
4278
4242
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4243
    """Show unmerged/unpulled revisions between two branches.
4280
4244
 
4281
4245
    OTHER_BRANCH may be local or remote.
4282
4246
 
4360
4324
            restrict = 'remote'
4361
4325
 
4362
4326
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4327
        parent = local_branch.get_parent()
4367
4328
        if other_branch is None:
4368
4329
            other_branch = parent
4377
4338
        remote_branch = Branch.open(other_branch)
4378
4339
        if remote_branch.base == local_branch.base:
4379
4340
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4341
 
 
4342
        local_branch.lock_read()
 
4343
        self.add_cleanup(local_branch.unlock)
4384
4344
        local_revid_range = _revision_range_to_revid_range(
4385
4345
            _get_revision_range(my_revision, local_branch,
4386
4346
                self.name()))
4387
4347
 
 
4348
        remote_branch.lock_read()
 
4349
        self.add_cleanup(remote_branch.unlock)
4388
4350
        remote_revid_range = _revision_range_to_revid_range(
4389
4351
            _get_revision_range(revision,
4390
4352
                remote_branch, self.name()))
4449
4411
 
4450
4412
 
4451
4413
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
 
    """
 
4414
    """Compress the data within a repository."""
4469
4415
 
4470
4416
    _see_also = ['repositories']
4471
4417
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4418
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4419
    def run(self, branch_or_repo='.'):
4477
4420
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4421
        try:
4479
4422
            branch = dir.open_branch()
4480
4423
            repository = branch.repository
4481
4424
        except errors.NotBranchError:
4482
4425
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4426
        repository.pack()
4484
4427
 
4485
4428
 
4486
4429
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4430
    """List the installed plugins.
4488
4431
 
4489
4432
    This command displays the list of installed plugins including
4490
4433
    version of plugin and a short description of each.
4529
4472
 
4530
4473
 
4531
4474
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4475
    """Show testament (signing-form) of a revision."""
4533
4476
    takes_options = [
4534
4477
            'revision',
4535
4478
            Option('long', help='Produce long-format testament.'),
4561
4504
 
4562
4505
 
4563
4506
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4507
    """Show the origin of each line in a file.
4565
4508
 
4566
4509
    This prints out the given file with an annotation on the left side
4567
4510
    indicating which revision, author and date introduced the change.
4614
4557
 
4615
4558
 
4616
4559
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4560
    """Create a digital signature for an existing revision."""
4618
4561
    # TODO be able to replace existing ones.
4619
4562
 
4620
4563
    hidden = True # is this right ?
4680
4623
 
4681
4624
 
4682
4625
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.
 
4626
    """Convert the current branch into a checkout of the supplied branch.
4685
4627
 
4686
4628
    Once converted into a checkout, commits must succeed on the master branch
4687
4629
    before they will be applied to the local branch.
4721
4663
 
4722
4664
 
4723
4665
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4666
    """Convert the current checkout into a regular branch.
4725
4667
 
4726
4668
    After unbinding, the local branch is considered independent and subsequent
4727
4669
    commits will be local only.
4738
4680
 
4739
4681
 
4740
4682
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4683
    """Remove the last committed revision.
4742
4684
 
4743
4685
    --verbose will print out what is being removed.
4744
4686
    --dry-run will go through all the motions, but not actually
4846
4788
 
4847
4789
 
4848
4790
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4791
    """Break a dead lock on a repository, branch or working directory.
4850
4792
 
4851
4793
    CAUTION: Locks should only be broken when you are sure that the process
4852
4794
    holding the lock has been stopped.
4871
4813
 
4872
4814
 
4873
4815
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4816
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4817
 
4876
4818
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4819
    """
4885
4827
 
4886
4828
 
4887
4829
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4830
    """Run the bzr server."""
4889
4831
 
4890
4832
    aliases = ['server']
4891
4833
 
4951
4893
 
4952
4894
 
4953
4895
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4896
    """Combine a tree into its containing tree.
4955
4897
 
4956
4898
    This command requires the target tree to be in a rich-root format.
4957
4899
 
4997
4939
 
4998
4940
 
4999
4941
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4942
    """Split a subdirectory of a tree into a separate tree.
5001
4943
 
5002
4944
    This command will produce a target tree in a format that supports
5003
4945
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4965
 
5024
4966
 
5025
4967
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4968
    """Generate a merge directive for auto-merge tools.
5027
4969
 
5028
4970
    A directive requests a merge to be performed, and also provides all the
5029
4971
    information necessary to do so.  This means it must either include a
5122
5064
 
5123
5065
 
5124
5066
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5067
    """Mail or create a merge-directive for submitting changes.
5126
5068
 
5127
5069
    A merge directive provides many things needed for requesting merges:
5128
5070
 
5239
5181
 
5240
5182
 
5241
5183
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5184
    """Create a merge-directive for submitting changes.
5243
5185
 
5244
5186
    A merge directive provides many things needed for requesting merges:
5245
5187
 
5312
5254
 
5313
5255
 
5314
5256
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5257
    """Create, remove or modify a tag naming a revision.
5316
5258
 
5317
5259
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5260
    (--revision) option can be given -rtag:X, where X is any previously
5385
5327
 
5386
5328
 
5387
5329
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5330
    """List tags.
5389
5331
 
5390
5332
    This command shows a table of tag names and the revisions they reference.
5391
5333
    """
5459
5401
 
5460
5402
 
5461
5403
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5404
    """Reconfigure the type of a bzr directory.
5463
5405
 
5464
5406
    A target configuration must be specified.
5465
5407
 
5550
5492
 
5551
5493
 
5552
5494
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5495
    """Set the branch of a checkout and update.
5554
5496
 
5555
5497
    For lightweight checkouts, this changes the branch being referenced.
5556
5498
    For heavyweight checkouts, this checks that there are no local commits
5646
5588
 
5647
5589
 
5648
5590
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5591
    """Manage filtered views.
5650
5592
 
5651
5593
    Views provide a mask over the tree so that users can focus on
5652
5594
    a subset of a tree when doing their work. After creating a view,
5800
5742
 
5801
5743
 
5802
5744
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5745
    """Show hooks."""
5804
5746
 
5805
5747
    hidden = True
5806
5748
 
5820
5762
 
5821
5763
 
5822
5764
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
 
5765
    """Remove a branch.
5824
5766
 
5825
5767
    This will remove the branch from the specified location but 
5826
5768
    will keep any working tree or repository in place.
5845
5787
        
5846
5788
 
5847
5789
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5790
    """Temporarily set aside some changes from the current tree.
5849
5791
 
5850
5792
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5793
    ie. out of the way, until a later time when you can bring them back from
5920
5862
 
5921
5863
 
5922
5864
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5865
    """Restore shelved changes.
5924
5866
 
5925
5867
    By default, the most recently shelved changes are restored. However if you
5926
5868
    specify a shelf by id those changes will be restored instead.  This works
5952
5894
 
5953
5895
 
5954
5896
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5897
    """Remove unwanted files from working tree.
5956
5898
 
5957
5899
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5900
    files are never deleted.
5986
5928
 
5987
5929
 
5988
5930
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5931
    """list, view and set branch locations for nested trees.
5990
5932
 
5991
5933
    If no arguments are provided, lists the branch locations for nested trees.
5992
5934
    If one argument is provided, display the branch location for that tree.
6032
5974
            self.outf.write('%s %s\n' % (path, location))
6033
5975
 
6034
5976
 
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)
 
5977
from bzrlib.cmd_version_info import cmd_version_info
 
5978
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5979
from bzrlib.foreign import cmd_dpush
 
5980
from bzrlib.sign_my_commits import cmd_sign_my_commits