Add some docs for the blockers cache format.

svn path=/main/trunk/; revision=5412

diff --git a/bin/emerge b/bin/emerge
index 9a38195057b8d6ab343810cb0acdb0a44ae381b2..92832317e167477fa2b2ccff514d1732f18098e8 100755 (executable)
--- a/bin/emerge
+++ b/bin/emerge
@@ -865,7 +865,15 @@ class BlockerCache(DictMixin):
                Currently, the cache is only written if the user has superuser
                privileges (since that's required to obtain a lock), but all users
                have read access and benefit from faster blocker lookups (as long as
-               the entire cache is still valid)."""
+               the entire cache is still valid).  The cache is stored as a pickled
+               dict object with the following format:
+
+               {
+                       version : "1",
+                       "blockers" : {cpv1:(counter,(atom1, atom2...)), cpv2...},
+                       "virtuals" : vardb.settings.getvirtuals()
+               }
+               """
                if self._modified and \
                        secpass >= 2:
                        try: