/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: Martin Pool
  • Date: 2010-04-21 11:27:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5189.
  • Revision ID: mbp@canonical.com-20100421112704-zijso22b6pdevrxy
Simplify various code to use user_url

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
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.
512
512
 
513
513
 
514
514
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
515
    """Show current revision number.
516
516
 
517
517
    This is equal to the number of revisions on this branch.
518
518
    """
548
548
 
549
549
 
550
550
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
551
    """Show revision number and revision id for a given revision identifier.
552
552
    """
553
553
    hidden = True
554
554
    takes_args = ['revision_info*']
610
610
 
611
611
 
612
612
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
613
    """Add specified files or directories.
614
614
 
615
615
    In non-recursive mode, all the named items are added, regardless
616
616
    of whether they were previously ignored.  A warning is given if
696
696
 
697
697
 
698
698
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
699
    """Create a new versioned directory.
700
700
 
701
701
    This is equivalent to creating the directory and then adding it.
702
702
    """
718
718
 
719
719
 
720
720
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
721
    """Show path of a file relative to root"""
722
722
 
723
723
    takes_args = ['filename']
724
724
    hidden = True
733
733
 
734
734
 
735
735
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
736
    """Show inventory of the current working copy or a revision.
737
737
 
738
738
    It is possible to limit the output to a particular entry
739
739
    type using the --kind option.  For example: --kind file.
794
794
 
795
795
 
796
796
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
797
    """Move or rename a file.
798
798
 
799
799
    :Usage:
800
800
        bzr mv OLDNAME NEWNAME
931
931
 
932
932
 
933
933
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
934
    """Turn this branch into a mirror of another branch.
935
935
 
936
936
    By default, this command only works on branches that have not diverged.
937
937
    Branches are considered diverged if the destination branch's most recent 
1058
1058
 
1059
1059
 
1060
1060
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1061
    """Update a mirror of this branch.
1062
1062
 
1063
1063
    The target branch will not have its working tree populated because this
1064
1064
    is both expensive, and is not supported on remote file systems.
1132
1132
        else:
1133
1133
            revision_id = None
1134
1134
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
1135
            tree.warn_if_changed_or_out_of_date(
 
1136
                strict, 'push_strict', 'Use --no-strict to force the push.')
1139
1137
        # Get the stacked_on branch, if any
1140
1138
        if stacked_on is not None:
1141
1139
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1171
 
1174
1172
 
1175
1173
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1174
    """Create a new branch that is a copy of an existing branch.
1177
1175
 
1178
1176
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1177
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1286
1284
 
1287
1285
 
1288
1286
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1287
    """Create a new checkout of an existing branch.
1290
1288
 
1291
1289
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1290
    the branch found in '.'. This is useful if you have removed the working tree
1355
1353
 
1356
1354
 
1357
1355
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1356
    """Show list of renamed files.
1359
1357
    """
1360
1358
    # TODO: Option to show renames between two historical versions.
1361
1359
 
1387
1385
 
1388
1386
 
1389
1387
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1388
    """Update a tree to have the latest code committed to its branch.
1391
1389
 
1392
1390
    This will perform a merge into the working tree, and may generate
1393
1391
    conflicts. If you have any local changes, you will still
1473
1471
 
1474
1472
 
1475
1473
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1474
    """Show information about a working tree, branch or repository.
1477
1475
 
1478
1476
    This command will show all known locations and formats associated to the
1479
1477
    tree, branch or repository.
1517
1515
 
1518
1516
 
1519
1517
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1518
    """Remove files or directories.
1521
1519
 
1522
1520
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1521
    them if they can easily be recovered using revert. If no options or
1571
1569
 
1572
1570
 
1573
1571
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1572
    """Print file_id of a particular file or directory.
1575
1573
 
1576
1574
    The file_id is assigned when the file is first added and remains the
1577
1575
    same through all revisions where the file exists, even when it is
1593
1591
 
1594
1592
 
1595
1593
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1594
    """Print path of file_ids to a file or directory.
1597
1595
 
1598
1596
    This prints one line for each directory down to the target,
1599
1597
    starting at the branch root.
1615
1613
 
1616
1614
 
