Shelve Extension
This extension is not distributed with Mercurial.
Author: TK Soh <teekaysoh@gmail.com>
Repository: http://bitbucket.org/tksoh/hgshelve/
1. Overview
The shelve extension provides the shelve command to lets you choose which parts of the changes in a working directory you'd like to set aside temporarily, at the granularity of patch hunks. You can later restore the shelved patch hunks using the unshelve command.
The shelve extension has been adapted from Mercurial's RecordExtension.
2. Compatibility with Mercurial
Mercurial |
Shelve Extension |
1.6 and later |
41e13e800fb6 or later |
1.5.x and later |
d95c583611f8 or later |
1.4.x and later |
276d8083dc3b or later |
1.3.x |
18815655993b or later |
1.1.x - 1.2.x |
|
< 1.1.x |
3. Configuration
Configure your .hgrc to enable the extension by adding following lines:
[extensions] hgshelve=/path/to/hgshelve.py
or place hgshelve.py in your 'hgext' directory and add the following lines:
[extensions] hgext.hgshelve=
If you use the win32text extension, make sure you have the following lines in your .hgrc or mercurial.ini. This enables automatic line-ending translation when applying patches.
[patch] eol = auto
4. Usage
(this is only a description of the basic usage)
hg shelve
Temporarily stash away changes. You can select the exact hunks of changes you want to shelve.
hg shelve --all
Temporarily stash away changes. All hunks will automatically be selected.
hg unshelve
Get the changes back into the workdir.
5. Shelves
Different changesets can be saves to different shelves, by using the --name parameter. Without this parameter, the shelf name "default" is used. You can have any number of shelves at one time.
hg shelve --name myshelf
Temporarily stash away changes to the shelf myshelf. Any changes already shelved to a different shelf will not be included.
hg shelve --name myshelf --append
Add any changes to the existing shelf myshelf.
hg unshelve --name myshelf
Get the changes stashed away changes to the shelf myshelf back into the workdir, and remove the shelf. Any changes shelved to a different shelf will not be included.
hg shelve --list
List all current shelves.
6. Hunk selection
y - shelve this change n - skip this change s - skip remaining changes to this file f - shelve remaining changes to this file d - done, skip remaining changes and files a - shelve all changes to all remaining files q - quit, shelveing no changes ? - display help