|
Size: 6683
Comment:
|
← Revision 45 as of 2020-07-05 06:29:48 ⇥
Size: 1322
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 = |
| 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 == '''As of Mercurial 5.1, shelve is part of Mercurial core and is enabled by default.''' |
| Line 17: | Line 19: |
| || '''Mercurial''' || '''Shelve Extension''' || || 1.6 and later || [[http://bitbucket.org/tksoh/hgshelve/changeset/41e13e800fb6/|41e13e800fb6]] or later|| || 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: |
If you are using an earlier version of Mercurial, configure your ''`.hgrc`'' to enable the extension by adding following lines: |
| Line 31: | Line 23: |
| hgshelve=/path/to/hgshelve.py | shelve= |
| Line 34: | Line 26: |
| or place hgshelve.py in your 'hgext' directory and add the following lines: | == Usage == |
| Line 36: | Line 28: |
| {{{ [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 56: | Line 33: |
| Temporarily stash away changes. You can select the exact hunks of changes you want to shelve. |
List all existing shelves: |
| Line 59: | Line 35: |
| hg shelve --all | hg shelve --list |
| Line 62: | Line 38: |
| Temporarily stash away changes. All hunks will automatically be selected. |
Get the changes back into the working directory: |
| Line 68: | 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 76: | Line 45: |
| hg shelve --name myshelf | hg shelve --name <name> hg unshelve <name> |
| Line 79: | Line 49: |
| Temporarily stash away changes to the shelf '''myshelf'''. Any changes already shelved to a different shelf will not be included. | See `hg shelve --help` for advance usage. |
| Line 81: | Line 51: |
| {{{ 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. === 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 also === AtticExtension === Feature Requests === I'd like to copy this comment from the RecordExtension page, as it equally applies here (and I think even more because the workflow of removing unnecessary things first, then checking the result and then committing it is much more natural than just committing parts of your workspace and hope for the best. I would really like to have the ability to split hunks in this plugin. The problem is, that if there are multiple adjacent changes that have nothing to do with each other (like two new functions right next to each other) it is downright hard to commit them separately short of removing one, comitting and adding the other one again. --MartinHäcker Me too. git has this handy feature. --LesliePolzer How does git do this? --ThurnerRupert When using {{{git add -p}}}, you will enter the interactive mode, and do something similar with darcs|hg record. But in git you've the choice of 'e' to open up an editor, and edit the patch. There is an example[1] at the footer of this page. --WeakishJiang Yes, this feature of {{{darcs record}}} is missing. It would be great to have it. As described below, git does have it - using the '''e''' option to open an editor, like in darcs. However, I like the darcs approach, with a "before" and "after" section, better than the git approach of editing "+" and "-" markers. I find it cleaner. --YitzGale fyi: this has been available for some time with the CrecordExtension (based on RecordExtension), so maybe it wouldn't be too hard to incorporate some of the changes back into record. --MarkEdgington crecord uses a curses interface, but record uses merely command line. so it's not very easy to specify how to split the hunks in record. Besides, crecord provides line-level granularity, which in most case is sufficient. But in some edge cases, we may have two changes doing different things in ''one'' line. The best practice I can think of right now is git's approach (manually editing the patch) explained above. --WeakishJiang I find crecord to be really clunky when dealing with sizable patches. It's slow, and requires me to scroll a lot unnecessarily. In addition to the (decent) interface in [1], git also has a powerful "interactive" interface. It's not user-friendly, but once you figure it out, it's much more efficient than crecord, and much more powerful than record. --JustinLebar |
== See also == * ThirdPartyShelveExtension * AtticExtension * [[/Talk|Talk]] page |
| Line 141: | Line 57: |
Footnotes: [1] a git example: {{{#!diff $ git add -p f.c diff --git a/f.c b/f.c index a32488e..cf4b43e 100644 --- a/f.c +++ b/f.c @@ -1,2 +1,4 @@ -void splodge(int c) { +int blorf() { return s_blorfulocity / s_RAT; } + +void splodge(long c) { } Stage this hunk [y/n/a/d/e/?]? e 4) External editor opens up with this content # Manual hunk edit mode -- see bottom for a quick guide @@ -1,2 +1,4 @@ -void splodge(int c) { +int blorf() { return s_blorfulocity / s_RAT; } + +void splodge(long c) { } # --- # To remove '-' lines, make them ' ' lines (context). # To remove '+' lines, delete them. # Lines starting with # will be removed. # # If the patch applies cleanly, the edited hunk will immediately be # marked for staging. If it does not apply cleanly, you will be given # an opportunity to edit again. If all lines of the hunk are removed, # then the edit is aborted and the hunk is left unchanged. }}} ---- ---- 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
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.