( )⚙ D11013 dirstate: add a `set_tracked` method for "hg add"-like usage

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11013

dirstate: add a `set_tracked` method for "hg add"-like usage
ClosedPublic

Authored by marmoute on Jul 8 2021, 3:33 AM.

Details

Reviewers
durin42
martinvonz
Alphare
Group Reviewers
hg-reviewers
Commits
rHGf927ad5a4e2c: dirstate: add a `set_tracked` method for "hg add"-like usage
Summary

This is a step further toward clarifying the semantic of various dirstate call.

Having a dedicated function comes with a couple of benefits:

  1. we can move duplicated logic about how to handle the previous state within

the dirstate. Since we are sure this is always called in the same situation, we
can implement that logic once in the dirstate.

  1. having a dedicated method for this case unlock also having a dedicated

method for the other case and recording more information at that time. All this
leading having more code within the dirstate and higher level API that are less
error prone.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute created this revision.Jul 8 2021, 3:33 AM
marmoute updated this revision to Diff 28962.Jul 8 2021, 4:16 AM
Alphare accepted this revision.Jul 9 2021, 12:01 PM
This revision is now accepted and ready to land.Jul 9 2021, 12:01 PM
marmoute retitled this revision from dirstate: add a set_tracked method for "hg add"-like usage to dirstate: add a `set_tracked` method for "hg add"-like usage.Jul 10 2021, 5:01 PM
marmoute edited the summary of this revision. (Show Details)
baymax updated this revision to Diff 29158.Jul 11 2021, 7:16 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 29249.Jul 15 2021, 12:03 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

pulkit added a subscriber: pulkit.Jul 19 2021, 8:33 AM
pulkit added inline comments.
mercurial/dirstate.py
78

This will also need a b'' prefix, can you follow up for that?

marmoute added inline comments.Jul 19 2021, 8:58 AM
mercurial/dirstate.py
78

Same feedback https://phab.mercurial-scm.org/D11012#170843

Revision Contents
Changeset List

Diff 28962

hgext/largefiles/lfutil.py

return path return path
return None return None
class largefilesdirstate(dirstate.dirstate): class largefilesdirstate(dirstate.dirstate):
def __getitem__(self, key): def __getitem__(self, key):
return super(largefilesdirstate, self).__getitem__(unixpath(key)) return super(largefilesdirstate, self).__getitem__(unixpath(key))
def set_tracked(self, f):
return super(largefilesdirstate, self).set_tracked(unixpath(f))
def normal(self, f): def normal(self, f):
return super(largefilesdirstate, self).normal(unixpath(f)) return super(largefilesdirstate, self).normal(unixpath(f))
def remove(self, f): def remove(self, f):
return super(largefilesdirstate, self).remove(unixpath(f)) return super(largefilesdirstate, self).remove(unixpath(f))
def add(self, f): def add(self, f):
return super(largefilesdirstate, self).add(unixpath(f)) return super(largefilesdirstate, self).add(unixpath(f))

hgext/narrow/narrowdirstate.py

class narrowdirstate(dirstate.__class__): class narrowdirstate(dirstate.__class__):
# Prevent adding/editing/copying/deleting files that are outside the # Prevent adding/editing/copying/deleting files that are outside the
# sparse checkout # sparse checkout
@_editfunc @_editfunc
def normal(self, *args, **kwargs): def normal(self, *args, **kwargs):
return super(narrowdirstate, self).normal(*args, **kwargs) return super(narrowdirstate, self).normal(*args, **kwargs)
@_editfunc @_editfunc
def set_tracked(self, *args):
return super(narrowdirstate, self).set_tracked(*args)
@_editfunc
def add(self, *args): def add(self, *args):
return super(narrowdirstate, self).add(*args) return super(narrowdirstate, self).add(*args)
@_editfunc @_editfunc
def normallookup(self, *args): def normallookup(self, *args):
return super(narrowdirstate, self).normallookup(*args) return super(narrowdirstate, self).normallookup(*args)
@_editfunc @_editfunc

hgext/sparse.py

return orig(self, parent, allfiles, changedfiles) return orig(self, parent, allfiles, changedfiles)
extensions.wrapfunction(dirstate.dirstate, b'rebuild', _rebuild) extensions.wrapfunction(dirstate.dirstate, b'rebuild', _rebuild)
# Prevent adding files that are outside the sparse checkout # Prevent adding files that are outside the sparse checkout
editfuncs = [ editfuncs = [
b'normal', b'normal',
b'set_tracked',
b'add', b'add',
b'normallookup', b'normallookup',
b'copy', b'copy',
b'remove', b'remove',
b'merge', b'merge',
] ]
hint = _( hint = _(
b'include file with `hg debugsparse --include <pattern>` or use ' b'include file with `hg debugsparse --include <pattern>` or use '

mercurial/dirstate.py

finally: finally:
os.close(tmpfd) os.close(tmpfd)
vfs.unlink(tmpname) vfs.unlink(tmpname)
@interfaceutil.implementer(intdirstate.idirstate) @interfaceutil.implementer(intdirstate.idirstate)
class dirstate(object): class dirstate(object):
def __init__( def __init__(
self, self,
pulkitUnsubmitted
Not Done

This will also need a b'' prefix, can you follow up for that?

pulkit: This will also need a `b''` prefix, can you follow up for that?
marmouteAuthorUnsubmitted
Done

Same feedback https://phab.mercurial-scm.org/D11012#170843

marmoute: Same feedback https://phab.mercurial-scm.org/D11012#170843
opener, opener,
ui, ui,
root, root,
validate, validate,
sparsematchfn, sparsematchfn,
nodeconstants, nodeconstants,
use_dirstate_v2, use_dirstate_v2,
): ):
self._updatedfiles.add(dest) self._updatedfiles.add(dest)
def copied(self, file): def copied(self, file):
return self._map.copymap.get(file, None) return self._map.copymap.get(file, None)
def copies(self): def copies(self):
return self._map.copymap return self._map.copymap
def set_tracked(self, filename):
"""a "public" method for generic code to mark a file as tracked
This function is to be called outside of "update/merge" case. For
example by a command like `hg add X`.
return True the file was previously untracked, False otherwise.
"""
if self._parentwriters > 0:
msg = b'calling set_tracked inside a parentchange context'
raise error.ProgrammingError(msg)
entry = self._map.get(filename)
if entry is None:
self._add(filename)
return True
elif not entry.tracked:
self.normallookup(filename)
return True
return False
def update_file_reference( def update_file_reference(
self, self,
filename, filename,
p1_tracked, p1_tracked,
): ):
"""Set a file as tracked in the parent (or not) """Set a file as tracked in the parent (or not)
Thi is to be called when adjust the dirstate to a new parent after an history Thi is to be called when adjust the dirstate to a new parent after an history