~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
239
239
# opens the branch?)
240
240
 
241
241
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
242
    """Display status summary.
243
243
 
244
244
    This reports on versioned and unknown files, reporting them
245
245
    grouped by state.  Possible states are:
332
332
 
333
333
 
334
334
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
335
    """Write out metadata for a revision.
336
336
 
337
337
    The revision to print can either be specified by a specific
338
338
    revision identifier, or you can use --revision.
390
390
        
391
391
 
392
392
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
393
    """Dump the contents of a btree index file to stdout.
394
394
 
395
395
    PATH is a btree index file, it can be any URL. This includes things like
396
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
471
471
 
472
472
 
473
473
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
474
    """Remove the working tree from a given branch/checkout.
475
475
 
476
476
    Since a lightweight checkout is little more than a working tree
477
477
    this will refuse to run against one.
504
504
                if (working.has_changes()):
505
505
                    raise errors.UncommittedChanges(working)
506
506
 
507
 
            if working.user_url != working.branch.user_url:
 
507
            working_path = working.bzrdir.root_transport.base
 
508
            branch_path = working.branch.bzrdir.root_transport.base
 
509
            if working_path != branch_path:
508
510
                raise errors.BzrCommandError("You cannot remove the working tree"
509
511
                                             " from a lightweight checkout")
510
512
 
512
514
 
513
515
 
514
516
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
517
    """Show current revision number.
516
518
 
517
519
    This is equal to the number of revisions on this branch.
518
520
    """
548
550
 
549
551
 
550
552
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
553
    """Show revision number and revision id for a given revision identifier.
552
554
    """
553
555
    hidden = True
554
556
    takes_args = ['revision_info*']
610
612
 
611
613
 
612
614
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
615
    """Add specified files or directories.
614
616
 
615
617
    In non-recursive mode, all the named items are added, regardless
616
618
    of whether they were previously ignored.  A warning is given if
696
698
 
697
699
 
698
700
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
701
    """Create a new versioned directory.
700
702
 
701
703
    This is equivalent to creating the directory and then adding it.
702
704
    """
718
720
 
719
721
 
720
722
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
723
    """Show path of a file relative to root"""
722
724
 
723
725
    takes_args = ['filename']
724
726
    hidden = True
733
735
 
734
736
 
735
737
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
738
    """Show inventory of the current working copy or a revision.
737
739
 
738
740
    It is possible to limit the output to a particular entry
739
741
    type using the --kind option.  For example: --kind file.
794
796
 
795
797
 
796
798
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
799
    """Move or rename a file.
798
800
 
799
801
    :Usage:
800
802
        bzr mv OLDNAME NEWNAME
931
933
 
932
934
 
933
935
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
936
    """Turn this branch into a mirror of another branch.
935
937
 
936
938
    By default, this command only works on branches that have not diverged.
937
939
    Branches are considered diverged if the destination branch's most recent 
986
988
        try:
987
989
            tree_to = WorkingTree.open_containing(directory)[0]
988
990
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
991
        except errors.NoWorkingTree:
992
992
            tree_to = None
993
993
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
994
        
997
995
        if local and not branch_to.get_bound_location():
998
996
            raise errors.LocalRequiresBoundBranch()
999
997
 
1029
1027
        else:
1030
1028
            branch_from = Branch.open(location,
1031
1029
                possible_transports=possible_transports)
 
1030
 
 
1031
            if branch_to.get_parent() is None or remember:
 
1032
                branch_to.set_parent(branch_from.base)
 
1033
 
 
1034
        if branch_from is not branch_to:
1032
1035
            branch_from.lock_read()
1033
1036
            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
1037
        if revision is not None:
1039
1038
            revision_id = revision.as_revision_id(branch_from)
1040
1039
 
 
1040
        branch_to.lock_write()
 
1041
        self.add_cleanup(branch_to.unlock)
1041
1042
        if tree_to is not None:
