/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-29 05:52:35 UTC
  • mfrom: (5192 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5193.
  • Revision ID: andrew.bennetts@canonical.com-20100429055235-24e81jfdse3h3ugt
MergeĀ lp:bzr.

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
 
    """Display status summary.
 
242
    __doc__ = """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
 
    """Write out metadata for a revision.
 
335
    __doc__ = """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
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """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
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """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
 
            working_path = working.bzrdir.root_transport.base
508
 
            branch_path = working.branch.bzrdir.root_transport.base
509
 
            if working_path != branch_path:
 
507
            if working.user_url != working.branch.user_url:
510
508
                raise errors.BzrCommandError("You cannot remove the working tree"
511
509
                                             " from a lightweight checkout")
512
510
 
514
512
 
515
513
 
516
514
class cmd_revno(Command):
517
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
518
516
 
519
517
    This is equal to the number of revisions on this branch.
520
518
    """
550
548
 
551
549
 
552
550
class cmd_revision_info(Command):
553
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
554
552
    """
555
553
    hidden = True
556
554
    takes_args = ['revision_info*']
612
610
 
613
611
 
614
612
class cmd_add(Command):
615
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
616
614
 
617
615
    In non-recursive mode, all the named items are added, regardless
618
616
    of whether they were previously ignored.  A warning is given if
698
696
 
699
697
 
700
698
class cmd_mkdir(Command):
701
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
702
700
 
703
701
    This is equivalent to creating the directory and then adding it.
704
702
    """
720
718
 
721
719
 
722
720
class cmd_relpath(Command):
723
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
724
722
 
725
723
    takes_args = ['filename']
726
724
    hidden = True
735
733
 
736
734
 
737
735
class cmd_inventory(Command):
738
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
739
737
 
740
738
    It is possible to limit the output to a particular entry
741
739
    type using the --kind option.  For example: --kind file.
796
794
 
797
795
 
798
796
class cmd_mv(Command):
799
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
800
798
 
801
799
    :Usage:
802
800
        bzr mv OLDNAME NEWNAME
933
931
 
934
932
 
935
933
class cmd_pull(Command):
936
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
937
935
 
938
936
    By default, this command only works on branches that have not diverged.
939
937
    Branches are considered diverged if the destination branch's most recent 
1060
1058
 
1061
1059
 
1062
1060
class cmd_push(Command):
1063
 
    """Update a mirror of this branch.
 
1061
    __doc__ = """Update a mirror of this branch.
1064
1062
 
1065
1063
    The target branch will not have its working tree populated because this
1066
1064
    is both expensive, and is not supported on remote file systems.
1134
1132
        else:
1135
1133
            revision_id = None
1136
1134
        if tree is not None and revision_id is None:
1137
 
            tree.warn_if_changed_or_out_of_date(
1138
 
                strict, 'push_strict', 'Use --no-strict to force the push.')
 
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.')
1139
1139
        # Get the stacked_on branch, if any
1140
1140
        if stacked_on is not None:
1141
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1173
 
1174
1174
 
1175
1175
class cmd_branch(Command):
1176
 
    """Create a new branch that is a copy of an existing branch.
 
1176
    __doc__ = """Create a new branch that is a copy of an existing branch.
1177
1177
 
1178
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1286
1286
 
1287
1287
 
1288
1288
class cmd_checkout(Command):
1289
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1290
1290
 
1291
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1292
    the branch found in '.'. This is useful if you have removed the working tree
1355
1355
 
1356
1356
 
1357
1357
class cmd_renames(Command):
1358
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1359
1359
    """
1360
1360
    # TODO: Option to show renames between two historical versions.
1361
1361
 
1387
1387
 
1388
1388
 
1389
1389
class cmd_update(Command):
1390
 
    """Update a tree to have the latest code committed to its branch.
 
1390
    __doc__ = """Update a tree to have the latest code committed to its branch.
1391
1391
 
1392
1392
    This will perform a merge into the working tree, and may generate
1393
1393
    conflicts. If you have any local changes, you will still
1473
1473
 
1474
1474
 
1475
1475
class cmd_info(Command):
1476
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1477
1477
 
1478
1478
    This command will show all known locations and formats associated to the
1479
1479
    tree, branch or repository.
1517
1517
 
1518
1518
 
1519
1519
class cmd_remove(Command):
1520
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1521
1521
 
1522
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1523
    them if they can easily be recovered using revert. If no options or
1571
1571
 
1572
1572
 
1573
1573
class cmd_file_id(Command):
1574
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1575
1575
 
1576
1576
    The file_id is assigned when the file is first added and remains the
1577
1577
    same through all revisions where the file exists, even when it is
1593
1593
 
1594
1594
 
1595
1595
class cmd_file_path(Command):
1596
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1597
1597
 
1598
1598
    This prints one line for each directory down to the target,
1599
1599
    starting at the branch root.
1615
1615
 
1616
1616
 
1617
1617
class cmd_reconcile(Command):
1618
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1619
1619
 
1620
1620
    This can correct data mismatches that may have been caused by
1621
1621
    previous ghost operations or bzr upgrades. You should only
1643
1643
 
1644
1644
 
1645
1645
class cmd_revision_history(Command):
1646
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1647
1647
 
1648
1648
    _see_also = ['log']
1649
1649
    takes_args = ['location?']
1659
1659
 
1660
1660
 
1661
1661
class cmd_ancestry(Command):
1662
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1663
1663
 
1664
1664
    _see_also = ['log', 'revision-history']
1665
1665
    takes_args = ['location?']
1684
1684
 
1685
1685
 
1686
1686
class cmd_init(Command):
1687
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1688
1688
 
1689
1689
    Use this to create an empty branch, or before importing an
1690
1690
    existing project.
1793
1793
 
1794
1794
 
1795
1795
class cmd_init_repository(Command):
1796
 
    """Create a shared repository for branches to share storage space.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1797
1797
 
1798
1798
    New branches created under the repository directory will store their
1799
1799
    revisions in the repository, not in the branch directory.  For branches
1853
1853
 
1854
1854
 
1855
1855
class cmd_diff(Command):
1856
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1857
1857
 
1858
1858
    If no arguments are given, all changes for the current tree are listed.
1859
1859
    If files are given, only the changes in those files are listed.
1994
1994
 
1995
1995
 
1996
1996
class cmd_deleted(Command):
1997
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1998
1998
    """
1999
1999
    # TODO: Show files deleted since a previous revision, or
2000
2000
    # between two revisions.
2023
2023
 
2024
2024
 
2025
2025
class cmd_modified(Command):
2026
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
2027
2027
    """
2028
2028
 
2029
2029
    hidden = True
2046
2046
 
2047
2047
 
2048
2048
class cmd_added(Command):
2049
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
2050
2050
    """
2051
2051
 
2052
2052
    hidden = True
2082
2082
 
2083
2083
 
2084
2084
class cmd_root(Command):
2085
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2086
2086
 
2087
2087
    The root is the nearest enclosing directory with a .bzr control
2088
2088
    directory."""
2112
2112
 
2113
2113
 
2114
2114
class cmd_log(Command):
2115
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2116
2116
 
2117
2117
    log is bzr's default tool for exploring the history of a branch.
2118
2118
    The branch to use is taken from the first parameter. If no parameters
2299
2299
                   help='Show changes made in each revision as a patch.'),
2300
2300
            Option('include-merges',
2301
2301
                   help='Show merged revisions like --levels 0 does.'),
 
2302
            Option('exclude-common-ancestry',
 
2303
                   help='Display only the revisions that are not part'
 
2304
                   ' of both ancestries (require -rX..Y)'
 
2305
                   )
2302
2306
            ]
2303
2307
    encoding_type = 'replace'
2304
2308
 
2314
2318
            message=None,
2315
2319
            limit=None,
2316
2320
            show_diff=False,
2317
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2318
2324
        from bzrlib.log import (
2319
2325
            Logger,
2320
2326
            make_log_request_dict,
2321
2327
            _get_info_for_log_files,
2322
2328
            )
2323
2329
        direction = (forward and 'forward') or 'reverse'
 
2330
        if (exclude_common_ancestry
 
2331
            and (revision is None or len(revision) != 2)):
 
2332
            raise errors.BzrCommandError(
 
2333
                '--exclude-common-ancestry requires -r with two revisions')
2324
2334
        if include_merges:
2325
2335
            if levels is None:
2326
2336
                levels = 0
2419
2429
            direction=direction, specific_fileids=file_ids,
2420
2430
            start_revision=rev1, end_revision=rev2, limit=limit,
2421
2431
            message_search=message, delta_type=delta_type,
2422
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2432
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2433
            exclude_common_ancestry=exclude_common_ancestry,
 
2434
            )
2423
2435
        Logger(b, rqst).show(lf)
2424
2436
 
2425
2437
 
2483
2495
 
2484
2496
 
2485
2497
class cmd_touching_revisions(Command):
2486
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2487
2499
 
2488
2500
    A more user-friendly interface is "bzr log FILE".
2489
2501
    """
2504
2516
 
2505
2517
 
2506
2518
class cmd_ls(Command):
2507
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2508
2520
    """
2509
2521
 
2510
2522
    _see_also = ['status', 'cat']
2621
2633
 
2622
2634
 
2623
2635
class cmd_unknowns(Command):
2624
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2625
2637
    """
2626
2638
 
2627
2639
    hidden = True
2634
2646
 
2635
2647
 
2636
2648
class cmd_ignore(Command):
2637
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2638
2650
 
2639
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2640
2652
 
2649
2661
    using this command or directly by using an editor, be sure to commit
2650
2662
    it.
2651
2663
    
 
2664
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2665
    the global ignore file can be found in the application data directory as
 
2666
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2667
    Global ignores are not touched by this command. The global ignore file
 
2668
    can be edited directly using an editor.
 
2669
 
2652
2670
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2653
2671
    precedence over regular ignores.  Such exceptions are used to specify
2654
2672
    files that should be versioned which would otherwise be ignored.
2695
2713
    _see_also = ['status', 'ignored', 'patterns']
2696
2714
    takes_args = ['name_pattern*']
2697
2715
    takes_options = [
2698
 
        Option('old-default-rules',
2699
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2716
        Option('default-rules',
 
2717
               help='Display the default ignore rules that bzr uses.')
2700
2718
        ]
2701
2719
 
2702
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2703
2721
        from bzrlib import ignores
2704
 
        if old_default_rules is not None:
2705
 
            # dump the rules and exit
2706
 
            for pattern in ignores.OLD_DEFAULTS:
 
2722
        if default_rules is not None:
 
2723
            # dump the default rules and exit
 
2724
            for pattern in ignores.USER_DEFAULTS:
2707
2725
                self.outf.write("%s\n" % pattern)
2708
2726
            return
2709
2727
        if not name_pattern_list:
2710
2728
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2712
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2713
2731
                             for p in name_pattern_list]
2714
2732
        for name_pattern in name_pattern_list:
2736
2754
 
2737
2755
 
2738
2756
class cmd_ignored(Command):
2739
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2740
2758
 
2741
2759
    List all the ignored files and the ignore pattern that caused the file to
2742
2760
    be ignored.
2763
2781
 
2764
2782
 
2765
2783
class cmd_lookup_revision(Command):
2766
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2767
2785
 
2768
2786
    :Examples:
2769
2787
        bzr lookup-revision 33
2783
2801
 
2784
2802
 
2785
2803
class cmd_export(Command):
2786
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2787
2805
 
2788
2806
    If no revision is specified this exports the last committed revision.
2789
2807
 
2846
2864
 
2847
2865
 
2848
2866
class cmd_cat(Command):
2849
 
    """Write the contents of a file as of a given revision to standard output.
 
2867
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2850
2868
 
2851
2869
    If no revision is nominated, the last revision is used.
2852
2870
 
2932
2950
 
2933
2951
 
2934
2952
class cmd_local_time_offset(Command):
2935
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2936
2954
    hidden = True
2937
2955
    @display_command
2938
2956
    def run(self):
2941
2959
 
2942
2960
 
2943
2961
class cmd_commit(Command):
2944
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2945
2963
 
2946
2964
    An explanatory message needs to be given for each commit. This is
2947
2965
    often done by using the --message option (getting the message from the
3207
3225
 
3208
3226
 
3209
3227
class cmd_check(Command):
3210
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3211
3229
 
3212
3230
    This command checks various invariants about branch and repository storage
3213
3231
    to detect data corruption or bzr bugs.
3277
3295
 
3278
3296
 
3279
3297
class cmd_upgrade(Command):
3280
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3281
3299
 
3282
3300
    The check command or bzr developers may sometimes advise you to run
3283
3301
    this command. When the default format has changed you may also be warned
3301
3319
 
3302
3320
 
3303
3321
class cmd_whoami(Command):
3304
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3305
3323
 
3306
3324
    :Examples:
3307
3325
        Show the email of the current user::
3351
3369
 
3352
3370
 
3353
3371
class cmd_nick(Command):
3354
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3355
3373
 
3356
3374
    If unset, the tree root directory name is used as the nickname.
3357
3375
    To print the current nickname, execute with no argument.
3375
3393
 
3376
3394
 
3377
3395
class cmd_alias(Command):
3378
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3379
3397
 
3380
3398
    :Examples:
3381
3399
        Show the current aliases::
3445
3463
 
3446
3464
 
3447
3465
class cmd_selftest(Command):
3448
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3449
3467
 
3450
3468
    If arguments are given, they are regular expressions that say which tests
3451
3469
    should run.  Tests matching any expression are run, and other tests are
3592
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3593
3611
                    "needs to be installed to use --subunit.")
3594
3612
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3613
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3614
            # stdout, which would corrupt the subunit stream. 
 
3615
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3616
                import msvcrt
 
3617
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3595
3618
        if parallel:
3596
3619
            self.additional_selftest_args.setdefault(
3597
3620
                'suite_decorators', []).append(parallel)
3628
3651
 
3629
3652
 
3630
3653
class cmd_version(Command):
3631
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3632
3655
 
3633
3656
    encoding_type = 'replace'
3634
3657
    takes_options = [
3645
3668
 
3646
3669
 
3647
3670
class cmd_rocks(Command):
3648
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3649
3672
 
3650
3673
    hidden = True
3651
3674
 
3655
3678
 
3656
3679
 
3657
3680
class cmd_find_merge_base(Command):
3658
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3659
3682
    # TODO: Options to specify revisions on either side, as if
3660
3683
    #       merging only part of the history.
3661
3684
    takes_args = ['branch', 'other']
3681
3704
 
3682
3705
 
3683
3706
class cmd_merge(Command):
3684
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3685
3708
 
3686
3709
    The source of the merge can be specified either in the form of a branch,
3687
3710
    or in the form of a path to a file containing a merge directive generated
4042
4065
 
4043
4066
 
4044
4067
class cmd_remerge(Command):
4045
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
4046
4069
 
4047
4070
    Use this if you want to try a different merge technique while resolving
4048
4071
    conflicts.  Some merge techniques are better than others, and remerge
4137
4160
 
4138
4161
 
4139
4162
class cmd_revert(Command):
4140
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
4141
4164
 
4142
4165
    Giving a list of files will revert only those files.  Otherwise, all files
4143
4166
    will be reverted.  If the revision is not specified with '--revision', the
4209
4232
 
4210
4233
 
4211
4234
class cmd_assert_fail(Command):
4212
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4213
4236
    # intended just for use in testing
4214
4237
 
4215
4238
    hidden = True
4219
4242
 
4220
4243
 
4221
4244
class cmd_help(Command):
4222
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4223
4246
    """
4224
4247
 
4225
4248
    _see_also = ['topics']
4238
4261
 
4239
4262
 
4240
4263
class cmd_shell_complete(Command):
4241
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4242
4265
 
4243
4266
    For a list of all available commands, say 'bzr shell-complete'.
4244
4267
    """
4253
4276
 
4254
4277
 
4255
4278
class cmd_missing(Command):
4256
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4257
4280
 
4258
4281
    OTHER_BRANCH may be local or remote.
4259
4282
 
4426
4449
 
4427
4450
 
4428
4451
class cmd_pack(Command):
4429
 
    """Compress the data within a repository.
 
4452
    __doc__ = """Compress the data within a repository.
4430
4453
 
4431
4454
    This operation compresses the data within a bazaar repository. As
4432
4455
    bazaar supports automatic packing of repository, this operation is
4461
4484
 
4462
4485
 
4463
4486
class cmd_plugins(Command):
4464
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4465
4488
 
4466
4489
    This command displays the list of installed plugins including
4467
4490
    version of plugin and a short description of each.
4506
4529
 
4507
4530
 
4508
4531
class cmd_testament(Command):
4509
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4510
4533
    takes_options = [
4511
4534
            'revision',
4512
4535
            Option('long', help='Produce long-format testament.'),
4538
4561
 
4539
4562
 
4540
4563
class cmd_annotate(Command):
4541
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4542
4565
 
4543
4566
    This prints out the given file with an annotation on the left side
4544
4567
    indicating which revision, author and date introduced the change.
4591
4614
 
4592
4615
 
4593
4616
class cmd_re_sign(Command):
4594
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4595
4618
    # TODO be able to replace existing ones.
4596
4619
 
4597
4620
    hidden = True # is this right ?
4657
4680
 
4658
4681
 
4659
4682
class cmd_bind(Command):
4660
 
    """Convert the current branch into a checkout of the supplied branch.
 
4683
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4661
4684
 
4662
4685
    Once converted into a checkout, commits must succeed on the master branch
4663
4686
    before they will be applied to the local branch.
4697
4720
 
4698
4721
 
4699
4722
class cmd_unbind(Command):
4700
 
    """Convert the current checkout into a regular branch.
 
4723
    __doc__ = """Convert the current checkout into a regular branch.
4701
4724
 
4702
4725
    After unbinding, the local branch is considered independent and subsequent
4703
4726
    commits will be local only.
4714
4737
 
4715
4738
 
4716
4739
class cmd_uncommit(Command):
4717
 
    """Remove the last committed revision.
 
4740
    __doc__ = """Remove the last committed revision.
4718
4741
 
4719
4742
    --verbose will print out what is being removed.
4720
4743
    --dry-run will go through all the motions, but not actually
4822
4845
 
4823
4846
 
4824
4847
class cmd_break_lock(Command):
4825
 
    """Break a dead lock on a repository, branch or working directory.
 
4848
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4826
4849
 
4827
4850
    CAUTION: Locks should only be broken when you are sure that the process
4828
4851
    holding the lock has been stopped.
4847
4870
 
4848
4871
 
4849
4872
class cmd_wait_until_signalled(Command):
4850
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4873
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4851
4874
 
4852
4875
    This just prints a line to signal when it is ready, then blocks on stdin.
4853
4876
    """
4861
4884
 
4862
4885
 
4863
4886
class cmd_serve(Command):
4864
 
    """Run the bzr server."""
 
4887
    __doc__ = """Run the bzr server."""
4865
4888
 
4866
4889
    aliases = ['server']
4867
4890
 
4927
4950
 
4928
4951
 
4929
4952
class cmd_join(Command):
4930
 
    """Combine a tree into its containing tree.
 
4953
    __doc__ = """Combine a tree into its containing tree.
4931
4954
 
4932
4955
    This command requires the target tree to be in a rich-root format.
4933
4956
 
4973
4996
 
4974
4997
 
4975
4998
class cmd_split(Command):
4976
 
    """Split a subdirectory of a tree into a separate tree.
 
4999
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4977
5000
 
4978
5001
    This command will produce a target tree in a format that supports
4979
5002
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4999
5022
 
5000
5023
 
5001
5024
class cmd_merge_directive(Command):
5002
 
    """Generate a merge directive for auto-merge tools.
 
5025
    __doc__ = """Generate a merge directive for auto-merge tools.
5003
5026
 
5004
5027
    A directive requests a merge to be performed, and also provides all the
5005
5028
    information necessary to do so.  This means it must either include a
5098
5121
 
5099
5122
 
5100
5123
class cmd_send(Command):
5101
 
    """Mail or create a merge-directive for submitting changes.
 
5124
    __doc__ = """Mail or create a merge-directive for submitting changes.
5102
5125
 
5103
5126
    A merge directive provides many things needed for requesting merges:
5104
5127
 
5215
5238
 
5216
5239
 
5217
5240
class cmd_bundle_revisions(cmd_send):
5218
 
    """Create a merge-directive for submitting changes.
 
5241
    __doc__ = """Create a merge-directive for submitting changes.
5219
5242
 
5220
5243
    A merge directive provides many things needed for requesting merges:
5221
5244
 
5288
5311
 
5289
5312
 
5290
5313
class cmd_tag(Command):
5291
 
    """Create, remove or modify a tag naming a revision.
 
5314
    __doc__ = """Create, remove or modify a tag naming a revision.
5292
5315
 
5293
5316
    Tags give human-meaningful names to revisions.  Commands that take a -r
5294
5317
    (--revision) option can be given -rtag:X, where X is any previously
5361
5384
 
5362
5385
 
5363
5386
class cmd_tags(Command):
5364
 
    """List tags.
 
5387
    __doc__ = """List tags.
5365
5388
 
5366
5389
    This command shows a table of tag names and the revisions they reference.
5367
5390
    """
5435
5458
 
5436
5459
 
5437
5460
class cmd_reconfigure(Command):
5438
 
    """Reconfigure the type of a bzr directory.
 
5461
    __doc__ = """Reconfigure the type of a bzr directory.
5439
5462
 
5440
5463
    A target configuration must be specified.
5441
5464
 
5526
5549
 
5527
5550
 
5528
5551
class cmd_switch(Command):
5529
 
    """Set the branch of a checkout and update.
 
5552
    __doc__ = """Set the branch of a checkout and update.
5530
5553
 
5531
5554
    For lightweight checkouts, this changes the branch being referenced.
5532
5555
    For heavyweight checkouts, this checks that there are no local commits
5622
5645
 
5623
5646
 
5624
5647
class cmd_view(Command):
5625
 
    """Manage filtered views.
 
5648
    __doc__ = """Manage filtered views.
5626
5649
 
5627
5650
    Views provide a mask over the tree so that users can focus on
5628
5651
    a subset of a tree when doing their work. After creating a view,
5776
5799
 
5777
5800
 
5778
5801
class cmd_hooks(Command):
5779
 
    """Show hooks."""
 
5802
    __doc__ = """Show hooks."""
5780
5803
 
5781
5804
    hidden = True
5782
5805
 
5796
5819
 
5797
5820
 
5798
5821
class cmd_remove_branch(Command):
5799
 
    """Remove a branch.
 
5822
    __doc__ = """Remove a branch.
5800
5823
 
5801
5824
    This will remove the branch from the specified location but 
5802
5825
    will keep any working tree or repository in place.
5821
5844
        
5822
5845
 
5823
5846
class cmd_shelve(Command):
5824
 
    """Temporarily set aside some changes from the current tree.
 
5847
    __doc__ = """Temporarily set aside some changes from the current tree.
5825
5848
 
5826
5849
    Shelve allows you to temporarily put changes you've made "on the shelf",
5827
5850
    ie. out of the way, until a later time when you can bring them back from
5896
5919
 
5897
5920
 
5898
5921
class cmd_unshelve(Command):
5899
 
    """Restore shelved changes.
 
5922
    __doc__ = """Restore shelved changes.
5900
5923
 
5901
5924
    By default, the most recently shelved changes are restored. However if you
5902
5925
    specify a shelf by id those changes will be restored instead.  This works
5928
5951
 
5929
5952
 
5930
5953
class cmd_clean_tree(Command):
5931
 
    """Remove unwanted files from working tree.
 
5954
    __doc__ = """Remove unwanted files from working tree.
5932
5955
 
5933
5956
    By default, only unknown files, not ignored files, are deleted.  Versioned
5934
5957
    files are never deleted.
5962
5985
 
5963
5986
 
5964
5987
class cmd_reference(Command):
5965
 
    """list, view and set branch locations for nested trees.
 
5988
    __doc__ = """list, view and set branch locations for nested trees.
5966
5989
 
5967
5990
    If no arguments are provided, lists the branch locations for nested trees.
5968
5991
    If one argument is provided, display the branch location for that tree.