Differences between revisions 2 and 45 (spanning 43 versions)
Revision 2 as of 2008-01-13 19:24:05
Size: 778
Editor: abuehl
Comment: cat
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 1: Line 1:
= Shelve extension = #pragma section-numbers 2
= 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''

<<TableOfContents>>

== 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.

== 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:
Line 4: Line 22:
interactively select changes to set aside

If a list of files is omitted, all changes reported by "hg status"
will be candidates for shelveing.

You will be prompted for whether to shelve changes to each
modified file, and for files with multiple changes, for each
change to use. For each query, the following responses are
possible:

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
[extensions]
shelve=
Line 27: Line 26:
[http://www.nabble.com/-ANN--shelve-extension-td12696573.html Initial announcement message.] == 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.

== See also ==
 * ThirdPartyShelveExtension
 * AtticExtension
 * [[/Talk|Talk]] page
Line 29: Line 57:
CategoryExtension 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)