1042
1043
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
1044
            change_reporter = delta._ChangeReporter(
1058
1059
 
1059
1060
 
1060
1061
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1062
    """Update a mirror of this branch.
1062
1063
 
1063
1064
    The target branch will not have its working tree populated because this
1064
1065
    is both expensive, and is not supported on remote file systems.
1125
1126
        # Get the source branch
1126
1127
        (tree, br_from,
1127
1128
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1129
        if strict is None:
 
1130
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1131
        if strict is None: strict = True # default value
1128
1132
        # Get the tip's revision_id
1129
1133
        revision = _get_one_revision('push', revision)
1130
1134
        if revision is not None:
1131
1135
            revision_id = revision.in_history(br_from).rev_id
1132
1136
        else:
1133
1137
            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.')
 
1138
        if strict and tree is not None and revision_id is None:
 
1139
            if (tree.has_changes()):
 
1140
                raise errors.UncommittedChanges(
 
1141
                    tree, more='Use --no-strict to force the push.')
 
1142
            if tree.last_revision() != tree.branch.last_revision():
 
1143
                # The tree has lost sync with its branch, there is little
 
1144
                # chance that the user is aware of it but he can still force
 
1145
                # the push with --no-strict
 
1146
                raise errors.OutOfDateTree(
 
1147
                    tree, more='Use --no-strict to force the push.')
 
1148
 
1139
1149
        # Get the stacked_on branch, if any
1140
1150
        if stacked_on is not None:
1141
1151
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1183
 
1174
1184
 
1175
1185
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1186
    """Create a new branch that is a copy of an existing branch.
1177
1187
 
1178
1188
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1189
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1286
1296
 
1287
1297
 
1288
1298
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1299
    """Create a new checkout of an existing branch.
1290
1300
 
1291
1301
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1302
    the branch found in '.'. This is useful if you have removed the working tree
1355
1365
 
1356
1366
 
1357
1367
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1368
    """Show list of renamed files.
1359
1369
    """
1360
1370
    # TODO: Option to show renames between two historical versions.
1361
1371
 
1387
1397
 
1388
1398
 
1389
1399
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1400
    """Update a tree to have the latest code committed to its branch.
1391
1401
 
1392
1402
    This will perform a merge into the working tree, and may generate
1393
1403
    conflicts. If you have any local changes, you will still
1438
1448
        else:
1439
1449
            revision_id = branch.last_revision()
1440
1450
        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))
 
1451
            revno = branch.revision_id_to_revno(revision_id)
 
1452
            note("Tree is up to date at revision %d of branch %s" %
 
1453
                (revno, branch_location))
1444
1454
            return 0
1445
1455
        view_info = _get_view_info_for_change_reporter(tree)
