obsstore: add some documentation about the marker fields
As the number of fields grow, it makes sense to start documenting their contents.
--- 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