~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-04-19 08:21:17 UTC
  • mfrom: (2425.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070419082117-znciscush3qbaky1
(robertc) Merge see-also support for command help. (Robert Collins).

Show diffs side-by-side

added added

removed removed

Lines of Context:
189
189
    aliases = ['st', 'stat']
190
190
 
191
191
    encoding_type = 'replace'
 
192
    _see_also = ['diff', 'revert']
192
193
    
193
194
    @display_command
194
195
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
247
248
 
248
249
    To re-create the working tree, use "bzr checkout".
249
250
    """
 
251
    _see_also = ['checkout']
250
252
 
251
253
    takes_args = ['location?']
252
254
 
276
278
    This is equal to the number of revisions on this branch.
277
279
    """
278
280
 
 
281
    _see_also = ['info']
279
282
    takes_args = ['location?']
280
283
 
281
284
    @display_command
352
355
                     Option('file-ids-from', type=unicode,
353
356
                            help='Lookup file ids from here')]
354
357
    encoding_type = 'replace'
 
358
    _see_also = ['remove']
355
359
 
356
360
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
357
361
            file_ids_from=None):
436
440
 
437
441
    It is also possible to restrict the list of files to a specific
438
442
    set. For example: bzr inventory --show-ids this/file
439
 
 
440
 
    See also: bzr ls
441
443
    """
442
444
 
443
445
    hidden = True
444
 
 
 
446
    _see_also = ['ls']
445
447
    takes_options = ['revision', 'show-ids', 'kind']
446
 
 
447
448
    takes_args = ['file*']
448
449
 
449
450
    @display_command
560
561
    location can be accessed.
561
562
    """
562
563
 
 
564
    _see_also = ['push', 'update']
