D10104: pure-parsers: document index class constants

[Alphare (Raphaël Gomès)]

Alphare created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REPOSITORY
  rHG Mercurial

BRANCH
  default

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

AFFECTED FILES
  mercurial/pure/parsers.py

CHANGE DETAILS

diff --git a/mercurial/pure/parsers.py b/mercurial/pure/parsers.py
--- a/mercurial/pure/parsers.py
+++ b/mercurial/pure/parsers.py
@@ -42,10 +42,15 @@
 
 
 class BaseIndexObject(object):
+    # Format of an index entry according to Python's `struct` language
     index_format = b">Qiiiiii20s12x"
+    # Size of a C unsigned long long int on this platform
     big_int_size = struct.calcsize(b'Q')
+    # Size of a C long int on this platform
     int_size = struct.calcsize(b'i')
+    # Size of the entire index format on this platform
     index_size = struct.calcsize(index_format)
+    # An empty index entry, used as a default value to be overridden, or nullrev
     null_item = (0, 0, 0, -1, -1, -1, -1, nullid)
 
     @property



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