This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6479

shelve: first prototype of storing/restoring unresolved changes
AbandonedPublic

Authored by durin42 on Jun 5 2019, 2:39 PM.

Details

Reviewers
navaneeth.suresh
Group Reviewers
hg-reviewers
Summary

This is an RFC patch. This does three things:

  1. Adds an --unresolved flag to hg shelve.
  2. Adds an --unresolved flag to hg unshelve.
  3. Adds an experimental config option store-in-extra to handle storage method.

When experimental.store-in-extra == True:
The mergestate records are stored in changeset extras. I have used the storage
format supported for hg versions 3.7 or later. For the time being, I have omitted
the storage of the content of the local version of unresolved files.

Otherwise:
The usual mergestate information in $HGRCPATH/merge/ is moved to
$HGRCPATH/merge-unresolved/<basename>/.

After shelving, and the working directory is updated to p1().

Unresolved shelve changesets are stored with the extra mapping
{'unresolved-merge': True}. Also, hg shelve --patch and
hg shelve --list will show unresolved files separately as:

$ hg shelve --list
default (unresolved)         (1s ago)    changes to: C

hg shelve will abort when:

  1. No merge is active on calling with --unresolved.
  2. No unresolved files found in active merge on calling with --unresolved.
  3. Merge is active on calling without --unresolved.

hg unshelve --unresolved will get the user back to the old unresolved merge by
the following steps:

Step 1: If the user has committed new changesets after shelving the changes,
they must update the working directory to one of the merge parents.

Step 2: Change parents of dirstate to p1 and p2.

Step 3: In order to restore our partially resolved state, we will move the
contents of $HGRCPATH/merge-unresolved/<basename>/
to $HGRCPATH/merge/ if experimental.store-in-extra not
set True. Otherwise, we'll write from data stored in changeset extras.

Step 4: We now have a state in which files marked as resolved might have
conflicts. But, we will apply the changes in shelve on the top of this so that we
can get our old unresolved merge again by the usual unshelve mechanism.

The usual rebase step is avoided on unresolved shelve changesets. Also, we
use the functions present in merge.py to read/write mergestate records
from/to changeset extras.

$ hg unshelve --unresolved will abort when:

  1. The working directory is dirty.
  2. If there is an ongoing merge.
  3. If the working directory is not at either p1 or p2.

(p1, p2 are the parents of the unresolved shelve changeset)

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

pulkit added a subscriber: pulkit.Jun 10 2019, 10:40 AM

step 2: Internally, merge p1 with p2 with the merge tool :fail.
This will not update the contents of the files with conflicting changes.
Instead, it will mark them as unresolved.

Can we prevent merging again? Since we are getting content from old unresolved commit, copying mergestate from previously stored one, what purpose does this merging serves?

step 3: This internal merge will also mark the files which are already
resolved by the user in the unresolved shelve changeset as unresolved. But,
we will move the contents of $HGRCPATH/merge-unresolved/<basename>/
to $HGRCPATH/merge/ so that we can restore the partially resolved states.
step 4: We now have a state in which files marked as resolved might have
conflicts. But, we will apply the changes in shelve on the top of this so that we
can get our old unresolved merge again by the usual unshelve mechanism.
The usual rebase step is avoided on unresolved shelve changesets.

navaneeth.suresh added a comment.Jun 10 2019, 11:48 AM

Can we prevent merging again? Since we are getting content from old unresolved commit, copying mergestate from previously stored one, what purpose does this merging serves?

The usual unshelve mechanism restores the content of the files in the mergestate. However, we'll be still in a state with only one parent. This merge will help to recreate the exact same state with two parents.

pulkit added a comment.Jun 10 2019, 11:56 AM
In D6479#94555, @navaneeth.suresh wrote:

Can we prevent merging again? Since we are getting content from old unresolved commit, copying mergestate from previously stored one, what purpose does this merging serves?

The usual unshelve mechanism restores the content of the files in the mergestate. However, we'll be still in a state with only one parent. This merge will help to recreate the exact same state with two parents.

There are other ways to set the second parent, like dirstate.setparents() I think. It is worth investigating to find a way to do it without merging again.

navaneeth.suresh added a comment.Jun 10 2019, 12:00 PM
In D6479#94556, @pulkit wrote:
In D6479#94555, @navaneeth.suresh wrote:

Can we prevent merging again? Since we are getting content from old unresolved commit, copying mergestate from previously stored one, what purpose does this merging serves?

The usual unshelve mechanism restores the content of the files in the mergestate. However, we'll be still in a state with only one parent. This merge will help to recreate the exact same state with two parents.

There are other ways to set the second parent, like dirstate.setparents() I think. It is worth investigating to find a way to do it without merging again.

Interesting. Then, I shall investigate it and update the diff.

navaneeth.suresh edited the summary of this revision. (Show Details)Jun 10 2019, 12:29 PM
navaneeth.suresh updated this revision to Diff 15420.
pulkit added inline comments.Jun 10 2019, 12:35 PM
hgext/shelve.py
768

why do we need to do this?

770

if merge-unresolved/ does not exists, it means there are no unresolved shelves, right? we should not be creating it then.

1092

we can do this check by looking into shelvectx extras below.

navaneeth.suresh marked 2 inline comments as done.Jun 10 2019, 1:11 PM
navaneeth.suresh updated this revision to Diff 15423.
navaneeth.suresh marked an inline comment as done.Jun 10 2019, 1:12 PM
pulkit added inline comments.Jun 10 2019, 1:39 PM
hgext/shelve.py
771

vfs.rename should be used here.

