# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 2021-09-28 23:23:10
# Node ID fabf687df0ff3ed9fcaa332090d201f73c81d2bb
# Parent  d73b42f905f89886b85885f3a109a4cba46b9d2d

dirstate-item: update the attribute documentation

It was very outdated. We are about to change these attribute so we should has
well have them documented so that the change get easier to grasp.

diff --git a/mercurial/pure/parsers.py b/mercurial/pure/parsers.py
--- a/mercurial/pure/parsers.py
+++ b/mercurial/pure/parsers.py
@@ -48,12 +48,28 @@ AMBIGUOUS_TIME = -1
 class DirstateItem(object):
     """represent a dirstate entry
 
-    It contains:
+    It hold multiple attributes
+
+    # about file tracking
+    - wc_tracked: is the file tracked by the working copy
+    - p1_tracked: is the file tracked in working copy first parent
+    - p2_tracked: is the file tracked in working copy second parent
 
-    - state (one of 'n', 'a', 'r', 'm')
-    - mode,
-    - size,
-    - mtime,
+    # about what possible merge action related to this file
+    - clean_p1: merge picked the file content from p1
+    - clean_p2: merge picked the file content from p2
+    - merged: file gather changes from both side.
+
+    # about the file state expected from p1 manifest:
+    - mode: the file mode in p1
+    - size: the file size in p1
+
+    # about the file state on disk last time we saw it:
+    - mtime: the last known clean mtime for the file.
+
+    The last three item (mode, size and mtime) can be None if no meaningful (or
+    trusted) value exists.
+
     """
 
     _wc_tracked = attr.ib()