Mercurial > hg
changeset 20181:b9515fb9e72a
branchmap: add documentation on the branchcache on-disk format
| author | Brodie Rao <brodie@sf.io> |
|---|---|
| date | Fri, 15 Nov 2013 23:18:08 -0500 |
| parents | 969148b49fc6 |
| children | 04036798ebed |
| files | mercurial/branchmap.py |
| diffstat | 1 files changed, 16 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/branchmap.py Sun Nov 17 18:04:29 2013 -0500 +++ b/mercurial/branchmap.py Fri Nov 15 23:18:08 2013 -0500 @@ -94,7 +94,22 @@ repo._branchcaches[repo.filtername] = partial class branchcache(dict): - """A dict like object that hold branches heads cache""" + """A dict like object that hold branches heads cache. + + This cache is used to avoid costly computations to determine all the + branch heads of a repo. + + The cache is serialized on disk in the following format: + + <tip hex node> <tip rev number> [optional filtered repo hex hash] + <branch head hex node> <branch name> + <branch head hex node> <branch name> + ... + + The first line is used to check if the cache is still valid. If the + branch cache is for a filtered repo view, an optional third hash is + included that hashes the hashes of all filtered revisions. + """ def __init__(self, entries=(), tipnode=nullid, tiprev=nullrev, filteredhash=None):