navaneeth.suresh marked an inline comment as done.Jun 10 2019, 2:41 PM
navaneeth.suresh updated this revision to Diff 15431.
pulkit added inline comments.Jun 10 2019, 6:47 PM
hgext/shelve.py
764

the functions needs documentation.

769

this comment can be a part of function documentation.

navaneeth.suresh marked 2 inline comments as done.Jun 11 2019, 7:30 AM
navaneeth.suresh updated this revision to Diff 15435.
pulkit added a comment.Jun 11 2019, 2:06 PM

Can you fold both the commits, it will be better to see code for both storing and restoring mergestates in one patch.

hgext/shelve.py
772

Let's move this parent changing of dirstate out of this function. This functions should only have logic related to storing and restoring unresolved states.

1114

let's have shelvectx an optional argument to _isunresolvedshelve(). If shelvectx is passed we use that, otherwise we fallback to checking the directory in merge-unresolved/.

And then use that function here.

navaneeth.suresh marked 2 inline comments as done.Jun 11 2019, 3:21 PM
navaneeth.suresh updated this revision to Diff 15449.
navaneeth.suresh retitled this revision from unshelve: first prototype of restoring unresolved changes to shelve: first prototype of storing/restoring unresolved changes.Jun 11 2019, 3:45 PM
navaneeth.suresh edited the summary of this revision. (Show Details)
navaneeth.suresh updated this revision to Diff 15451.
navaneeth.suresh mentioned this in D6478: shelve: first prototype of storing unresolved changes.Jun 11 2019, 3:49 PM
In D6479#94711, @pulkit wrote:

Can you fold both the commits, it will be better to see code for both storing and restoring mergestates in one patch.

@pulkit I've folded the changesets and updated the revision. Abandoned D6478. This looks like a huge change though. No worries as this work more or less like an RFC patch.

navaneeth.suresh edited the summary of this revision. (Show Details)Jun 14 2019, 3:56 PM
navaneeth.suresh updated this revision to Diff 15517.
navaneeth.suresh added a comment.Jun 14 2019, 4:19 PM

Now, we have mergestate information storage in changeset level too with the help of extra mapping.

pulkit added inline comments.Jun 16 2019, 10:23 AM
tests/test-shelve-unresolved.t
138

this if and endif can be removed.

169

We can get rid of this #if and #endif too. the usualstorage one will have (unresolved) in the test output. We have functionality to have test output case wise which can be used.

For example, here we have two different outputs in py3 and non-py3 cases. https://www.mercurial-scm.org/repo/hg-committed/file/tip/tests/test-debugcommands.t#l213

253

we don't need this #if and #endif, it can be removed.

279

we don't need this #if and #endif, it can be removed.

344

we don't need this #if and #endif, it can be removed.

371

we don't need this #if and #endif, it can be removed.

442

we don't need this #if and #endif, it can be removed.

528

we don't need this #if and #endif, it can be removed.

navaneeth.suresh marked 7 inline comments as done.Jun 16 2019, 11:13 AM
navaneeth.suresh updated this revision to Diff 15534.
navaneeth.suresh added inline comments.Jun 16 2019, 11:15 AM
tests/test-shelve-unresolved.t
169

fixed. i added (extrastorage !) manually to the corresponding test case. this will prevent it from changing on executing with usualstorage test case. thanks!

navaneeth.suresh marked an inline comment as done.Jun 28 2019, 8:17 AM
pulkit added a comment.Jul 2 2019, 5:58 PM

Since you did the nice work of moving shelve to core, how about rebasing this patch on tip of default with shelve in core?

navaneeth.suresh added a comment.Jul 4 2019, 11:04 AM
In D6479#96318, @pulkit wrote:

Since you did the nice work of moving shelve to core, how about rebasing this patch on tip of default with shelve in core?

Doing that right away!

durin42 added a subscriber: durin42.Aug 15 2019, 11:05 AM

The only thing I'm curious about really is why we have extrastorage and usualstorge. Can we get away with only one of those choices instead of having more options?