1446
1456
        change_reporter = delta._ChangeReporter(
1458
1468
                                  "bzr update --revision only works"
1459
1469
                                  " for a revision in the branch history"
1460
1470
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1471
        revno = tree.branch.revision_id_to_revno(
1462
1472
            _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:
 
1473
        note('Updated to revision %d of branch %s' %
 
1474
             (revno, branch_location))
 
1475
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1467
1476
            note('Your local commits will now show as pending merges with '
1468
1477
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
1478
        if conflicts != 0:
1473
1482
 
1474
1483
 
1475
1484
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1485
    """Show information about a working tree, branch or repository.
1477
1486
 
1478
1487
    This command will show all known locations and formats associated to the
1479
1488
    tree, branch or repository.
1517
1526
 
1518
1527
 
1519
1528
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1529
    """Remove files or directories.
1521
1530
 
1522
1531
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1532
    them if they can easily be recovered using revert. If no options or
1571
1580
 
1572
1581
 
1573
1582
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1583
    """Print file_id of a particular file or directory.
1575
1584
 
1576
1585
    The file_id is assigned when the file is first added and remains the
1577
1586
    same through all revisions where the file exists, even when it is
1593
1602
 
1594
1603
 
1595
1604
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1605
    """Print path of file_ids to a file or directory.
1597
1606
 
1598
1607
    This prints one line for each directory down to the target,
1599
1608
    starting at the branch root.
1615
1624
 
1616
1625
 
1617
1626
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1627
    """Reconcile bzr metadata in a branch.
1619
1628
 
1620
1629
    This can correct data mismatches that may have been caused by
1621
1630
    previous ghost operations or bzr upgrades. You should only
1643
1652
 
1644
1653
 
1645
1654
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1655
    """Display the list of revision ids on a branch."""
1647
1656
 
1648
1657
    _see_also = ['log']
1649
1658
    takes_args = ['location?']
1659
1668
 
1660
1669
 
1661
1670
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1671
    """List all revisions merged into this branch."""
1663
1672
 
1664
1673
    _see_also = ['log', 'revision-history']
1665
1674
    takes_args = ['location?']
1684
1693
 
1685
1694
 
1686
1695
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1696
    """Make a directory into a versioned branch.
1688
1697
 
1689
1698
    Use this to create an empty branch, or before importing an
1690
1699
    existing project.
1793
1802
 
1794
1803
 
1795
1804
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1805
    """Create a shared repository for branches to share storage space.
1797
1806
 
1798
1807
    New branches created under the repository directory will store their
1799
1808
    revisions in the repository, not in the branch directory.  For branches
1853
1862
 
1854
1863
 
1855
1864
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1865
    """Show differences in the working tree, between revisions or branches.
1857
1866
 
1858
1867
    If no arguments are given, all changes for the current tree are listed.
1859
1868
    If files are given, only the changes in those files are listed.
1956
1965
    @display_command
1957
1966
    def run(self, revision=None, file_list=None, diff_options=None,
1958
1967
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1968
        from bzrlib.diff import (get_trees_and_branches_to_diff,
1960
1969
            show_diff_trees)
1961
1970
 
1962
1971
        if (prefix is None) or (prefix == '0'):
1983
1992
 
1984
1993
        (old_tree, new_tree,
1985
1994
         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)
 
1995
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1996
            file_list, revision, old, new, apply_view=True)
1988
1997
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1998
                               specific_files=specific_files,
1990
1999
                               external_diff_options=diff_options,
1994
2003
 
1995
2004
 
1996
2005
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
2006
    """List files deleted in the working tree.
1998
2007
    """
1999
2008
    # TODO: Show files deleted since a previous revision, or
2000
2009
    # between two revisions.
2023
2032
 
2024
2033
 
2025
2034
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
2035
    """List files modified in working tree.
2027
2036
    """
2028
2037
 
2029
2038
    hidden = True
2046
2055
 
2047
2056
 
2048
2057
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
2058
    """List files added in working tree.
2050
2059
    """
2051
2060
 
2052
2061
    hidden = True
2082
2091
 
2083
2092
 
2084
2093
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2094
    """Show the tree root directory.
2086
2095
 
2087
2096
    The root is the nearest enclosing directory with a .bzr control
2088
2097
    directory."""
2112
2121
 
2113
2122
 
2114
2123
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2124
    """Show historical log for a branch or subset of a branch.
2116
2125
 
2117
2126
    log is bzr's default tool for exploring the history of a branch.
2118
2127
    The branch to use is taken from the first parameter. If no parameters
2299
2308
                   help='Show changes made in each revision as a patch.'),
2300
2309
            Option('include-merges',
2301
2310
                   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
2311
            ]
2307
2312
    encoding_type = 'replace'
2308
2313
 
2318
2323
            message=None,
2319
2324
            limit=None,
2320
2325
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2326
            include_merges=False):
2324
2327
        from bzrlib.log import (
2325
2328
            Logger,
2326
2329
            make_log_request_dict,
2327
2330
            _get_info_for_log_files,
2328
2331
            )
2329
2332
        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
2333
        if include_merges:
2335
2334
            if levels is None:
2336
2335
                levels = 0
2429
2428
            direction=direction, specific_fileids=file_ids,
2430
2429
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2430
            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
 
            )
 
2431
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2432
        Logger(b, rqst).show(lf)
2436
2433
 
2437
2434
 
2495
2492
 
2496
2493
 
2497
2494
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2495
    """Return revision-ids which affected a particular file.
2499
2496
 
2500
2497
    A more user-friendly interface is "bzr log FILE".
2501
2498
    """
2516
2513
 
2517
2514
 
2518
2515
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2516
    """List files in a tree.
2520
2517
    """
2521
2518
 
2522
2519
    _see_also = ['status', 'cat']
2633
2630
 
2634
2631
 
2635
2632
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2633
    """List unknown files.
2637
2634
    """
2638
2635
 
2639
2636
    hidden = True
2646
2643
 
2647
2644
 
2648
2645
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2646
    """Ignore specified files or patterns.
2650
2647
 
2651
2648
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2649
 
2661
2658
    using this command or directly by using an editor, be sure to commit
2662
2659
    it.
2663
2660
    
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
2661
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2662
    precedence over regular ignores.  Such exceptions are used to specify
2672
2663
    files that should be versioned which would otherwise be ignored.
2713
2704
    _see_also = ['status', 'ignored', 'patterns']
2714
2705
    takes_args = ['name_pattern*']
2715
2706
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2707
        Option('old-default-rules',
 
2708
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2709
        ]
2719
2710
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2711
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2712
        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:
 
2713
        if old_default_rules is not None:
 
2714
            # dump the rules and exit
 
2715
            for pattern in ignores.OLD_DEFAULTS:
2725
2716
                self.outf.write("%s\n" % pattern)
2726
2717
            return
2727
2718
        if not name_pattern_list:
2728
2719
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2720
                                  "NAME_PATTERN or --old-default-rules")
2730
2721
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2722
                             for p in name_pattern_list]
2732
2723
        for name_pattern in name_pattern_list:
2754
2745
 
2755
2746
 
2756
2747
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2748
    """List ignored files and the patterns that matched them.
2758
2749
 
2759
2750
    List all the ignored files and the ignore pattern that caused the file to
2760
2751
    be ignored.
2781
2772
 
2782
2773
 
2783
2774
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2775
    """Lookup the revision-id from a revision-number
2785
2776
 
2786
2777
    :Examples:
2787
2778
        bzr lookup-revision 33
2801
2792
 
2802
2793
 
2803
2794
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2795
    """Export current or past revision to a destination directory or archive.
2805
2796
 
2806
2797
    If no revision is specified this exports the last committed revision.
2807
2798
 
2864
2855
 
2865
2856
 
2866
2857
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2858
    """Write the contents of a file as of a given revision to standard output.
2868
2859
 
2869
2860
    If no revision is nominated, the last revision is used.
2870
2861
 
2950
2941
 
2951
2942
 
2952
2943
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2944
    """Show the offset in seconds from GMT to local time."""
2954
2945
    hidden = True
2955
2946
    @display_command
2956
2947
    def run(self):
2959
2950
 
2960
2951
 
2961
2952
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2953
    """Commit changes into a new revision.
2963
2954
 
2964
2955
    An explanatory message needs to be given for each commit. This is
2965
2956
    often done by using the --message option (getting the message from the
3073
3064
                         "the master branch until a normal commit "
3074
3065
                         "is performed."
3075
3066
                    ),
3076
 
             Option('show-diff', short_name='p',
 
3067
             Option('show-diff',
3077
3068
                    help='When no message is supplied, show the diff along'
3078
3069
                    ' with the status summary in the message editor.'),
3079
3070
             ]
3225
3216
 
3226
3217
 
3227
3218
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3219
    """Validate working tree structure, branch consistency and repository history.
3229
3220
 
3230
3221
    This command checks various invariants about branch and repository storage
3231
3222
    to detect data corruption or bzr bugs.
3295
3286
 
3296
3287
 
3297
3288
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3289
    """Upgrade branch storage to current format.
3299
3290
 
3300
3291
    The check command or bzr developers may sometimes advise you to run
3301
3292
    this command. When the default format has changed you may also be warned
3319
3310
 
3320
3311
 
3321
3312
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3313
    """Show or set bzr user id.
3323
3314
 
3324
3315
    :Examples:
3325
3316
        Show the email of the current user::
3369
3360
 
3370
3361
 
3371
3362
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3363
    """Print or set the branch nickname.
3373
3364
 
3374
3365
    If unset, the tree root directory name is used as the nickname.
3375
3366
    To print the current nickname, execute with no argument.
3393
3384
 
3394
3385
 
3395
3386
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3387
    """Set/unset and display aliases.
3397
3388
 
3398
3389
    :Examples:
3399
3390
        Show the current aliases::
3463
3454
 
3464
3455
 
3465
3456
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3457
    """Run internal test suite.
3467
3458
 
3468
3459
    If arguments are given, they are regular expressions that say which tests
3469
3460
    should run.  Tests matching any expression are run, and other tests are
3610
3601
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3602
                    "needs to be installed to use --subunit.")
3612
3603
            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
3604
        if parallel:
3619
3605
            self.additional_selftest_args.setdefault(
3620
3606
                'suite_decorators', []).append(parallel)
3651
3637
 
3652
3638
 
3653
3639
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3640
    """Show version of bzr."""
3655
3641
 
3656
3642
    encoding_type = 'replace'
3657
3643
    takes_options = [
3668
3654
 
3669
3655
 
3670
3656
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3657
    """Statement of optimism."""
3672
3658
 
3673
3659
    hidden = True
3674
3660
 
3678
3664
 
3679
3665
 
3680
3666
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3667
    """Find and print a base revision for merging two branches."""
3682
3668
    # TODO: Options to specify revisions on either side, as if
3683
3669
    #       merging only part of the history.
3684
3670
    takes_args = ['branch', 'other']
3704
3690
 
3705
3691
 
3706
3692
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3693
    """Perform a three-way merge.
3708
3694
 
3709
3695
    The source of the merge can be specified either in the form of a branch,
3710
3696
    or in the form of a path to a file containing a merge directive generated
4065
4051
 
4066
4052
 
4067
4053
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
4054
    """Redo a merge.
4069
4055
 
4070
4056
    Use this if you want to try a different merge technique while resolving
4071
4057
    conflicts.  Some merge techniques are better than others, and remerge
4160
4146
 
4161
4147
 
4162
4148
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4149
    """Revert files to a previous revision.
4164
4150
 
4165
4151
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4152
    will be reverted.  If the revision is not specified with '--revision', the
4217
4203
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4204
            forget_merges=None):
