Mercurial > hg
changeset 22253:4cdc3c333806
obsstore: add some documentation about the marker fields
As the number of fields grow, it makes sense to start documenting their contents.
| author | Pierre-Yves David <pierre-yves.david@fb.com> |
|---|---|
| date | Tue, 19 Aug 2014 14:42:08 -0700 |
| parents | de783f2403c4 |
| children | b8a0e8176693 |
| files | mercurial/obsolete.py |
| diffstat | 1 files changed, 5 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- 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