mercurial/shelve.py
432 ↗(On Diff #15765)

I think I'd like to see at least two changes here: one that introduces the code for storing merge state in extra, and then a second that uses it in shelve.

434 ↗(On Diff #15765)

why aren't we just going all in on using extra for this? It feels less likely to lose data.

navaneeth.suresh added a comment.Aug 15 2019, 11:37 AM
In D6479#98737, @durin42 wrote:

The only thing I'm curious about really is why we have extrastorage and usualstorge. Can we get away with only one of those choices instead of having more options?

The ultimate goal is to store the mergestate info in the changeset extras only. But, now , it has no support to store the local version of the files which are stored in the mergestate. This lacks info when the user gets conflicts other than a usual hg merge.

pulkit added a comment.Aug 17 2019, 3:30 PM
In D6479#98757, @navaneeth.suresh wrote:
In D6479#98737, @durin42 wrote:

The only thing I'm curious about really is why we have extrastorage and usualstorge. Can we get away with only one of those choices instead of having more options?

The ultimate goal is to store the mergestate info in the changeset extras only. But, now , it has no support to store the local version of the files which are stored in the mergestate. This lacks info when the user gets conflicts other than a usual hg merge.

Hm, sorry for missing this earlier. If we start the merge with a clean working directory, we don't need to store the local version of file then.

durin42 added a reviewer: navaneeth.suresh.Sep 11 2019, 11:28 AM
durin42 commandeered this revision.
durin42 abandoned this revision.

Revision Contents
Changeset List

PathPackages
Mhgext/shelve.py (131 lines)
Mmercurial/configitems.py (3 lines)
AMtests/test-shelve-unresolved.t (538 lines)
Mtests/test-shelve.t (1 line)

Diff 15517

hgext/shelve.py

shelvedfile(repo, name, 'hg').writebundle(bases, node) shelvedfile(repo, name, 'hg').writebundle(bases, node)
# Create a matcher so that prefetch doesn't attempt to fetch the entire # Create a matcher so that prefetch doesn't attempt to fetch the entire
# repository pointlessly. # repository pointlessly.
match = scmutil.matchfiles(repo, repo[node].files()) match = scmutil.matchfiles(repo, repo[node].files())
with shelvedfile(repo, name, patchextension).opener('wb') as fp: with shelvedfile(repo, name, patchextension).opener('wb') as fp:
cmdutil.exportfile(repo, [node], fp, opts=mdiff.diffopts(git=True), cmdutil.exportfile(repo, [node], fp, opts=mdiff.diffopts(git=True),
match=match) match=match)
def _encodemergerecords(records):
"""Encode mergestate records to store in changeset extras.
Takes list of tuples as input and returns str.
"""
items = [
'%s\033%s' % (rtype, record)
for rtype, record in sorted(records)
]
return "\n".join(items)
def _decodemergerecords(data):
"""Decode mergestate record from changeset extras to return
a list of tuples.
"""
records = []
for l in data.split('\n'):
rtype, record = l.split('\033')
records.append((rtype, record))
return records
def _storeunresolvedmerge(ui, repo, name=None, extra=None):
"""Store the mergestate information in changeset extra
if config option `experimental.store-in-extra` is set True.
Otherwise, move the usual mergestate information from
`.hg/merge` to `.hg/merge-unresolved/<name>`.
This will clear the mergestate and also stores the mergestate
information for later restoration.
"""
if ui.config('experimental', 'store-in-extra'):
ms = merge.mergestate.read(repo)
extra['mergerecords'] = _encodemergerecords(ms._readrecords())
ms.reset()
else:
if not repo.vfs.exists('merge-unresolved'):
repo.vfs.mkdir('merge-unresolved')
repo.vfs.rename('merge', 'merge-unresolved/%s' % name)
def _includeunknownfiles(repo, pats, opts, extra): def _includeunknownfiles(repo, pats, opts, extra):
s = repo.status(match=scmutil.match(repo[None], pats, opts), s = repo.status(match=scmutil.match(repo[None], pats, opts),
unknown=True) unknown=True)
if s.unknown: if s.unknown:
extra['shelve_unknown'] = '\0'.join(s.unknown) extra['shelve_unknown'] = '\0'.join(s.unknown)
repo[None].add(s.unknown) repo[None].add(s.unknown)
def _isunresolvedshelve(ui, repo, sname=None, shelvectx=None):
"""Checks whether the given shelve is unresolved or not"""
if shelvectx is not None:
return shelvectx.extra().get('unresolved-merge')
if not ui.config('experimental', 'store-in-extra'):
return repo.vfs.exists('merge-unresolved/%s' % sname)
#TODO: add functionality to distinguish unresolved shelves
# on doing `hg shelve --list` when `experimental.store-in-extra`
# set True
def _finishshelve(repo, tr): def _finishshelve(repo, tr):
if phases.supportinternal(repo): if phases.supportinternal(repo):
tr.close() tr.close()
else: else:
_aborttransaction(repo, tr) _aborttransaction(repo, tr)
def createcmd(ui, repo, pats, opts): def createcmd(ui, repo, pats, opts):
"""subcommand that creates a new shelve""" """subcommand that creates a new shelve"""
with repo.wlock(): with repo.wlock():
cmdutil.checkunfinished(repo) cmdutil.checkunfinished(repo)
return _docreatecmd(ui, repo, pats, opts) return _docreatecmd(ui, repo, pats, opts)
def _docreatecmd(ui, repo, pats, opts): def _docreatecmd(ui, repo, pats, opts):
wctx = repo[None] wctx = repo[None]
parents = wctx.parents() parents = wctx.parents()
if len(parents) > 1: unresolved = opts.get('unresolved')
raise error.Abort(_('cannot shelve while merging'))
parent = parents[0] parent = parents[0]
origbranch = wctx.branch() origbranch = wctx.branch()
ms = merge.mergestate.read(repo)
if unresolved:
if not ms.active():
raise error.Abort(_('no active mergestate found'))
elif not list(ms.unresolved()):
raise error.Abort(_('no unresolved '
'files found in the mergestate'))
elif ms.active():
raise error.Abort(_('mergestate found\n'
'try with --unresolved to shelve conflicts'))
if parent.node() != nodemod.nullid: if parent.node() != nodemod.nullid:
desc = "changes to: %s" % parent.description().split('\n', 1)[0] desc = "changes to: %s" % parent.description().split('\n', 1)[0]
else: else:
desc = '(changes in empty repository)' desc = '(changes in empty repository)'
if not opts.get('message'): if not opts.get('message'):
opts['message'] = desc opts['message'] = desc
lock = tr = activebookmark = None lock = tr = activebookmark = None
try: try:
lock = repo.lock() lock = repo.lock()
# use an uncommitted transaction to generate the bundle to avoid # use an uncommitted transaction to generate the bundle to avoid
# pull races. ensure we don't print the abort message to stderr. # pull races. ensure we don't print the abort message to stderr.
tr = repo.transaction('shelve', report=lambda x: None) tr = repo.transaction('shelve', report=lambda x: None)
interactive = opts.get('interactive', False) interactive = opts.get('interactive', False)
includeunknown = (opts.get('unknown', False) and includeunknown = (opts.get('unknown', False) and
not opts.get('addremove', False)) not opts.get('addremove', False))
name = getshelvename(repo, parent, opts) name = getshelvename(repo, parent, opts)
activebookmark = _backupactivebookmark(repo) activebookmark = _backupactivebookmark(repo)
extra = {'internal': 'shelve'} extra = {'internal': 'shelve'}
if unresolved:
extra['unresolved-merge'] = True
_storeunresolvedmerge(ui, repo, name, extra)
if includeunknown: if includeunknown:
_includeunknownfiles(repo, pats, opts, extra) _includeunknownfiles(repo, pats, opts, extra)
if _iswctxonnewbranch(repo) and not _isbareshelve(pats, opts): if _iswctxonnewbranch(repo) and not _isbareshelve(pats, opts):
# In non-bare shelve we don't store newly created branch # In non-bare shelve we don't store newly created branch
# at bundled commit # at bundled commit
repo.dirstate.setbranch(repo['.'].branch()) repo.dirstate.setbranch(repo['.'].branch())
st = shelvedfile(repo, name).stat() st = shelvedfile(repo, name).stat()
info.append((st[stat.ST_MTIME], shelvedfile(repo, pfx).filename())) info.append((st[stat.ST_MTIME], shelvedfile(repo, pfx).filename()))
return sorted(info, reverse=True) return sorted(info, reverse=True)
def listcmd(ui, repo, pats, opts): def listcmd(ui, repo, pats, opts):
"""subcommand that displays the list of shelves""" """subcommand that displays the list of shelves"""
pats = set(pats) pats = set(pats)
width = 80 width = 80
namewidth = 16
if not ui.plain(): if not ui.plain():
width = ui.termwidth() width = ui.termwidth()
namelabel = 'shelve.newest' namelabel = 'shelve.newest'
ui.pager('shelve') ui.pager('shelve')
for mtime, name in listshelves(repo): for mtime, name in listshelves(repo):
sname = util.split(name)[1] sname = util.split(name)[1]
if pats and sname not in pats: if pats and sname not in pats:
continue continue
if _isunresolvedshelve(ui, repo, sname):
sname += ' (unresolved)'
namewidth += len(' (unresolved)')
ui.write(sname, label=namelabel) ui.write(sname, label=namelabel)
namelabel = 'shelve.name' namelabel = 'shelve.name'
if ui.quiet: if ui.quiet:
ui.write('\n') ui.write('\n')
continue continue
ui.write(' ' * (16 - len(sname))) ui.write(' ' * (namewidth - len(sname)))
used = 16 used = namewidth
date = dateutil.makedate(mtime) date = dateutil.makedate(mtime)
age = '(%s)' % templatefilters.age(date, abbrev=True) age = '(%s)' % templatefilters.age(date, abbrev=True)
ui.write(age, label='shelve.age') ui.write(age, label='shelve.age')
ui.write(' ' * (12 - len(age))) ui.write(' ' * (12 - len(age)))
used += 12 used += 12
with open(name + '.' + patchextension, 'rb') as fp: with open(name + '.' + patchextension, 'rb') as fp:
while True: while True:
line = fp.readline() line = fp.readline()
ui.popbuffer() ui.popbuffer()
def restorebranch(ui, repo, branchtorestore): def restorebranch(ui, repo, branchtorestore):
if branchtorestore and branchtorestore != repo.dirstate.branch(): if branchtorestore and branchtorestore != repo.dirstate.branch():
repo.dirstate.setbranch(branchtorestore) repo.dirstate.setbranch(branchtorestore)
ui.status(_('marked working directory as branch %s\n') ui.status(_('marked working directory as branch %s\n')
% branchtorestore) % branchtorestore)
def restoreunresolvedshelve(ui, repo, shelvectx, basename):
pulkitUnsubmitted
Done

the functions needs documentation.

pulkit: the functions needs documentation.
"""Change the parents of the dirstate to the parents of the stored
unresolved shelvectx.
Rewrite the mergestate from changeset extra if
pulkitUnsubmitted
Done

why do we need to do this?

pulkit: why do we need to do this?
`experimental.store-in-extra` is set True.
pulkitUnsubmitted
Done

this comment can be a part of function documentation.

pulkit: this comment can be a part of function documentation.
pulkitUnsubmitted
Done

if merge-unresolved/ does not exists, it means there are no unresolved shelves, right? we should not be creating it then.

pulkit: if merge-unresolved/ does not exists, it means there are no unresolved shelves, right? we…
Otherwise, replace `.hg/merge` with `.hg/merge-unresolved/<basename>`
pulkitUnsubmitted
Done

vfs.rename should be used here.

pulkit: `vfs.rename` should be used here.
to restore the status of the resolved files in the shelvectx.
pulkitUnsubmitted
Done

Let's move this parent changing of dirstate out of this function. This functions should only have logic related to storing and restoring unresolved states.

pulkit: Let's move this parent changing of dirstate out of this function. This functions should only…
"""
p1, p2 = shelvectx.parents()
repo.dirstate.setparents(p1.node(), p2.node())
if ui.config('experimental', 'store-in-extra'):
records = shelvectx.extra().get('mergerecords')
ms = merge.mergestate.clean(repo)
ms._writerecordsv2(_decodemergerecords(records))
else:
repo.vfs.rename('merge-unresolved/%s' % basename, 'merge')
def unshelvecleanup(ui, repo, name, opts): def unshelvecleanup(ui, repo, name, opts):
"""remove related files after an unshelve""" """remove related files after an unshelve"""
if not opts.get('keep'): if not opts.get('keep'):
for filetype in shelvefileextensions: for filetype in shelvefileextensions:
shfile = shelvedfile(repo, name, filetype) shfile = shelvedfile(repo, name, filetype)
if shfile.exists(): if shfile.exists():
shfile.movetobackup() shfile.movetobackup()
cleanupoldbackups(repo) cleanupoldbackups(repo)
('c', 'continue', None, ('c', 'continue', None,
_('continue an incomplete unshelve operation')), _('continue an incomplete unshelve operation')),
('k', 'keep', None, ('k', 'keep', None,
_('keep shelve after unshelving')), _('keep shelve after unshelving')),
('n', 'name', '', ('n', 'name', '',
_('restore shelved change with given name'), _('NAME')), _('restore shelved change with given name'), _('NAME')),
('t', 'tool', '', _('specify merge tool')), ('t', 'tool', '', _('specify merge tool')),
('', 'date', '', ('', 'date', '',
_('set date for temporary commits (DEPRECATED)'), _('DATE'))], _('set date for temporary commits (DEPRECATED)'), _('DATE')),
('', 'unresolved', None,
_('unshelve mergestate with unresolved files'))],
_('hg unshelve [[-n] SHELVED]'), _('hg unshelve [[-n] SHELVED]'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY) helpcategory=command.CATEGORY_WORKING_DIRECTORY)
def unshelve(ui, repo, *shelved, **opts): def unshelve(ui, repo, *shelved, **opts):
"""restore a shelved change to the working directory """restore a shelved change to the working directory
This command accepts an optional name of a shelved change to This command accepts an optional name of a shelved change to
restore. If none is given, the most recent shelved change is used. restore. If none is given, the most recent shelved change is used.
""" """
with repo.wlock(): with repo.wlock():
return _dounshelve(ui, repo, *shelved, **opts) return _dounshelve(ui, repo, *shelved, **opts)
def _dounshelve(ui, repo, *shelved, **opts): def _dounshelve(ui, repo, *shelved, **opts):
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
abortf = opts.get('abort') abortf = opts.get('abort')
continuef = opts.get('continue') continuef = opts.get('continue')
unresolved = opts.get('unresolved')
if not abortf and not continuef: if not abortf and not continuef:
cmdutil.checkunfinished(repo) cmdutil.checkunfinished(repo)
shelved = list(shelved) shelved = list(shelved)
if opts.get("name"): if opts.get("name"):
shelved.append(opts["name"]) shelved.append(opts["name"])
if abortf or continuef: if abortf or continuef:
if abortf and continuef: if abortf and continuef:
raise error.Abort(_('no shelved changes to apply!')) raise error.Abort(_('no shelved changes to apply!'))
basename = util.split(shelved[0][1])[1] basename = util.split(shelved[0][1])[1]
ui.status(_("unshelving change '%s'\n") % basename) ui.status(_("unshelving change '%s'\n") % basename)
else: else:
basename = shelved[0] basename = shelved[0]
if not shelvedfile(repo, basename, patchextension).exists(): if not shelvedfile(repo, basename, patchextension).exists():
raise error.Abort(_("shelved change '%s' not found") % basename) raise error.Abort(_("shelved change '%s' not found") % basename)
if unresolved:
pulkitUnsubmitted
Done

