/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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.
1175
1173
 
1176
1174
 
1177
1175
class cmd_branch(Command):
1178
 
    """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.
1179
1177
 
1180
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1181
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1288
1286
 
1289
1287
 
1290
1288
class cmd_checkout(Command):
1291
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1292
1290
 
1293
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1294
1292
    the branch found in '.'. This is useful if you have removed the working tree
1357
1355
 
1358
1356
 
1359
1357
class cmd_renames(Command):
1360
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1361
1359
    """
1362
1360
    # TODO: Option to show renames between two historical versions.
1363
1361
 
1389
1387
 
1390
1388
 
1391
1389
class cmd_update(Command):
1392
 
    """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.
1393
1391
 
1394
1392
    This will perform a merge into the working tree, and may generate
1395
1393
    conflicts. If you have any local changes, you will still
1475
1473
 
1476
1474
 
1477
1475
class cmd_info(Command):
1478
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1479
1477
 
1480
1478
    This command will show all known locations and formats associated to the
1481
1479
    tree, branch or repository.
1519
1517
 
1520
1518
 
1521
1519
class cmd_remove(Command):
1522
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1523
1521
 
1524
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1525
1523
    them if they can easily be recovered using revert. If no options or
1573
1571
 
1574
1572
 
1575
1573
class cmd_file_id(Command):
1576
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1577
1575
 
1578
1576
    The file_id is assigned when the file is first added and remains the
1579
1577
    same through all revisions where the file exists, even when it is
1595
1593
 
1596
1594
 
1597
1595
class cmd_file_path(Command):
1598
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1599
1597
 
1600
1598
    This prints one line for each directory down to the target,
1601
1599
    starting at the branch root.
1617
1615
 
1618
1616
 
1619
1617
class cmd_reconcile(Command):
1620
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1621
1619
 
1622
1620
    This can correct data mismatches that may have been caused by
1623
1621
    previous ghost operations or bzr upgrades. You should only
1645
1643
 
1646
1644
 
1647
1645
class cmd_revision_history(Command):
1648
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1649
1647
 
1650
1648
    _see_also = ['log']
1651
1649
    takes_args = ['location?']
1661
1659
 
1662
1660
 
1663
1661
class cmd_ancestry(Command):
1664
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1665
1663
 
1666
1664
    _see_also = ['log', 'revision-history']
1667
1665
    takes_args = ['location?']
1686
1684
 
1687
1685
 
1688
1686
class cmd_init(Command):
1689
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1690
1688
 
1691
1689
    Use this to create an empty branch, or before importing an
1692
1690
    existing project.
1795
1793
 
1796
1794
 
1797
1795
class cmd_init_repository(Command):
1798
 
    """Create a shared repository for branches to share storage space.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1799
1797
 
1800
1798
    New branches created under the repository directory will store their
1801
1799
    revisions in the repository, not in the branch directory.  For branches
1855
1853
 
1856
1854
 
1857
1855
class cmd_diff(Command):
1858
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1859
1857
 
1860
1858
    If no arguments are given, all changes for the current tree are listed.
1861
1859
    If files are given, only the changes in those files are listed.
1996
1994
 
1997
1995
 
1998
1996
class cmd_deleted(Command):
1999
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
2000
1998
    """
2001
1999
    # TODO: Show files deleted since a previous revision, or
2002
2000
    # between two revisions.
2025
2023
 
2026
2024
 
2027
2025
class cmd_modified(Command):
2028
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
2029
2027
    """
2030
2028
 
2031
2029
    hidden = True
2048
2046
 
2049
2047
 
2050
2048
class cmd_added(Command):
2051
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
2052
2050
    """
2053
2051
 
2054
2052
    hidden = True
2084
2082
 
2085
2083
 
2086
2084
class cmd_root(Command):
2087
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2088
2086
 
2089
2087
    The root is the nearest enclosing directory with a .bzr control
2090
2088
    directory."""
2114
2112
 
2115
2113
 
2116
2114
class cmd_log(Command):
2117
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2118
2116
 
2119
2117
    log is bzr's default tool for exploring the history of a branch.
2120
2118
    The branch to use is taken from the first parameter. If no parameters
2301
2299
                   help='Show changes made in each revision as a patch.'),
2302
2300
            Option('include-merges',
2303
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
                   )
2304
2306
            ]
2305
2307
    encoding_type = 'replace'
2306
2308
 
2316
2318
            message=None,
2317
2319
            limit=None,
2318
2320
            show_diff=False,
2319
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2320
2324
        from bzrlib.log import (
2321
2325
            Logger,
2322
2326
            make_log_request_dict,
2323
2327
            _get_info_for_log_files,
2324
2328
            )
2325
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')
2326
2334
        if include_merges:
2327
2335
            if levels is None:
2328
2336
                levels = 0
