~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-22 10:20:40 UTC
  • mfrom: (5050.3.4 2.2)
  • mto: This revision was merged to the branch mainline in revision 5173.
  • Revision ID: v.ladeuil+lp@free.fr-20100422102040-3nv01vm15i8qjip0
Merge 2.2 into bzr.dev

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 
1058
1060
 
1059
1061
 
1060
1062
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1063
    """Update a mirror of this branch.
1062
1064
 
1063
1065
    The target branch will not have its working tree populated because this
1064
1066
    is both expensive, and is not supported on remote file systems.
1132
1134
        else:
1133
1135
            revision_id = None
1134
1136
        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.')
 
1137
            tree.warn_if_changed_or_out_of_date(
 
1138
                strict, 'push_strict', 'Use --no-strict to force the push.')
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
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1176
    """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
 
    __doc__ = """Create a new checkout of an existing branch.
 
1289
    """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
 
    __doc__ = """Show list of renamed files.
 
1358
    """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
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1390
    """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
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1476
    """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
 
    __doc__ = """Remove files or directories.
 
1520
    """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
 
    __doc__ = """Print file_id of a particular file or directory.
 
1574
    """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
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1596
    """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
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1618
    """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
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1646
    """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
 
    __doc__ = """List all revisions merged into this branch."""
 
1662
    """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
 
    __doc__ = """Make a directory into a versioned branch.
 
1687
    """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
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1796
    """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
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1856
    """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
 
    __doc__ = """List files deleted in the working tree.
 
1997
    """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
 
    __doc__ = """List files modified in working tree.
 
2026
    """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
 
    __doc__ = """List files added in working tree.
 
2049
    """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
 
    __doc__ = """Show the tree root directory.
 
2085
    """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
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2115
    """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
 
                   )
2306
2302
            ]
2307
2303
    encoding_type = 'replace'
2308
2304
 
2318
2314
            message=None,
2319
2315
            limit=None,
2320
2316
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2317
            include_merges=False):
2324
2318
        from bzrlib.log import (
2325
2319
            Logger,
2326
2320
            make_log_request_dict,
2327
2321
            _get_info_for_log_files,
2328
2322
            )
2329
2323
        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
2324
        if include_merges:
2335
2325
            if levels is None:
2336
2326
                levels = 0
2429
2419
            direction=direction, specific_fileids=file_ids,
2430
2420
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2421
            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
 
            )
 
2422
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2423
        Logger(b, rqst).show(lf)
2436
2424
 
2437
2425
 
2495
2483
 
2496
2484
 
2497
2485
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2486
    """Return revision-ids which affected a particular file.
2499
2487
 
2500
2488
    A more user-friendly interface is "bzr log FILE".
2501
2489
    """
2516
2504
 
2517
2505
 
2518
2506
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2507
    """List files in a tree.
2520
2508
    """
2521
2509
 
2522
2510
    _see_also = ['status', 'cat']
2633
2621
 
2634
2622
 
2635
2623
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2624
    """List unknown files.
2637
2625
    """
2638
2626
 
2639
2627
    hidden = True
2646
2634
 
2647
2635
 
2648
2636
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2637
    """Ignore specified files or patterns.
2650
2638
 
2651
2639
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2640
 
2661
2649
    using this command or directly by using an editor, be sure to commit
2662
2650
    it.
2663
2651
    
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
2652
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2653
    precedence over regular ignores.  Such exceptions are used to specify
2672
2654
    files that should be versioned which would otherwise be ignored.
2713
2695
    _see_also = ['status', 'ignored', 'patterns']
2714
2696
    takes_args = ['name_pattern*']
2715
2697
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2698
        Option('old-default-rules',
 
2699
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2700
        ]
2719
2701
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2702
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2703
        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:
 
2704
        if old_default_rules is not None:
 
2705
            # dump the rules and exit
 
2706
            for pattern in ignores.OLD_DEFAULTS:
2725
2707
                self.outf.write("%s\n" % pattern)