we can do this check by looking into shelvectx extras below.

pulkit: we can do this check by looking into shelvectx extras below.
cmdutil.bailifchanged(repo)
repo = repo.unfiltered() repo = repo.unfiltered()
lock = tr = None lock = tr = None
try: try:
lock = repo.lock() lock = repo.lock()
tr = repo.transaction('unshelve', report=lambda x: None) tr = repo.transaction('unshelve', report=lambda x: None)
oldtiprev = len(repo) oldtiprev = len(repo)
pctx = repo['.'] pctx = repo['.']
tmpwctx = pctx tmpwctx = pctx
# The goal is to have a commit structure like so: # The goal is to have a commit structure like so:
# ...-> pctx -> tmpwctx -> shelvectx # ...-> pctx -> tmpwctx -> shelvectx
# where tmpwctx is an optional commit with the user's pending changes # where tmpwctx is an optional commit with the user's pending changes
# and shelvectx is the unshelved changes. Then we merge it all down # and shelvectx is the unshelved changes. Then we merge it all down
# to the original pctx. # to the original pctx.
activebookmark = _backupactivebookmark(repo) activebookmark = _backupactivebookmark(repo)
tmpwctx, addedbefore = _commitworkingcopychanges(ui, repo, opts, tmpwctx, addedbefore = _commitworkingcopychanges(ui, repo, opts,
tmpwctx) tmpwctx)
repo, shelvectx = _unshelverestorecommit(ui, repo, tr, basename) repo, shelvectx = _unshelverestorecommit(ui, repo, tr, basename)
unresolvedshelve = _isunresolvedshelve(ui, repo, basename, shelvectx)
pulkitUnsubmitted
Done