1617
1615
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1616
    """Reconcile bzr metadata in a branch.
1619
1617
 
1620
1618
    This can correct data mismatches that may have been caused by
1621
1619
    previous ghost operations or bzr upgrades. You should only
1643
1641
 
1644
1642
 
1645
1643
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1644
    """Display the list of revision ids on a branch."""
1647
1645
 
1648
1646
    _see_also = ['log']
1649
1647
    takes_args = ['location?']
1659
1657
 
1660
1658
 
1661
1659
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1660
    """List all revisions merged into this branch."""
1663
1661
 
1664
1662
    _see_also = ['log', 'revision-history']
1665
1663
    takes_args = ['location?']
1684
1682
 
1685
1683
 
1686
1684
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1685
    """Make a directory into a versioned branch.
1688
1686
 
1689
1687
    Use this to create an empty branch, or before importing an
1690
1688
    existing project.
1793
1791
 
1794
1792
 
1795
1793
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1794
    """Create a shared repository for branches to share storage space.
1797
1795
 
1798
1796
    New branches created under the repository directory will store their
1799
1797
    revisions in the repository, not in the branch directory.  For branches
1853
1851
 
1854
1852
 
1855
1853
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1854
    """Show differences in the working tree, between revisions or branches.
1857
1855
 
1858
1856
    If no arguments are given, all changes for the current tree are listed.
1859
1857
    If files are given, only the changes in those files are listed.
1994
1992
 
1995
1993
 
1996
1994
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1995
    """List files deleted in the working tree.
1998
1996
    """
1999
1997
    # TODO: Show files deleted since a previous revision, or
2000
1998
    # between two revisions.
2023
2021
 
2024
2022
 
2025
2023
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
2024
    """List files modified in working tree.
2027
2025
    """
2028
2026
 
2029
2027
    hidden = True
2046
2044
 
2047
2045
 
2048
2046
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
2047
    """List files added in working tree.
2050
2048
    """
2051
2049
 
2052
2050
    hidden = True
2082
2080
 
2083
2081
 
2084
2082
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2083
    """Show the tree root directory.
2086
2084
 
2087
2085
    The root is the nearest enclosing directory with a .bzr control
2088
2086
    directory."""
2112
2110
 
2113
2111
 
2114
2112
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2113
    """Show historical log for a branch or subset of a branch.
2116
2114
 
2117
2115
    log is bzr's default tool for exploring the history of a branch.
2118
2116
    The branch to use is taken from the first parameter. If no parameters
2299
2297
                   help='Show changes made in each revision as a patch.'),
2300
2298
            Option('include-merges',
2301
2299
                   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
2300
            ]
2307
2301
    encoding_type = 'replace'
2308
2302
 
2318
2312
            message=None,
2319
2313
            limit=None,
2320
2314
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2315
            include_merges=False):
2324
2316
        from bzrlib.log import (
2325
2317
            Logger,
2326
2318
            make_log_request_dict,
2327
2319
            _get_info_for_log_files,
2328
2320
            )
2329
2321
        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
2322
        if include_merges:
2335
2323
            if levels is None:
2336
2324
                levels = 0
2429
2417
            direction=direction, specific_fileids=file_ids,
2430
2418
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
2419
            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
 
            )
 
2420
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2421
        Logger(b, rqst).show(lf)
2436
2422
 
2437
2423
 
2495
2481
 
2496
2482
 
2497
2483
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2484
    """Return revision-ids which affected a particular file.
2499
2485
 
2500
2486
    A more user-friendly interface is "bzr log FILE".
2501
2487
    """
2516
2502
 
2517
2503
 
2518
2504
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2505
    """List files in a tree.
2520
2506
    """
2521
2507
 
2522
2508
    _see_also = ['status', 'cat']
2633
2619
 
2634
2620
 
2635
2621
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2622
    """List unknown files.
2637
2623
    """
2638
2624
 
2639
2625
    hidden = True
2646
2632
 
2647
2633
 
2648
2634
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2635
    """Ignore specified files or patterns.
2650
2636
 
2651
2637
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2638
 
2661
2647
    using this command or directly by using an editor, be sure to commit
2662
2648
    it.
2663
2649
    
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
2650
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2651
    precedence over regular ignores.  Such exceptions are used to specify
2672
2652
    files that should be versioned which would otherwise be ignored.