2726
2708
            return
2727
2709
        if not name_pattern_list:
2728
2710
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2711
                                  "NAME_PATTERN or --old-default-rules")
2730
2712
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2713
                             for p in name_pattern_list]
2732
2714
        for name_pattern in name_pattern_list:
2754
2736
 
2755
2737
 
2756
2738
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2739
    """List ignored files and the patterns that matched them.
2758
2740
 
2759
2741
    List all the ignored files and the ignore pattern that caused the file to
2760
2742
    be ignored.
2781
2763
 
2782
2764
 
2783
2765
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2766
    """Lookup the revision-id from a revision-number
2785
2767
 
2786
2768
    :Examples:
2787
2769
        bzr lookup-revision 33
2801
2783
 
2802
2784
 
2803
2785
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2786
    """Export current or past revision to a destination directory or archive.
2805
2787
 
2806
2788
    If no revision is specified this exports the last committed revision.
2807
2789
 
2864
2846
 
2865
2847
 
2866
2848
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2849
    """Write the contents of a file as of a given revision to standard output.
2868
2850
 
2869
2851
    If no revision is nominated, the last revision is used.
2870
2852
 
2950
2932
 
2951
2933
 
2952
2934
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2935
    """Show the offset in seconds from GMT to local time."""
2954
2936
    hidden = True
2955
2937
    @display_command
2956
2938
    def run(self):
2959
2941
 
2960
2942
 
2961
2943
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2944
    """Commit changes into a new revision.
2963
2945
 
2964
2946
    An explanatory message needs to be given for each commit. This is
2965
2947
    often done by using the --message option (getting the message from the
3073
3055
                         "the master branch until a normal commit "
3074
3056
                         "is performed."
3075
3057
                    ),
3076
 
             Option('show-diff', short_name='p',
 
3058
             Option('show-diff',
3077
3059
                    help='When no message is supplied, show the diff along'
3078
3060
                    ' with the status summary in the message editor.'),
3079
3061
             ]
3225
3207
 
3226
3208
 
3227
3209
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3210
    """Validate working tree structure, branch consistency and repository history.
3229
3211
 
3230
3212
    This command checks various invariants about branch and repository storage
3231
3213
    to detect data corruption or bzr bugs.
3295
3277
 
3296
3278
 
3297
3279
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3280
    """Upgrade branch storage to current format.
3299
3281
 
3300
3282
    The check command or bzr developers may sometimes advise you to run
3301
3283
    this command. When the default format has changed you may also be warned
3319
3301
 
3320
3302
 
3321
3303
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3304
    """Show or set bzr user id.
3323
3305
 
3324
3306
    :Examples:
3325
3307
        Show the email of the current user::
3369
3351
 
3370
3352
 
3371
3353
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3354
    """Print or set the branch nickname.
3373
3355
 
3374
3356
    If unset, the tree root directory name is used as the nickname.
3375
3357
    To print the current nickname, execute with no argument.
3393
3375
 
3394
3376
 
3395
3377
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3378
    """Set/unset and display aliases.
3397
3379
 
3398
3380
    :Examples:
3399
3381
        Show the current aliases::
3463
3445
 
3464
3446
 
3465
3447
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3448
    """Run internal test suite.
3467
3449
 
3468
3450
    If arguments are given, they are regular expressions that say which tests
3469
3451
    should run.  Tests matching any expression are run, and other tests are
3610
3592
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3593
                    "needs to be installed to use --subunit.")
3612
3594
            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
3595
        if parallel:
3619
3596
            self.additional_selftest_args.setdefault(
3620
3597
                'suite_decorators', []).append(parallel)
3651
3628
 
3652
3629
 
3653
3630
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3631
    """Show version of bzr."""
3655
3632
 
3656
3633
    encoding_type = 'replace'
3657
3634
    takes_options = [
3668
3645
 
3669
3646
 
3670
3647
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3648
    """Statement of optimism."""
3672
3649
 
3673
3650
    hidden = True
3674
3651
 
3678
3655
 
3679
3656
 
3680
3657
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3658
    """Find and print a base revision for merging two branches."""
3682
3659
    # TODO: Options to specify revisions on either side, as if
3683
3660
    #       merging only part of the history.
3684
3661
    takes_args = ['branch', 'other']
3704
3681
 
3705
3682
 
3706
3683
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3684
    """Perform a three-way merge.