let's have shelvectx an optional argument to _isunresolvedshelve(). If shelvectx is passed we use that, otherwise we fallback to checking the directory in merge-unresolved/.

And then use that function here.

pulkit: let's have `shelvectx` an optional argument to `_isunresolvedshelve()`. If `shelvectx` is…
_checkunshelveuntrackedproblems(ui, repo, shelvectx) _checkunshelveuntrackedproblems(ui, repo, shelvectx)
branchtorestore = '' branchtorestore = ''
if shelvectx.branch() != shelvectx.p1().branch(): if shelvectx.branch() != shelvectx.p1().branch():
branchtorestore = shelvectx.branch() branchtorestore = shelvectx.branch()
if unresolved:
if not unresolvedshelve:
raise error.Abort(_('%s is not an unresolved shelve\n') %
basename)
p1, p2 = shelvectx.parents()
if pctx.node() not in [p1.node(), p2.node()]:
raise error.Abort(_('dirstate is not on either of the merge'
' parents.\nuse hg update to one of the'
' merge parents.'))
elif unresolvedshelve:
raise error.Abort(_('%s is an unresolved shelve, use'
' --unresolved to unshelve it') % basename)
else:
shelvectx = _rebaserestoredcommit(ui, repo, opts, tr, oldtiprev, shelvectx = _rebaserestoredcommit(ui, repo, opts, tr, oldtiprev,
basename, pctx, tmpwctx, basename, pctx, tmpwctx,
shelvectx, branchtorestore, shelvectx, branchtorestore,
activebookmark) activebookmark)
overrides = {('ui', 'forcemerge'): opts.get('tool', '')} overrides = {('ui', 'forcemerge'): opts.get('tool', '')}
with ui.configoverride(overrides, 'unshelve'): with ui.configoverride(overrides, 'unshelve'):
mergefiles(ui, repo, pctx, shelvectx) mergefiles(ui, repo, pctx, shelvectx)
if unresolved:
with repo.dirstate.parentchange():
restoreunresolvedshelve(ui, repo, shelvectx, basename)
restorebranch(ui, repo, branchtorestore) restorebranch(ui, repo, branchtorestore)
_forgetunknownfiles(repo, shelvectx, addedbefore) _forgetunknownfiles(repo, shelvectx, addedbefore)
shelvedstate.clear(repo) shelvedstate.clear(repo)
_finishunshelve(repo, oldtiprev, tr, activebookmark) _finishunshelve(repo, oldtiprev, tr, activebookmark)
unshelvecleanup(ui, repo, basename, opts) unshelvecleanup(ui, repo, basename, opts)
finally: finally:
if tr: if tr:
_('use the given name for the shelved commit'), _('NAME')), _('use the given name for the shelved commit'), _('NAME')),
('p', 'patch', None, ('p', 'patch', None,
_('output patches for changes (provide the names of the shelved ' _('output patches for changes (provide the names of the shelved '
'changes as positional arguments)')), 'changes as positional arguments)')),
('i', 'interactive', None, ('i', 'interactive', None,
_('interactive mode, only works while creating a shelve')), _('interactive mode, only works while creating a shelve')),
('', 'stat', None, ('', 'stat', None,
_('output diffstat-style summary of changes (provide the names of ' _('output diffstat-style summary of changes (provide the names of '
'the shelved changes as positional arguments)') 'the shelved changes as positional arguments)')),
('', 'unresolved', None,
_('unshelve mergestate with unresolved files')
)] + cmdutil.walkopts, )] + cmdutil.walkopts,
_('hg shelve [OPTION]... [FILE]...'), _('hg shelve [OPTION]... [FILE]...'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY) helpcategory=command.CATEGORY_WORKING_DIRECTORY)
def shelvecmd(ui, repo, *pats, **opts): def shelvecmd(ui, repo, *pats, **opts):
'''save and set aside changes from the working directory '''save and set aside changes from the working directory
Shelving takes files that "hg status" reports as not clean, saves Shelving takes files that "hg status" reports as not clean, saves
the modifications to a bundle (a shelved change), and reverts the the modifications to a bundle (a shelved change), and reverts the

