← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-06 08:25:46 UTC
  • mto: (2674.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2675.
  • Revision ID: ian.clatworthy@internode.on.net-20070806082546-oup6ujeleehqoqfj
Bazaar User Reference generated from online help

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
501
501
class cmd_mv(Command):
502
502
    """Move or rename a file.
503
503
 
504
 
    usage:
 
504
    :Usage:
505
505
        bzr mv OLDNAME NEWNAME
 
506
 
506
507
        bzr mv SOURCE... DESTINATION
507
508
 
508
509
    If the last argument is a versioned directory, all the other names
1243
1244
    If there is already a branch at the location but it has no working tree,
1244
1245
    the tree can be populated with 'bzr checkout'.
1245
1246
 
1246
 
    Recipe for importing a tree of files:
 
1247
    Recipe for importing a tree of files::
 
1248
 
1247
1249
        cd ~/project
1248
1250
        bzr init
1249
1251
        bzr add .
1328
1330
    If the --no-trees option is used then the branches in the repository
1329
1331
    will not have working trees by default.
1330
1332
 
1331
 
    example:
1332
 
        bzr init-repo --no-trees repo
1333
 
        bzr init repo/trunk
1334
 
        bzr checkout --lightweight repo/trunk trunk-checkout
1335
 
        cd trunk-checkout
1336
 
        (add files here)
1337
 
 
1338
 
    See 'bzr help repositories' for more information.
 
1333
    :Examples:
 
1334
        Create a shared repositories holding just branches::
 
1335
 
 
1336
            bzr init-repo --no-trees repo
 
1337
            bzr init repo/trunk
 
1338
 
 
1339
        Make a lightweight checkout elsewhere::
 
1340
 
 
1341
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1342
            cd trunk-checkout
 
1343
            (add files here)
1339
1344
    """
1340
1345
 
1341
 
    _see_also = ['init', 'branch', 'checkout']
 
1346
    _see_also = ['init', 'branch', 'checkout', 'repositories']
1342
1347
    takes_args = ["location"]
1343
1348
    takes_options = [RegistryOption('format',
1344
1349
                            help='Specify a format for this repository. See'
1376
1381
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1377
1382
    produces patches suitable for "patch -p1".
1378
1383
 
1379
 
    examples:
1380
 
        bzr diff
1381
 
            Shows the difference in the working tree versus the last commit
1382
 
        bzr diff -r1
1383
 
            Difference between the working tree and revision 1
1384
 
        bzr diff -r1..2
1385
 
            Difference between revision 2 and revision 1
1386
 
        bzr diff --prefix old/:new/
1387
 
            Same as 'bzr diff' but prefix paths with old/ and new/
1388
 
        bzr diff bzr.mine bzr.dev
1389
 
            Show the differences between the two working trees
1390
 
        bzr diff foo.c
1391
 
            Show just the differences for 'foo.c'
 
1384
    :Examples:
 
1385
        Shows the difference in the working tree versus the last commit::
 
1386
 
 
1387
            bzr diff
 
1388
 
 
1389
        Difference between the working tree and revision 1::
 
1390
 
 
1391
            bzr diff -r1
 
1392
 
 
1393
        Difference between revision 2 and revision 1::
 
1394
 
 
1395
            bzr diff -r1..2
 
1396
 
 
1397
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1398
 
 
1399
            bzr diff --prefix old/:new/
 
1400
 
 
1401
        Show the differences between the two working trees::
 
1402
 
 
1403
            bzr diff bzr.mine bzr.dev
 
1404
 
 
1405
        Show just the differences for 'foo.c'::
 
1406
 
 
1407
            bzr diff foo.c
1392
1408
    """
1393
1409
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
1394
1410
    #       or a graphical diff.
1592
1608
    -r revision requests a specific revision, -r ..end or -r begin.. are
1593
1609
    also valid.
1594
1610
 
1595
 
    examples:
1596
 
        bzr log
1597
 
        bzr log foo.c
1598
 
        bzr log -r -10.. http://server/branch
 
1611
    :Examples:
 
1612
        Log the current branch::
 
1613
 
 
1614
            bzr log
 
1615
 
 
1616
        Log a file::
 
1617
 
 
1618
            bzr log foo.c
 
1619
 
 
1620
        Log the last 10 revisions of a branch::
 
1621
 
 
1622
            bzr log -r -10.. http://server/branch
1599
1623
    """
1600
1624
 
1601
1625
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
1858
1882
 
1859
1883
    Ignore patterns specifying absolute paths are not allowed.
1860
1884
 
1861
 
    Ignore patterns may include globbing wildcards such as:
 
1885
    Ignore patterns may include globbing wildcards such as::
 
1886
 
1862
1887
      ? - Matches any single character except '/'
1863
1888
      * - Matches 0 or more characters except '/'
1864
1889
      /**/ - Matches 0 or more directories in a path
1872
1897
    Note: ignore patterns containing shell wildcards must be quoted from 
1873
1898
    the shell on Unix.
1874
1899
 
1875
 
    examples:
1876
 
        bzr ignore ./Makefile
1877
 
        bzr ignore '*.class'
1878
 
        bzr ignore 'lib/**/*.o'
1879
 
        bzr ignore 'RE:lib/.*\.o'
 
1900
    :Examples:
 
1901
        Ignore the top level Makefile::
 
1902
 
 
1903
            bzr ignore ./Makefile
 
1904
 
 
1905
        Ignore class files in all directories::
 
1906
 
 
1907
            bzr ignore '*.class'
 
1908
 
 
1909
        Ignore .o files under the lib directory::
 
1910
 
 
1911
            bzr ignore 'lib/**/*.o'
 
1912
 
 
1913
        Ignore .o files under the lib directory::
 
1914
 
 
1915
            bzr ignore 'RE:lib/.*\.o'
1880
1916
    """
1881
1917
 
1882
1918
    _see_also = ['status', 'ignored']
1956
1992
class cmd_lookup_revision(Command):
1957
1993
    """Lookup the revision-id from a revision-number
1958
1994
 
1959
 
    example:
 
1995
    :Examples:
1960
1996
        bzr lookup-revision 33
1961
1997
    """
1962
1998
    hidden = True
1990
2026
 
1991
2027
    Note: Export of tree with non-ASCII filenames to zip is not supported.
1992
2028
 
1993
 
     Supported formats       Autodetected by extension
1994
 
     -----------------       -------------------------
 
2029
      =================       =========================
 
2030
      Supported formats       Autodetected by extension
 
2031
      =================       =========================
1995
2032
         dir                            -
1996
2033
         tar                          .tar
1997
2034
         tbz2                    .tar.bz2, .tbz2
1998
2035
         tgz                      .tar.gz, .tgz
1999
2036
         zip                          .zip
 
2037
      =================       =========================
2000
2038
    """
2001
2039
    takes_args = ['dest', 'branch?']
2002
2040
    takes_options = [
2312
2350
class cmd_whoami(Command):
2313
2351
    """Show or set bzr user id.
2314
2352
    
2315
 
    examples:
2316
 
        bzr whoami --email
2317
 
        bzr whoami 'Frank Chu <fchu@example.com>'
 
2353
    :Examples:
 
2354
        Show the email of the current user::
 
2355
 
 
2356
            bzr whoami --email
 
2357
 
 
2358
        Set the current user::
 
2359
 
 
2360
            bzr whoami 'Frank Chu <fchu@example.com>'
2318
2361
    """
2319
2362
    takes_options = [ Option('email',
2320
2363
                             help='Display email address only.'),
2409
2452
    Tests that need working space on disk use a common temporary directory, 
2410
2453
    typically inside $TMPDIR or /tmp.
2411
2454
 
2412
 
    examples::
2413
 
        bzr selftest ignore
2414
 
            run only tests relating to 'ignore'
2415
 
        bzr --no-plugins selftest -v
2416
 
            disable plugins and list tests as they're run
 
2455
    :Examples:
 
2456
        Run only tests relating to 'ignore'::
 
2457
 
 
2458
            bzr selftest ignore
 
2459
 
 
2460
        Disable plugins and list tests as they're run::
 
2461
 
 
2462
            bzr --no-plugins selftest -v
2417
2463
    """
2418
2464
    # NB: this is used from the class without creating an instance, which is
2419
2465
    # why it does not have a self parameter.
2591
2637
    The results of the merge are placed into the destination working
2592
2638
    directory, where they can be reviewed (with bzr diff), tested, and then
2593
2639
    committed to record the result of the merge.
2594
 
 
2595
 
    Examples:
2596
 
 
2597
 
    To merge the latest revision from bzr.dev:
2598
 
        bzr merge ../bzr.dev
2599
 
 
2600
 
    To merge changes up to and including revision 82 from bzr.dev:
2601
 
        bzr merge -r 82 ../bzr.dev
2602
 
 
2603
 
    To merge the changes introduced by 82, without previous changes:
2604
 
        bzr merge -r 81..82 ../bzr.dev
2605
2640
    
2606
2641
    merge refuses to run if there are any uncommitted changes, unless
2607
2642
    --force is given.
 
2643
 
 
2644
    :Examples:
 
2645
        To merge the latest revision from bzr.dev::
 
2646
 
 
2647
            bzr merge ../bzr.dev
 
2648
 
 
2649
        To merge changes up to and including revision 82 from bzr.dev::
 
2650
 
 
2651
            bzr merge -r 82 ../bzr.dev
 
2652
 
 
2653
        To merge the changes introduced by 82, without previous changes::
 
2654
 
 
2655
            bzr merge -r 81..82 ../bzr.dev
2608
2656
    """
2609
2657
 
2610
2658
    _see_also = ['update', 'remerge', 'status-flags']
2837
2885
    merge.  The difference is that remerge can (only) be run when there is a
2838
2886
    pending merge, and it lets you specify particular files.
2839
2887
 
2840
 
    Examples:
2841
 
 
2842
 
    $ bzr remerge --show-base
 
2888
    :Examples:
2843
2889
        Re-do the merge of all conflicted files, and show the base text in
2844
 
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2890
        conflict regions, in addition to the usual THIS and OTHER texts::
 
2891
      
 
2892
            bzr remerge --show-base
2845
2893
 
2846
 
    $ bzr remerge --merge-type weave --reprocess foobar
2847
2894
        Re-do the merge of "foobar", using the weave merge algorithm, with
2848
 
        additional processing to reduce the size of conflict regions.
 
2895
        additional processing to reduce the size of conflict regions::
 
2896
      
 
2897
            bzr remerge --merge-type weave --reprocess foobar
2849
2898
    """
2850
2899
    takes_args = ['file*']
2851
2900
    takes_options = [
3447
3496
 
3448
3497
    You can get information on what locks are open via the 'bzr info' command.
3449
3498
    
3450
 
    example:
 
3499
    :Examples:
3451
3500
        bzr break-lock
3452
3501
    """
3453
3502
    takes_args = ['location?']
3727
3776
    """Create a merge-directive for submiting changes.
3728
3777
 
3729
3778
    A merge directive provides many things needed for requesting merges:
3730
 
    - A machine-readable description of the merge to perform
3731
 
    - An optional patch that is a preview of the changes requested
3732
 
    - An optional bundle of revision data, so that the changes can be applied
 
3779
 
 
3780
    * A machine-readable description of the merge to perform
 
3781
 
 
3782
    * An optional patch that is a preview of the changes requested
 
3783
 
 
3784
    * An optional bundle of revision data, so that the changes can be applied
3733
3785
      directly from the merge directive, without retrieving data from a
3734
3786
      branch.
3735
3787