3708
3685
 
3709
3686
    The source of the merge can be specified either in the form of a branch,
3710
3687
    or in the form of a path to a file containing a merge directive generated
4065
4042
 
4066
4043
 
4067
4044
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
4045
    """Redo a merge.
4069
4046
 
4070
4047
    Use this if you want to try a different merge technique while resolving
4071
4048
    conflicts.  Some merge techniques are better than others, and remerge
4160
4137
 
4161
4138
 
4162
4139
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4140
    """Revert files to a previous revision.
4164
4141
 
4165
4142
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4143
    will be reverted.  If the revision is not specified with '--revision', the
4232
4209
 
4233
4210
 
4234
4211
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4212
    """Test reporting of assertion failures"""
4236
4213
    # intended just for use in testing
4237
4214
 
4238
4215
    hidden = True
4242
4219
 
4243
4220
 
4244
4221
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4222
    """Show help on a command or other topic.
4246
4223
    """
4247
4224
 
4248
4225
    _see_also = ['topics']
4261
4238
 
4262
4239
 
4263
4240
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4241
    """Show appropriate completions for context.
4265
4242
 
4266
4243
    For a list of all available commands, say 'bzr shell-complete'.
4267
4244
    """
4276
4253
 
4277
4254
 
4278
4255
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4256
    """Show unmerged/unpulled revisions between two branches.
4280
4257
 
4281
4258
    OTHER_BRANCH may be local or remote.
4282
4259
 
4449
4426
 
4450
4427
 
4451
4428
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
 
4429
    """Compress the data within a repository.
4453
4430
 
4454
4431
    This operation compresses the data within a bazaar repository. As
4455
4432
    bazaar supports automatic packing of repository, this operation is
4484
4461
 
4485
4462
 
4486
4463
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4464
    """List the installed plugins.
4488
4465
 
4489
4466
    This command displays the list of installed plugins including
4490
4467
    version of plugin and a short description of each.
4529
4506
 
4530
4507
 
4531
4508
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4509
    """Show testament (signing-form) of a revision."""
4533
4510
    takes_options = [
4534
4511
            'revision',
4535
4512
            Option('long', help='Produce long-format testament.'),
4561
4538
 
4562
4539
 
4563
4540
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4541
    """Show the origin of each line in a file.
4565
4542
 
4566
4543
    This prints out the given file with an annotation on the left side
4567
4544
    indicating which revision, author and date introduced the change.
4614
4591
 
4615
4592
 
4616
4593
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4594
    """Create a digital signature for an existing revision."""
4618
4595
    # TODO be able to replace existing ones.
4619
4596
 
4620
4597
    hidden = True # is this right ?
4680
4657
 
4681
4658
 
4682
4659
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.
 
4660
    """Convert the current branch into a checkout of the supplied branch.
4685
4661
 
4686
4662
    Once converted into a checkout, commits must succeed on the master branch
4687
4663
    before they will be applied to the local branch.
4721
4697
 
4722
4698
 
4723
4699
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4700
    """Convert the current checkout into a regular branch.
4725
4701
 
4726
4702
    After unbinding, the local branch is considered independent and subsequent
4727
4703
    commits will be local only.
4738
4714
 
4739
4715
 
4740
4716
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4717
    """Remove the last committed revision.
4742
4718
 
4743
4719
    --verbose will print out what is being removed.
4744
4720
    --dry-run will go through all the motions, but not actually
4846
4822
 
4847
4823
 
4848
4824
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4825
    """Break a dead lock on a repository, branch or working directory.
4850
4826
 