563
565
    takes_options = ['remember', 'overwrite', 'revision', 'verbose',
564
566
        Option('directory',
565
567
            help='branch to pull into, '
666
668
    location can be accessed.
667
669
    """
668
670
 
 
671
    _see_also = ['pull', 'update']
669
672
    takes_options = ['remember', 'overwrite', 'verbose',
670
673
        Option('create-prefix',
671
674
               help='Create the path leading up to the branch '
848
851
    To retrieve the branch as of a particular revision, supply the --revision
849
852
    parameter, as in "branch foo/bar -r 5".
850
853
    """
 
854
 
 
855
    _see_also = ['checkout']
851
856
    takes_args = ['from_location', 'to_location?']
852
857
    takes_options = ['revision']
853
858
    aliases = ['get', 'clone']
916
921
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
917
922
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
918
923
    code.)
 
924
    """
919
925
 
920
 
    See "help checkouts" for more information on checkouts.
921
 
    """
 
926
    _see_also = ['checkouts', 'branch']
922
927
    takes_args = ['branch_location?', 'to_location?']
923
928
    takes_options = ['revision',
924
929
                     Option('lightweight',
978
983
    # TODO: Option to show renames between two historical versions.
979
984
 
980
985
    # TODO: Only show renames under dir, rather than in the whole branch.
 
986
    _see_also = ['status']
981
987
    takes_args = ['dir?']
982
988
 
983
989
    @display_command
1010
1016
    If you want to discard your local changes, you can just do a 
1011
1017
    'bzr revert' instead of 'bzr commit' after the update.
1012
1018
    """
 
1019
 
 
1020
    _see_also = ['pull']
1013
1021
    takes_args = ['dir?']
1014
1022
    aliases = ['up']
1015
1023
 
1053
1061
 
1054
1062
    Branches and working trees will also report any missing revisions.
1055
1063
    """
 
1064
    _see_also = ['revno']
1056
1065
    takes_args = ['location?']
1057
1066
    takes_options = ['verbose']
1058
1067
 
1103
1112
    """
1104
1113
 
1105
1114
    hidden = True
 
1115
    _see_also = ['inventory', 'ls']
1106
1116
    takes_args = ['filename']
1107
1117
 
1108
1118
    @display_command
1155
1165
 
1156
1166
    The branch *MUST* be on a listable system such as local disk or sftp.
1157
1167
    """
 
1168
 
 
1169
    _see_also = ['check']
1158
1170
    takes_args = ['branch?']
1159
1171
 
1160
1172
    def run(self, branch="."):
1165
1177
 
1166
1178
class cmd_revision_history(Command):
1167
1179
    """Display the list of revision ids on a branch."""
 
1180
 
 
1181
    _see_also = ['log']
1168
1182
    takes_args = ['location?']
1169
1183
 
1170
1184
    hidden = True
1179
1193
 
1180
1194
class cmd_ancestry(Command):
1181
1195
    """List all revisions merged into this branch."""
 
1196
 
 
1197
    _see_also = ['log', 'revision-history']
1182
1198
    takes_args = ['location?']
1183
1199
 
1184
1200
    hidden = True
1222
1238
        bzr status
1223
1239
        bzr commit -m 'imported project'
1224
1240
    """
 
1241
 
 
1242
    _see_also = ['init-repo', 'branch', 'checkout']
1225
1243
    takes_args = ['location?']
1226
1244
    takes_options = [
1227
1245
         RegistryOption('format',
1293
1311
        (add files here)
1294
1312
    """
1295
1313
 
 
1314
    _see_also = ['init', 'branch', 'checkout']
1296
1315
    takes_args = ["location"]
1297
1316
    takes_options = [RegistryOption('format',
1298
1317
                            help='Specify a format for this repository. See'
1358
1377
 
1359
1378
    # TODO: This probably handles non-Unix newlines poorly.
1360
1379
 
 
1380
    _see_also = ['status']
1361
1381
    takes_args = ['file*']
1362
1382
    takes_options = ['revision', 'diff-options',
1363
1383
        Option('prefix', type=str,
1443
1463
    # directories with readdir, rather than stating each one.  Same
1444
1464
    # level of effort but possibly much less IO.  (Or possibly not,
1445
1465
    # if the directories are very large...)
 
1466
    _see_also = ['status', 'ls']
1446
1467
    takes_options = ['show-ids']
1447
1468
 
1448
1469
    @display_command
1468
1489
 
1469
1490
class cmd_modified(Command):
1470
1491
    """List files modified in working tree.
1471
 
 
1472
 
    See also: "bzr status".
1473
1492
    """
1474
1493
 
1475
1494
    hidden = True
 
1495
    _see_also = ['status', 'ls']
1476
1496
 
1477
1497
    @display_command
1478
1498
    def run(self):
1484
1504
 
1485
1505
class cmd_added(Command):
1486
1506
    """List files added in working tree.
1487
 
 
1488
 
    See also: "bzr status".
1489
1507
    """
1490
1508
 
1491
1509
    hidden = True
 
1510
    _see_also = ['status', 'ls']
1492
1511
 
1493
1512
    @display_command
1494
1513
    def run(self):
1520
1539
 
1521
1540
    The root is the nearest enclosing directory with a .bzr control
1522
1541
    directory."""
 
1542
 
1523
1543
    takes_args = ['filename?']
1524
1544
    @display_command
1525
1545
    def run(self, filename=None):
1687
1707
    """List files in a tree.
1688
1708
    """
1689
1709
 
 
1710
    _see_also = ['status', 'cat']
1690
1711
    takes_args = ['path?']
1691
1712
    # TODO: Take a revision or remote path and list that tree instead.
1692
1713
    takes_options = ['verbose', 'revision',
1776
1797
 
1777
1798
class cmd_unknowns(Command):
1778
1799
    """List unknown files.
1779
 
 
1780
 
    See also: "bzr ls --unknown".
1781
1800
    """
1782
1801
 
1783
1802
    hidden = True
 
1803
    _see_also = ['ls']
1784
1804
 
1785
1805
    @display_command
1786
1806
    def run(self):
1821
1841
        bzr ignore 'lib/**/*.o'
1822
1842
        bzr ignore 'RE:lib/.*\.o'
1823
1843
    """
 
1844
 
 
1845
    _see_also = ['status', 'ignored']
1824
1846
    takes_args = ['name_pattern*']
1825
1847
    takes_options = [
1826
1848
                     Option('old-default-rules',
1876
1898
 
1877
1899
class cmd_ignored(Command):
1878
1900
    """List ignored files and the patterns that matched them.
 
1901
    """
1879
1902
 
1880
 
    See also: bzr ignore"""
 
1903
    _see_also = ['ignore']
1881
1904
    @display_command
1882
1905
    def run(self):
1883
1906
        tree = WorkingTree.open_containing(u'.')[0]
1972
1995
    binary file. 
1973
1996
    """
1974
1997
 
 
1998
    _see_also = ['ls']
1975
1999
    takes_options = ['revision', 'name-from-revision']
1976
2000
    takes_args = ['filename']
1977
2001
    encoding_type = 'exact'
2063
2087
 
2064
2088
    # XXX: verbose currently does nothing
2065
2089
 
 
2090
    _see_also = ['uncommit']
2066
2091
    takes_args = ['selected*']
2067
2092
    takes_options = ['message', 'verbose', 
2068
2093
                     Option('unchanged',
2160
2185
    This command checks various invariants about the branch storage to
2161
2186
    detect data corruption or bzr bugs.
2162
2187
    """
 
2188
 
 
2189
    _see_also = ['reconcile']
2163
2190
    takes_args = ['branch?']
2164
2191
    takes_options = ['verbose']
2165
2192
 
2180
2207
    this command. When the default format has changed you may also be warned
2181
2208
    during other operations to upgrade.
2182
2209
    """
 
2210
 
 
2211
    _see_also = ['check']
2183
2212
    takes_args = ['url?']
2184
2213
    takes_options = [
2185
2214
                    RegistryOption('format',
2248
2277
    If unset, the tree root directory name is used as the nickname
2249
2278
    To print the current nickname, execute with no argument.  
2250
2279
    """
 
2280
 
 
2281
    _see_also = ['info']
2251
2282
    takes_args = ['nickname?']
2252
2283
    def run(self, nickname=None):
2253
2284
        branch = Branch.open_containing(u'.')[0]
2492
2523
    merge refuses to run if there are any uncommitted changes, unless
2493
2524
    --force is given.
2494
2525
    """
 
2526
 
 
2527
    _see_also = ['update', 'remerge']
2495
2528
    takes_args = ['branch?']
2496
2529
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2497
2530
        Option('show-base', help="Show base revision text in "
2757
2790
    name.  If you name a directory, all the contents of that directory will be
2758
2791
    reverted.
2759
2792
    """
 
2793
 
 
2794
    _see_also = ['cat', 'export']
2760
2795
    takes_options = ['revision', 'no-backup']
2761
2796
    takes_args = ['file*']
2762
2797
 
2796
2831
 
2797
2832
class cmd_help(Command):
2798
2833
    """Show help on a command or other topic.
 
2834
    """
2799
2835
 
2800
 
    For a list of all available commands, say 'bzr help commands'.
2801
 
    """
 
2836
    _see_also = ['topics']
2802
2837
    takes_options = [Option('long', 'show help on all commands')]
2803
2838
    takes_args = ['topic?']
2804
2839
    aliases = ['?', '--help', '-?', '-h']
2845
2880
 
2846
2881
    OTHER_BRANCH may be local or remote.
2847
2882
    """
 
2883
 
 
2884
    _see_also = ['merge', 'pull']
2848
2885
    takes_args = ['other_branch?']
2849
2886
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
2850
2887
                     Option('mine-only', 
2947
2984
 
2948
2985
class cmd_testament(Command):
2949
2986
    """Show testament (signing-form) of a revision."""
2950
 
    takes_options = ['revision', 
 
2987
    takes_options = ['revision',
2951
2988
                     Option('long', help='Produce long-format testament'), 
2952
2989
                     Option('strict', help='Produce a strict-format'
2953
2990
                            ' testament')]
3063
3100
 
3064
3101
    Once converted into a checkout, commits must succeed on the master branch
3065
3102
    before they will be applied to the local branch.
3066
 
 
3067
 
    See "help checkouts" for more information on checkouts.
3068
3103
    """
3069
3104
 
 
3105
    _see_also = ['checkouts', 'unbind']
3070
3106
    takes_args = ['location?']
3071
3107
    takes_options = []
3072
3108
 
3095
3131
 
3096
3132
    After unbinding, the local branch is considered independent and subsequent
3097
3133
    commits will be local only.
3098
 
 
3099
 
    See "help checkouts" for more information on checkouts.
3100
3134
    """
3101
3135
 
 
3136
    _see_also = ['checkouts', 'bind']
3102
3137
    takes_args = []
3103
3138
    takes_options = []
3104
3139
 
3123
3158
    # unreferenced information in 'branch-as-repository' branches.
3124
3159
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3125
3160
    # information in shared branches as well.
 
3161
    _see_also = ['commit']
3126
3162
    takes_options = ['verbose', 'revision',
3127
3163
                    Option('dry-run', help='Don\'t actually make changes'),
3128
3164
                    Option('force', help='Say yes to all questions.')]
3279
3315
            sys.stdout.flush()
3280
3316
        smart_server.serve()
3281
3317
 
 
3318
 
3282
3319
class cmd_join(Command):
3283
3320
    """Combine a subtree into its containing tree.
3284
3321
    
3300
3337
    and merge, will recurse into the subtree.
3301
3338
    """
3302
3339
 
 
3340
    _see_also = ['split']
3303
3341
    takes_args = ['tree']
3304
3342
    takes_options = [Option('reference', 'join by reference')]
3305
3343
    hidden = True
3341
3379
    subdirectory will be converted into an independent tree, with its own
3342
3380
    branch.  Commits in the top-level tree will not apply to the new subtree.
3343
3381
    If you want that behavior, do "bzr join --reference TREE".
3344
 
 
3345
 
    To undo this operation, do "bzr join TREE".
3346
3382
    """
3347
3383
 
 
3384
    _see_also = ['join']
3348
3385
    takes_args = ['tree']
3349
3386
 
3350
3387
    hidden = True
3460
3497
    --force, in which case the tag is moved to point to the new revision.
3461
3498
    """
3462
3499
 
 
3500
    _see_also = ['commit', 'tags']
3463
3501
    takes_args = ['tag_name']
3464
3502
    takes_options = [
3465
3503
        Option('delete',
3511
3549
    This tag shows a table of tag names and the revisions they reference.
3512
3550
    """
3513
3551
 
 
3552
    _see_also = ['tag']
3514
3553
    takes_options = [
3515
3554
        Option('directory',
3516
3555
            help='Branch whose tags should be displayed',