← Back to branch summary

~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-12 15:03:56 UTC
  • mfrom: (2371.1.2 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070412150356-jeie6iap22sae8xf
(Ian Clatworthy) Help text fixes for add, commit, and export

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
244
244
 
245
245
    Since a lightweight checkout is little more than a working tree
246
246
    this will refuse to run against one.
 
247
 
 
248
    To re-create the working tree, use "bzr checkout".
247
249
    """
248
250
 
249
251
    takes_args = ['location?']
339
341
 
340
342
    --file-ids-from will try to use the file ids from the supplied path.
341
343
    It looks up ids trying to find a matching parent directory with the
342
 
    same filename, and then by pure path.
 
344
    same filename, and then by pure path. This option is rarely needed
 
345
    but can be useful when adding the same logical file into two
 
346
    branches that will be merged later (without showing the two different
 
347
    adds as a conflict). It is also useful when merging another project
 
348
    into a subdirectory of this one.
343
349
    """
344
350
    takes_args = ['file*']
345
351
    takes_options = ['no-recurse', 'dry-run', 'verbose',
1915
1921
    given, try to find the format with the extension. If no extension
1916
1922
    is found exports to a directory (equivalent to --format=dir).
1917
1923
 
1918
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1919
 
    is given, the top directory will be the root name of the file.
 
1924
    If root is supplied, it will be used as the root directory inside
 
1925
    container formats (tar, zip, etc). If it is not supplied it will default
 
1926
    to the exported filename. The root option has no effect for 'dir' format.
1920
1927
 
1921
1928
    If branch is omitted then the branch containing the current working
1922
1929
    directory will be used.
1923
1930
 
1924
 
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1931
    Note: Export of tree with non-ASCII filenames to zip is not supported.
1925
1932
 
1926
1933
     Supported formats       Autodetected by extension
1927
1934
     -----------------       -------------------------
2029
2036
    within it is committed.
2030
2037
 
2031
2038
    A selected-file commit may fail in some cases where the committed
2032
 
    tree would be invalid, such as trying to commit a file in a
2033
 
    newly-added directory that is not itself committed.
 
2039
    tree would be invalid. Consider::
 
2040
 
 
2041
      bzr init foo
 
2042
      mkdir foo/bar
 
2043
      bzr add foo/bar
 
2044
      bzr commit foo -m "committing foo"
 
2045
      bzr mv foo/bar foo/baz
 
2046
      mkdir foo/bar
 
2047
      bzr add foo/bar
 
2048
      bzr commit foo/bar -m "committing bar but not baz"
 
2049
 
 
2050
    In the example above, the last commit will fail by design. This gives
 
2051
    the user the opportunity to decide whether they want to commit the
 
2052
    rename at the same time, separately first, or not at all. (As a general
 
2053
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2054
 
 
2055
    Note: A selected-file commit after a merge is not yet supported.
2034
2056
    """
2035
2057
    # TODO: Run hooks on tree to-be-committed, and after commit.
2036
2058
 
2454
2476
 
2455
2477
    Examples:
2456
2478
 
2457
 
    To merge the latest revision from bzr.dev
2458
 
    bzr merge ../bzr.dev
 
2479
    To merge the latest revision from bzr.dev:
 
2480
        bzr merge ../bzr.dev
2459
2481
 
2460
 
    To merge changes up to and including revision 82 from bzr.dev
2461
 
    bzr merge -r 82 ../bzr.dev
 
2482
    To merge changes up to and including revision 82 from bzr.dev:
 
2483
        bzr merge -r 82 ../bzr.dev
2462
2484
 
2463
2485
    To merge the changes introduced by 82, without previous changes:
2464
 
    bzr merge -r 81..82 ../bzr.dev
 
2486
        bzr merge -r 81..82 ../bzr.dev
2465
2487
    
2466
2488
    merge refuses to run if there are any uncommitted changes, unless
2467
2489
    --force is given.
2633
2655
    pending merge, and it lets you specify particular files.
2634
2656
 
2635
2657
    Examples:
 
2658
 
2636
2659
    $ bzr remerge --show-base
2637
2660
        Re-do the merge of all conflicted files, and show the base text in
2638
2661
        conflict regions, in addition to the usual THIS and OTHER texts.