4851
4827
    CAUTION: Locks should only be broken when you are sure that the process
4852
4828
    holding the lock has been stopped.
4871
4847
 
4872
4848
 
4873
4849
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4850
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4851
 
4876
4852
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4853
    """
4885
4861
 
4886
4862
 
4887
4863
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4864
    """Run the bzr server."""
4889
4865
 
4890
4866
    aliases = ['server']
4891
4867
 
4951
4927
 
4952
4928
 
4953
4929
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4930
    """Combine a tree into its containing tree.
4955
4931
 
4956
4932
    This command requires the target tree to be in a rich-root format.
4957
4933
 
4997
4973
 
4998
4974
 
4999
4975
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4976
    """Split a subdirectory of a tree into a separate tree.
5001
4977
 
5002
4978
    This command will produce a target tree in a format that supports
5003
4979
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4999
 
5024
5000
 
5025
5001
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
5002
    """Generate a merge directive for auto-merge tools.
5027
5003
 
5028
5004
    A directive requests a merge to be performed, and also provides all the
5029
5005
    information necessary to do so.  This means it must either include a
5122
5098
 
5123
5099
 
5124
5100
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5101
    """Mail or create a merge-directive for submitting changes.
5126
5102
 
5127
5103
    A merge directive provides many things needed for requesting merges:
5128
5104
 
5239
5215
 
5240
5216
 
5241
5217
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5218
    """Create a merge-directive for submitting changes.
5243
5219
 
5244
5220
    A merge directive provides many things needed for requesting merges:
5245
5221
 
5312
5288
 
5313
5289
 
5314
5290
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5291
    """Create, remove or modify a tag naming a revision.
5316
5292
 
5317
5293
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5294
    (--revision) option can be given -rtag:X, where X is any previously
5385
5361
 
5386
5362
 
5387
5363
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5364
    """List tags.
5389
5365
 
5390
5366
    This command shows a table of tag names and the revisions they reference.
5391
5367
    """
5459
5435
 
5460
5436
 
5461
5437
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5438
    """Reconfigure the type of a bzr directory.
5463
5439
 
5464
5440
    A target configuration must be specified.
5465
5441
 
5550
5526
 
5551
5527
 
5552
5528
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5529
    """Set the branch of a checkout and update.
5554
5530
 
5555
5531
    For lightweight checkouts, this changes the branch being referenced.
5556
5532
    For heavyweight checkouts, this checks that there are no local commits
5646
5622
 
5647
5623
 
5648
5624
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5625
    """Manage filtered views.
5650
5626
 
5651
5627
    Views provide a mask over the tree so that users can focus on
5652
5628
    a subset of a tree when doing their work. After creating a view,
5800
5776
 
5801
5777
 
5802
5778
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5779
    """Show hooks."""
5804
5780
 
5805
5781
    hidden = True
5806
5782
 
5820
5796
 
5821
5797
 
5822
5798
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
 
5799
    """Remove a branch.
5824
5800
 
5825
5801
    This will remove the branch from the specified location but 
5826
5802
    will keep any working tree or repository in place.
5845
5821
        
5846
5822
 
5847
5823
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5824
    """Temporarily set aside some changes from the current tree.
5849
5825
 
5850
5826
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5827
    ie. out of the way, until a later time when you can bring them back from
5920
5896
 
5921
5897
 
5922
5898
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5899
    """Restore shelved changes.
5924
5900
 
5925
5901
    By default, the most recently shelved changes are restored. However if you
5926
5902
    specify a shelf by id those changes will be restored instead.  This works
5952
5928
 
5953
5929
 
5954
5930
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5931
    """Remove unwanted files from working tree.
5956
5932
 
5957
5933
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5934
    files are never deleted.
5986
5962
 
5987
5963
 
5988
5964
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5965
    """list, view and set branch locations for nested trees.
5990
5966
 
5991
5967
    If no arguments are provided, lists the branch locations for nested trees.
5992
5968
    If one argument is provided, display the branch location for that tree.