4219
4205
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
 
4206
        tree.lock_write()
4221
4207
        self.add_cleanup(tree.unlock)
4222
4208
        if forget_merges:
4223
4209
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4232
4218
 
4233
4219
 
4234
4220
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4221
    """Test reporting of assertion failures"""
4236
4222
    # intended just for use in testing
4237
4223
 
4238
4224
    hidden = True
4242
4228
 
4243
4229
 
4244
4230
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4231
    """Show help on a command or other topic.
4246
4232
    """
4247
4233
 
4248
4234
    _see_also = ['topics']
4261
4247
 
4262
4248
 
4263
4249
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4250
    """Show appropriate completions for context.
4265
4251
 
4266
4252
    For a list of all available commands, say 'bzr shell-complete'.
4267
4253
    """
4276
4262
 
4277
4263
 
4278
4264
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4265
    """Show unmerged/unpulled revisions between two branches.
4280
4266
 
4281
4267
    OTHER_BRANCH may be local or remote.
4282
4268
 
4360
4346
            restrict = 'remote'
4361
4347
 
4362
4348
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4349
        parent = local_branch.get_parent()
4367
4350
        if other_branch is None:
4368
4351
            other_branch = parent
4377
4360
        remote_branch = Branch.open(other_branch)
4378
4361
        if remote_branch.base == local_branch.base:
4379
4362
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4363
 
 
4364
        local_branch.lock_read()
 
4365
        self.add_cleanup(local_branch.unlock)
4384
4366
        local_revid_range = _revision_range_to_revid_range(
4385
4367
            _get_revision_range(my_revision, local_branch,
4386
4368
                self.name()))
4387
4369
 
 
4370
        remote_branch.lock_read()
 
4371
        self.add_cleanup(remote_branch.unlock)
4388
4372
        remote_revid_range = _revision_range_to_revid_range(
4389
4373
            _get_revision_range(revision,
4390
4374
                remote_branch, self.name()))
4449
4433
 
4450
4434
 
4451
4435
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
 
    """
 
