( )⚙ D8705 commitctx: document the manifest writing function

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8705

commitctx: document the manifest writing function
ClosedPublic

Authored by marmoute on Jul 8 2020, 4:37 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG5a80915e99ce: commitctx: document the manifest writing function
rHG3c2b4f08d79e: commitctx: document the manifest writing function
Summary

Same spirit as for _filecommit lets document the input and output before
making any change or improvement.

This is part of a larger refactoring/cleanup of the commitctx code to clarify
and augment the logic gathering metadata useful for copy tracing. The current
code is a tad too long and entangled to make such update easy. We start with
easy and small cleanup.

Diff Detail

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

Revision Contents
Changeset List

PathPackages
Mmercurial/manifest.py (16 lines)

Diff 21802

mercurial/manifest.py

link, link,
p1, p1,
p2, p2,
added, added,
removed, removed,
readtree=None, readtree=None,
match=None, match=None,
): ):
"""add some manifest entry in to the manifest log
input:
m: the manifest dict we want to store
transaction: the open transaction
p1: manifest-node of p1
p2: manifest-node of p2
added: file added/changed compared to parent
removed: file removed compared to parent
tree manifest input:
readtree: a function to read a subtree
match: a filematcher for the subpart of the tree manifest
"""
try: try:
if p1 not in self.fulltextcache: if p1 not in self.fulltextcache:
raise FastdeltaUnavailable() raise FastdeltaUnavailable()
# If our first parent is in the manifest cache, we can # If our first parent is in the manifest cache, we can
# compute a delta here using properties we know about the # compute a delta here using properties we know about the
# manifest up-front, which may save time later for the # manifest up-front, which may save time later for the
# revlog layer. # revlog layer.