[Zodb-checkins] CVS: ZODB3/ZEO - cache.py:1.1.2.15

[Jeremy Hylton]

Update of /cvs-repository/ZODB3/ZEO
In directory cvs.zope.org:/tmp/cvs-serv24543

Modified Files:
      Tag: ZODB3-mvcc-2-branch
	cache.py 
Log Message:
Add brief explanation of how the two cache classes are used.


=== ZODB3/ZEO/cache.py 1.1.2.14 => 1.1.2.15 ===
--- ZODB3/ZEO/cache.py:1.1.2.14	Tue Dec 23 00:08:49 2003
+++ ZODB3/ZEO/cache.py	Tue Dec 23 00:11:34 2003
@@ -11,7 +11,16 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Disk-based client cache for ZEO."""
+"""Disk-based client cache for ZEO.
+
+ClientCache exposes an API used by the ZEO client storage.  FileCache
+stores objects one disk using a 2-tuple of oid and tid as key.
+
+The upper cache's API is similar to a storage API with methods like
+load(), store(), and invalidate().  It manages in-memory data
+structures that allow it to map this richer API onto the simple
+key-based API of the lower-level cache.
+"""
 
 import bisect
 import logging