This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8182

nodemap: document the docket attributes
ClosedPublic

Authored by marmoute on Feb 28 2020, 1:54 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG283fd803afa5: nodemap: document the docket attributes
Summary

More documentation rarely hurts.

Diff Detail

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

Event Timeline

marmoute created this revision.Feb 28 2020, 1:54 PM
marmoute added a commit: rHG283fd803afa5: nodemap: document the docket attributes.Mar 10 2020, 4:48 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG283fd803afa5: nodemap: document the docket attributes (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/revlogutils/nodemap.py (11 lines)

Diff 20385

mercurial/revlogutils/nodemap.py

"""metadata associated with persistent nodemap data """metadata associated with persistent nodemap data
The persistent data may come from disk or be on their way to disk. The persistent data may come from disk or be on their way to disk.
""" """
def __init__(self, uid=None): def __init__(self, uid=None):
if uid is None: if uid is None:
uid = _make_uid() uid = _make_uid()
# a unique identifier for the data file:
# - When new data are appended, it is preserved.
# - When a new data file is created, a new identifier is generated.
self.uid = uid self.uid = uid
# the tipmost revision stored in the data file. This revision and all
# revision before it are expected to be encoded in the data file.
self.tip_rev = None self.tip_rev = None
# the size (in bytes) of the persisted data to encode the nodemap valid
# for `tip_rev`.
# - data file shorter than this are corrupted,
# - any extra data should be ignored.
self.data_length = None self.data_length = None
# the amount (in bytes) of "dead" data, still in the data file but no
# longer used for the nodemap.
self.data_unused = 0 self.data_unused = 0
def copy(self): def copy(self):
new = NodeMapDocket(uid=self.uid) new = NodeMapDocket(uid=self.uid)
new.tip_rev = self.tip_rev new.tip_rev = self.tip_rev
new.data_length = self.data_length new.data_length = self.data_length
new.data_unused = self.data_unused new.data_unused = self.data_unused
return new return new