~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2010-04-30 11:03:59 UTC
  • mto: This revision was merged to the branch mainline in revision 5197.
  • Revision ID: jelmer@samba.org-20100430110359-ow3e3grh7sxy93pa
Remove more unused imports.

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