4436
    """Compress the data within a repository."""
4469
4437
 
4470
4438
    _see_also = ['repositories']
4471
4439
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4440
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4441
    def run(self, branch_or_repo='.'):
4477
4442
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4443
        try:
4479
4444
            branch = dir.open_branch()
4480
4445
            repository = branch.repository
4481
4446
        except errors.NotBranchError:
4482
4447
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4448
        repository.pack()
4484
4449
 
4485
4450
 
4486
4451
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4452
    """List the installed plugins.
4488
4453
 
4489
4454
    This command displays the list of installed plugins including
4490
4455
    version of plugin and a short description of each.
4529
4494
 
4530
4495
 
4531
4496
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4497
    """Show testament (signing-form) of a revision."""
4533
4498
    takes_options = [
4534
4499
            'revision',
4535
4500
            Option('long', help='Produce long-format testament.'),
4561
4526
 
4562
4527
 
4563
4528
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4529
    """Show the origin of each line in a file.
4565
4530
 
4566
4531
    This prints out the given file with an annotation on the left side
4567
4532
    indicating which revision, author and date introduced the change.
4614
4579
 
4615
4580
 
4616
4581
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4582
    """Create a digital signature for an existing revision."""
4618
4583
    # TODO be able to replace existing ones.
4619
4584
 
4620
4585
    hidden = True # is this right ?
4680
4645
 
4681
4646
 
4682
4647
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.
 
4648
    """Convert the current branch into a checkout of the supplied branch.
4685
4649
 
4686
4650
    Once converted into a checkout, commits must succeed on the master branch
4687
4651
    before they will be applied to the local branch.
4721
4685
 
4722
4686
 
4723
4687
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4688
    """Convert the current checkout into a regular branch.
4725
4689
 
