|
Size: 2260
Comment:
|
Size: 1184
Comment: Expand hatnote: refer users of earlier versions to ThirdPartyShelveExtension
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| == Shelve Extension == | #pragma section-numbers 2 = Shelve Extension = |
| Line 3: | Line 4: |
| '''This extension is not distributed with Mercurial.''' | '''This extension is distributed with Mercurial 2.8 and later. If you are using an earlier version of Mercurial, see ThirdPartyShelveExtension.''' |
| Line 5: | Line 6: |
| ''Author: TK Soh <teekaysoh@gmail.com>'' | ''Author: Bryan O'Sullivan'' |
| Line 7: | Line 8: |
| Repository: [[http://bitbucket.org/tksoh/hgshelve/]] | ''Current maintainer: Facebook'' |
| Line 9: | Line 10: |
| === Overview === | <<TableOfContents>> |
| Line 11: | Line 12: |
| 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. | == Overview == |
| Line 13: | Line 14: |
| The shelve extension has been adapted from Mercurial's RecordExtension. | The shelve extension lets you set your pending changes aside temporarily and restore them at a later time. It is useful in situations where you need to switch tasks, but are not ready to commit your current work. |
| Line 15: | Line 16: |
| === Compatibility with Mercurial === | == Configuration == |
| Line 17: | Line 18: |
| || '''Mercurial''' || '''Shelve Extension''' || || 1.5.x and later || [[http://bitbucket.org/tksoh/hgshelve/changeset/d95c583611f8/|d95c583611f8]] or later|| || 1.4.x and later || [[http://bitbucket.org/tksoh/hgshelve/changeset/276d8083dc3b/|276d8083dc3b]] or later|| || 1.3.x || [[http://bitbucket.org/tksoh/hgshelve/changeset/18815655993b/|18815655993b]] or later|| || 1.1.x - 1.2.x || [[http://bitbucket.org/tksoh/hgshelve/changeset/7090a3ed2da7/|7090a3ed2da7]] || || < 1.1.x || [[http://bitbucket.org/tksoh/hgshelve/changeset/ef85a6331d31/|ef85a6331d31]] || === Configuration === Configure your .hgrc to enable the extension by adding following lines: |
Configure your ''`.hgrc`'' to enable the extension by adding following lines: |
| Line 30: | Line 22: |
| hgshelve=/path/to/hgshelve.py | shelve= |
| Line 33: | Line 25: |
| or place hgshelve.py in your 'hgext' directory and add the following lines: | == Usage == |
| Line 35: | Line 27: |
| {{{ [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 }}} === Usage === (this is only a description of the basic usage) |
Temporarily stash away changes: |
| Line 55: | Line 32: |
| Temporarily stash away changes. You can select the exact hunks of changes you want to shelve. | List all existing shelves: {{{ hg shelve --list }}} |
| Line 57: | Line 37: |
| Get the changes back into the working directory: | |
| Line 61: | Line 42: |
| Get the changes back into the workdir. | Shelves can be given custom names (the default name is your active bookmark or branch): {{{ hg shelve --name <name> hg unshelve <name> }}} |
| Line 63: | Line 48: |
| See `hg shelve --help` for advance usage. | |
| Line 64: | Line 50: |
| === Hunks selection === | == See also == * ThirdPartyShelveExtension * AtticExtension * [[/Talk|Talk]] page |
| Line 66: | Line 55: |
| {{{ 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 }}} |
|
| Line 80: | Line 56: |
| CategoryExtensionsByOthers | CategoryBundledExtension |
Shelve Extension
This extension is distributed with Mercurial 2.8 and later. If you are using an earlier version of Mercurial, see ThirdPartyShelveExtension.
Author: Bryan O'Sullivan
Current maintainer: Facebook
Contents
1. Overview
The shelve extension lets you set your pending changes aside temporarily and restore them at a later time. It is useful in situations where you need to switch tasks, but are not ready to commit your current work.
2. Configuration
Configure your .hgrc to enable the extension by adding following lines:
[extensions] shelve=
3. Usage
Temporarily stash away changes:
hg shelve
List all existing shelves:
hg shelve --list
Get the changes back into the working directory:
hg unshelve
Shelves can be given custom names (the default name is your active bookmark or branch):
hg shelve --name <name> hg unshelve <name>
See hg shelve --help for advance usage.