Patchwork D8699: commitctx: document _filecommit input and output

login
register
mail settings
Submitter phabricator
Date July 8, 2020, 8:37 a.m.
Message ID <differential-rev-PHID-DREV-tsrjxprfz5gp23h2ymlr-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/46656/
State Superseded
Headers show

Comments

phabricator - July 8, 2020, 8:37 a.m.
marmoute created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  This is the beginning 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.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D8699

AFFECTED FILES
  mercurial/localrepo.py

CHANGE DETAILS




To: marmoute, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/mercurial/localrepo.py b/mercurial/localrepo.py
--- a/mercurial/localrepo.py
+++ b/mercurial/localrepo.py
@@ -2786,6 +2786,22 @@ 
     ):
         """
         commit an individual file as part of a larger transaction
+
+        input:
+
+            fctx:       a file context with the content we are trying to commit
+            manifest1:  manifest of changeset first parent
+            manifest2:  manifest of changeset second parent
+            linkrev:    revision number of the changeset being created
+            tr:         current transation
+            changelist: list of file being changed (modified inplace)
+            individual: boolean, set to False to skip storing the copy data
+                        (only used by the Google specific feature of using
+                        changeset extra as copy source of truth).
+
+        output:
+
+            The resulting filenode
         """
 
         fname = fctx.path()