shelve: add interactive mode command line option

hgext/shelve.py

@@ -1,722 +1,725 b''
 # shelve.py - save/restore working directory state
 #
 # Copyright 2013 Facebook, Inc.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """save and restore changes to the working directory
 
 The "hg shelve" command saves changes made to the working directory
 and reverts those changes, resetting the working directory to a clean
 state.
 
 Later on, the "hg unshelve" command restores the changes saved by "hg
 shelve". Changes can be restored even after updating to a different
 parent, in which case Mercurial's merge machinery will resolve any
 conflicts if necessary.
 
 You can have more than one shelved change outstanding at a time; each
 shelved change has a distinct name. For details, see the help for "hg
 shelve".
 """
 
 from mercurial.i18n import _
 from mercurial.node import nullid, nullrev, bin, hex
 from mercurial import changegroup, cmdutil, scmutil, phases, commands
 from mercurial import error, hg, mdiff, merge, patch, repair, util
 from mercurial import templatefilters, exchange, bundlerepo
 from mercurial import lock as lockmod
 from hgext import rebase
 import errno
 
 cmdtable = {}
 command = cmdutil.command(cmdtable)
 testedwith = 'internal'
 
 class shelvedfile(object):
     """Helper for the file storing a single shelve
 
     Handles common functions on shelve files (.hg/.patch) using
     the vfs layer"""
     def __init__(self, repo, name, filetype=None):
         self.repo = repo
         self.name = name
         self.vfs = scmutil.vfs(repo.join('shelved'))
         self.ui = self.repo.ui
         if filetype:
             self.fname = name + '.' + filetype
         else:
             self.fname = name
 
     def exists(self):
         return self.vfs.exists(self.fname)
 
     def filename(self):
         return self.vfs.join(self.fname)
 
     def unlink(self):
         util.unlink(self.filename())
 
     def stat(self):
         return self.vfs.stat(self.fname)
 
     def opener(self, mode='rb'):
         try:
             return self.vfs(self.fname, mode)
         except IOError, err:
             if err.errno != errno.ENOENT:
                 raise
             raise util.Abort(_("shelved change '%s' not found") % self.name)
 
     def applybundle(self):
         fp = self.opener()
         try:
             gen = exchange.readbundle(self.repo.ui, fp, self.fname, self.vfs)
             changegroup.addchangegroup(self.repo, gen, 'unshelve',
                                        'bundle:' + self.vfs.join(self.fname),
                                        targetphase=phases.secret)
         finally:
             fp.close()
 
     def bundlerepo(self):
         return bundlerepo.bundlerepository(self.repo.baseui, self.repo.root,
                                            self.vfs.join(self.fname))
     def writebundle(self, cg):
         changegroup.writebundle(self.ui, cg, self.fname, 'HG10UN', self.vfs)
 
 class shelvedstate(object):
     """Handle persistence during unshelving operations.
 
     Handles saving and restoring a shelved state. Ensures that different
     versions of a shelved state are possible and handles them appropriately.
     """
     _version = 1
     _filename = 'shelvedstate'
 
     @classmethod
     def load(cls, repo):
         fp = repo.vfs(cls._filename)
         try:
             version = int(fp.readline().strip())
 
             if version != cls._version:
                 raise util.Abort(_('this version of shelve is incompatible '
                                    'with the version used in this repo'))
             name = fp.readline().strip()
             wctx = fp.readline().strip()
             pendingctx = fp.readline().strip()
             parents = [bin(h) for h in fp.readline().split()]
             stripnodes = [bin(h) for h in fp.readline().split()]
         finally:
             fp.close()
 
         obj = cls()
         obj.name = name
         obj.wctx = repo[bin(wctx)]
         obj.pendingctx = repo[bin(pendingctx)]
         obj.parents = parents
         obj.stripnodes = stripnodes
 
         return obj
 
     @classmethod
     def save(cls, repo, name, originalwctx, pendingctx, stripnodes):
         fp = repo.vfs(cls._filename, 'wb')
         fp.write('%i\n' % cls._version)
         fp.write('%s\n' % name)
         fp.write('%s\n' % hex(originalwctx.node()))
         fp.write('%s\n' % hex(pendingctx.node()))
         fp.write('%s\n' % ' '.join([hex(p) for p in repo.dirstate.parents()]))
         fp.write('%s\n' % ' '.join([hex(n) for n in stripnodes]))
         fp.close()
 
     @classmethod
     def clear(cls, repo):
         util.unlinkpath(repo.join(cls._filename), ignoremissing=True)
 
 def createcmd(ui, repo, pats, opts):
     """subcommand that creates a new shelve"""
 
     def publicancestors(ctx):
         """Compute the public ancestors of a commit.
 
         Much faster than the revset ancestors(ctx) & draft()"""
         seen = set([nullrev])
         visit = util.deque()
         visit.append(ctx)
         while visit:
             ctx = visit.popleft()
             yield ctx.node()
             for parent in ctx.parents():
                 rev = parent.rev()
                 if rev not in seen:
                     seen.add(rev)
                     if parent.mutable():
                         visit.append(parent)
 
     wctx = repo[None]
     parents = wctx.parents()
     if len(parents) > 1:
         raise util.Abort(_('cannot shelve while merging'))
     parent = parents[0]
 
     # we never need the user, so we use a generic user for all shelve operations
     user = 'shelve@localhost'
     label = repo._bookmarkcurrent or parent.branch() or 'default'
 
     # slashes aren't allowed in filenames, therefore we rename it
     label = label.replace('/', '_')
 
     def gennames():
         yield label
         for i in xrange(1, 100):
             yield '%s-%02d' % (label, i)
 
     def commitfunc(ui, repo, message, match, opts):
         hasmq = util.safehasattr(repo, 'mq')
         if hasmq:
             saved, repo.mq.checkapplied = repo.mq.checkapplied, False
         backup = repo.ui.backupconfig('phases', 'new-commit')
         try:
             repo.ui. setconfig('phases', 'new-commit', phases.secret)
             editor = cmdutil.getcommiteditor(editform='shelve.shelve', **opts)
             return repo.commit(message, user, opts.get('date'), match,
                                editor=editor)
         finally:
             repo.ui.restoreconfig(backup)
             if hasmq:
                 repo.mq.checkapplied = saved
 
     if parent.node() != nullid:
         desc = "changes to '%s'" % parent.description().split('\n', 1)[0]
     else:
         desc = '(changes in empty repository)'
 
     if not opts['message']:
         opts['message'] = desc
 
     name = opts['name']
 
     wlock = lock = tr = bms = None
     try:
         wlock = repo.wlock()
         lock = repo.lock()
 
         bms = repo._bookmarks.copy()
         # use an uncommitted transaction to generate the bundle to avoid
         # pull races. ensure we don't print the abort message to stderr.
         tr = repo.transaction('commit', report=lambda x: None)
 
         if name:
             if shelvedfile(repo, name, 'hg').exists():
                 raise util.Abort(_("a shelved change named '%s' already exists")
                                  % name)
         else:
             for n in gennames():
                 if not shelvedfile(repo, n, 'hg').exists():
                     name = n
                     break
             else:
                 raise util.Abort(_("too many shelved changes named '%s'") %
                                  label)
 
         # ensure we are not creating a subdirectory or a hidden file
         if '/' in name or '\\' in name:
             raise util.Abort(_('shelved change names may not contain slashes'))
         if name.startswith('.'):
             raise util.Abort(_("shelved change names may not start with '.'"))
+        interactive = opts.get('interactive', False)
 
         node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
 
         if not node:
             stat = repo.status(match=scmutil.match(repo[None], pats, opts))
             if stat.deleted:
                 ui.status(_("nothing changed (%d missing files, see "
                             "'hg status')\n") % len(stat.deleted))
             else:
                 ui.status(_("nothing changed\n"))
             return 1
 
         bases = list(publicancestors(repo[node]))
         cg = changegroup.changegroupsubset(repo, bases, [node], 'shelve')
         shelvedfile(repo, name, 'hg').writebundle(cg)
         cmdutil.export(repo, [node],
                        fp=shelvedfile(repo, name, 'patch').opener('wb'),
                        opts=mdiff.diffopts(git=True))
 
 
         if ui.formatted():
             desc = util.ellipsis(desc, ui.termwidth())
         ui.status(_('shelved as %s\n') % name)
         hg.update(repo, parent.node())
     finally:
         if bms:
             # restore old bookmarks
             repo._bookmarks.update(bms)
             repo._bookmarks.write()
         if tr:
             tr.abort()
         lockmod.release(lock, wlock)
 
 def cleanupcmd(ui, repo):
     """subcommand that deletes all shelves"""
 
     wlock = None
     try:
         wlock = repo.wlock()
         for (name, _type) in repo.vfs.readdir('shelved'):
             suffix = name.rsplit('.', 1)[-1]
             if suffix in ('hg', 'patch'):
                 shelvedfile(repo, name).unlink()
     finally:
         lockmod.release(wlock)
 
 def deletecmd(ui, repo, pats):
     """subcommand that deletes a specific shelve"""
     if not pats:
         raise util.Abort(_('no shelved changes specified!'))
     wlock = None
     try:
         wlock = repo.wlock()
         try:
             for name in pats:
                 for suffix in 'hg patch'.split():
                     shelvedfile(repo, name, suffix).unlink()
         except OSError, err:
             if err.errno != errno.ENOENT:
                 raise
             raise util.Abort(_("shelved change '%s' not found") % name)
     finally:
         lockmod.release(wlock)
 
 def listshelves(repo):
     """return all shelves in repo as list of (time, filename)"""
     try:
         names = repo.vfs.readdir('shelved')
     except OSError, err:
         if err.errno != errno.ENOENT:
             raise
         return []
     info = []
     for (name, _type) in names:
         pfx, sfx = name.rsplit('.', 1)
         if not pfx or sfx != 'patch':
             continue
         st = shelvedfile(repo, name).stat()
         info.append((st.st_mtime, shelvedfile(repo, pfx).filename()))
     return sorted(info, reverse=True)
 
 def listcmd(ui, repo, pats, opts):
     """subcommand that displays the list of shelves"""
     pats = set(pats)
     width = 80
     if not ui.plain():
         width = ui.termwidth()
     namelabel = 'shelve.newest'
     for mtime, name in listshelves(repo):
         sname = util.split(name)[1]
         if pats and sname not in pats:
             continue
         ui.write(sname, label=namelabel)
         namelabel = 'shelve.name'
         if ui.quiet:
             ui.write('\n')
             continue
         ui.write(' ' * (16 - len(sname)))
         used = 16
         age = '(%s)' % templatefilters.age(util.makedate(mtime), abbrev=True)
         ui.write(age, label='shelve.age')
         ui.write(' ' * (12 - len(age)))
         used += 12
         fp = open(name + '.patch', 'rb')
         try:
             while True:
                 line = fp.readline()
                 if not line:
                     break
                 if not line.startswith('#'):
                     desc = line.rstrip()
                     if ui.formatted():
                         desc = util.ellipsis(desc, width - used)
                     ui.write(desc)
                     break
             ui.write('\n')
             if not (opts['patch'] or opts['stat']):
                 continue
             difflines = fp.readlines()
             if opts['patch']:
                 for chunk, label in patch.difflabel(iter, difflines):
                     ui.write(chunk, label=label)
             if opts['stat']:
                 for chunk, label in patch.diffstatui(difflines, width=width,
                                                      git=True):
                     ui.write(chunk, label=label)
         finally:
             fp.close()
 
 def checkparents(repo, state):
     """check parent while resuming an unshelve"""
     if state.parents != repo.dirstate.parents():
         raise util.Abort(_('working directory parents do not match unshelve '
                            'state'))
 
 def pathtofiles(repo, files):
     cwd = repo.getcwd()
     return [repo.pathto(f, cwd) for f in files]
 
 def unshelveabort(ui, repo, state, opts):
     """subcommand that abort an in-progress unshelve"""
     wlock = repo.wlock()
     lock = None
     try:
         checkparents(repo, state)
 
         util.rename(repo.join('unshelverebasestate'),
                     repo.join('rebasestate'))
         try:
             rebase.rebase(ui, repo, **{
                 'abort' : True
             })
         except Exception:
             util.rename(repo.join('rebasestate'),
                         repo.join('unshelverebasestate'))
             raise
 
         lock = repo.lock()
 
         mergefiles(ui, repo, state.wctx, state.pendingctx)
 
         repair.strip(ui, repo, state.stripnodes, backup=False, topic='shelve')
         shelvedstate.clear(repo)
         ui.warn(_("unshelve of '%s' aborted\n") % state.name)
     finally:
         lockmod.release(lock, wlock)
 
 def mergefiles(ui, repo, wctx, shelvectx):
     """updates to wctx and merges the changes from shelvectx into the
     dirstate."""
     oldquiet = ui.quiet
     try:
         ui.quiet = True
         hg.update(repo, wctx.node())
         files = []
         files.extend(shelvectx.files())
         files.extend(shelvectx.parents()[0].files())
 
         # revert will overwrite unknown files, so move them out of the way
         for file in repo.status(unknown=True).unknown:
             if file in files:
                 util.rename(file, file + ".orig")
         ui.pushbuffer(True)
         cmdutil.revert(ui, repo, shelvectx, repo.dirstate.parents(),
                        *pathtofiles(repo, files),
                        **{'no_backup': True})
         ui.popbuffer()
     finally:
         ui.quiet = oldquiet
 
 def unshelvecleanup(ui, repo, name, opts):
     """remove related files after an unshelve"""
     if not opts['keep']:
         for filetype in 'hg patch'.split():
             shelvedfile(repo, name, filetype).unlink()
 
 def unshelvecontinue(ui, repo, state, opts):
     """subcommand to continue an in-progress unshelve"""
     # We're finishing off a merge. First parent is our original
     # parent, second is the temporary "fake" commit we're unshelving.
     wlock = repo.wlock()
     lock = None
     try:
         checkparents(repo, state)
         ms = merge.mergestate(repo)
         if [f for f in ms if ms[f] == 'u']:
             raise util.Abort(
                 _("unresolved conflicts, can't continue"),
                 hint=_("see 'hg resolve', then 'hg unshelve --continue'"))
 
         lock = repo.lock()
 
         util.rename(repo.join('unshelverebasestate'),
                     repo.join('rebasestate'))
         try:
             rebase.rebase(ui, repo, **{
                 'continue' : True
             })
         except Exception:
             util.rename(repo.join('rebasestate'),
                         repo.join('unshelverebasestate'))
             raise
 
         shelvectx = repo['tip']
         if not shelvectx in state.pendingctx.children():
             # rebase was a no-op, so it produced no child commit
             shelvectx = state.pendingctx
         else:
             # only strip the shelvectx if the rebase produced it
             state.stripnodes.append(shelvectx.node())
 
         mergefiles(ui, repo, state.wctx, shelvectx)
 
         repair.strip(ui, repo, state.stripnodes, backup=False, topic='shelve')
         shelvedstate.clear(repo)
         unshelvecleanup(ui, repo, state.name, opts)
         ui.status(_("unshelve of '%s' complete\n") % state.name)
     finally:
         lockmod.release(lock, wlock)
 
 @command('unshelve',
          [('a', 'abort', None,
            _('abort an incomplete unshelve operation')),
           ('c', 'continue', None,
            _('continue an incomplete unshelve operation')),
           ('', 'keep', None,
            _('keep shelve after unshelving')),
           ('', 'date', '',
            _('set date for temporary commits (DEPRECATED)'), _('DATE'))],
          _('hg unshelve [SHELVED]'))
 def unshelve(ui, repo, *shelved, **opts):
     """restore a shelved change to the working directory
 
     This command accepts an optional name of a shelved change to
     restore. If none is given, the most recent shelved change is used.
 
     If a shelved change is applied successfully, the bundle that
     contains the shelved changes is deleted afterwards.
 
     Since you can restore a shelved change on top of an arbitrary
     commit, it is possible that unshelving will result in a conflict
     between your changes and the commits you are unshelving onto. If
     this occurs, you must resolve the conflict, then use
     ``--continue`` to complete the unshelve operation. (The bundle
     will not be deleted until you successfully complete the unshelve.)
 
     (Alternatively, you can use ``--abort`` to abandon an unshelve
     that causes a conflict. This reverts the unshelved changes, and
     does not delete the bundle.)
     """
     abortf = opts['abort']
     continuef = opts['continue']
     if not abortf and not continuef:
         cmdutil.checkunfinished(repo)
 
     if abortf or continuef:
         if abortf and continuef:
             raise util.Abort(_('cannot use both abort and continue'))
         if shelved:
             raise util.Abort(_('cannot combine abort/continue with '
                                'naming a shelved change'))
 
         try:
             state = shelvedstate.load(repo)
         except IOError, err:
             if err.errno != errno.ENOENT:
                 raise
             raise util.Abort(_('no unshelve operation underway'))
 
         if abortf:
             return unshelveabort(ui, repo, state, opts)
         elif continuef:
             return unshelvecontinue(ui, repo, state, opts)
     elif len(shelved) > 1:
         raise util.Abort(_('can only unshelve one change at a time'))
     elif not shelved:
         shelved = listshelves(repo)
         if not shelved:
             raise util.Abort(_('no shelved changes to apply!'))
         basename = util.split(shelved[0][1])[1]
         ui.status(_("unshelving change '%s'\n") % basename)
     else:
         basename = shelved[0]
 
     if not shelvedfile(repo, basename, 'patch').exists():
         raise util.Abort(_("shelved change '%s' not found") % basename)
 
     oldquiet = ui.quiet
     wlock = lock = tr = None
     try:
         lock = repo.lock()
         wlock = repo.wlock()
 
         tr = repo.transaction('unshelve', report=lambda x: None)
         oldtiprev = len(repo)
 
         pctx = repo['.']
         tmpwctx = pctx
         # The goal is to have a commit structure like so:
         # ...-> pctx -> tmpwctx -> shelvectx
         # where tmpwctx is an optional commit with the user's pending changes
         # and shelvectx is the unshelved changes. Then we merge it all down
         # to the original pctx.
 
         # Store pending changes in a commit
         s = repo.status()
         if s.modified or s.added or s.removed or s.deleted:
             ui.status(_("temporarily committing pending changes "
                         "(restore with 'hg unshelve --abort')\n"))
             def commitfunc(ui, repo, message, match, opts):
                 hasmq = util.safehasattr(repo, 'mq')
                 if hasmq:
                     saved, repo.mq.checkapplied = repo.mq.checkapplied, False
 
                 backup = repo.ui.backupconfig('phases', 'new-commit')
                 try:
                     repo.ui. setconfig('phases', 'new-commit', phases.secret)
                     return repo.commit(message, 'shelve@localhost',
                                        opts.get('date'), match)
                 finally:
                     repo.ui.restoreconfig(backup)
                     if hasmq:
                         repo.mq.checkapplied = saved
 
             tempopts = {}
             tempopts['message'] = "pending changes temporary commit"
             tempopts['date'] = opts.get('date')
             ui.quiet = True
             node = cmdutil.commit(ui, repo, commitfunc, [], tempopts)
             tmpwctx = repo[node]
 
         ui.quiet = True
         shelvedfile(repo, basename, 'hg').applybundle()
 
         ui.quiet = oldquiet
 
         shelvectx = repo['tip']
 
         # If the shelve is not immediately on top of the commit
         # we'll be merging with, rebase it to be on top.
         if tmpwctx.node() != shelvectx.parents()[0].node():
             ui.status(_('rebasing shelved changes\n'))
             try:
                 rebase.rebase(ui, repo, **{
                     'rev' : [shelvectx.rev()],
                     'dest' : str(tmpwctx.rev()),
                     'keep' : True,
                 })
             except error.InterventionRequired:
                 tr.close()
 
                 stripnodes = [repo.changelog.node(rev)
                               for rev in xrange(oldtiprev, len(repo))]
                 shelvedstate.save(repo, basename, pctx, tmpwctx, stripnodes)
 
                 util.rename(repo.join('rebasestate'),
                             repo.join('unshelverebasestate'))
                 raise error.InterventionRequired(
                     _("unresolved conflicts (see 'hg resolve', then "
                       "'hg unshelve --continue')"))
 
             # refresh ctx after rebase completes
             shelvectx = repo['tip']
 
             if not shelvectx in tmpwctx.children():
                 # rebase was a no-op, so it produced no child commit
                 shelvectx = tmpwctx
 
         mergefiles(ui, repo, pctx, shelvectx)
         shelvedstate.clear(repo)
 
         # The transaction aborting will strip all the commits for us,
         # but it doesn't update the inmemory structures, so addchangegroup
         # hooks still fire and try to operate on the missing commits.
         # Clean up manually to prevent this.
         repo.unfiltered().changelog.strip(oldtiprev, tr)
 
         unshelvecleanup(ui, repo, basename, opts)
     finally:
         ui.quiet = oldquiet
         if tr:
             tr.release()
         lockmod.release(lock, wlock)
 
 @command('shelve',
          [('A', 'addremove', None,
            _('mark new/missing files as added/removed before shelving')),
           ('', 'cleanup', None,
            _('delete all shelved changes')),
           ('', 'date', '',
            _('shelve with the specified commit date'), _('DATE')),
           ('d', 'delete', None,
            _('delete the named shelved change(s)')),
           ('e', 'edit', False,
            _('invoke editor on commit messages')),
           ('l', 'list', None,
            _('list current shelves')),
           ('m', 'message', '',
            _('use text as shelve message'), _('TEXT')),
           ('n', 'name', '',
            _('use the given name for the shelved commit'), _('NAME')),
           ('p', 'patch', None,
            _('show patch')),
+          ('i', 'interactive', None,
+           _('interactive mode, only works while creating a shelve')),
           ('', 'stat', None,
            _('output diffstat-style summary of changes'))] + commands.walkopts,
          _('hg shelve [OPTION]... [FILE]...'))
 def shelvecmd(ui, repo, *pats, **opts):
     '''save and set aside changes from the working directory
 
     Shelving takes files that "hg status" reports as not clean, saves
     the modifications to a bundle (a shelved change), and reverts the
     files so that their state in the working directory becomes clean.
 
     To restore these changes to the working directory, using "hg
     unshelve"; this will work even if you switch to a different
     commit.
 
     When no files are specified, "hg shelve" saves all not-clean
     files. If specific files or directories are named, only changes to
     those files are shelved.
 
     Each shelved change has a name that makes it easier to find later.
     The name of a shelved change defaults to being based on the active
     bookmark, or if there is no active bookmark, the current named
     branch.  To specify a different name, use ``--name``.
 
     To see a list of existing shelved changes, use the ``--list``
     option. For each shelved change, this will print its name, age,
     and description; use ``--patch`` or ``--stat`` for more details.
 
     To delete specific shelved changes, use ``--delete``. To delete
     all shelved changes, use ``--cleanup``.
     '''
     cmdutil.checkunfinished(repo)
 
     allowables = [
         ('addremove', 'create'), # 'create' is pseudo action
         ('cleanup', 'cleanup'),
 #       ('date', 'create'), # ignored for passing '--date "0 0"' in tests
         ('delete', 'delete'),
         ('edit', 'create'),
         ('list', 'list'),
         ('message', 'create'),
         ('name', 'create'),
         ('patch', 'list'),
         ('stat', 'list'),
     ]
     def checkopt(opt):
         if opts[opt]:
             for i, allowable in allowables:
                 if opts[i] and opt != allowable:
                     raise util.Abort(_("options '--%s' and '--%s' may not be "
                                        "used together") % (opt, i))
             return True
     if checkopt('cleanup'):
         if pats:
             raise util.Abort(_("cannot specify names when using '--cleanup'"))
         return cleanupcmd(ui, repo)
     elif checkopt('delete'):
         return deletecmd(ui, repo, pats)
     elif checkopt('list'):
         return listcmd(ui, repo, pats, opts)
     else:
         for i in ('patch', 'stat'):
             if opts[i]:
                 raise util.Abort(_("option '--%s' may not be "
                                    "used when shelving a change") % (i,))
         return createcmd(ui, repo, pats, opts)
 
 def extsetup(ui):
     cmdutil.unfinishedstates.append(
         [shelvedstate._filename, False, False,
          _('unshelve already in progress'),
          _("use 'hg unshelve --continue' or 'hg unshelve --abort'")])

tests/test-shelve.t

@@ -1,743 +1,794 b''
   $ cat <<EOF >> $HGRCPATH
   > [extensions]
   > mq =
   > shelve =
   > [defaults]
   > diff = --nodates --git
   > qnew = --date '0 0'
   > EOF
 
   $ hg init repo
   $ cd repo
   $ mkdir a b
   $ echo a > a/a
   $ echo b > b/b
   $ echo c > c
   $ echo d > d
   $ echo x > x
   $ hg addremove -q
 
+shelve has a help message
+  $ hg shelve -h
+  hg shelve [OPTION]... [FILE]...
+  
+  save and set aside changes from the working directory
+  
+      Shelving takes files that "hg status" reports as not clean, saves the
+      modifications to a bundle (a shelved change), and reverts the files so
+      that their state in the working directory becomes clean.
+  
+      To restore these changes to the working directory, using "hg unshelve";
+      this will work even if you switch to a different commit.
+  
+      When no files are specified, "hg shelve" saves all not-clean files. If
+      specific files or directories are named, only changes to those files are
+      shelved.
+  
+      Each shelved change has a name that makes it easier to find later. The
+      name of a shelved change defaults to being based on the active bookmark,
+      or if there is no active bookmark, the current named branch.  To specify a
+      different name, use "--name".
+  
+      To see a list of existing shelved changes, use the "--list" option. For
+      each shelved change, this will print its name, age, and description; use "
+      --patch" or "--stat" for more details.
+  
+      To delete specific shelved changes, use "--delete". To delete all shelved
+      changes, use "--cleanup".
+  
+  (use "hg help -e shelve" to show help for the shelve extension)
+  
+  options ([+] can be repeated):
+  
+   -A --addremove           mark new/missing files as added/removed before
+                            shelving
+      --cleanup             delete all shelved changes
+      --date DATE           shelve with the specified commit date
+   -d --delete              delete the named shelved change(s)
+   -e --edit                invoke editor on commit messages
+   -l --list                list current shelves
+   -m --message TEXT        use text as shelve message
+   -n --name NAME           use the given name for the shelved commit
+   -p --patch               show patch
+   -i --interactive         interactive mode, only works while creating a shelve
+      --stat                output diffstat-style summary of changes
+   -I --include PATTERN [+] include names matching the given patterns
+   -X --exclude PATTERN [+] exclude names matching the given patterns
+      --mq                  operate on patch repository
+  
+  (some details hidden, use --verbose to show complete help)
+
 shelving in an empty repo should be possible
 (this tests also that editor is not invoked, if '--edit' is not
 specified)
 
   $ HGEDITOR=cat hg shelve
   shelved as default
   0 files updated, 0 files merged, 5 files removed, 0 files unresolved
 
   $ hg unshelve
   unshelving change 'default'
 
   $ hg commit -q -m 'initial commit'
 
   $ hg shelve
   nothing changed
   [1]
 
 create an mq patch - shelving should work fine with a patch applied
 
   $ echo n > n
   $ hg add n
   $ hg commit n -m second
   $ hg qnew second.patch
 
 shelve a change that we will delete later
 
   $ echo a >> a/a
   $ hg shelve
   shelved as default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 set up some more complex changes to shelve
 
   $ echo a >> a/a
   $ hg mv b b.rename
   moving b/b to b.rename/b (glob)
   $ hg cp c c.copy
   $ hg status -C
   M a/a
   A b.rename/b
     b/b
   A c.copy
     c
   R b/b
 
 prevent some foot-shooting
 
   $ hg shelve -n foo/bar
   abort: shelved change names may not contain slashes
   [255]
   $ hg shelve -n .baz
   abort: shelved change names may not start with '.'
   [255]
 
 the common case - no options or filenames
 
   $ hg shelve
   shelved as default-01
   2 files updated, 0 files merged, 2 files removed, 0 files unresolved
   $ hg status -C
 
 ensure that our shelved changes exist
 
   $ hg shelve -l
   default-01      (*)* changes to '[mq]: second.patch' (glob)
   default         (*)* changes to '[mq]: second.patch' (glob)
 
   $ hg shelve -l -p default
   default         (*)* changes to '[mq]: second.patch' (glob)
   
   diff --git a/a/a b/a/a
   --- a/a/a
   +++ b/a/a
   @@ -1,1 +1,2 @@
    a
   +a
 
   $ hg shelve --list --addremove
   abort: options '--list' and '--addremove' may not be used together
   [255]
 
 delete our older shelved change
 
   $ hg shelve -d default
   $ hg qfinish -a -q
 
 local edits should not prevent a shelved change from applying
 
   $ printf "z\na\n" > a/a
   $ hg unshelve --keep
   unshelving change 'default-01'
   temporarily committing pending changes (restore with 'hg unshelve --abort')
   rebasing shelved changes
   rebasing 4:4702e8911fe0 "changes to '[mq]: second.patch'" (tip)
   merging a/a
 
   $ hg revert --all -q
   $ rm a/a.orig b.rename/b c.copy
 
 apply it and make sure our state is as expected
 
   $ hg unshelve
   unshelving change 'default-01'
   $ hg status -C
   M a/a
   A b.rename/b
     b/b
   A c.copy
     c
   R b/b
   $ hg shelve -l
 
   $ hg unshelve
   abort: no shelved changes to apply!
   [255]
   $ hg unshelve foo
   abort: shelved change 'foo' not found
   [255]
 
 named shelves, specific filenames, and "commit messages" should all work
 (this tests also that editor is invoked, if '--edit' is specified)
 
   $ hg status -C
   M a/a
   A b.rename/b
     b/b
   A c.copy
     c
   R b/b
   $ HGEDITOR=cat hg shelve -q -n wibble -m wat -e a
   wat
   
   
   HG: Enter commit message.  Lines beginning with 'HG:' are removed.
   HG: Leave message empty to abort commit.
   HG: --
   HG: user: shelve@localhost
   HG: branch 'default'
   HG: changed a/a
 
 expect "a" to no longer be present, but status otherwise unchanged
 
   $ hg status -C
   A b.rename/b
     b/b
   A c.copy
     c
   R b/b
   $ hg shelve -l --stat
   wibble          (*)    wat (glob)
    a/a |  1 +
    1 files changed, 1 insertions(+), 0 deletions(-)
 
 and now "a/a" should reappear
 
   $ cd a
   $ hg unshelve -q wibble
   $ cd ..
   $ hg status -C
   M a/a
   A b.rename/b
     b/b
   A c.copy
     c
   R b/b
 
 cause unshelving to result in a merge with 'a' conflicting
 
   $ hg shelve -q
   $ echo c>>a/a
   $ hg commit -m second
   $ hg tip --template '{files}\n'
   a/a
 
 add an unrelated change that should be preserved
 
   $ mkdir foo
   $ echo foo > foo/foo
   $ hg add foo/foo
 
 force a conflicted merge to occur
 
   $ hg unshelve
   unshelving change 'default'
   temporarily committing pending changes (restore with 'hg unshelve --abort')
   rebasing shelved changes
   rebasing 5:4702e8911fe0 "changes to '[mq]: second.patch'" (tip)
   merging a/a
   warning: conflicts during merge.
   merging a/a incomplete! (edit conflicts, then use 'hg resolve --mark')
   unresolved conflicts (see 'hg resolve', then 'hg unshelve --continue')
   [1]
 
 ensure that we have a merge with unresolved conflicts
 
   $ hg heads -q --template '{rev}\n'
   5
   4
   $ hg parents -q --template '{rev}\n'
   4
   5
   $ hg status
   M a/a
   M b.rename/b
   M c.copy
   R b/b
   ? a/a.orig
   $ hg diff
   diff --git a/a/a b/a/a
   --- a/a/a
   +++ b/a/a
   @@ -1,2 +1,6 @@
    a
   +<<<<<<< dest:   *  - shelve: pending changes temporary commit (glob)
    c
   +=======
   +a
   +>>>>>>> source: 4702e8911fe0 - shelve: changes to '[mq]: second.patch'
   diff --git a/b/b b/b.rename/b
   rename from b/b
   rename to b.rename/b
   diff --git a/c b/c.copy
   copy from c
   copy to c.copy
   $ hg resolve -l
   U a/a
 
   $ hg shelve
   abort: unshelve already in progress
   (use 'hg unshelve --continue' or 'hg unshelve --abort')
   [255]
 
 abort the unshelve and be happy
 
   $ hg status
   M a/a
   M b.rename/b
   M c.copy
   R b/b
   ? a/a.orig
   $ hg unshelve -a
   rebase aborted
   unshelve of 'default' aborted
   $ hg heads -q
   3:2e69b451d1ea
   $ hg parents
   changeset:   3:2e69b451d1ea
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     second
   
   $ hg resolve -l
   $ hg status
   A foo/foo
   ? a/a.orig
 
 try to continue with no unshelve underway
 
   $ hg unshelve -c
   abort: no unshelve operation underway
   [255]
   $ hg status
   A foo/foo
   ? a/a.orig
 
 redo the unshelve to get a conflict
 
   $ hg unshelve -q
   warning: conflicts during merge.
   merging a/a incomplete! (edit conflicts, then use 'hg resolve --mark')
   unresolved conflicts (see 'hg resolve', then 'hg unshelve --continue')
   [1]
 
 attempt to continue
 
   $ hg unshelve -c
   abort: unresolved conflicts, can't continue
   (see 'hg resolve', then 'hg unshelve --continue')
   [255]
 
   $ hg revert -r . a/a
   $ hg resolve -m a/a
   (no more unresolved files)
 
   $ hg commit -m 'commit while unshelve in progress'
   abort: unshelve already in progress
   (use 'hg unshelve --continue' or 'hg unshelve --abort')
   [255]
 
   $ hg unshelve -c
   rebasing 5:4702e8911fe0 "changes to '[mq]: second.patch'" (tip)
   unshelve of 'default' complete
 
 ensure the repo is as we hope
 
   $ hg parents
   changeset:   3:2e69b451d1ea
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     second
   
   $ hg heads -q
   3:2e69b451d1ea
 
   $ hg status -C
   A b.rename/b
     b/b
   A c.copy
     c
   A foo/foo
   R b/b
   ? a/a.orig
 
 there should be no shelves left
 
   $ hg shelve -l
 
 #if execbit
 
 ensure that metadata-only changes are shelved
 
   $ chmod +x a/a
   $ hg shelve -q -n execbit a/a
   $ hg status a/a
   $ hg unshelve -q execbit
   $ hg status a/a
   M a/a
   $ hg revert a/a
 
 #endif
 
 #if symlink
 
   $ rm a/a
   $ ln -s foo a/a
   $ hg shelve -q -n symlink a/a
   $ hg status a/a
   $ hg unshelve -q symlink
   $ hg status a/a
   M a/a
   $ hg revert a/a
 
 #endif
 
 set up another conflict between a commit and a shelved change
 
   $ hg revert -q -C -a
   $ rm a/a.orig b.rename/b c.copy
   $ echo a >> a/a
   $ hg shelve -q
   $ echo x >> a/a
   $ hg ci -m 'create conflict'
   $ hg add foo/foo
 
 if we resolve a conflict while unshelving, the unshelve should succeed
 
   $ HGMERGE=true hg unshelve
   unshelving change 'default'
   temporarily committing pending changes (restore with 'hg unshelve --abort')
   rebasing shelved changes
   rebasing 6:c5e6910e7601 "changes to 'second'" (tip)
   merging a/a
   note: rebase of 6:c5e6910e7601 created no changes to commit
   $ hg parents -q
   4:33f7f61e6c5e
   $ hg shelve -l
   $ hg status
   A foo/foo
   $ cat a/a
   a
   c
   x
 
 test keep and cleanup
 
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg shelve --list
   default         (*)    changes to 'create conflict' (glob)
   $ hg unshelve --keep
   unshelving change 'default'
   $ hg shelve --list
   default         (*)    changes to 'create conflict' (glob)
   $ hg shelve --cleanup
   $ hg shelve --list
 
   $ hg shelve --cleanup --delete
   abort: options '--cleanup' and '--delete' may not be used together
   [255]
   $ hg shelve --cleanup --patch
   abort: options '--cleanup' and '--patch' may not be used together
   [255]
   $ hg shelve --cleanup --message MESSAGE
   abort: options '--cleanup' and '--message' may not be used together
   [255]
 
 test bookmarks
 
   $ hg bookmark test
   $ hg bookmark
    * test                      4:33f7f61e6c5e
   $ hg shelve
   shelved as test
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg bookmark
    * test                      4:33f7f61e6c5e
   $ hg unshelve
   unshelving change 'test'
   $ hg bookmark
    * test                      4:33f7f61e6c5e
 
 shelve should still work even if mq is disabled
 
   $ hg --config extensions.mq=! shelve
   shelved as test
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg --config extensions.mq=! shelve --list
   test            (*)    changes to 'create conflict' (glob)
   $ hg --config extensions.mq=! unshelve
   unshelving change 'test'
 
 shelve should leave dirstate clean (issue4055)
 
   $ cd ..
   $ hg init shelverebase
   $ cd shelverebase
   $ printf 'x\ny\n' > x
   $ echo z > z
   $ hg commit -Aqm xy
   $ echo z >> x
   $ hg commit -Aqm z
   $ hg up 0
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ printf 'a\nx\ny\nz\n' > x
   $ hg commit -Aqm xyz
   $ echo c >> z
   $ hg shelve
   shelved as default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg rebase -d 1 --config extensions.rebase=
   rebasing 2:323bfa07f744 "xyz" (tip)
   merging x
   saved backup bundle to $TESTTMP/shelverebase/.hg/strip-backup/323bfa07f744-78114325-backup.hg (glob)
   $ hg unshelve
   unshelving change 'default'
   rebasing shelved changes
   rebasing 4:b8fefe789ed0 "changes to 'xyz'" (tip)
   $ hg status
   M z
 
   $ cd ..
 
 shelve should only unshelve pending changes (issue4068)
 
   $ hg init onlypendingchanges
   $ cd onlypendingchanges
   $ touch a
   $ hg ci -Aqm a
   $ touch b
   $ hg ci -Aqm b
   $ hg up -q 0
   $ touch c
   $ hg ci -Aqm c
 
   $ touch d
   $ hg add d
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg up -q 1
   $ hg unshelve
   unshelving change 'default'
   rebasing shelved changes
   rebasing 3:0cae6656c016 "changes to 'c'" (tip)
   $ hg status
   A d
 
 unshelve should work on an ancestor of the original commit
 
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg up 0
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg unshelve
   unshelving change 'default'
   rebasing shelved changes
   rebasing 3:be58f65f55fb "changes to 'b'" (tip)
   $ hg status
   A d
 
 test bug 4073 we need to enable obsolete markers for it
 
   $ cat >> $HGRCPATH << EOF
   > [experimental]
   > evolution=createmarkers
   > EOF
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg debugobsolete `hg --debug id -i -r 1`
   $ hg unshelve
   unshelving change 'default'
 
 unshelve should leave unknown files alone (issue4113)
 
   $ echo e > e
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg status
   ? e
   $ hg unshelve
   unshelving change 'default'
   $ hg status
   A d
   ? e
   $ cat e
   e
 
 unshelve should keep a copy of unknown files
 
   $ hg add e
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 2 files removed, 0 files unresolved
   $ echo z > e
   $ hg unshelve
   unshelving change 'default'
   $ cat e
   e
   $ cat e.orig
   z
 
 
 unshelve and conflicts with tracked and untracked files
 
  preparing:
 
   $ rm *.orig
   $ hg ci -qm 'commit stuff'
   $ hg phase -p null:
 
  no other changes - no merge:
 
   $ echo f > f
   $ hg add f
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo g > f
   $ hg unshelve
   unshelving change 'default'
   $ hg st
   A f
   ? f.orig
   $ cat f
   f
   $ cat f.orig
   g
 
  other uncommitted changes - merge:
 
   $ hg st
   A f
   ? f.orig
   $ hg shelve
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg log -G --template '{rev}  {desc|firstline}  {author}' -R bundle://.hg/shelved/default.hg -r 'bundle()'
   o  4  changes to 'commit stuff'  shelve@localhost
   |
   $ hg log -G --template '{rev}  {desc|firstline}  {author}'
   @  3  commit stuff  test
   |
   | o  2  c  test
   |/
   o  0  a  test
   
   $ mv f.orig f
   $ echo 1 > a
   $ hg unshelve --date '1073741824 0'
   unshelving change 'default'
   temporarily committing pending changes (restore with 'hg unshelve --abort')
   rebasing shelved changes
   rebasing 5:23b29cada8ba "changes to 'commit stuff'" (tip)
   merging f
   warning: conflicts during merge.
   merging f incomplete! (edit conflicts, then use 'hg resolve --mark')
   unresolved conflicts (see 'hg resolve', then 'hg unshelve --continue')
   [1]
   $ hg log -G --template '{rev}  {desc|firstline}  {author}  {date|isodate}'
   @  5  changes to 'commit stuff'  shelve@localhost  1970-01-01 00:00 +0000
   |
   | @  4  pending changes temporary commit  shelve@localhost  2004-01-10 13:37 +0000
   |/
   o  3  commit stuff  test  1970-01-01 00:00 +0000
   |
   | o  2  c  test  1970-01-01 00:00 +0000
   |/
   o  0  a  test  1970-01-01 00:00 +0000
   
   $ hg st
   M f
   ? f.orig
   $ cat f
   <<<<<<< dest:   5f6b880e719b  - shelve: pending changes temporary commit
   g
   =======
   f
   >>>>>>> source: 23b29cada8ba - shelve: changes to 'commit stuff'
   $ cat f.orig
   g
   $ hg unshelve --abort
   rebase aborted
   unshelve of 'default' aborted
   $ hg st
   M a
   ? f.orig
   $ cat f.orig
   g
   $ hg unshelve
   unshelving change 'default'
   temporarily committing pending changes (restore with 'hg unshelve --abort')
   rebasing shelved changes
   rebasing 5:23b29cada8ba "changes to 'commit stuff'" (tip)
   $ hg st
   M a
   A f
   ? f.orig
 
  other committed changes - merge:
 
   $ hg shelve f
   shelved as default
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg ci a -m 'intermediate other change'
   $ mv f.orig f
   $ hg unshelve
   unshelving change 'default'
   rebasing shelved changes
   rebasing 5:23b29cada8ba "changes to 'commit stuff'" (tip)
   merging f
   warning: conflicts during merge.
   merging f incomplete! (edit conflicts, then use 'hg resolve --mark')
   unresolved conflicts (see 'hg resolve', then 'hg unshelve --continue')
   [1]
   $ hg st
   M f
   ? f.orig
   $ cat f
   <<<<<<< dest:   *  - test: intermediate other change (glob)
   g
   =======
   f
   >>>>>>> source: 23b29cada8ba - shelve: changes to 'commit stuff'
   $ cat f.orig
   g
   $ hg unshelve --abort
   rebase aborted
   unshelve of 'default' aborted
   $ hg st
   ? f.orig
   $ cat f.orig
   g
   $ hg shelve --delete default
 
 Recreate some conflict again
 
   $ cd ../repo
   $ hg up -C -r 3
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (leaving bookmark test)
   $ echo y >> a/a
   $ hg shelve
   shelved as default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg up test
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (activating bookmark test)
   $ hg unshelve
   unshelving change 'default'
   rebasing shelved changes
   rebasing 5:4b555fdb4e96 "changes to 'second'" (tip)
   merging a/a
   warning: conflicts during merge.
   merging a/a incomplete! (edit conflicts, then use 'hg resolve --mark')
   unresolved conflicts (see 'hg resolve', then 'hg unshelve --continue')
   [1]
 
 Test that resolving all conflicts in one direction (so that the rebase
 is a no-op), works (issue4398)
 
   $ hg revert -a -r .
   reverting a/a (glob)
   $ hg resolve -m a/a
   (no more unresolved files)
   $ hg unshelve -c
   rebasing 5:4b555fdb4e96 "changes to 'second'" (tip)
   note: rebase of 5:4b555fdb4e96 created no changes to commit
   unshelve of 'default' complete
   $ hg diff
   $ hg status
   ? a/a.orig
   ? foo/foo
   $ hg summary
   parent: 4:33f7f61e6c5e tip
    create conflict
   branch: default
   bookmarks: *test
   commit: 2 unknown (clean)
   update: (current)
 
   $ hg shelve --delete --stat
   abort: options '--delete' and '--stat' may not be used together
   [255]
   $ hg shelve --delete --name NAME
   abort: options '--delete' and '--name' may not be used together
   [255]
 
   $ cd ..