mercurial/configitems.py

default=False, default=False,
) )
coreconfigitem('experimental', 'sparse-read.density-threshold', coreconfigitem('experimental', 'sparse-read.density-threshold',
default=0.50, default=0.50,
) )
coreconfigitem('experimental', 'sparse-read.min-gap-size', coreconfigitem('experimental', 'sparse-read.min-gap-size',
default='65K', default='65K',
) )
coreconfigitem('experimental', 'store-in-extra',
default=False,
)
coreconfigitem('experimental', 'treemanifest', coreconfigitem('experimental', 'treemanifest',
default=False, default=False,
) )
coreconfigitem('experimental', 'update.atomic-file', coreconfigitem('experimental', 'update.atomic-file',
default=False, default=False,
) )
coreconfigitem('experimental', 'sshpeer.advertise-v2', coreconfigitem('experimental', 'sshpeer.advertise-v2',
default=False, default=False,

tests/test-shelve-unresolved.t

  • This file was added.
#testcases extrastorage usualstorage
$ addunresolvedmerge() {
> echo A >> $1
> echo A >> $2
> hg ci -m A
> echo B >> $1
> echo B >> $2
> hg ci -m B
> hg up $3
> echo C >> $1
> echo C >> $2
> hg ci -m C
> hg merge -r $(($3+1))
> }
Test shelve with unresolved mergestate
$ cat >> $HGRCPATH <<EOF
> [extensions]
> shelve =
> EOF
#if extrastorage
$ cat <<EOF >> $HGRCPATH
> [experimental]
> store-in-extra = True
> EOF
#endif
$ hg init shelve-unresolved
$ cd shelve-unresolved
$ echo A >> file1
$ echo A >> file2
$ hg ci -Am A
adding file1
adding file2
$ echo foo >> bar
$ hg add bar
-- should abort on absence of mergestate
$ hg shelve --unresolved
abort: no active mergestate found
[255]
$ hg forget bar
$ echo B >> file1
$ echo B >> file2
$ hg ci -m B
$ hg up 0
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ echo C >> file1
$ echo C >> file2
$ hg ci -m C
created new head
$ hg merge
merging file1
merging file2
warning: conflicts while merging file1! (edit, then use 'hg resolve --mark')
warning: conflicts while merging file2! (edit, then use 'hg resolve --mark')
0 files updated, 0 files merged, 0 files removed, 2 files unresolved
use 'hg resolve' to retry unresolved file merges or 'hg merge --abort' to abandon
[1]
-- let's partially solve the conflicts
$ cat > file1 <<EOF
> A
> B
> C
> EOF
$ hg resolve -m file1
-- mark file2 as resolved to check abort
$ hg resolve -m file2
(no more unresolved files)
$ hg log -G
@ changeset: 2:69004294ad57
| tag: tip
| parent: 0:c32ef6121744
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| @ changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
$ cat file1
A
B
C
$ hg diff
diff -r 69004294ad57 file1
--- a/file1 Thu Jan 01 00:00:00 1970 +0000
+++ b/file1 Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +1,3 @@
A
+B
C
diff -r 69004294ad57 file2
--- a/file2 Thu Jan 01 00:00:00 1970 +0000
+++ b/file2 Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +1,6 @@
A
+<<<<<<< working copy: 69004294ad57 - test: C
C
+=======
+B
+>>>>>>> merge rev: fd9a4049234b - test: B
-- should abort on absence of conflicts
$ hg shelve
abort: mergestate found
try with --unresolved to shelve conflicts
[255]
$ hg shelve --unresolved
abort: no unresolved files found in the mergestate
[255]
$ hg resolve -u file2
$ hg resolve -l
R file1
U file2
-- should suggest --unresolved on shelving with mergestate
$ hg shelve
abort: mergestate found
try with --unresolved to shelve conflicts
[255]
#if extrastorage
pulkitUnsubmitted
Done

this if and endif can be removed.

pulkit: this if and endif can be removed.
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
#else
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
#endif
$ cat file1
A
C
$ hg log -G
@ changeset: 2:69004294ad57
| tag: tip
| parent: 0:c32ef6121744
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| o changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
#if extrastorage
pulkitUnsubmitted
Done

We can get rid of this #if and #endif too. the usualstorage one will have (unresolved) in the test output. We have functionality to have test output case wise which can be used.

For example, here we have two different outputs in py3 and non-py3 cases. https://www.mercurial-scm.org/repo/hg-committed/file/tip/tests/test-debugcommands.t#l213

pulkit: We can get rid of this #if and #endif too. the usualstorage one will have `(unresolved)` in the…
navaneeth.sureshUnsubmitted
Done

fixed. i added (extrastorage !) manually to the corresponding test case. this will prevent it from changing on executing with usualstorage test case. thanks!

navaneeth.suresh: fixed. i added `(extrastorage !)` manually to the corresponding test case. this will prevent it…
$ hg shelve --list
default (1s ago) changes to: C
$ hg shelve --patch
default (1s ago) changes to: C
diff --git a/file1 b/file1
--- a/file1
+++ b/file1
@@ -1,2 +1,3 @@
A
+B
C
diff --git a/file2 b/file2
--- a/file2
+++ b/file2
@@ -1,2 +1,6 @@
A
+<<<<<<< working copy: 69004294ad57 - test: C
C
+=======
+B
+>>>>>>> merge rev: fd9a4049234b - test: B
else
$ hg shelve --list
default (1s ago) changes to: C
$ hg shelve --patch
default (1s ago) changes to: C
diff --git a/file1 b/file1
--- a/file1
+++ b/file1
@@ -1,2 +1,3 @@
A
+B
C
diff --git a/file2 b/file2
--- a/file2
+++ b/file2
@@ -1,2 +1,6 @@
A
+<<<<<<< working copy: 69004294ad57 - test: C
C
+=======
+B
+>>>>>>> merge rev: fd9a4049234b - test: B
#endif
-- now, fix an urgent bug
$ echo fixed >> bug
$ ls
bar
bug
file1
file1.orig
file2
file2.orig
$ hg add bug
$ hg ci -m "fix bug"
$ hg log -G
@ changeset: 3:a53a9a7475b3
| tag: tip
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: fix bug
|
o changeset: 2:69004294ad57
| parent: 0:c32ef6121744
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| o changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
-- let's get back to the old mergestate
-- we need to update to one of the merge parents. otherwise, abort.
#if extrastorage
pulkitUnsubmitted
Done

we don't need this #if and #endif, it can be removed.

pulkit: we don't need this #if and #endif, it can be removed.
$ hg unshelve --unresolved
unshelving change 'default'
abort: dirstate is not on either of the merge parents.
use hg update to one of the merge parents.
[255]
#else
$ hg unshelve --unresolved
unshelving change 'default'
abort: dirstate is not on either of the merge parents.
use hg update to one of the merge parents.
[255]
#endif
$ hg up 2
0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ cat file2
A
C
-- flag --unshelve is not passed. but, the last shelve is unresolved
$ hg unshelve
unshelving change 'default'
abort: default is an unresolved shelve, use --unresolved to unshelve it
[255]
#if extrastorage
pulkitUnsubmitted
Done

we don't need this #if and #endif, it can be removed.

pulkit: we don't need this #if and #endif, it can be removed.
$ hg unshelve --unresolved
unshelving change 'default'
#else
$ hg unshelve --unresolved
unshelving change 'default'
#endif
$ hg log -G
o changeset: 3:a53a9a7475b3
| tag: tip
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: fix bug
|
@ changeset: 2:69004294ad57
| parent: 0:c32ef6121744
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| @ changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
$ cat file1
A
B
C
$ hg diff
diff -r 69004294ad57 file1
--- a/file1 Thu Jan 01 00:00:00 1970 +0000
+++ b/file1 Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +1,3 @@
A
+B
C
diff -r 69004294ad57 file2
--- a/file2 Thu Jan 01 00:00:00 1970 +0000
+++ b/file2 Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +1,6 @@
A
+<<<<<<< working copy: 69004294ad57 - test: C
C
+=======
+B
+>>>>>>> merge rev: fd9a4049234b - test: B
$ cat file2
A
<<<<<<< working copy: 69004294ad57 - test: C
C
=======
B
>>>>>>> merge rev: fd9a4049234b - test: B
$ hg resolve -l
R file1
U file2
-- flag --unresolved is passed but the top most shelve is not unresolved
#if extrastorage
pulkitUnsubmitted
Done

we don't need this #if and #endif, it can be removed.

pulkit: we don't need this #if and #endif, it can be removed.
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
#else
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
#endif
$ echo garbage >> bug
$ hg st
? bar
? bug
? file1.orig
? file2.orig
$ hg add bug
$ hg shelve
shelved as default-01
0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ hg unshelve --unresolved
unshelving change 'default-01'
abort: default-01 is not an unresolved shelve
[255]
-- now, unshelve default
#if extrastorage
pulkitUnsubmitted
Done

we don't need this #if and #endif, it can be removed.

pulkit: we don't need this #if and #endif, it can be removed.
$ hg unshelve -n default --unresolved
#else
$ hg unshelve -n default --unresolved
#endif
-- commit the merge after completing conflict resolution
$ cat >> file2 <<EOF
> A
> B
> C
> EOF
$ hg resolve -m file2
(no more unresolved files)
$ hg ci -m merge
$ hg verify
checking changesets
checking manifests
crosschecking files in changesets and manifests
checking files
checked 5 changesets with 9 changes to 3 files
$ hg log -G
@ changeset: 4:745dca2ee1f1
|\ tag: tip
| | parent: 2:69004294ad57
| | parent: 1:fd9a4049234b
| | user: test
| | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: merge
| |
| | o changeset: 3:a53a9a7475b3
| |/ user: test
| | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: fix bug
| |
| o changeset: 2:69004294ad57
| | parent: 0:c32ef6121744
| | user: test
| | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: C
| |
o | changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
-- flag --unsresolved is passed but we don’t have any unresolved shelve
$ hg unshelve --unresolved
unshelving change 'default-01'
abort: default-01 is not an unresolved shelve
[255]
-- when working directory is dirty
$ addunresolvedmerge file1 file2 5
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
created new head
merging file1
merging file2
warning: conflicts while merging file1! (edit, then use 'hg resolve --mark')
warning: conflicts while merging file2! (edit, then use 'hg resolve --mark')
0 files updated, 0 files merged, 0 files removed, 2 files unresolved
use 'hg resolve' to retry unresolved file merges or 'hg merge --abort' to abandon
[1]
#if extrastorage
pulkitUnsubmitted
Done

we don't need this #if and #endif, it can be removed.

pulkit: we don't need this #if and #endif, it can be removed.
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
#else
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
#endif
$ echo dirt >> bar
$ hg add bar
$ hg unshelve --unresolved
unshelving change 'default'
abort: uncommitted changes
[255]
--- unshelve --unresolved when there is another merge going on
$ hg ci -m dirt
$ hg up 7
0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ echo foo >> bug
$ hg add bug
$ hg ci -m foo2
created new head
$ hg log -G
@ changeset: 9:c74a624102ed
| tag: tip
| parent: 7:974ec4298b79
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: foo2
|
| o changeset: 8:4acf09fb3a59
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: dirt
|
o changeset: 7:974ec4298b79
| parent: 5:db68c6c84fe6
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| o changeset: 6:e236d497f76b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 5:db68c6c84fe6
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: A
|
o changeset: 4:745dca2ee1f1
|\ parent: 2:69004294ad57
| | parent: 1:fd9a4049234b
| | user: test
| | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: merge
| |
| | o changeset: 3:a53a9a7475b3
| |/ user: test
| | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: fix bug
| |
| o changeset: 2:69004294ad57
| | parent: 0:c32ef6121744
| | user: test
| | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: C
| |
o | changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
$ hg merge -r 8
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
(branch merge, don't forget to commit)
#if extrastorage
pulkitUnsubmitted
Done

we don't need this #if and #endif, it can be removed.

pulkit: we don't need this #if and #endif, it can be removed.
$ hg unshelve --unresolved
unshelving change 'default'
abort: outstanding uncommitted merge
[255]
#else
$ hg unshelve --unresolved
unshelving change 'default'
abort: outstanding uncommitted merge
[255]
#endif

tests/test-shelve.t

-m --message TEXT use text as shelve message -m --message TEXT use text as shelve message
-n --name NAME use the given name for the shelved commit -n --name NAME use the given name for the shelved commit
-p --patch output patches for changes (provide the names of the -p --patch output patches for changes (provide the names of the
shelved changes as positional arguments) shelved changes as positional arguments)
-i --interactive interactive mode, only works while creating a shelve -i --interactive interactive mode, only works while creating a shelve
--stat output diffstat-style summary of changes (provide --stat output diffstat-style summary of changes (provide
the names of the shelved changes as positional the names of the shelved changes as positional
arguments) arguments)
--unresolved unshelve mergestate with unresolved files
-I --include PATTERN [+] include names matching the given patterns -I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns
--mq operate on patch repository --mq operate on patch repository
(some details hidden, use --verbose to show complete help) (some details hidden, use --verbose to show complete help)
shelving in an empty repo should be possible shelving in an empty repo should be possible
(this tests also that editor is not invoked, if '--edit' is not (this tests also that editor is not invoked, if '--edit' is not