Differences between revisions 37 and 45 (spanning 8 versions)

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

Overview
Configuration
Usage
See also

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

-  ⇤ ← Revision 37 as of 2013-08-05 22:56:01 → 
  Size: 4127
  Editor: balticom-142-114-156
  Comment: compatibility update for Mercurial 2.7
+   ← 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:
-'''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 6:
-''Author: TK Soh (<<MailTo(teekaysoh AT gmail DOT com)>>)''
+''Author: Bryan O'Sullivan''
 Line 8:
-''Current maintainer: Oleg Oshmyan (<<MailTo(chortos AT inbox DOT lv)>>)''

Repository: https://bitbucket.org/astiob/hgshelve
+''Current maintainer: Facebook''
-Line 16:
+Line 14:
-The shelve extension provides the `shelve` command to let 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.

== Compatibility with Mercurial ==

|| '''Mercurial''' || '''Shelve Extension''' ||
|| 2.7.x - || [[https://bitbucket.org/astiob/hgshelve/commits/62eece7dd02f|62eece7dd02f]] or later ||
|| 2.2.x - 2.6.x || [[https://bitbucket.org/astiob/hgshelve/commits/53dbf2e68dc6|53dbf2e68dc6]] to [[https://bitbucket.org/astiob/hgshelve/commits/f482f58b8054|f482f58b8054]] ||
|| 1.9.x - 2.1.x || [[https://bitbucket.org/astiob/hgshelve/commits/53dbf2e68dc6|53dbf2e68dc6]] to [[https://bitbucket.org/astiob/hgshelve/commits/80217a869c9b|80217a869c9b]] ||
|| 1.6.x - 1.8.x || [[https://bitbucket.org/astiob/hgshelve/commits/41e13e800fb6|41e13e800fb6]] to [[https://bitbucket.org/astiob/hgshelve/commits/3d7a2a3ae9a5|3d7a2a3ae9a5]] ||
|| 1.5.x || [[https://bitbucket.org/astiob/hgshelve/commits/d95c583611f8|d95c583611f8]] ||
|| 1.4.x || [[https://bitbucket.org/astiob/hgshelve/commits/276d8083dc3b|276d8083dc3b]] ||
|| 1.3.x || [[https://bitbucket.org/astiob/hgshelve/commits/18815655993b|18815655993b]] to [[https://bitbucket.org/astiob/hgshelve/commits/3920be7ffb42|3920be7ffb42]] ||
|| 1.1.x - 1.2.x || [[https://bitbucket.org/astiob/hgshelve/commits/7090a3ed2da7|7090a3ed2da7]] ||
|| < 1.1.x || [[https://bitbucket.org/astiob/hgshelve/commits/ef85a6331d31|ef85a6331d31]] ||

The source repository has tags denoting the last changesets compatible with particular versions of Mercurial.
+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 36:
+Line 17:
+'''As of Mercurial 5.1, shelve is part of Mercurial core and is enabled by default.'''
-Line 37:
+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 41:
+Line 23:
-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
+shelve=
-Line 60:
+Line 28:
-(this is only a description of the basic usage)
+Temporarily stash away changes:
-Line 66:
+Line 33:
-Temporarily stash away changes. You can select the exact hunks of changes you want to shelve.
+List all existing shelves:
-Line 69:
+Line 35:
-hg shelve --all
+hg shelve --list
-Line 72:
+Line 38:
-Temporarily stash away changes. All hunks will automatically be selected.
+Get the changes back into the working directory:
-Line 78:
+Line 43:
-Get the changes back into the workdir. 

=== Shelves ===

Different changesets can be saved 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.
+Shelves can be given custom names (the default name is your active bookmark or branch):
-Line 86:
+Line 45:
-hg shelve --name myshelf
+hg shelve --name <name>
hg unshelve <name>
-Line 89:
+Line 49:
-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 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.

=== 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
}}}
+See `hg shelve --help` for advance usage.
-Line 126:
+Line 52:
+ * ThirdPartyShelveExtension
-Line 130:
+Line 57:
-CategoryExtensionsByOthers
+CategoryBundledExtension

Diff for "ShelveExtension"

Shelve Extension

1. Overview

2. Configuration

3. Usage

4. See also