# HG changeset patch
# User Pulkit Goyal <7895pulkit@gmail.com>
# Date 2020-07-09 13:13:38
# Node ID a5be403dd7a00ed9e4bd5ff973a0c3b7b119e720
# Parent  01c4dccfd6b51408b2e64e8c4f16dd2341161d70

mergestate: document what mergestate._results is for

Understanding that dict is important for understanding how mergestate is
performing operations on dirstate.

Differential Revision: https://phab.mercurial-scm.org/D8739

diff --git a/mercurial/mergestate.py b/mercurial/mergestate.py
--- a/mercurial/mergestate.py
+++ b/mercurial/mergestate.py
@@ -267,6 +267,11 @@ class mergestate(object):
                 self._labels = [l for l in labels if len(l) > 0]
             elif not rtype.islower():
                 unsupported.add(rtype)
+        # contains a mapping of form:
+        # {filename : (merge_return_value, action_to_be_performed}
+        # these are results of re-running merge process
+        # this dict is used to perform actions on dirstate caused by re-running
+        # the merge
         self._results = {}
         self._dirty = False