Differences between revisions 41 and 45 (spanning 4 versions)
Revision 41 as of 2013-11-07 19:23:32
Size: 865
Editor: Rain
Comment:
Revision 45 as of 2020-07-05 06:29:48
Size: 1322
Editor: DanKurtz
Comment: Document that shelve is part of core and no longer needs to be enabled explicitly.
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
'''This extension is distributed with Mercurial 2.8 and later.''' '''This extension is distributed with Mercurial 2.8 and later. If you are using an earlier version of Mercurial, see ThirdPartyShelveExtension.'''
Line 14: Line 14:
The shelve extension lets you set the changes in your working directory aside temporarily and restore them. 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 17: Line 17:
'''As of Mercurial 5.1, shelve is part of Mercurial core and is enabled by default.'''
Line 18: Line 19:
Configure your ''`.hgrc`'' to enable the extension by adding following lines: If you are using an earlier version of Mercurial, configure your ''`.hgrc`'' to enable the extension by adding following lines:
Line 27: Line 28:
(this is only a description of the basic usage)
Temporarily stash away changes:
Line 33: Line 33:
Temporarily stash away changes.
List all existing shelves:
Line 39: Line 38:
List all existing shelves.
Get the changes back into the working directory:
Line 45: Line 43:
Get the changes back into the working directory. 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.
Line 53: Line 57:
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

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

As of Mercurial 5.1, shelve is part of Mercurial core and is enabled by default.

If you are using an earlier version of Mercurial, 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.

4. See also


CategoryBundledExtension

ShelveExtension (last edited 2020-07-05 06:29:48 by DanKurtz)