2713
2693
    _see_also = ['status', 'ignored', 'patterns']
2714
2694
    takes_args = ['name_pattern*']
2715
2695
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2696
        Option('old-default-rules',
 
2697
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2698
        ]
2719
2699
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2700
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2701
        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:
 
2702
        if old_default_rules is not None:
 
2703
            # dump the rules and exit
 
2704
            for pattern in ignores.OLD_DEFAULTS:
2725
2705
                self.outf.write("%s\n" % pattern)
2726
2706
            return
2727
2707
        if not name_pattern_list:
2728
2708
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2709
                                  "NAME_PATTERN or --old-default-rules")
2730
2710
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2711
                             for p in name_pattern_list]
2732
2712
        for name_pattern in name_pattern_list:
2754
2734
 
2755
2735
 
2756
2736
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2737
    """List ignored files and the patterns that matched them.
2758
2738
 
2759
2739
    List all the ignored files and the ignore pattern that caused the file to
2760
2740
    be ignored.
2781
2761
 
2782
2762
 
2783
2763
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2764
    """Lookup the revision-id from a revision-number
2785
2765
 
2786
2766
    :Examples:
2787
2767
        bzr lookup-revision 33
2801
2781
 
2802
2782
 
2803
2783
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2784
    """Export current or past revision to a destination directory or archive.
2805
2785
 
2806
2786
    If no revision is specified this exports the last committed revision.
2807
2787
 
2864
2844
 
2865
2845
 
2866
2846
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2847
    """Write the contents of a file as of a given revision to standard output.
2868
2848
 
2869
2849
    If no revision is nominated, the last revision is used.
2870
2850
 
2950
2930
 
2951
2931
 
2952
2932
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2933
    """Show the offset in seconds from GMT to local time."""
2954
2934
    hidden = True
2955
2935
    @display_command
2956
2936
    def run(self):
2959
2939
 
2960
2940
 
2961
2941
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2942
    """Commit changes into a new revision.
2963
2943
 
2964
2944
    An explanatory message needs to be given for each commit. This is
2965
2945
    often done by using the --message option (getting the message from the
3073
3053
                         "the master branch until a normal commit "
3074
3054
                         "is performed."
3075
3055
                    ),
3076
 
             Option('show-diff', short_name='p',
 
3056
             Option('show-diff',
3077
3057
                    help='When no message is supplied, show the diff along'
3078
3058
                    ' with the status summary in the message editor.'),
3079
3059
             ]
3225
3205
 
3226
3206
 
3227
3207
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3208
    """Validate working tree structure, branch consistency and repository history.
3229
3209
 
3230
3210
    This command checks various invariants about branch and repository storage
3231
3211
    to detect data corruption or bzr bugs.
3295
3275
 
3296
3276
 
3297
3277
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3278
    """Upgrade branch storage to current format.
3299
3279
 
3300
3280
    The check command or bzr developers may sometimes advise you to run
3301
3281
    this command. When the default format has changed you may also be warned
3319
3299
 
3320
3300
 
3321
3301
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3302
    """Show or set bzr user id.
3323
3303
 
3324
3304
    :Examples:
3325
3305
        Show the email of the current user::
3369
3349
 
3370
3350
 
3371
3351
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3352
    """Print or set the branch nickname.
3373
3353
 
3374
3354
    If unset, the tree root directory name is used as the nickname.
3375
3355
    To print the current nickname, execute with no argument.
3393
3373
 
3394
3374
 
3395
3375
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3376
    """Set/unset and display aliases.
3397
3377
 
3398
3378
    :Examples:
3399
3379
        Show the current aliases::
3463
3443
 
3464
3444
 
3465
3445
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3446
    """Run internal test suite.
3467
3447
 
3468
3448
    If arguments are given, they are regular expressions that say which tests
3469
3449
    should run.  Tests matching any expression are run, and other tests are
3610
3590
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3591
                    "needs to be installed to use --subunit.")
3612
3592
            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
3593
        if parallel:
3619
3594
            self.additional_selftest_args.setdefault(
3620
3595
                'suite_decorators', []).append(parallel)
3651
3626
 
3652
3627
 
3653
3628
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3629
    """Show version of bzr."""
3655
3630
 
3656
3631
    encoding_type = 'replace'
3657
3632
    takes_options = [
3668
3643
 
3669
3644
 
3670
3645
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3646
    """Statement of optimism."""
3672
3647
 
3673
3648
    hidden = True
3674
3649
 
3678
3653
 
3679
3654
 
3680
3655
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3656
    """Find and print a base revision for merging two branches."""
3682
3657
    # TODO: Options to specify revisions on either side, as if
3683
3658
    #       merging only part of the history.
3684
3659
    takes_args = ['branch', 'other']
3704
3679
 
3705
3680
 
3706
3681
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3682
    """Perform a three-way merge.
