# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 1408484528 25200
# Node ID 4cdc3c333806dac8c8317614e4ae47b1b8dd8587
# Parent  de783f2403c498ef1e20121acf178b32ec27199c
obsstore: add some documentation about the marker fields

As the number of fields grow, it makes sense to start documenting their contents.

diff -r de783f2403c4 -r 4cdc3c333806 mercurial/obsolete.py
--- a/mercurial/obsolete.py	Sat Aug 16 10:43:59 2014 +0900
+++ b/mercurial/obsolete.py	Tue Aug 19 14:42:08 2014 -0700
@@ -243,6 +243,11 @@
     """
 
     fields = ('prec', 'succs', 'flag', 'meta', 'date')
+    # prec:   nodeid, precursor changesets
+    # succs: tuple of nodeid, successor changesets (0-N length)
+    # flag:   integer, flag field carrying modifier for the markers (see doc)
+    # meta:   binary blob, encoded metadata dictionary
+    # date:   (float, int) tuple, date of marker creation
 
     def __init__(self, sopener):
         # caches for various obsolescence related cache