2421
2429
            direction=direction, specific_fileids=file_ids,
2422
2430
            start_revision=rev1, end_revision=rev2, limit=limit,
2423
2431
            message_search=message, delta_type=delta_type,
2424
 
            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
            )
2425
2435
        Logger(b, rqst).show(lf)
2426
2436
 
2427
2437
 
2485
2495
 
2486
2496
 
2487
2497
class cmd_touching_revisions(Command):
2488
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2489
2499
 
2490
2500
    A more user-friendly interface is "bzr log FILE".
2491
2501
    """
2506
2516
 
2507
2517
 
2508
2518
class cmd_ls(Command):
2509
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2510
2520
    """
2511
2521
 
2512
2522
    _see_also = ['status', 'cat']
2623
2633
 
2624
2634
 
2625
2635
class cmd_unknowns(Command):
2626
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2627
2637
    """
2628
2638
 
2629
2639
    hidden = True
2636
2646
 
2637
2647
 
2638
2648
class cmd_ignore(Command):
2639
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2640
2650
 
2641
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2642
2652
 
2651
2661
    using this command or directly by using an editor, be sure to commit
2652
2662
    it.
2653
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
 
2654
2670
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2655
2671
    precedence over regular ignores.  Such exceptions are used to specify
2656
2672
    files that should be versioned which would otherwise be ignored.
2697
2713
    _see_also = ['status', 'ignored', 'patterns']
2698
2714
    takes_args = ['name_pattern*']
2699
2715
    takes_options = [
2700
 
        Option('old-default-rules',
2701
 
               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.')
2702
2718
        ]
2703
2719
 
2704
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2705
2721
        from bzrlib import ignores
2706
 
        if old_default_rules is not None:
2707
 
            # dump the rules and exit
2708
 
            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:
2709
2725
                self.outf.write("%s\n" % pattern)
2710
2726
            return
2711
2727
        if not name_pattern_list:
2712
2728
            raise errors.BzrCommandError("ignore requires at least one "
2713
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2714
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2715
2731
                             for p in name_pattern_list]
2716
2732
        for name_pattern in name_pattern_list:
2738
2754
 
2739
2755
 
2740
2756
class cmd_ignored(Command):
2741
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2742
2758
 
2743
2759
    List all the ignored files and the ignore pattern that caused the file to
2744
2760
    be ignored.
2765
2781
 
2766
2782
 
2767
2783
class cmd_lookup_revision(Command):
2768
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2769
2785
 
2770
2786
    :Examples:
2771
2787
        bzr lookup-revision 33
2785
2801
 
2786
2802
 
2787
2803
class cmd_export(Command):
2788
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2789
2805
 
2790
2806
    If no revision is specified this exports the last committed revision.
2791
2807
 
2848
2864
 
2849
2865
 
2850
2866
class cmd_cat(Command):
2851
 
    """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.
2852
2868
 
2853
2869
    If no revision is nominated, the last revision is used.
2854
2870
 
2934
2950
 
2935
2951
 
2936
2952
class cmd_local_time_offset(Command):
2937
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2938
2954
    hidden = True
2939
2955
    @display_command
2940
2956
    def run(self):
2943
2959
 
2944
2960
 
2945
2961
class cmd_commit(Command):
2946
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2947
2963
 
2948
2964
    An explanatory message needs to be given for each commit. This is
2949
2965
    often done by using the --message option (getting the message from the
3057
3073
                         "the master branch until a normal commit "
3058
3074
                         "is performed."
3059
3075
                    ),
3060
 
             Option('show-diff',
 
3076
             Option('show-diff', short_name='p',
3061
3077
                    help='When no message is supplied, show the diff along'
3062
3078
                    ' with the status summary in the message editor.'),
3063
3079
             ]
3209
3225
 
3210
3226
 
3211
3227
class cmd_check(Command):
3212
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3213
3229
 
3214
3230
    This command checks various invariants about branch and repository storage
3215
3231
    to detect data corruption or bzr bugs.
3279
3295
 
3280
3296
 
3281
3297
class cmd_upgrade(Command):
3282
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3283
3299
 
3284
3300
    The check command or bzr developers may sometimes advise you to run
3285
3301
    this command. When the default format has changed you may also be warned
3303
3319
 
3304
3320
 
3305
3321
class cmd_whoami(Command):
3306
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3307
3323
 
3308
3324
    :Examples:
3309
3325
        Show the email of the current user::
3353
3369
 
3354
3370
 
3355
3371
class cmd_nick(Command):
3356
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3357
3373
 
3358
3374
    If unset, the tree root directory name is used as the nickname.
3359
3375
    To print the current nickname, execute with no argument.
3377
3393
 
3378
3394
 
3379
3395
class cmd_alias(Command):
3380
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3381
3397
 
3382
3398
    :Examples:
3383
3399
        Show the current aliases::