3708
3683
 
3709
3684
    The source of the merge can be specified either in the form of a branch,
3710
3685
    or in the form of a path to a file containing a merge directive generated
4065
4040
 
4066
4041
 
4067
4042
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
4043
    """Redo a merge.
4069
4044
 
4070
4045
    Use this if you want to try a different merge technique while resolving
4071
4046
    conflicts.  Some merge techniques are better than others, and remerge
4160
4135
 
4161
4136
 
4162
4137
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4138
    """Revert files to a previous revision.
4164
4139
 
4165
4140
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4141
    will be reverted.  If the revision is not specified with '--revision', the
4217
4192
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4193
            forget_merges=None):
4219
4194
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
 
4195
        tree.lock_write()
4221
4196
        self.add_cleanup(tree.unlock)
4222
4197
        if forget_merges:
4223
4198
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4232
4207
 
4233
4208
 
4234
4209
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4210
    """Test reporting of assertion failures"""
4236
4211
    # intended just for use in testing
4237
4212
 
4238
4213
    hidden = True
4242
4217
 
4243
4218
 
4244
4219
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4220
    """Show help on a command or other topic.
4246
4221
    """
4247
4222
 
4248
4223
    _see_also = ['topics']
4261
4236
 
4262
4237
 
4263
4238
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4239
    """Show appropriate completions for context.
4265
4240
 
4266
4241
    For a list of all available commands, say 'bzr shell-complete'.
4267
4242
    """
4276
4251
 
4277
4252
 
4278
4253
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4254
    """Show unmerged/unpulled revisions between two branches.
4280
4255
 
4281
4256
    OTHER_BRANCH may be local or remote.
4282
4257
 
4449
4424
 
4450
4425
 
4451
4426
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
4427
    """Compress the data within a repository."""
4469
4428
 
4470
4429
    _see_also = ['repositories']
4471
4430
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4431
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4432
    def run(self, branch_or_repo='.'):
4477
4433
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4434
        try:
4479
4435
            branch = dir.open_branch()
4480
4436
            repository = branch.repository
4481
4437
        except errors.NotBranchError:
4482
4438
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4439
        repository.pack()
4484
4440
 
4485
4441
 
4486
4442
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4443
    """List the installed plugins.
4488
4444
 
4489
4445
    This command displays the list of installed plugins including
4490
4446
    version of plugin and a short description of each.
4529
4485
 
4530
4486
 
4531
4487
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4488
    """Show testament (signing-form) of a revision."""