4726
4690
    After unbinding, the local branch is considered independent and subsequent
4727
4691
    commits will be local only.
4738
4702
 
4739
4703
 
4740
4704
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4705
    """Remove the last committed revision.
4742
4706
 
4743
4707
    --verbose will print out what is being removed.
4744
4708
    --dry-run will go through all the motions, but not actually
4846
4810
 
4847
4811
 
4848
4812
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4813
    """Break a dead lock on a repository, branch or working directory.
4850
4814
 
4851
4815
    CAUTION: Locks should only be broken when you are sure that the process
4852
4816
    holding the lock has been stopped.
4871
4835
 
4872
4836
 
4873
4837
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4838
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4839
 
4876
4840
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4841
    """
4885
4849
 
4886
4850
 
4887
4851
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4852
    """Run the bzr server."""
4889
4853
 
4890
4854
    aliases = ['server']
4891
4855
 
4951
4915
 
4952
4916
 
4953
4917
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4918
    """Combine a tree into its containing tree.
4955
4919
 
4956
4920
    This command requires the target tree to be in a rich-root format.
4957
4921
 
4997
4961
 
4998
4962
 
4999
4963
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4964
    """Split a subdirectory of a tree into a separate tree.
5001
4965
 
5002
4966
    This command will produce a target tree in a format that supports
5003
4967
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4987
 
5024
4988
 
5025
4989
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4990
    """Generate a merge directive for auto-merge tools.
5027
4991
 
5028
4992
    A directive requests a merge to be performed, and also provides all the
5029
4993
    information necessary to do so.  This means it must either include a
5122
5086
 
5123
5087
 
5124
5088
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5089
    """Mail or create a merge-directive for submitting changes.
5126
5090
 
5127
5091
    A merge directive provides many things needed for requesting merges:
5128
5092
 
5239
5203
 
5240
5204
 
5241
5205
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5206
    """Create a merge-directive for submitting changes.
5243
5207
 
5244
5208
    A merge directive provides many things needed for requesting merges:
5245
5209
 
5312
5276
 
5313
5277
 
5314
5278
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5279
    """Create, remove or modify a tag naming a revision.
5316
5280
 
5317
5281
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5282
    (--revision) option can be given -rtag:X, where X is any previously
5385
5349
 
5386
5350
 
5387
5351
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5352
    """List tags.
5389
5353
 
5390
5354
    This command shows a table of tag names and the revisions they reference.
5391
5355
    """
5459
5423
 
5460
5424
 
5461
5425
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5426
    """Reconfigure the type of a bzr directory.
5463
5427
 
5464
5428
    A target configuration must be specified.
5465
5429
 
5550
5514
 
5551
5515
 
5552
5516
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5517
    """Set the branch of a checkout and update.
5554
5518
 
5555
5519
    For lightweight checkouts, this changes the branch being referenced.
5556
5520
    For heavyweight checkouts, this checks that there are no local commits
5646
5610
 
5647
5611
 
5648
5612
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5613
    """Manage filtered views.
5650
5614
 
5651
5615
    Views provide a mask over the tree so that users can focus on
5652
5616
    a subset of a tree when doing their work. After creating a view,
5800
5764
 
5801
5765
 
5802
5766
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5767
    """Show hooks."""
5804
5768
 
5805
5769
    hidden = True
5806
5770
 
5820
5784
 
5821
5785
 
5822
5786
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
 
5787
    """Remove a branch.
5824
5788
 
5825
5789
    This will remove the branch from the specified location but 
5826
5790
    will keep any working tree or repository in place.
5845
5809
        
5846
5810
 
5847
5811
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5812
    """Temporarily set aside some changes from the current tree.
5849
5813
 
5850
5814
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5815
    ie. out of the way, until a later time when you can bring them back from
5920
5884
 
5921
5885
 
5922
5886
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5887
    """Restore shelved changes.
5924
5888
 
5925
5889
    By default, the most recently shelved changes are restored. However if you
5926
5890
    specify a shelf by id those changes will be restored instead.  This works
5952
5916
 
5953
5917
 
5954
5918
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5919
    """Remove unwanted files from working tree.
5956
5920
 
5957
5921
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5922
    files are never deleted.
5986
5950
 
5987
5951
 
5988
5952
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5953
    """list, view and set branch locations for nested trees.
5990
5954
 
5991
5955
    If no arguments are provided, lists the branch locations for nested trees.
5992
5956
    If one argument is provided, display the branch location for that tree.