~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Michael Ellerman
  • Date: 2006-06-05 15:11:57 UTC
  • mto: (0.3.1 shelf-dev)
  • mto: This revision was merged to the branch mainline in revision 393.
  • Revision ID: michael@ellerman.id.au-20060605151157-76bb35698cc25a51
Update README.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
 
4
4
This is the shelf plugin for bzr.
5
5
 
 
6
Temporarily set aside some changes from the current tree.
 
7
 
6
8
Shelve allows you to temporarily put changes you've made "on the shelf",
7
9
ie. out of the way, until a later time when you can bring them back from
8
10
the shelf with the 'unshelve' command.
9
11
 
10
 
You can put multiple items on the shelf, each time you run unshelve the
11
 
most recently shelved changes will be reinstated.
 
12
Shelve is intended to help separate several sets of text changes that have
 
13
been inappropriately mingled.  If you just want to get rid of all changes
 
14
(text and otherwise) and you don't need to restore them later, use revert.
 
15
 
 
16
By default shelve asks you what you want to shelve, press '?' at the
 
17
prompt to get help. To shelve everything run shelve --all.
12
18
 
13
19
If filenames are specified, only the changes to those files will be
14
20
shelved, other files will be left untouched.
15
21
 
16
22
If a revision is specified, changes since that revision will be shelved.
17
23
 
18
 
If you specifiy "--pick" you'll be prompted for each hunk of the diff as
19
 
to whether you want to shelve it or not. Press "?" at the prompt for help.
 
24
You can put multiple items on the shelf. Normally each time you run
 
25
unshelve the most recently shelved changes will be reinstated. However,
 
26
you can also unshelve changes in a different order by explicitly
 
27
specifiying which changes to unshelve. This works best when the changes
 
28
don't depend on each other.
 
29
 
 
30
    --all                     Shelve all changes without prompting
 
31
    --message ARG, -m
 
32
    --revision ARG, -r
20
33
 
21
34
More Info
22
35
=========
23
36
 
24
37
http://bazaar.canonical.com/BzrShelveExample
 
38