4533
4489
    takes_options = [
4534
4490
            'revision',
4535
4491
            Option('long', help='Produce long-format testament.'),
4561
4517
 
4562
4518
 
4563
4519
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4520
    """Show the origin of each line in a file.
4565
4521
 
4566
4522
    This prints out the given file with an annotation on the left side
4567
4523
    indicating which revision, author and date introduced the change.
4614
4570
 
4615
4571
 
4616
4572
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4573
    """Create a digital signature for an existing revision."""
4618
4574
    # TODO be able to replace existing ones.
4619
4575
 
4620
4576
    hidden = True # is this right ?
4680
4636
 
4681
4637
 
4682
4638
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.
 
4639
    """Convert the current branch into a checkout of the supplied branch.
4685
4640
 
4686
4641
    Once converted into a checkout, commits must succeed on the master branch
4687
4642
    before they will be applied to the local branch.
4721
4676
 
4722
4677
 
4723
4678
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4679
    """Convert the current checkout into a regular branch.
4725
4680
 
4726
4681
    After unbinding, the local branch is considered independent and subsequent
4727
4682
    commits will be local only.
4738
4693
 
4739
4694
 
4740
4695
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4696
    """Remove the last committed revision.
4742
4697
 
4743
4698
    --verbose will print out what is being removed.
4744
4699
    --dry-run will go through all the motions, but not actually
4846
4801
 
4847
4802
 
4848
4803
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4804
    """Break a dead lock on a repository, branch or working directory.
4850
4805
 
4851
4806
    CAUTION: Locks should only be broken when you are sure that the process
4852
4807
    holding the lock has been stopped.
4871
4826
 
4872
4827
 
4873
4828
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4829
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4830
 
4876
4831
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4832
    """
4885
4840
 
4886
4841
 
4887
4842
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4843
    """Run the bzr server."""
4889
4844
 
4890
4845
    aliases = ['server']
4891
4846
 
4951
4906
 
4952
4907
 
4953
4908
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4909
    """Combine a tree into its containing tree.
4955
4910
 
4956
4911
    This command requires the target tree to be in a rich-root format.
4957
4912
 
4997
4952
 
4998
4953
 
4999
4954
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4955
    """Split a subdirectory of a tree into a separate tree.
5001
4956
 
5002
4957
    This command will produce a target tree in a format that supports
5003
4958
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4978
 
5024
4979
 
5025
4980
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4981
    """Generate a merge directive for auto-merge tools.
5027
4982
 
5028
4983
    A directive requests a merge to be performed, and also provides all the
5029
4984
    information necessary to do so.  This means it must either include a
5122
5077
 
5123
5078
 
5124
5079
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5080
    """Mail or create a merge-directive for submitting changes.
5126
5081
 
5127
5082
    A merge directive provides many things needed for requesting merges:
5128
5083
 
5239
5194
 
5240
5195
 
5241
5196
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5197
    """Create a merge-directive for submitting changes.
5243
5198
 
5244
5199
    A merge directive provides many things needed for requesting merges:
5245
5200
 
5312
5267
 
5313
5268
 
5314
5269
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5270
    """Create, remove or modify a tag naming a revision.
5316
5271
 
5317
5272
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5273
    (--revision) option can be given -rtag:X, where X is any previously
5385
5340
 
5386
5341
 
5387
5342
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5343
    """List tags.
5389
5344
 
5390
5345
    This command shows a table of tag names and the revisions they reference.
5391
5346
    """
5459
5414
 
5460
5415
 
5461
5416
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5417
    """Reconfigure the type of a bzr directory.
5463
5418
 
5464
5419
    A target configuration must be specified.
5465
5420
 
5550
5505
 
5551
5506
 
5552
5507
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5508
    """Set the branch of a checkout and update.
5554
5509
 
5555
5510
    For lightweight checkouts, this changes the branch being referenced.
5556
5511
    For heavyweight checkouts, this checks that there are no local commits
5646
5601
 
5647
5602
 
5648
5603
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5604
    """Manage filtered views.
5650
5605
 
5651
5606
    Views provide a mask over the tree so that users can focus on
5652
5607
    a subset of a tree when doing their work. After creating a view,
5800
5755
 
5801
5756
 
5802
5757
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5758
    """Show hooks."""
5804
5759
 
5805
5760
    hidden = True
5806
5761
 
5820
5775
 
5821
5776
 
5822
5777
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
 
5778
    """Remove a branch.
5824
5779
 
5825
5780
    This will remove the branch from the specified location but 
5826
5781
    will keep any working tree or repository in place.
5845
5800
        
5846
5801
 
5847
5802
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5803
    """Temporarily set aside some changes from the current tree.
5849
5804
 
5850
5805
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5806
    ie. out of the way, until a later time when you can bring them back from
5920
5875
 
5921
5876
 
5922
5877
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5878
    """Restore shelved changes.
5924
5879
 
5925
5880
    By default, the most recently shelved changes are restored. However if you
5926
5881
    specify a shelf by id those changes will be restored instead.  This works
5952
5907
 
5953
5908
 
5954
5909
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5910
    """Remove unwanted files from working tree.
5956
5911
 
5957
5912
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5913
    files are never deleted.
5986
5941
 
5987
5942
 
5988
5943
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5944
    """list, view and set branch locations for nested trees.
5990
5945
 
5991
5946
    If no arguments are provided, lists the branch locations for nested trees.
5992
5947
    If one argument is provided, display the branch location for that tree.