3447
3463
 
3448
3464
 
3449
3465
class cmd_selftest(Command):
3450
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3451
3467
 
3452
3468
    If arguments are given, they are regular expressions that say which tests
3453
3469
    should run.  Tests matching any expression are run, and other tests are
3594
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3595
3611
                    "needs to be installed to use --subunit.")
3596
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)
3597
3618
        if parallel:
3598
3619
            self.additional_selftest_args.setdefault(
3599
3620
                'suite_decorators', []).append(parallel)
3630
3651
 
3631
3652
 
3632
3653
class cmd_version(Command):
3633
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3634
3655
 
3635
3656
    encoding_type = 'replace'
3636
3657
    takes_options = [
3647
3668
 
3648
3669
 
3649
3670
class cmd_rocks(Command):
3650
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3651
3672
 
3652
3673
    hidden = True
3653
3674
 
3657
3678
 
3658
3679
 
3659
3680
class cmd_find_merge_base(Command):
3660
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3661
3682
    # TODO: Options to specify revisions on either side, as if
3662
3683
    #       merging only part of the history.
3663
3684
    takes_args = ['branch', 'other']
3683
3704
 
3684
3705
 
3685
3706
class cmd_merge(Command):
3686
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3687
3708
 
3688
3709
    The source of the merge can be specified either in the form of a branch,
3689
3710
    or in the form of a path to a file containing a merge directive generated
4044
4065
 
4045
4066
 
4046
4067
class cmd_remerge(Command):
4047
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
4048
4069
 
4049
4070
    Use this if you want to try a different merge technique while resolving
4050
4071
    conflicts.  Some merge techniques are better than others, and remerge
4139
4160
 
4140
4161
 
4141
4162
class cmd_revert(Command):
4142
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
4143
4164
 
4144
4165
    Giving a list of files will revert only those files.  Otherwise, all files
4145
4166
    will be reverted.  If the revision is not specified with '--revision', the
4211
4232
 
4212
4233
 
4213
4234
class cmd_assert_fail(Command):
4214
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4215
4236
    # intended just for use in testing
4216
4237
 
4217
4238
    hidden = True
4221
4242
 
4222
4243
 
4223
4244
class cmd_help(Command):
4224
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4225
4246
    """
4226
4247
 
4227
4248
    _see_also = ['topics']
4240
4261
 
4241
4262
 
4242
4263
class cmd_shell_complete(Command):
4243
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4244
4265
 
4245
4266
    For a list of all available commands, say 'bzr shell-complete'.
4246
4267
    """
4255
4276
 
4256
4277
 
4257
4278
class cmd_missing(Command):
4258
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4259
4280
 
4260
4281
    OTHER_BRANCH may be local or remote.
4261
4282
 
4428
4449
 
4429
4450
 
4430
4451
class cmd_pack(Command):
4431
 
    """Compress the data within a repository.
 
4452
    __doc__ = """Compress the data within a repository.
4432
4453
 
4433
4454
    This operation compresses the data within a bazaar repository. As
4434
4455
    bazaar supports automatic packing of repository, this operation is
4463
4484
 
4464
4485
 
4465
4486
class cmd_plugins(Command):
4466
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4467
4488
 
4468
4489
    This command displays the list of installed plugins including
4469
4490
    version of plugin and a short description of each.
4508
4529
 
4509
4530
 
4510
4531
class cmd_testament(Command):
4511
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4512
4533
    takes_options = [
4513
4534
            'revision',
4514
4535
            Option('long', help='Produce long-format testament.'),
4540
4561
 
4541
4562
 
4542
4563
class cmd_annotate(Command):
4543
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4544
4565
 
4545
4566
    This prints out the given file with an annotation on the left side
4546
4567
    indicating which revision, author and date introduced the change.
4593
4614
 
4594
4615
 
4595
4616
class cmd_re_sign(Command):
4596
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4597
4618
    # TODO be able to replace existing ones.
4598
4619
 
4599
4620
    hidden = True # is this right ?
4659
4680
 
4660
4681
 
4661
4682
class cmd_bind(Command):
4662
 
    """Convert the current branch into a checkout of the supplied branch.
 
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.
4663
4685
 
4664
4686
    Once converted into a checkout, commits must succeed on the master branch
4665
4687
    before they will be applied to the local branch.
4699
4721
 
4700
4722
 
4701
4723
class cmd_unbind(Command):
4702
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
4703
4725
 
4704
4726
    After unbinding, the local branch is considered independent and subsequent
4705
4727
    commits will be local only.
4716
4738
 
4717
4739
 
4718
4740
class cmd_uncommit(Command):
4719
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
4720
4742
 
4721
4743
    --verbose will print out what is being removed.
4722
4744
    --dry-run will go through all the motions, but not actually
4824
4846
 
4825
4847
 
4826
4848
class cmd_break_lock(Command):
4827
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4828
4850
 
4829
4851
    CAUTION: Locks should only be broken when you are sure that the process
4830
4852
    holding the lock has been stopped.
4849
4871
 
4850
4872
 
4851
4873
class cmd_wait_until_signalled(Command):
4852
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4853
4875
 
4854
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
4855
4877
    """
4863
4885
 
4864
4886
 
4865
4887
class cmd_serve(Command):
4866
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
4867
4889
 
4868
4890
    aliases = ['server']
4869
4891
 
4929
4951
 
4930
4952
 
4931
4953
class cmd_join(Command):
4932
 
    """Combine a tree into its containing tree.
 
4954
    __doc__ = """Combine a tree into its containing tree.
4933
4955
 
4934
4956
    This command requires the target tree to be in a rich-root format.
4935
4957
 
4975
4997
 
4976
4998
 
4977
4999
class cmd_split(Command):
4978
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4979
5001
 
4980
5002
    This command will produce a target tree in a format that supports
4981
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5001
5023
 
5002
5024
 
5003
5025
class cmd_merge_directive(Command):
5004
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
5005
5027
 
5006
5028
    A directive requests a merge to be performed, and also provides all the
5007
5029
    information necessary to do so.  This means it must either include a
5100
5122
 
5101
5123
 
5102
5124
class cmd_send(Command):
5103
 
    """Mail or create a merge-directive for submitting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
5104
5126
 
5105
5127
    A merge directive provides many things needed for requesting merges:
5106
5128
 
5217
5239
 
5218
5240
 
5219
5241
class cmd_bundle_revisions(cmd_send):
5220
 
    """Create a merge-directive for submitting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
5221
5243
 
5222
5244
    A merge directive provides many things needed for requesting merges:
5223
5245
 
5290
5312
 
5291
5313
 
5292
5314
class cmd_tag(Command):
5293
 
    """Create, remove or modify a tag naming a revision.
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
5294
5316
 
5295
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
5296
5318
    (--revision) option can be given -rtag:X, where X is any previously
5363
5385
 
5364
5386
 
5365
5387
class cmd_tags(Command):
5366
 
    """List tags.
 
5388
    __doc__ = """List tags.
5367
5389
 
5368
5390
    This command shows a table of tag names and the revisions they reference.
5369
5391
    """
5437
5459
 
5438
5460
 
5439
5461
class cmd_reconfigure(Command):
5440
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
5441
5463
 
5442
5464
    A target configuration must be specified.
5443
5465
 
5528
5550
 
5529
5551
 
5530
5552
class cmd_switch(Command):
5531
 
    """Set the branch of a checkout and update.
 
5553
    __doc__ = """Set the branch of a checkout and update.
5532
5554
 
5533
5555
    For lightweight checkouts, this changes the branch being referenced.
5534
5556
    For heavyweight checkouts, this checks that there are no local commits
5624
5646
 
5625
5647
 
5626
5648
class cmd_view(Command):
5627
 
    """Manage filtered views.
 
5649
    __doc__ = """Manage filtered views.
5628
5650
 
5629
5651
    Views provide a mask over the tree so that users can focus on
5630
5652
    a subset of a tree when doing their work. After creating a view,
5778
5800
 
5779
5801
 
5780
5802
class cmd_hooks(Command):
5781
 
    """Show hooks."""
 
5803
    __doc__ = """Show hooks."""
5782
5804
 
5783
5805
    hidden = True
5784
5806
 
5798
5820
 
5799
5821
 
5800
5822
class cmd_remove_branch(Command):
5801
 
    """Remove a branch.
 
5823
    __doc__ = """Remove a branch.
5802
5824
 
5803
5825
    This will remove the branch from the specified location but 
5804
5826
    will keep any working tree or repository in place.
5823
5845
        
5824
5846
 
5825
5847
class cmd_shelve(Command):
5826
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5827
5849
 
5828
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
5829
5851
    ie. out of the way, until a later time when you can bring them back from
5898
5920
 
5899
5921
 
5900
5922
class cmd_unshelve(Command):
5901
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
5902
5924
 
5903
5925
    By default, the most recently shelved changes are restored. However if you
5904
5926
    specify a shelf by id those changes will be restored instead.  This works
5930
5952
 
5931
5953
 
5932
5954
class cmd_clean_tree(Command):
5933
 
    """Remove unwanted files from working tree.
 
5955
    __doc__ = """Remove unwanted files from working tree.
5934
5956
 
5935
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
5936
5958
    files are never deleted.
5964
5986
 
5965
5987
 
5966
5988
class cmd_reference(Command):
5967
 
    """list, view and set branch locations for nested trees.
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
5968
5990
 
5969
5991
    If no arguments are provided, lists the branch locations for nested trees.
5970
5992
    If one argument is provided, display the branch location for that tree.